Documentation

S3Client extends AwsClient
in package

Application

implements S3ClientInterface Uses S3ClientTrait

Client used to interact with **Amazon Simple Storage Service (Amazon S3)**.

Interfaces, Classes and Traits

S3ClientInterface: Represents an AWS client.

$aliases : array<string|int, mixed>
$api : Service
$config : array<string|int, mixed>
$credentialProvider : callable
$defaultRequestOptions : array<string|int, mixed>
$endpoint : string
$handlerList : HandlerList
$mandatoryAttributes : array<string|int, mixed>
$region : string
$signatureProvider : callable
__call() : mixed
__construct() : mixed: The client constructor accepts the following options:
__sleep() : mixed
_apply_use_arn_region() : mixed
abortMultipartUpload() :
abortMultipartUploadAsync() :
completeMultipartUpload() :
completeMultipartUploadAsync() :
copy() : mixed
copyAsync() : mixed
copyObject() :
copyObjectAsync() :
createBucket() :
createBucketAsync() :
createMultipartUpload() :
createMultipartUploadAsync() :
createPresignedRequest() : RequestInterface: Create a pre-signed URL for the given S3 command object.
deleteBucket() :
deleteBucketAnalyticsConfiguration() :
deleteBucketAnalyticsConfigurationAsync() :
deleteBucketAsync() :
deleteBucketCors() :
deleteBucketCorsAsync() :
deleteBucketEncryption() :
deleteBucketEncryptionAsync() :
deleteBucketIntelligentTieringConfiguration() :
deleteBucketIntelligentTieringConfigurationAsync() :
deleteBucketInventoryConfiguration() :
deleteBucketInventoryConfigurationAsync() :
deleteBucketLifecycle() :
deleteBucketLifecycleAsync() :
deleteBucketMetricsConfiguration() :
deleteBucketMetricsConfigurationAsync() :
deleteBucketOwnershipControls() :
deleteBucketOwnershipControlsAsync() :
deleteBucketPolicy() :
deleteBucketPolicyAsync() :
deleteBucketReplication() :
deleteBucketReplicationAsync() :
deleteBucketTagging() :
deleteBucketTaggingAsync() :
deleteBucketWebsite() :
deleteBucketWebsiteAsync() :
deleteMatchingObjects() : mixed
deleteMatchingObjectsAsync() : mixed
deleteObject() :
deleteObjectAsync() :
deleteObjects() :
deleteObjectsAsync() :
deleteObjectTagging() :
deleteObjectTaggingAsync() :
deletePublicAccessBlock() :
deletePublicAccessBlockAsync() :
determineBucketRegion() : mixed
determineBucketRegionAsync() : PromiseInterface
doesBucketExist() : mixed
doesObjectExist() : mixed
downloadBucket() : mixed
downloadBucketAsync() : mixed
encodeKey() : string: Raw URL encode a key and allow for '/' characters
execute() : mixed
executeAsync() : mixed
factory() : static
getApi() : Service
getArguments() : array<string|int, mixed>: Get an array of client constructor arguments used by the client.
getBucketAccelerateConfiguration() :
getBucketAccelerateConfigurationAsync() :
getBucketAcl() :
getBucketAclAsync() :
getBucketAnalyticsConfiguration() :
getBucketAnalyticsConfigurationAsync() :
getBucketCors() :
getBucketCorsAsync() :
getBucketEncryption() :
getBucketEncryptionAsync() :
getBucketIntelligentTieringConfiguration() :
getBucketIntelligentTieringConfigurationAsync() :
getBucketInventoryConfiguration() :
getBucketInventoryConfigurationAsync() :
getBucketLifecycle() :
getBucketLifecycleAsync() :
getBucketLifecycleConfiguration() :
getBucketLifecycleConfigurationAsync() :
getBucketLocation() :
getBucketLocationAsync() :
getBucketLogging() :
getBucketLoggingAsync() :
getBucketMetricsConfiguration() :
getBucketMetricsConfigurationAsync() :
getBucketNotification() :
getBucketNotificationAsync() :
getBucketNotificationConfiguration() :
getBucketNotificationConfigurationAsync() :
getBucketOwnershipControls() :
getBucketOwnershipControlsAsync() :
getBucketPolicy() :
getBucketPolicyAsync() :
getBucketPolicyStatus() :
getBucketPolicyStatusAsync() :
getBucketReplication() :
getBucketReplicationAsync() :
getBucketRequestPayment() :
getBucketRequestPaymentAsync() :
getBucketTagging() :
getBucketTaggingAsync() :
getBucketVersioning() :
getBucketVersioningAsync() :
getBucketWebsite() :
getBucketWebsiteAsync() :
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
getObject() :
getObjectAcl() :
getObjectAclAsync() :
getObjectAsync() :
getObjectLegalHold() :
getObjectLegalHoldAsync() :
getObjectLockConfiguration() :
getObjectLockConfigurationAsync() :
getObjectRetention() :
getObjectRetentionAsync() :
getObjectTagging() :
getObjectTaggingAsync() :
getObjectTorrent() :
getObjectTorrentAsync() :
getObjectUrl() : string: Returns the URL to an object identified by its bucket and key.
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.
getWaiter() : mixed
headBucket() :
headBucketAsync() :
headObject() :
headObjectAsync() :
isBucketDnsCompatible() : bool: Determine if a string is a valid name for a DNS compatible Amazon S3 bucket.
listBucketAnalyticsConfigurations() :
listBucketAnalyticsConfigurationsAsync() :
listBucketIntelligentTieringConfigurations() :
listBucketIntelligentTieringConfigurationsAsync() :
listBucketInventoryConfigurations() :
listBucketInventoryConfigurationsAsync() :
listBucketMetricsConfigurations() :
listBucketMetricsConfigurationsAsync() :
listBuckets() :
listBucketsAsync() :
listMultipartUploads() :
listMultipartUploadsAsync() :
listObjects() :
listObjectsAsync() :
listObjectsV2() :
listObjectsV2Async() :
listObjectVersions() :
listObjectVersionsAsync() :
listParts() :
listPartsAsync() :
putBucketAccelerateConfiguration() :
putBucketAccelerateConfigurationAsync() :
putBucketAcl() :
putBucketAclAsync() :
putBucketAnalyticsConfiguration() :
putBucketAnalyticsConfigurationAsync() :
putBucketCors() :
putBucketCorsAsync() :
putBucketEncryption() :
putBucketEncryptionAsync() :
putBucketIntelligentTieringConfiguration() :
putBucketIntelligentTieringConfigurationAsync() :
putBucketInventoryConfiguration() :
putBucketInventoryConfigurationAsync() :
putBucketLifecycle() :
putBucketLifecycleAsync() :
putBucketLifecycleConfiguration() :
putBucketLifecycleConfigurationAsync() :
putBucketLogging() :
putBucketLoggingAsync() :
putBucketMetricsConfiguration() :
putBucketMetricsConfigurationAsync() :
putBucketNotification() :
putBucketNotificationAsync() :
putBucketNotificationConfiguration() :
putBucketNotificationConfigurationAsync() :
putBucketOwnershipControls() :
putBucketOwnershipControlsAsync() :
putBucketPolicy() :
putBucketPolicyAsync() :
putBucketReplication() :
putBucketReplicationAsync() :
putBucketRequestPayment() :
putBucketRequestPaymentAsync() :
putBucketTagging() :
putBucketTaggingAsync() :
putBucketVersioning() :
putBucketVersioningAsync() :
putBucketWebsite() :
putBucketWebsiteAsync() :
putObject() :
putObjectAcl() :
putObjectAclAsync() :
putObjectAsync() :
putObjectLegalHold() :
putObjectLegalHoldAsync() :
putObjectLockConfiguration() :
putObjectLockConfigurationAsync() :
putObjectRetention() :
putObjectRetentionAsync() :
putObjectTagging() :
putObjectTaggingAsync() :
putPublicAccessBlock() :
putPublicAccessBlockAsync() :
registerStreamWrapper() : mixed
restoreObject() :
restoreObjectAsync() :
selectObjectContent() :
selectObjectContentAsync() :
upload() : mixed
uploadAsync() : mixed
uploadDirectory() : mixed
uploadDirectoryAsync() : mixed
uploadPart() :
uploadPartAsync() :
uploadPartCopy() :
uploadPartCopyAsync() :
waitUntil() : mixed
addEndpointDiscoveryMiddleware() : mixed
addEndpointParameterMiddleware() : mixed
addInvocationId() : mixed
addSignatureMiddleware() : mixed
addStreamRequestPayload() : mixed
checkExistenceWithCommand() : bool: Determines whether or not a resource exists using a command
determineBucketRegionFromExceptionBody() : mixed
getEncodingTypeMiddleware() : Closure: Provides a middleware that autopopulates the EncodingType parameter on ListObjects commands.
getHeadObjectMiddleware() : Closure: Provides a middleware that disables content decoding on HeadObject commands.
getLocationConstraintMiddleware() : Closure: Provides a middleware that removes the need to specify LocationConstraint on CreateBucket.
getSaveAsParameter() : Closure: Provides a middleware that supports the `SaveAs` parameter.
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".

