S3ControlClient
extends AwsClient
in package
This client is used to interact with the **AWS S3 Control** service.
Table of Contents
- $aliases : array<string|int, mixed>
- $api : Service
- $config : array<string|int, mixed>
- $credentialProvider : callable
- $defaultRequestOptions : array<string|int, mixed>
- $endpoint : string
- $handlerList : HandlerList
- $region : string
- $signatureProvider : callable
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- _apply_use_arn_region() : mixed
- createAccessPoint() :
- createAccessPointAsync() :
- createBucket() :
- createBucketAsync() :
- createJob() :
- createJobAsync() :
- deleteAccessPoint() :
- deleteAccessPointAsync() :
- deleteAccessPointPolicy() :
- deleteAccessPointPolicyAsync() :
- deleteBucket() :
- deleteBucketAsync() :
- deleteBucketLifecycleConfiguration() :
- deleteBucketLifecycleConfigurationAsync() :
- deleteBucketPolicy() :
- deleteBucketPolicyAsync() :
- deleteBucketTagging() :
- deleteBucketTaggingAsync() :
- deleteJobTagging() :
- deleteJobTaggingAsync() :
- deletePublicAccessBlock() :
- deletePublicAccessBlockAsync() :
- deleteStorageLensConfiguration() :
- deleteStorageLensConfigurationAsync() :
- deleteStorageLensConfigurationTagging() :
- deleteStorageLensConfigurationTaggingAsync() :
- describeJob() :
- describeJobAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getAccessPoint() :
- getAccessPointAsync() :
- getAccessPointPolicy() :
- getAccessPointPolicyAsync() :
- getAccessPointPolicyStatus() :
- getAccessPointPolicyStatusAsync() :
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getBucket() :
- getBucketAsync() :
- getBucketLifecycleConfiguration() :
- getBucketLifecycleConfigurationAsync() :
- getBucketPolicy() :
- getBucketPolicyAsync() :
- getBucketTagging() :
- getBucketTaggingAsync() :
- 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.
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIterator() : mixed
- getJobTagging() :
- getJobTaggingAsync() :
- getPaginator() : mixed
- getPublicAccessBlock() :
- getPublicAccessBlockAsync() :
- 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() :
- getStorageLensConfigurationAsync() :
- getStorageLensConfigurationTagging() :
- getStorageLensConfigurationTaggingAsync() :
- getWaiter() : mixed
- listAccessPoints() :
- listAccessPointsAsync() :
- listJobs() :
- listJobsAsync() :
- listRegionalBuckets() :
- listRegionalBucketsAsync() :
- listStorageLensConfigurations() :
- listStorageLensConfigurationsAsync() :
- putAccessPointPolicy() :
- putAccessPointPolicyAsync() :
- putBucketLifecycleConfiguration() :
- putBucketLifecycleConfigurationAsync() :
- putBucketPolicy() :
- putBucketPolicyAsync() :
- putBucketTagging() :
- putBucketTaggingAsync() :
- putJobTagging() :
- putJobTaggingAsync() :
- putPublicAccessBlock() :
- putPublicAccessBlockAsync() :
- putStorageLensConfiguration() :
- putStorageLensConfigurationAsync() :
- putStorageLensConfigurationTagging() :
- putStorageLensConfigurationTaggingAsync() :
- updateJobPriority() :
- updateJobPriorityAsync() :
- updateJobStatus() :
- updateJobStatusAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- loadAliases() : mixed
- parseClass() : array<string|int, mixed>
- Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
Properties
$aliases
private
array<string|int, mixed>
$aliases
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$signatureProvider
private
callable
$signatureProvider
Methods
__call()
public
__call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed>
Return values
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>
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
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
Return values
mixed —createAccessPoint()
public
createAccessPoint(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createAccessPointAsync()
public
createAccessPointAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createBucket()
public
createBucket(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createBucketAsync()
public
createBucketAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createJob()
public
createJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createJobAsync()
public
createJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAccessPoint()
public
deleteAccessPoint(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAccessPointAsync()
public
deleteAccessPointAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAccessPointPolicy()
public
deleteAccessPointPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteAccessPointPolicyAsync()
public
deleteAccessPointPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucket()
public
deleteBucket(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketAsync()
public
deleteBucketAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketLifecycleConfiguration()
public
deleteBucketLifecycleConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketLifecycleConfigurationAsync()
public
deleteBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketPolicy()
public
deleteBucketPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketPolicyAsync()
public
deleteBucketPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketTagging()
public
deleteBucketTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteBucketTaggingAsync()
public
deleteBucketTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteJobTagging()
public
deleteJobTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteJobTaggingAsync()
public
deleteJobTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePublicAccessBlock()
public
deletePublicAccessBlock(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePublicAccessBlockAsync()
public
deletePublicAccessBlockAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteStorageLensConfiguration()
public
deleteStorageLensConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteStorageLensConfigurationAsync()
public
deleteStorageLensConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteStorageLensConfigurationTagging()
public
deleteStorageLensConfigurationTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteStorageLensConfigurationTaggingAsync()
public
deleteStorageLensConfigurationTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeJob()
public
describeJob(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeJobAsync()
public
describeJobAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getAccessPoint()
public
getAccessPoint(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccessPointAsync()
public
getAccessPointAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccessPointPolicy()
public
getAccessPointPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccessPointPolicyAsync()
public
getAccessPointPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccessPointPolicyStatus()
public
getAccessPointPolicyStatus(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccessPointPolicyStatusAsync()
public
getAccessPointPolicyStatusAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getApi()
public
abstract getApi() : Service
Return values
Service —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 = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketAsync()
public
getBucketAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketLifecycleConfiguration()
public
getBucketLifecycleConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketLifecycleConfigurationAsync()
public
getBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketPolicy()
public
getBucketPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketPolicyAsync()
public
getBucketPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketTagging()
public
getBucketTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getBucketTaggingAsync()
public
getBucketTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 —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> = []
Return values
mixed —getJobTagging()
public
getJobTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getJobTaggingAsync()
public
getJobTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getPublicAccessBlock()
public
getPublicAccessBlock(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getPublicAccessBlockAsync()
public
getPublicAccessBlockAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—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 = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getStorageLensConfigurationAsync()
public
getStorageLensConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getStorageLensConfigurationTagging()
public
getStorageLensConfigurationTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getStorageLensConfigurationTaggingAsync()
public
getStorageLensConfigurationTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —listAccessPoints()
public
listAccessPoints(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAccessPointsAsync()
public
listAccessPointsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listJobs()
public
listJobs(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listJobsAsync()
public
listJobsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRegionalBuckets()
public
listRegionalBuckets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listRegionalBucketsAsync()
public
listRegionalBucketsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listStorageLensConfigurations()
public
listStorageLensConfigurations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listStorageLensConfigurationsAsync()
public
listStorageLensConfigurationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putAccessPointPolicy()
public
putAccessPointPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putAccessPointPolicyAsync()
public
putAccessPointPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putBucketLifecycleConfiguration()
public
putBucketLifecycleConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putBucketLifecycleConfigurationAsync()
public
putBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putBucketPolicy()
public
putBucketPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putBucketPolicyAsync()
public
putBucketPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putBucketTagging()
public
putBucketTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putBucketTaggingAsync()
public
putBucketTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putJobTagging()
public
putJobTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putJobTaggingAsync()
public
putJobTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putPublicAccessBlock()
public
putPublicAccessBlock(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putPublicAccessBlockAsync()
public
putPublicAccessBlockAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putStorageLensConfiguration()
public
putStorageLensConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putStorageLensConfigurationAsync()
public
putStorageLensConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putStorageLensConfigurationTagging()
public
putStorageLensConfigurationTagging(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—putStorageLensConfigurationTaggingAsync()
public
putStorageLensConfigurationTaggingAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateJobPriority()
public
updateJobPriority(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateJobPriorityAsync()
public
updateJobPriorityAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateJobStatus()
public
updateJobStatus(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateJobStatusAsync()
public
updateJobStatusAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —addEndpointDiscoveryMiddleware()
private
addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
- $config : mixed
- $args : mixed
Return values
mixed —addEndpointParameterMiddleware()
private
addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —addInvocationId()
private
addInvocationId() : mixed
Return values
mixed —addSignatureMiddleware()
private
addSignatureMiddleware() : mixed
Return values
mixed —addStreamRequestPayload()
private
addStreamRequestPayload() : mixed
Return values
mixed —loadAliases()
private
loadAliases([mixed $file = null ]) : mixed
Parameters
- $file : mixed = null
Return values
mixed —parseClass()
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
private
parseClass() : array<string|int, mixed>