SDK for PHP V3

S3ControlClient extends AwsClient
in package

This client is used to interact with the AWS S3 Control service.

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Tags
phpstan-method

\Aws\Result associateAccessGrantsIdentityCenter(array{AccountId?: string, IdentityCenterArn?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise associateAccessGrantsIdentityCenterAsync(array{AccountId?: string, IdentityCenterArn?: string, ...} $args = [])

phpstan-method

\Aws\Result createAccessGrant(array{ AccountId?: string, AccessGrantsLocationId?: string, AccessGrantsLocationConfiguration?: array{S3SubPrefix?: string, ...}, Grantee?: array{GranteeType?: 'DIRECTORY_GROUP'|'DIRECTORY_USER'|'IAM', GranteeIdentifier?: string, ...}, Permission?: 'READ'|'READWRITE'|'WRITE', ApplicationArn?: string, S3PrefixType?: 'Object', Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createAccessGrantAsync(array{ AccountId?: string, AccessGrantsLocationId?: string, AccessGrantsLocationConfiguration?: array{S3SubPrefix?: string, ...}, Grantee?: array{GranteeType?: 'DIRECTORY_GROUP'|'DIRECTORY_USER'|'IAM', GranteeIdentifier?: string, ...}, Permission?: 'READ'|'READWRITE'|'WRITE', ApplicationArn?: string, S3PrefixType?: 'Object', Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result createAccessGrantsInstance(array{ AccountId?: string, IdentityCenterArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createAccessGrantsInstanceAsync(array{ AccountId?: string, IdentityCenterArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result createAccessGrantsLocation(array{ AccountId?: string, LocationScope?: string, IAMRoleArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createAccessGrantsLocationAsync(array{ AccountId?: string, LocationScope?: string, IAMRoleArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result createAccessPoint(array{ AccountId?: string, Name?: string, Bucket?: string, VpcConfiguration?: array{VpcId?: string, ...}, PublicAccessBlockConfiguration?: array{ BlockPublicAcls?: bool, IgnorePublicAcls?: bool, BlockPublicPolicy?: bool, RestrictPublicBuckets?: bool, ..., }, BucketAccountId?: string, Scope?: array{ Prefixes?: list, Permissions?: list<'AbortMultipartUpload'|'DeleteObject'|'GetObject'|'GetObjectAttributes'|'ListBucket'|'ListBucketMultipartUploads'|'ListMultipartUploadParts'|'PutObject'>, ..., }, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createAccessPointAsync(array{ AccountId?: string, Name?: string, Bucket?: string, VpcConfiguration?: array{VpcId?: string, ...}, PublicAccessBlockConfiguration?: array{ BlockPublicAcls?: bool, IgnorePublicAcls?: bool, BlockPublicPolicy?: bool, RestrictPublicBuckets?: bool, ..., }, BucketAccountId?: string, Scope?: array{ Prefixes?: list, Permissions?: list<'AbortMultipartUpload'|'DeleteObject'|'GetObject'|'GetObjectAttributes'|'ListBucket'|'ListBucketMultipartUploads'|'ListMultipartUploadParts'|'PutObject'>, ..., }, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result createAccessPointForObjectLambda(array{ AccountId?: string, Name?: string, Configuration?: array{ SupportingAccessPoint?: string, CloudWatchMetricsEnabled?: bool, AllowedFeatures?: list<'GetObject-PartNumber'|'GetObject-Range'|'HeadObject-PartNumber'|'HeadObject-Range'>, TransformationConfigurations?: list, ..., }, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createAccessPointForObjectLambdaAsync(array{ AccountId?: string, Name?: string, Configuration?: array{ SupportingAccessPoint?: string, CloudWatchMetricsEnabled?: bool, AllowedFeatures?: list<'GetObject-PartNumber'|'GetObject-Range'|'HeadObject-PartNumber'|'HeadObject-Range'>, TransformationConfigurations?: list, ..., }, ..., } $args = [])

phpstan-method

\Aws\Result createBucket(array{ ACL?: 'authenticated-read'|'private'|'public-read'|'public-read-write', Bucket?: string, CreateBucketConfiguration?: array{ LocationConstraint?: 'EU'|'ap-northeast-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'cn-north-1'|'eu-central-1'|'eu-west-1'|'sa-east-1'|'us-west-1'|'us-west-2', ..., }, GrantFullControl?: string, GrantRead?: string, GrantReadACP?: string, GrantWrite?: string, GrantWriteACP?: string, ObjectLockEnabledForBucket?: bool, OutpostId?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createBucketAsync(array{ ACL?: 'authenticated-read'|'private'|'public-read'|'public-read-write', Bucket?: string, CreateBucketConfiguration?: array{ LocationConstraint?: 'EU'|'ap-northeast-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'cn-north-1'|'eu-central-1'|'eu-west-1'|'sa-east-1'|'us-west-1'|'us-west-2', ..., }, GrantFullControl?: string, GrantRead?: string, GrantReadACP?: string, GrantWrite?: string, GrantWriteACP?: string, ObjectLockEnabledForBucket?: bool, OutpostId?: string, ..., } $args = [])

phpstan-method

\Aws\Result createJob(array{ AccountId?: string, ConfirmationRequired?: bool, Operation?: array{ LambdaInvoke?: array{FunctionArn?: string, InvocationSchemaVersion?: string, UserArguments?: array<string, string>, ...}, S3PutObjectCopy?: array{ TargetResource?: string, CannedAccessControlList?: 'authenticated-read'|'aws-exec-read'|'bucket-owner-full-control'|'bucket-owner-read'|'private'|'public-read'|'public-read-write', AccessControlGrants?: list, MetadataDirective?: 'COPY'|'REPLACE', AnnotationDirective?: 'COPY'|'EXCLUDE', ModifiedSinceConstraint?: int|string|\DateTimeInterface, NewObjectMetadata?: array, NewObjectTagging?: list, RedirectLocation?: string, RequesterPays?: bool, StorageClass?: 'DEEP_ARCHIVE'|'GLACIER'|'GLACIER_IR'|'INTELLIGENT_TIERING'|'ONEZONE_IA'|'STANDARD'|'STANDARD_IA', UnModifiedSinceConstraint?: int|string|\DateTimeInterface, SSEAwsKmsKeyId?: string, TargetKeyPrefix?: string, ObjectLockLegalHoldStatus?: 'OFF'|'ON', ObjectLockMode?: 'COMPLIANCE'|'GOVERNANCE', ObjectLockRetainUntilDate?: int|string|\DateTimeInterface, BucketKeyEnabled?: bool, ChecksumAlgorithm?: 'CRC32'|'CRC32C'|'CRC64NVME'|'MD5'|'SHA1'|'SHA256'|'SHA512'|'XXHASH128'|'XXHASH3'|'XXHASH64', ObjectLockEventHold?: 'OFF'|'ON', ObjectLockEventHoldDuration?: array, ..., }, S3PutObjectAcl?: array{AccessControlPolicy?: array, ...}, S3PutObjectTagging?: array{TagSet?: list, ...}, S3DeleteObjectTagging?: array, S3InitiateRestoreObject?: array{ExpirationInDays?: int, GlacierJobTier?: 'BULK'|'STANDARD', ...}, S3PutObjectLegalHold?: array{LegalHold?: array, ...}, S3PutObjectRetention?: array{BypassGovernanceRetention?: bool, Retention?: array, ...}, S3ReplicateObject?: array, S3ComputeObjectChecksum?: array{ ChecksumAlgorithm?: 'CRC32'|'CRC32C'|'CRC64NVME'|'MD5'|'SHA1'|'SHA256'|'SHA512'|'XXHASH128'|'XXHASH3'|'XXHASH64', ChecksumType?: 'COMPOSITE'|'FULL_OBJECT', ..., }, S3UpdateObjectEncryption?: array{ObjectEncryption?: array, ...}, ..., }, Report?: array{ Bucket?: string, Format?: 'Report_CSV_20180820', Enabled?: bool, Prefix?: string, ReportScope?: 'AllTasks'|'FailedTasksOnly', ExpectedBucketOwner?: string, ..., }, ClientRequestToken?: string, Manifest?: array{ Spec?: array{ Format?: 'S3BatchOperations_CSV_20180820'|'S3InventoryReport_CSV_20161130', Fields?: list<'Bucket'|'Ignore'|'Key'|'VersionId'>, ..., }, Location?: array{ObjectArn?: string, ObjectVersionId?: string, ETag?: string, ...}, ..., }, Description?: string, Priority?: int, RoleArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ManifestGenerator?: array{ S3JobManifestGenerator?: array{ ExpectedBucketOwner?: string, SourceBucket?: string, ManifestOutputLocation?: array, Filter?: array, EnableManifestOutput?: bool, ..., }, ..., }, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createJobAsync(array{ AccountId?: string, ConfirmationRequired?: bool, Operation?: array{ LambdaInvoke?: array{FunctionArn?: string, InvocationSchemaVersion?: string, UserArguments?: array<string, string>, ...}, S3PutObjectCopy?: array{ TargetResource?: string, CannedAccessControlList?: 'authenticated-read'|'aws-exec-read'|'bucket-owner-full-control'|'bucket-owner-read'|'private'|'public-read'|'public-read-write', AccessControlGrants?: list, MetadataDirective?: 'COPY'|'REPLACE', AnnotationDirective?: 'COPY'|'EXCLUDE', ModifiedSinceConstraint?: int|string|\DateTimeInterface, NewObjectMetadata?: array, NewObjectTagging?: list, RedirectLocation?: string, RequesterPays?: bool, StorageClass?: 'DEEP_ARCHIVE'|'GLACIER'|'GLACIER_IR'|'INTELLIGENT_TIERING'|'ONEZONE_IA'|'STANDARD'|'STANDARD_IA', UnModifiedSinceConstraint?: int|string|\DateTimeInterface, SSEAwsKmsKeyId?: string, TargetKeyPrefix?: string, ObjectLockLegalHoldStatus?: 'OFF'|'ON', ObjectLockMode?: 'COMPLIANCE'|'GOVERNANCE', ObjectLockRetainUntilDate?: int|string|\DateTimeInterface, BucketKeyEnabled?: bool, ChecksumAlgorithm?: 'CRC32'|'CRC32C'|'CRC64NVME'|'MD5'|'SHA1'|'SHA256'|'SHA512'|'XXHASH128'|'XXHASH3'|'XXHASH64', ObjectLockEventHold?: 'OFF'|'ON', ObjectLockEventHoldDuration?: array, ..., }, S3PutObjectAcl?: array{AccessControlPolicy?: array, ...}, S3PutObjectTagging?: array{TagSet?: list, ...}, S3DeleteObjectTagging?: array, S3InitiateRestoreObject?: array{ExpirationInDays?: int, GlacierJobTier?: 'BULK'|'STANDARD', ...}, S3PutObjectLegalHold?: array{LegalHold?: array, ...}, S3PutObjectRetention?: array{BypassGovernanceRetention?: bool, Retention?: array, ...}, S3ReplicateObject?: array, S3ComputeObjectChecksum?: array{ ChecksumAlgorithm?: 'CRC32'|'CRC32C'|'CRC64NVME'|'MD5'|'SHA1'|'SHA256'|'SHA512'|'XXHASH128'|'XXHASH3'|'XXHASH64', ChecksumType?: 'COMPOSITE'|'FULL_OBJECT', ..., }, S3UpdateObjectEncryption?: array{ObjectEncryption?: array, ...}, ..., }, Report?: array{ Bucket?: string, Format?: 'Report_CSV_20180820', Enabled?: bool, Prefix?: string, ReportScope?: 'AllTasks'|'FailedTasksOnly', ExpectedBucketOwner?: string, ..., }, ClientRequestToken?: string, Manifest?: array{ Spec?: array{ Format?: 'S3BatchOperations_CSV_20180820'|'S3InventoryReport_CSV_20161130', Fields?: list<'Bucket'|'Ignore'|'Key'|'VersionId'>, ..., }, Location?: array{ObjectArn?: string, ObjectVersionId?: string, ETag?: string, ...}, ..., }, Description?: string, Priority?: int, RoleArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ManifestGenerator?: array{ S3JobManifestGenerator?: array{ ExpectedBucketOwner?: string, SourceBucket?: string, ManifestOutputLocation?: array, Filter?: array, EnableManifestOutput?: bool, ..., }, ..., }, ..., } $args = [])

phpstan-method

\Aws\Result createMultiRegionAccessPoint(array{ AccountId?: string, ClientToken?: string, Details?: array{ Name?: string, PublicAccessBlock?: array{ BlockPublicAcls?: bool, IgnorePublicAcls?: bool, BlockPublicPolicy?: bool, RestrictPublicBuckets?: bool, ..., }, Regions?: list, ..., }, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createMultiRegionAccessPointAsync(array{ AccountId?: string, ClientToken?: string, Details?: array{ Name?: string, PublicAccessBlock?: array{ BlockPublicAcls?: bool, IgnorePublicAcls?: bool, BlockPublicPolicy?: bool, RestrictPublicBuckets?: bool, ..., }, Regions?: list, ..., }, ..., } $args = [])

phpstan-method

\Aws\Result createStorageLensGroup(array{ AccountId?: string, StorageLensGroup?: array{ Name?: string, Filter?: array{ MatchAnyPrefix?: list, MatchAnySuffix?: list, MatchAnyTag?: list, MatchObjectAge?: array, MatchObjectSize?: array, And?: array, Or?: array, ..., }, StorageLensGroupArn?: string, ..., }, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise createStorageLensGroupAsync(array{ AccountId?: string, StorageLensGroup?: array{ Name?: string, Filter?: array{ MatchAnyPrefix?: list, MatchAnySuffix?: list, MatchAnyTag?: list, MatchObjectAge?: array, MatchObjectSize?: array, And?: array, Or?: array, ..., }, StorageLensGroupArn?: string, ..., }, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result deleteAccessGrant(array{AccountId?: string, AccessGrantId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessGrantAsync(array{AccountId?: string, AccessGrantId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessGrantsInstance(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessGrantsInstanceAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessGrantsInstanceResourcePolicy(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessGrantsInstanceResourcePolicyAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessGrantsLocation(array{AccountId?: string, AccessGrantsLocationId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessGrantsLocationAsync(array{AccountId?: string, AccessGrantsLocationId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessPoint(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessPointAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessPointForObjectLambda(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessPointForObjectLambdaAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessPointPolicy(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessPointPolicyAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessPointPolicyForObjectLambda(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessPointPolicyForObjectLambdaAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteAccessPointScope(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteAccessPointScopeAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBucket(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBucketAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBucketLifecycleConfiguration(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBucketLifecycleConfigurationAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBucketPolicy(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBucketPolicyAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBucketReplication(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBucketReplicationAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteBucketTagging(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteBucketTaggingAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteJobTagging(array{AccountId?: string, JobId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteJobTaggingAsync(array{AccountId?: string, JobId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteMultiRegionAccessPoint(array{AccountId?: string, ClientToken?: string, Details?: array{Name?: string, ...}, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteMultiRegionAccessPointAsync(array{AccountId?: string, ClientToken?: string, Details?: array{Name?: string, ...}, ...} $args = [])

phpstan-method

\Aws\Result deletePublicAccessBlock(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deletePublicAccessBlockAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteStorageLensConfiguration(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteStorageLensConfigurationAsync(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteStorageLensConfigurationTagging(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteStorageLensConfigurationTaggingAsync(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result deleteStorageLensGroup(array{Name?: string, AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise deleteStorageLensGroupAsync(array{Name?: string, AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result describeJob(array{AccountId?: string, JobId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise describeJobAsync(array{AccountId?: string, JobId?: string, ...} $args = [])

phpstan-method

\Aws\Result describeMultiRegionAccessPointOperation(array{AccountId?: string, RequestTokenARN?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise describeMultiRegionAccessPointOperationAsync(array{AccountId?: string, RequestTokenARN?: string, ...} $args = [])

phpstan-method

\Aws\Result dissociateAccessGrantsIdentityCenter(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise dissociateAccessGrantsIdentityCenterAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessGrant(array{AccountId?: string, AccessGrantId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessGrantAsync(array{AccountId?: string, AccessGrantId?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessGrantsInstance(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessGrantsInstanceAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessGrantsInstanceForPrefix(array{AccountId?: string, S3Prefix?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessGrantsInstanceForPrefixAsync(array{AccountId?: string, S3Prefix?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessGrantsInstanceResourcePolicy(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessGrantsInstanceResourcePolicyAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessGrantsLocation(array{AccountId?: string, AccessGrantsLocationId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessGrantsLocationAsync(array{AccountId?: string, AccessGrantsLocationId?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPoint(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointConfigurationForObjectLambda(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointConfigurationForObjectLambdaAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointForObjectLambda(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointForObjectLambdaAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointPolicy(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointPolicyAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointPolicyForObjectLambda(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointPolicyForObjectLambdaAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointPolicyStatus(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointPolicyStatusAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointPolicyStatusForObjectLambda(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointPolicyStatusForObjectLambdaAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getAccessPointScope(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getAccessPointScopeAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getBucket(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBucketAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result getBucketLifecycleConfiguration(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBucketLifecycleConfigurationAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result getBucketPolicy(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBucketPolicyAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result getBucketReplication(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBucketReplicationAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result getBucketTagging(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBucketTaggingAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result getBucketVersioning(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getBucketVersioningAsync(array{AccountId?: string, Bucket?: string, ...} $args = [])

phpstan-method

\Aws\Result getDataAccess(array{ AccountId?: string, Target?: string, Permission?: 'READ'|'READWRITE'|'WRITE', DurationSeconds?: int, Privilege?: 'Default'|'Minimal', TargetType?: 'Object', AuditContext?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getDataAccessAsync(array{ AccountId?: string, Target?: string, Permission?: 'READ'|'READWRITE'|'WRITE', DurationSeconds?: int, Privilege?: 'Default'|'Minimal', TargetType?: 'Object', AuditContext?: string, ..., } $args = [])

phpstan-method

\Aws\Result getJobTagging(array{AccountId?: string, JobId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getJobTaggingAsync(array{AccountId?: string, JobId?: string, ...} $args = [])

phpstan-method

\Aws\Result getMultiRegionAccessPoint(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMultiRegionAccessPointAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getMultiRegionAccessPointPolicy(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMultiRegionAccessPointPolicyAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getMultiRegionAccessPointPolicyStatus(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMultiRegionAccessPointPolicyStatusAsync(array{AccountId?: string, Name?: string, ...} $args = [])

phpstan-method

\Aws\Result getMultiRegionAccessPointRoutes(array{AccountId?: string, Mrap?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getMultiRegionAccessPointRoutesAsync(array{AccountId?: string, Mrap?: string, ...} $args = [])

phpstan-method

\Aws\Result getPublicAccessBlock(array{AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getPublicAccessBlockAsync(array{AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result getStorageLensConfiguration(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getStorageLensConfigurationAsync(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result getStorageLensConfigurationTagging(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getStorageLensConfigurationTaggingAsync(array{ConfigId?: string, AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result getStorageLensGroup(array{Name?: string, AccountId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise getStorageLensGroupAsync(array{Name?: string, AccountId?: string, ...} $args = [])

phpstan-method

\Aws\Result listAccessGrants(array{ AccountId?: string, NextToken?: string, MaxResults?: int, GranteeType?: 'DIRECTORY_GROUP'|'DIRECTORY_USER'|'IAM', GranteeIdentifier?: string, Permission?: 'READ'|'READWRITE'|'WRITE', GrantScope?: string, ApplicationArn?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAccessGrantsAsync(array{ AccountId?: string, NextToken?: string, MaxResults?: int, GranteeType?: 'DIRECTORY_GROUP'|'DIRECTORY_USER'|'IAM', GranteeIdentifier?: string, Permission?: 'READ'|'READWRITE'|'WRITE', GrantScope?: string, ApplicationArn?: string, ..., } $args = [])

phpstan-method

\Aws\Result listAccessGrantsInstances(array{AccountId?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAccessGrantsInstancesAsync(array{AccountId?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listAccessGrantsLocations(array{AccountId?: string, NextToken?: string, MaxResults?: int, LocationScope?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAccessGrantsLocationsAsync(array{AccountId?: string, NextToken?: string, MaxResults?: int, LocationScope?: string, ...} $args = [])

phpstan-method

\Aws\Result listAccessPoints(array{ AccountId?: string, Bucket?: string, NextToken?: string, MaxResults?: int, DataSourceId?: string, DataSourceType?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAccessPointsAsync(array{ AccountId?: string, Bucket?: string, NextToken?: string, MaxResults?: int, DataSourceId?: string, DataSourceType?: string, ..., } $args = [])

phpstan-method

\Aws\Result listAccessPointsForDirectoryBuckets(array{AccountId?: string, DirectoryBucket?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAccessPointsForDirectoryBucketsAsync(array{AccountId?: string, DirectoryBucket?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listAccessPointsForObjectLambda(array{AccountId?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listAccessPointsForObjectLambdaAsync(array{AccountId?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listCallerAccessGrants(array{ AccountId?: string, GrantScope?: string, NextToken?: string, MaxResults?: int, AllowedByApplication?: bool, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listCallerAccessGrantsAsync(array{ AccountId?: string, GrantScope?: string, NextToken?: string, MaxResults?: int, AllowedByApplication?: bool, ..., } $args = [])

phpstan-method

\Aws\Result listJobs(array{ AccountId?: string, JobStatuses?: list<'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended'>, NextToken?: string, MaxResults?: int, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listJobsAsync(array{ AccountId?: string, JobStatuses?: list<'Active'|'Cancelled'|'Cancelling'|'Complete'|'Completing'|'Failed'|'Failing'|'New'|'Paused'|'Pausing'|'Preparing'|'Ready'|'Suspended'>, NextToken?: string, MaxResults?: int, ..., } $args = [])

phpstan-method

\Aws\Result listMultiRegionAccessPoints(array{AccountId?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listMultiRegionAccessPointsAsync(array{AccountId?: string, NextToken?: string, MaxResults?: int, ...} $args = [])

phpstan-method

\Aws\Result listRegionalBuckets(array{AccountId?: string, NextToken?: string, MaxResults?: int, OutpostId?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listRegionalBucketsAsync(array{AccountId?: string, NextToken?: string, MaxResults?: int, OutpostId?: string, ...} $args = [])

phpstan-method

\Aws\Result listStorageLensConfigurations(array{AccountId?: string, NextToken?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listStorageLensConfigurationsAsync(array{AccountId?: string, NextToken?: string, ...} $args = [])

phpstan-method

\Aws\Result listStorageLensGroups(array{AccountId?: string, NextToken?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listStorageLensGroupsAsync(array{AccountId?: string, NextToken?: string, ...} $args = [])

phpstan-method

\Aws\Result listTagsForResource(array{AccountId?: string, ResourceArn?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise listTagsForResourceAsync(array{AccountId?: string, ResourceArn?: string, ...} $args = [])

phpstan-method

\Aws\Result putAccessGrantsInstanceResourcePolicy(array{AccountId?: string, Policy?: string, Organization?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putAccessGrantsInstanceResourcePolicyAsync(array{AccountId?: string, Policy?: string, Organization?: string, ...} $args = [])

phpstan-method

\Aws\Result putAccessPointConfigurationForObjectLambda(array{ AccountId?: string, Name?: string, Configuration?: array{ SupportingAccessPoint?: string, CloudWatchMetricsEnabled?: bool, AllowedFeatures?: list<'GetObject-PartNumber'|'GetObject-Range'|'HeadObject-PartNumber'|'HeadObject-Range'>, TransformationConfigurations?: list, ..., }, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putAccessPointConfigurationForObjectLambdaAsync(array{ AccountId?: string, Name?: string, Configuration?: array{ SupportingAccessPoint?: string, CloudWatchMetricsEnabled?: bool, AllowedFeatures?: list<'GetObject-PartNumber'|'GetObject-Range'|'HeadObject-PartNumber'|'HeadObject-Range'>, TransformationConfigurations?: list, ..., }, ..., } $args = [])

phpstan-method

\Aws\Result putAccessPointPolicy(array{AccountId?: string, Name?: string, Policy?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putAccessPointPolicyAsync(array{AccountId?: string, Name?: string, Policy?: string, ...} $args = [])

phpstan-method

\Aws\Result putAccessPointPolicyForObjectLambda(array{AccountId?: string, Name?: string, Policy?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putAccessPointPolicyForObjectLambdaAsync(array{AccountId?: string, Name?: string, Policy?: string, ...} $args = [])

phpstan-method

\Aws\Result putAccessPointScope(array{ AccountId?: string, Name?: string, Scope?: array{ Prefixes?: list, Permissions?: list<'AbortMultipartUpload'|'DeleteObject'|'GetObject'|'GetObjectAttributes'|'ListBucket'|'ListBucketMultipartUploads'|'ListMultipartUploadParts'|'PutObject'>, ..., }, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putAccessPointScopeAsync(array{ AccountId?: string, Name?: string, Scope?: array{ Prefixes?: list, Permissions?: list<'AbortMultipartUpload'|'DeleteObject'|'GetObject'|'GetObjectAttributes'|'ListBucket'|'ListBucketMultipartUploads'|'ListMultipartUploadParts'|'PutObject'>, ..., }, ..., } $args = [])

phpstan-method

\Aws\Result putBucketLifecycleConfiguration(array{AccountId?: string, Bucket?: string, LifecycleConfiguration?: array{Rules?: list, ...}, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putBucketLifecycleConfigurationAsync(array{AccountId?: string, Bucket?: string, LifecycleConfiguration?: array{Rules?: list, ...}, ...} $args = [])

phpstan-method

\Aws\Result putBucketPolicy(array{AccountId?: string, Bucket?: string, ConfirmRemoveSelfBucketAccess?: bool, Policy?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putBucketPolicyAsync(array{AccountId?: string, Bucket?: string, ConfirmRemoveSelfBucketAccess?: bool, Policy?: string, ...} $args = [])

phpstan-method

\Aws\Result putBucketReplication(array{ AccountId?: string, Bucket?: string, ReplicationConfiguration?: array{Role?: string, Rules?: list, ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putBucketReplicationAsync(array{ AccountId?: string, Bucket?: string, ReplicationConfiguration?: array{Role?: string, Rules?: list, ...}, ..., } $args = [])

phpstan-method

\Aws\Result putBucketTagging(array{AccountId?: string, Bucket?: string, Tagging?: array{TagSet?: list, ...}, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putBucketTaggingAsync(array{AccountId?: string, Bucket?: string, Tagging?: array{TagSet?: list, ...}, ...} $args = [])

phpstan-method

\Aws\Result putBucketVersioning(array{ AccountId?: string, Bucket?: string, MFA?: string, VersioningConfiguration?: array{MFADelete?: 'Disabled'|'Enabled', Status?: 'Enabled'|'Suspended', ...}, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putBucketVersioningAsync(array{ AccountId?: string, Bucket?: string, MFA?: string, VersioningConfiguration?: array{MFADelete?: 'Disabled'|'Enabled', Status?: 'Enabled'|'Suspended', ...}, ..., } $args = [])

phpstan-method

\Aws\Result putJobTagging(array{AccountId?: string, JobId?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putJobTaggingAsync(array{AccountId?: string, JobId?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ...} $args = [])

phpstan-method

\Aws\Result putMultiRegionAccessPointPolicy(array{AccountId?: string, ClientToken?: string, Details?: array{Name?: string, Policy?: string, ...}, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putMultiRegionAccessPointPolicyAsync(array{AccountId?: string, ClientToken?: string, Details?: array{Name?: string, Policy?: string, ...}, ...} $args = [])

phpstan-method

\Aws\Result putPublicAccessBlock(array{ PublicAccessBlockConfiguration?: array{ BlockPublicAcls?: bool, IgnorePublicAcls?: bool, BlockPublicPolicy?: bool, RestrictPublicBuckets?: bool, ..., }, AccountId?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putPublicAccessBlockAsync(array{ PublicAccessBlockConfiguration?: array{ BlockPublicAcls?: bool, IgnorePublicAcls?: bool, BlockPublicPolicy?: bool, RestrictPublicBuckets?: bool, ..., }, AccountId?: string, ..., } $args = [])

phpstan-method

\Aws\Result putStorageLensConfiguration(array{ ConfigId?: string, AccountId?: string, StorageLensConfiguration?: array{ Id?: string, AccountLevel?: array{ ActivityMetrics?: array, BucketLevel?: array, AdvancedCostOptimizationMetrics?: array, AdvancedDataProtectionMetrics?: array, DetailedStatusCodesMetrics?: array, AdvancedPerformanceMetrics?: array, StorageLensGroupLevel?: array, ..., }, Include?: array{Buckets?: list, Regions?: list, ...}, Exclude?: array{Buckets?: list, Regions?: list, ...}, DataExport?: array{S3BucketDestination?: array, CloudWatchMetrics?: array, StorageLensTableDestination?: array, ...}, ExpandedPrefixesDataExport?: array{S3BucketDestination?: array, StorageLensTableDestination?: array, ...}, IsEnabled?: bool, AwsOrg?: array{Arn?: string, ...}, StorageLensArn?: string, PrefixDelimiter?: string, ..., }, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putStorageLensConfigurationAsync(array{ ConfigId?: string, AccountId?: string, StorageLensConfiguration?: array{ Id?: string, AccountLevel?: array{ ActivityMetrics?: array, BucketLevel?: array, AdvancedCostOptimizationMetrics?: array, AdvancedDataProtectionMetrics?: array, DetailedStatusCodesMetrics?: array, AdvancedPerformanceMetrics?: array, StorageLensGroupLevel?: array, ..., }, Include?: array{Buckets?: list, Regions?: list, ...}, Exclude?: array{Buckets?: list, Regions?: list, ...}, DataExport?: array{S3BucketDestination?: array, CloudWatchMetrics?: array, StorageLensTableDestination?: array, ...}, ExpandedPrefixesDataExport?: array{S3BucketDestination?: array, StorageLensTableDestination?: array, ...}, IsEnabled?: bool, AwsOrg?: array{Arn?: string, ...}, StorageLensArn?: string, PrefixDelimiter?: string, ..., }, Tags?: list<array{Key?: string, Value?: string, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result putStorageLensConfigurationTagging(array{ConfigId?: string, AccountId?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise putStorageLensConfigurationTaggingAsync(array{ConfigId?: string, AccountId?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ...} $args = [])

phpstan-method

\Aws\Result submitMultiRegionAccessPointRoutes(array{ AccountId?: string, Mrap?: string, RouteUpdates?: list<array{Bucket?: string, Region?: string, TrafficDialPercentage?: int, ...}>, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise submitMultiRegionAccessPointRoutesAsync(array{ AccountId?: string, Mrap?: string, RouteUpdates?: list<array{Bucket?: string, Region?: string, TrafficDialPercentage?: int, ...}>, ..., } $args = [])

phpstan-method

\Aws\Result tagResource(array{AccountId?: string, ResourceArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise tagResourceAsync(array{AccountId?: string, ResourceArn?: string, Tags?: list<array{Key?: string, Value?: string, ...}>, ...} $args = [])

phpstan-method

\Aws\Result untagResource(array{AccountId?: string, ResourceArn?: string, TagKeys?: list, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise untagResourceAsync(array{AccountId?: string, ResourceArn?: string, TagKeys?: list, ...} $args = [])

phpstan-method

\Aws\Result updateAccessGrantsLocation(array{AccountId?: string, AccessGrantsLocationId?: string, IAMRoleArn?: string, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateAccessGrantsLocationAsync(array{AccountId?: string, AccessGrantsLocationId?: string, IAMRoleArn?: string, ...} $args = [])

phpstan-method

\Aws\Result updateJobPriority(array{AccountId?: string, JobId?: string, Priority?: int, ...} $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateJobPriorityAsync(array{AccountId?: string, JobId?: string, Priority?: int, ...} $args = [])

phpstan-method

\Aws\Result updateJobStatus(array{ AccountId?: string, JobId?: string, RequestedJobStatus?: 'Cancelled'|'Ready', StatusUpdateReason?: string, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateJobStatusAsync(array{ AccountId?: string, JobId?: string, RequestedJobStatus?: 'Cancelled'|'Ready', StatusUpdateReason?: string, ..., } $args = [])

phpstan-method

\Aws\Result updateStorageLensGroup(array{ Name?: string, AccountId?: string, StorageLensGroup?: array{ Name?: string, Filter?: array{ MatchAnyPrefix?: list, MatchAnySuffix?: list, MatchAnyTag?: list, MatchObjectAge?: array, MatchObjectSize?: array, And?: array, Or?: array, ..., }, StorageLensGroupArn?: string, ..., }, ..., } $args = [])

phpstan-method

\GuzzleHttp\Promise\Promise updateStorageLensGroupAsync(array{ Name?: string, AccountId?: string, StorageLensGroup?: array{ Name?: string, Filter?: array{ MatchAnyPrefix?: list, MatchAnySuffix?: list, MatchAnyTag?: list, MatchObjectAge?: array, MatchObjectSize?: array, And?: array, Or?: array, ..., }, StorageLensGroupArn?: string, ..., }, ..., } $args = [])

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
_apply_use_arn_region()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getToken()  : mixed
getWaiter()  : mixed
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed

In addition to the options available to AwsClient::__construct, S3ControlClient accepts the following option:

  • use_dual_stack_endpoint: (bool) Set to true to send requests to an S3 Control Dual Stack endpoint by default, which enables IPv6 Protocol. Can be enabled or disabled on individual operations by setting '@use_dual_stack_endpoint' to true or false. Note: you cannot use it together with an accelerate endpoint.
Parameters
$args : array<string|int, mixed>

__sleep()

public __sleep() : mixed

_apply_use_arn_region()

public static _apply_use_arn_region(mixed $value, array<string|int, mixed> &$args, HandlerList $list) : mixed
Parameters
$value : mixed
$args : array<string|int, mixed>
$list : HandlerList

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommand()

public abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
$name : string
$args : array<string|int, mixed> = []
Return values
CommandInterface

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getToken()

public getToken() : mixed

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
<-- modeled_exceptions -->
On this page