SDK for PHP 3.x

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.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
_apply_use_arn_region()  : mixed
associateAccessGrantsIdentityCenter()  : Result
associateAccessGrantsIdentityCenterAsync()  : Promise
createAccessGrant()  : Result
createAccessGrantAsync()  : Promise
createAccessGrantsInstance()  : Result
createAccessGrantsInstanceAsync()  : Promise
createAccessGrantsLocation()  : Result
createAccessGrantsLocationAsync()  : Promise
createAccessPoint()  : Result
createAccessPointAsync()  : Promise
createAccessPointForObjectLambda()  : Result
createAccessPointForObjectLambdaAsync()  : Promise
createBucket()  : Result
createBucketAsync()  : Promise
createJob()  : Result
createJobAsync()  : Promise
createMultiRegionAccessPoint()  : Result
createMultiRegionAccessPointAsync()  : Promise
createStorageLensGroup()  : Result
createStorageLensGroupAsync()  : Promise
deleteAccessGrant()  : Result
deleteAccessGrantAsync()  : Promise
deleteAccessGrantsInstance()  : Result
deleteAccessGrantsInstanceAsync()  : Promise
deleteAccessGrantsInstanceResourcePolicy()  : Result
deleteAccessGrantsInstanceResourcePolicyAsync()  : Promise
deleteAccessGrantsLocation()  : Result
deleteAccessGrantsLocationAsync()  : Promise
deleteAccessPoint()  : Result
deleteAccessPointAsync()  : Promise
deleteAccessPointForObjectLambda()  : Result
deleteAccessPointForObjectLambdaAsync()  : Promise
deleteAccessPointPolicy()  : Result
deleteAccessPointPolicyAsync()  : Promise
deleteAccessPointPolicyForObjectLambda()  : Result
deleteAccessPointPolicyForObjectLambdaAsync()  : Promise
deleteBucket()  : Result
deleteBucketAsync()  : Promise
deleteBucketLifecycleConfiguration()  : Result
deleteBucketLifecycleConfigurationAsync()  : Promise
deleteBucketPolicy()  : Result
deleteBucketPolicyAsync()  : Promise
deleteBucketReplication()  : Result
deleteBucketReplicationAsync()  : Promise
deleteBucketTagging()  : Result
deleteBucketTaggingAsync()  : Promise
deleteJobTagging()  : Result
deleteJobTaggingAsync()  : Promise
deleteMultiRegionAccessPoint()  : Result
deleteMultiRegionAccessPointAsync()  : Promise
deletePublicAccessBlock()  : Result
deletePublicAccessBlockAsync()  : Promise
deleteStorageLensConfiguration()  : Result
deleteStorageLensConfigurationAsync()  : Promise
deleteStorageLensConfigurationTagging()  : Result
deleteStorageLensConfigurationTaggingAsync()  : Promise
deleteStorageLensGroup()  : Result
deleteStorageLensGroupAsync()  : Promise
describeJob()  : Result
describeJobAsync()  : Promise
describeMultiRegionAccessPointOperation()  : Result
describeMultiRegionAccessPointOperationAsync()  : Promise
dissociateAccessGrantsIdentityCenter()  : Result
dissociateAccessGrantsIdentityCenterAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAccessGrant()  : Result
getAccessGrantAsync()  : Promise
getAccessGrantsInstance()  : Result
getAccessGrantsInstanceAsync()  : Promise
getAccessGrantsInstanceForPrefix()  : Result
getAccessGrantsInstanceForPrefixAsync()  : Promise
getAccessGrantsInstanceResourcePolicy()  : Result
getAccessGrantsInstanceResourcePolicyAsync()  : Promise
getAccessGrantsLocation()  : Result
getAccessGrantsLocationAsync()  : Promise
getAccessPoint()  : Result
getAccessPointAsync()  : Promise
getAccessPointConfigurationForObjectLambda()  : Result
getAccessPointConfigurationForObjectLambdaAsync()  : Promise
getAccessPointForObjectLambda()  : Result
getAccessPointForObjectLambdaAsync()  : Promise
getAccessPointPolicy()  : Result
getAccessPointPolicyAsync()  : Promise
getAccessPointPolicyForObjectLambda()  : Result
getAccessPointPolicyForObjectLambdaAsync()  : Promise
getAccessPointPolicyStatus()  : Result
getAccessPointPolicyStatusAsync()  : Promise
getAccessPointPolicyStatusForObjectLambda()  : Result
getAccessPointPolicyStatusForObjectLambdaAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getBucket()  : Result
getBucketAsync()  : Promise
getBucketLifecycleConfiguration()  : Result
getBucketLifecycleConfigurationAsync()  : Promise
getBucketPolicy()  : Result
getBucketPolicyAsync()  : Promise
getBucketReplication()  : Result
getBucketReplicationAsync()  : Promise
getBucketTagging()  : Result
getBucketTaggingAsync()  : Promise
getBucketVersioning()  : Result
getBucketVersioningAsync()  : Promise
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.
getDataAccess()  : Result
getDataAccessAsync()  : Promise
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
getJobTagging()  : Result
getJobTaggingAsync()  : Promise
getMultiRegionAccessPoint()  : Result
getMultiRegionAccessPointAsync()  : Promise
getMultiRegionAccessPointPolicy()  : Result
getMultiRegionAccessPointPolicyAsync()  : Promise
getMultiRegionAccessPointPolicyStatus()  : Result
getMultiRegionAccessPointPolicyStatusAsync()  : Promise
getMultiRegionAccessPointRoutes()  : Result
getMultiRegionAccessPointRoutesAsync()  : Promise
getPaginator()  : mixed
getPublicAccessBlock()  : Result
getPublicAccessBlockAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getStorageLensConfiguration()  : Result
getStorageLensConfigurationAsync()  : Promise
getStorageLensConfigurationTagging()  : Result
getStorageLensConfigurationTaggingAsync()  : Promise
getStorageLensGroup()  : Result
getStorageLensGroupAsync()  : Promise
getWaiter()  : mixed
listAccessGrants()  : Result
listAccessGrantsAsync()  : Promise
listAccessGrantsInstances()  : Result
listAccessGrantsInstancesAsync()  : Promise
listAccessGrantsLocations()  : Result
listAccessGrantsLocationsAsync()  : Promise
listAccessPoints()  : Result
listAccessPointsAsync()  : Promise
listAccessPointsForObjectLambda()  : Result
listAccessPointsForObjectLambdaAsync()  : Promise
listJobs()  : Result
listJobsAsync()  : Promise
listMultiRegionAccessPoints()  : Result
listMultiRegionAccessPointsAsync()  : Promise
listRegionalBuckets()  : Result
listRegionalBucketsAsync()  : Promise
listStorageLensConfigurations()  : Result
listStorageLensConfigurationsAsync()  : Promise
listStorageLensGroups()  : Result
listStorageLensGroupsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
putAccessGrantsInstanceResourcePolicy()  : Result
putAccessGrantsInstanceResourcePolicyAsync()  : Promise
putAccessPointConfigurationForObjectLambda()  : Result
putAccessPointConfigurationForObjectLambdaAsync()  : Promise
putAccessPointPolicy()  : Result
putAccessPointPolicyAsync()  : Promise
putAccessPointPolicyForObjectLambda()  : Result
putAccessPointPolicyForObjectLambdaAsync()  : Promise
putBucketLifecycleConfiguration()  : Result
putBucketLifecycleConfigurationAsync()  : Promise
putBucketPolicy()  : Result
putBucketPolicyAsync()  : Promise
putBucketReplication()  : Result
putBucketReplicationAsync()  : Promise
putBucketTagging()  : Result
putBucketTaggingAsync()  : Promise
putBucketVersioning()  : Result
putBucketVersioningAsync()  : Promise
putJobTagging()  : Result
putJobTaggingAsync()  : Promise
putMultiRegionAccessPointPolicy()  : Result
putMultiRegionAccessPointPolicyAsync()  : Promise
putPublicAccessBlock()  : Result
putPublicAccessBlockAsync()  : Promise
putStorageLensConfiguration()  : Result
putStorageLensConfigurationAsync()  : Promise
putStorageLensConfigurationTagging()  : Result
putStorageLensConfigurationTaggingAsync()  : Promise
submitMultiRegionAccessPointRoutes()  : Result
submitMultiRegionAccessPointRoutesAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateAccessGrantsLocation()  : Result
updateAccessGrantsLocationAsync()  : Promise
updateJobPriority()  : Result
updateJobPriorityAsync()  : Promise
updateJobStatus()  : Result
updateJobStatusAsync()  : Promise
updateStorageLensGroup()  : Result
updateStorageLensGroupAsync()  : Promise
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

