SDK for PHP 3.x

S3Client extends AwsClient
in package
implements S3ClientInterface Uses S3ClientTrait

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

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

Interfaces

S3ClientInterface
Represents an AWS client.

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
_apply_use_arn_region()  : mixed
_default_disable_express_session_auth()  : mixed
_default_s3_express_identity_provider()  : mixed
abortMultipartUpload()  : Result
abortMultipartUploadAsync()  : Promise
completeMultipartUpload()  : Result
completeMultipartUploadAsync()  : Promise
copy()  : mixed
copyAsync()  : mixed
copyObject()  : Result
copyObjectAsync()  : Promise
createBucket()  : Result
createBucketAsync()  : Promise
createMultipartUpload()  : Result
createMultipartUploadAsync()  : Promise
createPresignedRequest()  : RequestInterface
Create a pre-signed URL for the given S3 command object.
createSession()  : Result
createSessionAsync()  : Promise
deleteBucket()  : Result
deleteBucketAnalyticsConfiguration()  : Result
deleteBucketAnalyticsConfigurationAsync()  : Promise
deleteBucketAsync()  : Promise
deleteBucketCors()  : Result
deleteBucketCorsAsync()  : Promise
deleteBucketEncryption()  : Result
deleteBucketEncryptionAsync()  : Promise
deleteBucketIntelligentTieringConfiguration()  : Result
deleteBucketIntelligentTieringConfigurationAsync()  : Promise
deleteBucketInventoryConfiguration()  : Result
deleteBucketInventoryConfigurationAsync()  : Promise
deleteBucketLifecycle()  : Result
deleteBucketLifecycleAsync()  : Promise
deleteBucketMetricsConfiguration()  : Result
deleteBucketMetricsConfigurationAsync()  : Promise
deleteBucketOwnershipControls()  : Result
deleteBucketOwnershipControlsAsync()  : Promise
deleteBucketPolicy()  : Result
deleteBucketPolicyAsync()  : Promise
deleteBucketReplication()  : Result
deleteBucketReplicationAsync()  : Promise
deleteBucketTagging()  : Result
deleteBucketTaggingAsync()  : Promise
deleteBucketWebsite()  : Result
deleteBucketWebsiteAsync()  : Promise
deleteMatchingObjects()  : mixed
deleteMatchingObjectsAsync()  : mixed
deleteObject()  : Result
deleteObjectAsync()  : Promise
deleteObjects()  : Result
deleteObjectsAsync()  : Promise
deleteObjectTagging()  : Result
deleteObjectTaggingAsync()  : Promise
deletePublicAccessBlock()  : Result
deletePublicAccessBlockAsync()  : Promise
determineBucketRegion()  : mixed
determineBucketRegionAsync()  : PromiseInterface
doesBucketExist()  : mixed
doesBucketExistV2()  : mixed
doesObjectExist()  : mixed
doesObjectExistV2()  : mixed
downloadBucket()  : mixed
downloadBucketAsync()  : mixed
emitDeprecationWarning()  : 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()  : Result
getBucketAccelerateConfigurationAsync()  : Promise
getBucketAcl()  : Result
getBucketAclAsync()  : Promise
getBucketAnalyticsConfiguration()  : Result
getBucketAnalyticsConfigurationAsync()  : Promise
getBucketCors()  : Result
getBucketCorsAsync()  : Promise
getBucketEncryption()  : Result
getBucketEncryptionAsync()  : Promise
getBucketIntelligentTieringConfiguration()  : Result
getBucketIntelligentTieringConfigurationAsync()  : Promise
getBucketInventoryConfiguration()  : Result
getBucketInventoryConfigurationAsync()  : Promise
getBucketLifecycle()  : Result
getBucketLifecycleAsync()  : Promise
getBucketLifecycleConfiguration()  : Result
getBucketLifecycleConfigurationAsync()  : Promise
getBucketLocation()  : Result
getBucketLocationAsync()  : Promise
getBucketLogging()  : Result
getBucketLoggingAsync()  : Promise
getBucketMetricsConfiguration()  : Result
getBucketMetricsConfigurationAsync()  : Promise
getBucketNotification()  : Result
getBucketNotificationAsync()  : Promise
getBucketNotificationConfiguration()  : Result
getBucketNotificationConfigurationAsync()  : Promise
getBucketOwnershipControls()  : Result
getBucketOwnershipControlsAsync()  : Promise
getBucketPolicy()  : Result
getBucketPolicyAsync()  : Promise
getBucketPolicyStatus()  : Result
getBucketPolicyStatusAsync()  : Promise
getBucketReplication()  : Result
getBucketReplicationAsync()  : Promise
getBucketRequestPayment()  : Result
getBucketRequestPaymentAsync()  : Promise
getBucketTagging()  : Result
getBucketTaggingAsync()  : Promise
getBucketVersioning()  : Result
getBucketVersioningAsync()  : Promise
getBucketWebsite()  : Result
getBucketWebsiteAsync()  : 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.
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
getObject()  : Result
getObjectAcl()  : Result
getObjectAclAsync()  : Promise
getObjectAsync()  : Promise
getObjectAttributes()  : Result
getObjectAttributesAsync()  : Promise
getObjectLegalHold()  : Result
getObjectLegalHoldAsync()  : Promise
getObjectLockConfiguration()  : Result
getObjectLockConfigurationAsync()  : Promise
getObjectRetention()  : Result
getObjectRetentionAsync()  : Promise
getObjectTagging()  : Result
getObjectTaggingAsync()  : Promise
getObjectTorrent()  : Result
getObjectTorrentAsync()  : Promise
getObjectUrl()  : string
Returns the URL to an object identified by its bucket and key.
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.
getWaiter()  : mixed
headBucket()  : Result
headBucketAsync()  : Promise
headObject()  : Result
headObjectAsync()  : Promise
isBucketDnsCompatible()  : bool
Determine if a string is a valid name for a DNS compatible Amazon S3 bucket.
listBucketAnalyticsConfigurations()  : Result
listBucketAnalyticsConfigurationsAsync()  : Promise
listBucketIntelligentTieringConfigurations()  : Result
listBucketIntelligentTieringConfigurationsAsync()  : Promise
listBucketInventoryConfigurations()  : Result
listBucketInventoryConfigurationsAsync()  : Promise
listBucketMetricsConfigurations()  : Result
listBucketMetricsConfigurationsAsync()  : Promise
listBuckets()  : Result
listBucketsAsync()  : Promise
listDirectoryBuckets()  : Result
listDirectoryBucketsAsync()  : Promise
listMultipartUploads()  : Result
listMultipartUploadsAsync()  : Promise
listObjects()  : Result
listObjectsAsync()  : Promise
listObjectsV2()  : Result
listObjectsV2Async()  : Promise
listObjectVersions()  : Result
listObjectVersionsAsync()  : Promise
listParts()  : Result
listPartsAsync()  : Promise
putBucketAccelerateConfiguration()  : Result
putBucketAccelerateConfigurationAsync()  : Promise
putBucketAcl()  : Result
putBucketAclAsync()  : Promise
putBucketAnalyticsConfiguration()  : Result
putBucketAnalyticsConfigurationAsync()  : Promise
putBucketCors()  : Result
putBucketCorsAsync()  : Promise
putBucketEncryption()  : Result
putBucketEncryptionAsync()  : Promise
putBucketIntelligentTieringConfiguration()  : Result
putBucketIntelligentTieringConfigurationAsync()  : Promise
putBucketInventoryConfiguration()  : Result
putBucketInventoryConfigurationAsync()  : Promise
putBucketLifecycle()  : Result
putBucketLifecycleAsync()  : Promise
putBucketLifecycleConfiguration()  : Result
putBucketLifecycleConfigurationAsync()  : Promise
putBucketLogging()  : Result
putBucketLoggingAsync()  : Promise
putBucketMetricsConfiguration()  : Result
putBucketMetricsConfigurationAsync()  : Promise
putBucketNotification()  : Result
putBucketNotificationAsync()  : Promise
putBucketNotificationConfiguration()  : Result
putBucketNotificationConfigurationAsync()  : Promise
putBucketOwnershipControls()  : Result
putBucketOwnershipControlsAsync()  : Promise
putBucketPolicy()  : Result
putBucketPolicyAsync()  : Promise
putBucketReplication()  : Result
putBucketReplicationAsync()  : Promise
putBucketRequestPayment()  : Result
putBucketRequestPaymentAsync()  : Promise
putBucketTagging()  : Result
putBucketTaggingAsync()  : Promise
putBucketVersioning()  : Result
putBucketVersioningAsync()  : Promise
putBucketWebsite()  : Result
putBucketWebsiteAsync()  : Promise
putObject()  : Result
putObjectAcl()  : Result
putObjectAclAsync()  : Promise
putObjectAsync()  : Promise
putObjectLegalHold()  : Result
putObjectLegalHoldAsync()  : Promise
putObjectLockConfiguration()  : Result
putObjectLockConfigurationAsync()  : Promise
putObjectRetention()  : Result
putObjectRetentionAsync()  : Promise
putObjectTagging()  : Result
putObjectTaggingAsync()  : Promise
putPublicAccessBlock()  : Result
putPublicAccessBlockAsync()  : Promise
registerStreamWrapper()  : mixed
registerStreamWrapperV2()  : mixed
restoreObject()  : Result
restoreObjectAsync()  : Promise
selectObjectContent()  : Result
selectObjectContentAsync()  : Promise
upload()  : mixed
uploadAsync()  : mixed
uploadDirectory()  : mixed
uploadDirectoryAsync()  : mixed
uploadPart()  : Result
uploadPartAsync()  : Promise
uploadPartCopy()  : Result
uploadPartCopyAsync()  : Promise
waitUntil()  : mixed
writeGetObjectResponse()  : Result
writeGetObjectResponseAsync()  : Promise

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, 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. Note: if you are using version 2.243.0 and above and do not expect the bucket name to appear in the host, you will also need to set use_path_style_endpoint to true.
  • 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.
  • disable_multiregion_access_points: (bool) Set to true to disable sending multi region requests. They are enabled by default. Can be enabled or disabled on individual operations by setting '@disable_multiregion_access_points' to true or false. Note: you cannot use it together with an accelerate or dualstack 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