$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

$mandatoryAttributes


    private
    static    array<string|int, mixed>
    $mandatoryAttributes
     = ['Bucket', 'Key']

$region


    private
        string
    $region

$signatureProvider


    private
        callable
    $signatureProvider

__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, S3Client accepts the following options:

bucket_endpoint: (bool) Set to true to send requests to a hardcoded bucket endpoint rather than create an endpoint as a result of injecting the bucket into the URL. This option is useful for interacting with CNAME endpoints.
calculate_md5: (bool) Set to false to disable calculating an MD5 for all Amazon S3 signed uploads.
s3_us_east_1_regional_endpoint: (Aws\S3\RegionalEndpoint\ConfigurationInterface|Aws\CacheInterface|callable|string|array) Specifies whether to use regional or legacy endpoints for the us-east-1 region. Provide an Aws\S3\RegionalEndpoint\ConfigurationInterface object, an instance of Aws\CacheInterface, a callable configuration provider used to create endpoint configuration, a string value of legacy or regional, or an associative array with the following keys: endpoint_types: (string) Set to legacy or regional, defaults to legacy
use_accelerate_endpoint: (bool) Set to true to send requests to an S3 Accelerate endpoint by default. Can be enabled or disabled on individual operations by setting '@use_accelerate_endpoint' to true or false. Note: you must enable S3 Accelerate on a bucket before it can be accessed via an Accelerate endpoint.
use_arn_region: (Aws\S3\UseArnRegion\ConfigurationInterface, Aws\CacheInterface, bool, callable) Set to true to enable the client to use the region from a supplied ARN argument instead of the client's region. Provide an instance of Aws\S3\UseArnRegion\ConfigurationInterface, an instance of Aws\CacheInterface, a callable that provides a promise for a Configuration object, or a boolean value. Defaults to false (i.e. the SDK will not follow the ARN region if it conflicts with the client region and instead throw an error).
use_dual_stack_endpoint: (bool) Set to true to send requests to an S3 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.
use_path_style_endpoint: (bool) Set to true to send requests to an S3 path style endpoint by default. Can be enabled or disabled on individual operations by setting '@use_path_style_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 —