associateAccessGrantsIdentityCenter()

public associateAccessGrantsIdentityCenter(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

associateAccessGrantsIdentityCenterAsync()

public associateAccessGrantsIdentityCenterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createAccessGrant()

public createAccessGrant(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createAccessGrantAsync()

public createAccessGrantAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createAccessGrantsInstance()

public createAccessGrantsInstance(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createAccessGrantsInstanceAsync()

public createAccessGrantsInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createAccessGrantsLocation()

public createAccessGrantsLocation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createAccessGrantsLocationAsync()

public createAccessGrantsLocationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createAccessPoint()

public createAccessPoint(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createAccessPointAsync()

public createAccessPointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createAccessPointForObjectLambda()

public createAccessPointForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createAccessPointForObjectLambdaAsync()

public createAccessPointForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createBucket()

public createBucket(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createBucketAsync()

public createBucketAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createJob()

public createJob(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createJobAsync()

public createJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createMultiRegionAccessPoint()

public createMultiRegionAccessPoint(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createMultiRegionAccessPointAsync()

public createMultiRegionAccessPointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

createStorageLensGroup()

public createStorageLensGroup(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

createStorageLensGroupAsync()

public createStorageLensGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessGrant()

public deleteAccessGrant(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessGrantAsync()

public deleteAccessGrantAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessGrantsInstance()

public deleteAccessGrantsInstance(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessGrantsInstanceAsync()

public deleteAccessGrantsInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessGrantsInstanceResourcePolicy()

public deleteAccessGrantsInstanceResourcePolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessGrantsInstanceResourcePolicyAsync()

public deleteAccessGrantsInstanceResourcePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessGrantsLocation()

public deleteAccessGrantsLocation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessGrantsLocationAsync()

public deleteAccessGrantsLocationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessPoint()

public deleteAccessPoint(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessPointAsync()

public deleteAccessPointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessPointForObjectLambda()

public deleteAccessPointForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessPointForObjectLambdaAsync()

public deleteAccessPointForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessPointPolicy()

public deleteAccessPointPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessPointPolicyAsync()

public deleteAccessPointPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteAccessPointPolicyForObjectLambda()

public deleteAccessPointPolicyForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteAccessPointPolicyForObjectLambdaAsync()

public deleteAccessPointPolicyForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteBucket()

public deleteBucket(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteBucketAsync()

public deleteBucketAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteBucketLifecycleConfiguration()

public deleteBucketLifecycleConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteBucketLifecycleConfigurationAsync()

public deleteBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteBucketPolicy()

public deleteBucketPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteBucketPolicyAsync()

public deleteBucketPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteBucketReplication()

public deleteBucketReplication(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteBucketReplicationAsync()

public deleteBucketReplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteBucketTagging()

public deleteBucketTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteBucketTaggingAsync()

public deleteBucketTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteJobTagging()

public deleteJobTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteJobTaggingAsync()

public deleteJobTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteMultiRegionAccessPoint()

public deleteMultiRegionAccessPoint(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteMultiRegionAccessPointAsync()

public deleteMultiRegionAccessPointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deletePublicAccessBlock()

public deletePublicAccessBlock(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deletePublicAccessBlockAsync()

public deletePublicAccessBlockAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteStorageLensConfiguration()

public deleteStorageLensConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteStorageLensConfigurationAsync()

public deleteStorageLensConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteStorageLensConfigurationTagging()

public deleteStorageLensConfigurationTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteStorageLensConfigurationTaggingAsync()

public deleteStorageLensConfigurationTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

deleteStorageLensGroup()

public deleteStorageLensGroup(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

deleteStorageLensGroupAsync()

public deleteStorageLensGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeJob()

public describeJob(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeJobAsync()

public describeJobAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

describeMultiRegionAccessPointOperation()

public describeMultiRegionAccessPointOperation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

describeMultiRegionAccessPointOperationAsync()

public describeMultiRegionAccessPointOperationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

dissociateAccessGrantsIdentityCenter()

public dissociateAccessGrantsIdentityCenter(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

dissociateAccessGrantsIdentityCenterAsync()

public dissociateAccessGrantsIdentityCenterAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

getAccessGrant()

public getAccessGrant(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessGrantAsync()

public getAccessGrantAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessGrantsInstance()

public getAccessGrantsInstance(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessGrantsInstanceAsync()

public getAccessGrantsInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessGrantsInstanceForPrefix()

public getAccessGrantsInstanceForPrefix(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessGrantsInstanceForPrefixAsync()

public getAccessGrantsInstanceForPrefixAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessGrantsInstanceResourcePolicy()

public getAccessGrantsInstanceResourcePolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessGrantsInstanceResourcePolicyAsync()

public getAccessGrantsInstanceResourcePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessGrantsLocation()

public getAccessGrantsLocation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessGrantsLocationAsync()

public getAccessGrantsLocationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPoint()

public getAccessPoint(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointAsync()

public getAccessPointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPointConfigurationForObjectLambda()

public getAccessPointConfigurationForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointConfigurationForObjectLambdaAsync()

public getAccessPointConfigurationForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPointForObjectLambda()

public getAccessPointForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointForObjectLambdaAsync()

public getAccessPointForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPointPolicy()

public getAccessPointPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointPolicyAsync()

public getAccessPointPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPointPolicyForObjectLambda()

public getAccessPointPolicyForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointPolicyForObjectLambdaAsync()

public getAccessPointPolicyForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPointPolicyStatus()

public getAccessPointPolicyStatus(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointPolicyStatusAsync()

public getAccessPointPolicyStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getAccessPointPolicyStatusForObjectLambda()

public getAccessPointPolicyStatusForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getAccessPointPolicyStatusForObjectLambdaAsync()

public getAccessPointPolicyStatusForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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>

getBucket()

public getBucket(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBucketAsync()

public getBucketAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getBucketLifecycleConfiguration()

public getBucketLifecycleConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBucketLifecycleConfigurationAsync()

public getBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getBucketPolicy()

public getBucketPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBucketPolicyAsync()

public getBucketPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getBucketReplication()

public getBucketReplication(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBucketReplicationAsync()

public getBucketReplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getBucketTagging()

public getBucketTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBucketTaggingAsync()

public getBucketTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getBucketVersioning()

public getBucketVersioning(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getBucketVersioningAsync()

public getBucketVersioningAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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

getDataAccess()

public getDataAccess(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getDataAccessAsync()

public getDataAccessAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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> = []

getJobTagging()

public getJobTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getJobTaggingAsync()

public getJobTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMultiRegionAccessPoint()

public getMultiRegionAccessPoint(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMultiRegionAccessPointAsync()

public getMultiRegionAccessPointAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMultiRegionAccessPointPolicy()

public getMultiRegionAccessPointPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMultiRegionAccessPointPolicyAsync()

public getMultiRegionAccessPointPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMultiRegionAccessPointPolicyStatus()

public getMultiRegionAccessPointPolicyStatus(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMultiRegionAccessPointPolicyStatusAsync()

public getMultiRegionAccessPointPolicyStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getMultiRegionAccessPointRoutes()

public getMultiRegionAccessPointRoutes(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getMultiRegionAccessPointRoutesAsync()

public getMultiRegionAccessPointRoutesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getPaginator()

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

getPublicAccessBlock()

public getPublicAccessBlock(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getPublicAccessBlockAsync()

public getPublicAccessBlockAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

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

getStorageLensConfiguration()

public getStorageLensConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getStorageLensConfigurationAsync()

public getStorageLensConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getStorageLensConfigurationTagging()

public getStorageLensConfigurationTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getStorageLensConfigurationTaggingAsync()

public getStorageLensConfigurationTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getStorageLensGroup()

public getStorageLensGroup(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getStorageLensGroupAsync()

public getStorageLensGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

getWaiter()

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

listAccessGrants()

public listAccessGrants(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAccessGrantsAsync()

public listAccessGrantsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listAccessGrantsInstances()

public listAccessGrantsInstances(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAccessGrantsInstancesAsync()

public listAccessGrantsInstancesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listAccessGrantsLocations()

public listAccessGrantsLocations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAccessGrantsLocationsAsync()

public listAccessGrantsLocationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listAccessPoints()

public listAccessPoints(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAccessPointsAsync()

public listAccessPointsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listAccessPointsForObjectLambda()

public listAccessPointsForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listAccessPointsForObjectLambdaAsync()

public listAccessPointsForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listJobs()

public listJobs(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listJobsAsync()

public listJobsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listMultiRegionAccessPoints()

public listMultiRegionAccessPoints(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listMultiRegionAccessPointsAsync()

public listMultiRegionAccessPointsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listRegionalBuckets()

public listRegionalBuckets(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listRegionalBucketsAsync()

public listRegionalBucketsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listStorageLensConfigurations()

public listStorageLensConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listStorageLensConfigurationsAsync()

public listStorageLensConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listStorageLensGroups()

public listStorageLensGroups(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listStorageLensGroupsAsync()

public listStorageLensGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

listTagsForResource()

public listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listTagsForResourceAsync()

public listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putAccessGrantsInstanceResourcePolicy()

public putAccessGrantsInstanceResourcePolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putAccessGrantsInstanceResourcePolicyAsync()

public putAccessGrantsInstanceResourcePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putAccessPointConfigurationForObjectLambda()

public putAccessPointConfigurationForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putAccessPointConfigurationForObjectLambdaAsync()

public putAccessPointConfigurationForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putAccessPointPolicy()

public putAccessPointPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putAccessPointPolicyAsync()

public putAccessPointPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putAccessPointPolicyForObjectLambda()

public putAccessPointPolicyForObjectLambda(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putAccessPointPolicyForObjectLambdaAsync()

public putAccessPointPolicyForObjectLambdaAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putBucketLifecycleConfiguration()

public putBucketLifecycleConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putBucketLifecycleConfigurationAsync()

public putBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putBucketPolicy()

public putBucketPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putBucketPolicyAsync()

public putBucketPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putBucketReplication()

public putBucketReplication(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putBucketReplicationAsync()

public putBucketReplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putBucketTagging()

public putBucketTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putBucketTaggingAsync()

public putBucketTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putBucketVersioning()

public putBucketVersioning(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putBucketVersioningAsync()

public putBucketVersioningAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putJobTagging()

public putJobTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putJobTaggingAsync()

public putJobTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putMultiRegionAccessPointPolicy()

public putMultiRegionAccessPointPolicy(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putMultiRegionAccessPointPolicyAsync()

public putMultiRegionAccessPointPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putPublicAccessBlock()

public putPublicAccessBlock(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putPublicAccessBlockAsync()

public putPublicAccessBlockAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putStorageLensConfiguration()

public putStorageLensConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putStorageLensConfigurationAsync()

public putStorageLensConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

putStorageLensConfigurationTagging()

public putStorageLensConfigurationTagging(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

putStorageLensConfigurationTaggingAsync()

public putStorageLensConfigurationTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

submitMultiRegionAccessPointRoutes()

public submitMultiRegionAccessPointRoutes(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

submitMultiRegionAccessPointRoutesAsync()

public submitMultiRegionAccessPointRoutesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

tagResource()

public tagResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

untagResource()

public untagResource(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateAccessGrantsLocation()

public updateAccessGrantsLocation(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateAccessGrantsLocationAsync()

public updateAccessGrantsLocationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateJobPriority()

public updateJobPriority(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateJobPriorityAsync()

public updateJobPriorityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateJobStatus()

public updateJobStatus(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateJobStatusAsync()

public updateJobStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

updateStorageLensGroup()

public updateStorageLensGroup(array<string|int, mixed> $args = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

updateStorageLensGroupAsync()

public updateStorageLensGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
$args = [] : array<string|int, mixed>
Return values
Promise

waitUntil()

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