_default_disable_express_session_auth()

public static _default_disable_express_session_auth(array<string|int, mixed> &$args) : mixed
Parameters
$args : array<string|int, mixed>

_default_s3_express_identity_provider()

public static _default_s3_express_identity_provider(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>

abortMultipartUpload()

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

abortMultipartUploadAsync()

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

completeMultipartUpload()

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

completeMultipartUploadAsync()

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

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> = []
Tags
see
S3ClientInterface::copy()

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> = []
Tags
see
S3ClientInterface::copyAsync()

copyObject()

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

copyObjectAsync()

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

createMultipartUpload()

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

createMultipartUploadAsync()

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

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

createSession()

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

createSessionAsync()

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

deleteBucketAnalyticsConfiguration()

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

deleteBucketAnalyticsConfigurationAsync()

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

deleteBucketAsync()

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

deleteBucketCors()

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

deleteBucketCorsAsync()

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

deleteBucketEncryption()

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

deleteBucketEncryptionAsync()

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

deleteBucketIntelligentTieringConfiguration()

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

deleteBucketIntelligentTieringConfigurationAsync()

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

deleteBucketInventoryConfiguration()

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

deleteBucketInventoryConfigurationAsync()

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

deleteBucketLifecycle()

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

deleteBucketLifecycleAsync()

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

deleteBucketMetricsConfiguration()

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

deleteBucketMetricsConfigurationAsync()

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

deleteBucketOwnershipControls()

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

deleteBucketOwnershipControlsAsync()

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

deleteBucketWebsite()

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

deleteBucketWebsiteAsync()

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

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> = []
Tags
see
S3ClientInterface::deleteMatchingObjects()

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> = []
Tags
see
S3ClientInterface::deleteMatchingObjectsAsync()

deleteObject()

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

deleteObjectAsync()

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

deleteObjects()

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

deleteObjectsAsync()

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

deleteObjectTagging()

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

deleteObjectTaggingAsync()

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

doesBucketExistV2()

public doesBucketExistV2(mixed $bucket[, mixed $accept403 = false ]) : mixed
Parameters
$bucket : mixed
$accept403 : mixed = false
Tags
see
S3ClientInterface::doesBucketExistV2()

doesObjectExist()

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

doesObjectExistV2()

public doesObjectExistV2(mixed $bucket, mixed $key[, mixed $includeDeleteMarkers = false ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$bucket : mixed
$key : mixed
$includeDeleteMarkers : mixed = false
$options : array<string|int, mixed> = []
Tags
see
S3ClientInterface::doesObjectExistV2()

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> = []
Tags
see
S3ClientInterface::downloadBucket()

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> = []
Tags
see
S3ClientInterface::downloadBucketAsync()

emitDeprecationWarning()

public static emitDeprecationWarning() : 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

factory()

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

getArguments()

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

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

getBucketAccelerateConfiguration()

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

getBucketAccelerateConfigurationAsync()

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

getBucketAcl()

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

getBucketAclAsync()

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

getBucketAnalyticsConfiguration()

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

getBucketAnalyticsConfigurationAsync()

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

getBucketCors()

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

getBucketCorsAsync()

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

getBucketEncryption()

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

getBucketEncryptionAsync()

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

getBucketIntelligentTieringConfiguration()

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

getBucketIntelligentTieringConfigurationAsync()

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

getBucketInventoryConfiguration()

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

getBucketInventoryConfigurationAsync()

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

getBucketLifecycle()

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

getBucketLifecycleAsync()

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

getBucketLocation()

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

getBucketLocationAsync()

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

getBucketLogging()

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

getBucketLoggingAsync()

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

getBucketMetricsConfiguration()

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

getBucketMetricsConfigurationAsync()

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

getBucketNotification()

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

getBucketNotificationAsync()

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

getBucketNotificationConfiguration()

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

getBucketNotificationConfigurationAsync()

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

getBucketOwnershipControls()

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

getBucketOwnershipControlsAsync()

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

getBucketPolicyStatus()

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

getBucketPolicyStatusAsync()

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

getBucketRequestPayment()

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

getBucketRequestPaymentAsync()

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

getBucketWebsite()

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

getBucketWebsiteAsync()

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

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

getObject()

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

getObjectAcl()

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

getObjectAclAsync()

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

getObjectAsync()

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

getObjectAttributes()

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

getObjectAttributesAsync()

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

getObjectLegalHold()

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

getObjectLegalHoldAsync()

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

getObjectLockConfiguration()

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

getObjectLockConfigurationAsync()

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

getObjectRetention()

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

getObjectRetentionAsync()

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

getObjectTagging()

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

getObjectTaggingAsync()

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

getObjectTorrent()

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

getObjectTorrentAsync()

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

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

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

getWaiter()

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

headBucket()

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

headBucketAsync()

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

headObject()

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

headObjectAsync()

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

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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

listBucketAnalyticsConfigurationsAsync()

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

listBucketIntelligentTieringConfigurations()

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

listBucketIntelligentTieringConfigurationsAsync()

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

listBucketInventoryConfigurations()

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

listBucketInventoryConfigurationsAsync()

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

listBucketMetricsConfigurations()

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

listBucketMetricsConfigurationsAsync()

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

listBuckets()

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

listBucketsAsync()

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

listDirectoryBuckets()

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

listDirectoryBucketsAsync()

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

listMultipartUploads()

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

listMultipartUploadsAsync()

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

listObjects()

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

listObjectsAsync()

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

listObjectsV2()

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

listObjectsV2Async()

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

listObjectVersions()

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

listObjectVersionsAsync()

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

listParts()

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

listPartsAsync()

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

putBucketAccelerateConfiguration()

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

putBucketAccelerateConfigurationAsync()

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

putBucketAcl()

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

putBucketAclAsync()

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

putBucketAnalyticsConfiguration()

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

putBucketAnalyticsConfigurationAsync()

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

putBucketCors()

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

putBucketCorsAsync()

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

putBucketEncryption()

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

putBucketEncryptionAsync()

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

putBucketIntelligentTieringConfiguration()

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

putBucketIntelligentTieringConfigurationAsync()

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

putBucketInventoryConfiguration()

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

putBucketInventoryConfigurationAsync()

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

putBucketLifecycle()

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

putBucketLifecycleAsync()

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

putBucketLogging()

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

putBucketLoggingAsync()

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

putBucketMetricsConfiguration()

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

putBucketMetricsConfigurationAsync()

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

putBucketNotification()

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

putBucketNotificationAsync()

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

putBucketNotificationConfiguration()

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

putBucketNotificationConfigurationAsync()

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

putBucketOwnershipControls()

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

putBucketOwnershipControlsAsync()

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

putBucketRequestPayment()

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

putBucketRequestPaymentAsync()

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

putBucketWebsite()

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

putBucketWebsiteAsync()

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

putObject()

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

putObjectAcl()

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

putObjectAclAsync()

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

putObjectAsync()

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

putObjectLegalHold()

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

putObjectLegalHoldAsync()

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

putObjectLockConfiguration()

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

putObjectLockConfigurationAsync()

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

putObjectRetention()

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

putObjectRetentionAsync()

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

putObjectTagging()

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

putObjectTaggingAsync()

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

restoreObject()

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

restoreObjectAsync()

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

selectObjectContent()

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

selectObjectContentAsync()

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

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> = []
Tags
see
S3ClientInterface::upload()

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> = []
Tags
see
S3ClientInterface::uploadAsync()

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> = []
Tags
see
S3ClientInterface::uploadDirectory()

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> = []
Tags
see
S3ClientInterface::uploadDirectoryAsync()

uploadPart()

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

uploadPartAsync()

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

uploadPartCopy()

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

uploadPartCopyAsync()

public uploadPartCopyAsync(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> = []

writeGetObjectResponse()

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

writeGetObjectResponseAsync()

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