abortMultipartUpload()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

abortMultipartUploadAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

completeMultipartUpload()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

completeMultipartUploadAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

copy()


    public
                copy(mixed $fromB, mixed $fromK, mixed $destB, mixed $destK[, mixed $acl = 'private' ][, array<string|int, mixed> $opts = [] ]) : mixed

Parameters

$fromB : mixed
$fromK : mixed
$destB : mixed
$destK : mixed
$acl : mixed = 'private'
$opts : array<string|int, mixed> = []

Return values

mixed —

copyAsync()


    public
                copyAsync(mixed $fromB, mixed $fromK, mixed $destB, mixed $destK[, mixed $acl = 'private' ][, array<string|int, mixed> $opts = [] ]) : mixed

Parameters

$fromB : mixed
$fromK : mixed
$destB : mixed
$destK : mixed
$acl : mixed = 'private'
$opts : array<string|int, mixed> = []

Return values

mixed —

copyObject()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

copyObjectAsync()


    public
                copyObjectAsync(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

—

createMultipartUpload()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

createMultipartUploadAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

createPresignedRequest()

Create a pre-signed URL for the given S3 command object.


    public
                createPresignedRequest(CommandInterface $command, mixed $expires[, array<string|int, mixed> $options = [] ]) : RequestInterface

Parameters

$command : CommandInterface: Command to create a pre-signed URL for.
$expires : mixed: The time at which the URL should expire. This can be a Unix timestamp, a PHP DateTime object, or a string that can be evaluated by strtotime().
$options : array<string|int, mixed> = []

Return values

RequestInterface —

deleteBucket()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketAnalyticsConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketAnalyticsConfigurationAsync()


    public
                deleteBucketAnalyticsConfigurationAsync(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

—

deleteBucketCors()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketCorsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketEncryption()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketEncryptionAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketIntelligentTieringConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketIntelligentTieringConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketInventoryConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketInventoryConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketLifecycle()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketLifecycleAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketMetricsConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketMetricsConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketOwnershipControls()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketOwnershipControlsAsync()


    public
                deleteBucketOwnershipControlsAsync(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

—

deleteBucketReplication()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketReplicationAsync()


    public
                deleteBucketReplicationAsync(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

—

deleteBucketWebsite()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteBucketWebsiteAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteMatchingObjects()


    public
                deleteMatchingObjects(mixed $bucket[, mixed $prefix = '' ][, mixed $regex = '' ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$bucket : mixed
$prefix : mixed = ''
$regex : mixed = ''
$options : array<string|int, mixed> = []

Return values

mixed —

deleteMatchingObjectsAsync()


    public
                deleteMatchingObjectsAsync(mixed $bucket[, mixed $prefix = '' ][, mixed $regex = '' ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$bucket : mixed
$prefix : mixed = ''
$regex : mixed = ''
$options : array<string|int, mixed> = []

Return values

mixed —

deleteObject()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteObjectAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteObjects()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteObjectsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteObjectTagging()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

deleteObjectTaggingAsync()


    public
                deleteObjectTaggingAsync(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

—

determineBucketRegion()


    public
                determineBucketRegion(mixed $bucketName) : mixed

Parameters

$bucketName : mixed

Return values

mixed —

determineBucketRegionAsync()


    public
                determineBucketRegionAsync(string $bucketName) : PromiseInterface

Parameters

$bucketName : string

Return values

PromiseInterface —

doesBucketExist()


    public
                doesBucketExist(mixed $bucket) : mixed

Parameters

$bucket : mixed

Return values

mixed —

doesObjectExist()


    public
                doesObjectExist(mixed $bucket, mixed $key[, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$bucket : mixed
$key : mixed
$options : array<string|int, mixed> = []

Return values

mixed —

downloadBucket()


    public
                downloadBucket(mixed $directory, mixed $bucket[, mixed $keyPrefix = '' ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$directory : mixed
$bucket : mixed
$keyPrefix : mixed = ''
$options : array<string|int, mixed> = []

Return values

mixed —

downloadBucketAsync()


    public
                downloadBucketAsync(mixed $directory, mixed $bucket[, mixed $keyPrefix = '' ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$directory : mixed
$bucket : mixed
$keyPrefix : mixed = ''
$options : array<string|int, mixed> = []

Return values

mixed —

encodeKey()

Raw URL encode a key and allow for '/' characters


    public
            static    encodeKey(string $key) : string

Parameters

$key : string: Key to encode

Return values

string —

Returns the encoded key

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

Return values

static —

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> —

getBucketAccelerateConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketAccelerateConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketAcl()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketAclAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketAnalyticsConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketAnalyticsConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketCors()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketCorsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketEncryption()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketEncryptionAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketIntelligentTieringConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketIntelligentTieringConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketInventoryConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketInventoryConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketLifecycle()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketLifecycleAsync()


    public
                getBucketLifecycleAsync(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

—

getBucketLocation()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketLocationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketLogging()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketLoggingAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketMetricsConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketMetricsConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketNotification()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketNotificationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketNotificationConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketNotificationConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketOwnershipControls()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketOwnershipControlsAsync()


    public
                getBucketOwnershipControlsAsync(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

—

getBucketPolicyStatus()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketPolicyStatusAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketReplication()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketReplicationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketRequestPayment()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketRequestPaymentAsync()


    public
                getBucketRequestPaymentAsync(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

—

getBucketVersioning()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketVersioningAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketWebsite()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getBucketWebsiteAsync()


    public
                getBucketWebsiteAsync(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 —

getObject()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectAcl()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectAclAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectLegalHold()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectLegalHoldAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectLockConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectLockConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectRetention()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectRetentionAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectTagging()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectTaggingAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectTorrent()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectTorrentAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

getObjectUrl()

Returns the URL to an object identified by its bucket and key.


    public
                getObjectUrl(string $bucket, string $key) : string

The URL returned by this method is not signed nor does it ensure that the bucket and key given to the method exist. If you need a signed URL, then use the S3Client::createPresignedRequest method and get the URI of the signed request.

Parameters

$bucket : string: The name of the bucket where the object is located
$key : string: The key of the object

Return values

string —

The URL to the object

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 —

getWaiter()


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

Parameters

$name : mixed
$args : array<string|int, mixed> = []

Return values

mixed —

headBucket()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

headBucketAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

headObject()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

headObjectAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

isBucketDnsCompatible()

Determine if a string is a valid name for a DNS compatible Amazon S3 bucket.


    public
            static    isBucketDnsCompatible(string $bucket) : bool

DNS compatible bucket names can be used as a subdomain in a URL (e.g., ".s3.amazonaws.com").

Parameters

$bucket : string: Bucket name to check.

Return values

bool —

listBucketAnalyticsConfigurations()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketAnalyticsConfigurationsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketIntelligentTieringConfigurations()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketIntelligentTieringConfigurationsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketInventoryConfigurations()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketInventoryConfigurationsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketMetricsConfigurations()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketMetricsConfigurationsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBuckets()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listBucketsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listMultipartUploads()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listMultipartUploadsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listObjects()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listObjectsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listObjectsV2()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listObjectsV2Async()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listObjectVersions()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listObjectVersionsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listParts()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

listPartsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketAccelerateConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketAccelerateConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketAcl()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketAclAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketAnalyticsConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketAnalyticsConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketCors()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketCorsAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketEncryption()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketEncryptionAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketIntelligentTieringConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketIntelligentTieringConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketInventoryConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketInventoryConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketLifecycle()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketLifecycleAsync()


    public
                putBucketLifecycleAsync(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

—

putBucketLogging()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketLoggingAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketMetricsConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketMetricsConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketNotification()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketNotificationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketNotificationConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketNotificationConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketOwnershipControls()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketOwnershipControlsAsync()


    public
                putBucketOwnershipControlsAsync(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

—

putBucketReplication()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketReplicationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketRequestPayment()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketRequestPaymentAsync()


    public
                putBucketRequestPaymentAsync(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

—

putBucketVersioning()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketVersioningAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketWebsite()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putBucketWebsiteAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObject()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectAcl()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectAclAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectLegalHold()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectLegalHoldAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectLockConfiguration()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectLockConfigurationAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectRetention()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectRetentionAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectTagging()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

putObjectTaggingAsync()


    public
                putObjectTaggingAsync(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

—

registerStreamWrapper()


    public
                registerStreamWrapper() : mixed

Return values

mixed —

restoreObject()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

restoreObjectAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

selectObjectContent()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

selectObjectContentAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

upload()


    public
                upload(mixed $bucket, mixed $key, mixed $body[, mixed $acl = 'private' ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$bucket : mixed
$key : mixed
$body : mixed
$acl : mixed = 'private'
$options : array<string|int, mixed> = []

Return values

mixed —

uploadAsync()


    public
                uploadAsync(mixed $bucket, mixed $key, mixed $body[, mixed $acl = 'private' ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$bucket : mixed
$key : mixed
$body : mixed
$acl : mixed = 'private'
$options : array<string|int, mixed> = []

Return values

mixed —

uploadDirectory()


    public
                uploadDirectory(mixed $directory, mixed $bucket[, mixed $keyPrefix = null ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$directory : mixed
$bucket : mixed
$keyPrefix : mixed = null
$options : array<string|int, mixed> = []

Return values

mixed —

uploadDirectoryAsync()


    public
                uploadDirectoryAsync(mixed $directory, mixed $bucket[, mixed $keyPrefix = null ][, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$directory : mixed
$bucket : mixed
$keyPrefix : mixed = null
$options : array<string|int, mixed> = []

Return values

mixed —

uploadPart()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

uploadPartAsync()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

uploadPartCopy()


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

Parameters

$args = [] : array<string|int, mixed>

Return values

—

uploadPartCopyAsync()


    public
                uploadPartCopyAsync(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 —

checkExistenceWithCommand()

Determines whether or not a resource exists using a command


    private
                checkExistenceWithCommand(CommandInterface $command) : bool

Parameters

$command : CommandInterface: Command used to poll for the resource

Return values

bool —

determineBucketRegionFromExceptionBody()


    private
                determineBucketRegionFromExceptionBody(ResponseInterface $response) : mixed

Parameters

$response : ResponseInterface

Return values

mixed —

getEncodingTypeMiddleware()

Provides a middleware that autopopulates the EncodingType parameter on ListObjects commands.


    private
                getEncodingTypeMiddleware() : Closure

Return values

Closure —

getHeadObjectMiddleware()

Provides a middleware that disables content decoding on HeadObject commands.


    private
                getHeadObjectMiddleware() : Closure

Return values

Closure —

getLocationConstraintMiddleware()

Provides a middleware that removes the need to specify LocationConstraint on CreateBucket.


    private
                getLocationConstraintMiddleware() : Closure

Return values

Closure —

getSaveAsParameter()

Provides a middleware that supports the `SaveAs` parameter.


    private
                getSaveAsParameter() : Closure

Return values

Closure —

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>

Return values

array<string|int, mixed> —