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.
- AbortMultipartUpload
- CompleteMultipartUpload
- CopyObject
- CreateBucket
- CreateMultipartUpload
- CreateSession
- DeleteBucket
- DeleteBucketAnalyticsConfiguration
- DeleteBucketCors
- DeleteBucketEncryption
- DeleteBucketIntelligentTieringConfiguration
- DeleteBucketInventoryConfiguration
- DeleteBucketLifecycle
- DeleteBucketMetricsConfiguration
- DeleteBucketOwnershipControls
- DeleteBucketPolicy
- DeleteBucketReplication
- DeleteBucketTagging
- DeleteBucketWebsite
- DeleteObject
- DeleteObjectTagging
- DeleteObjects
- DeletePublicAccessBlock
- GetBucketAccelerateConfiguration
- GetBucketAcl
- GetBucketAnalyticsConfiguration
- GetBucketCors
- GetBucketEncryption
- GetBucketIntelligentTieringConfiguration
- GetBucketInventoryConfiguration
- GetBucketLifecycle
- GetBucketLifecycleConfiguration
- GetBucketLocation
- GetBucketLogging
- GetBucketMetricsConfiguration
- GetBucketNotification
- GetBucketNotificationConfiguration
- GetBucketOwnershipControls
- GetBucketPolicy
- GetBucketPolicyStatus
- GetBucketReplication
- GetBucketRequestPayment
- GetBucketTagging
- GetBucketVersioning
- GetBucketWebsite
- GetObject
- GetObjectAcl
- GetObjectAttributes
- GetObjectLegalHold
- GetObjectLockConfiguration
- GetObjectRetention
- GetObjectTagging
- GetObjectTorrent
- GetPublicAccessBlock
- HeadBucket
- HeadObject
- ListBucketAnalyticsConfigurations
- ListBucketIntelligentTieringConfigurations
- ListBucketInventoryConfigurations
- ListBucketMetricsConfigurations
- ListBuckets
- ListDirectoryBuckets
- ListMultipartUploads
- ListObjectVersions
- ListObjects
- ListObjectsV2
- ListParts
- PutBucketAccelerateConfiguration
- PutBucketAcl
- PutBucketAnalyticsConfiguration
- PutBucketCors
- PutBucketEncryption
- PutBucketIntelligentTieringConfiguration
- PutBucketInventoryConfiguration
- PutBucketLifecycle
- PutBucketLifecycleConfiguration
- PutBucketLogging
- PutBucketMetricsConfiguration
- PutBucketNotification
- PutBucketNotificationConfiguration
- PutBucketOwnershipControls
- PutBucketPolicy
- PutBucketReplication
- PutBucketRequestPayment
- PutBucketTagging
- PutBucketVersioning
- PutBucketWebsite
- PutObject
- PutObjectAcl
- PutObjectLegalHold
- PutObjectLockConfiguration
- PutObjectRetention
- PutObjectTagging
- PutPublicAccessBlock
- RestoreObject
- SelectObjectContent
- UploadPart
- UploadPartCopy
- WriteGetObjectResponse
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
totrue
. - 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
orregional
, or an associative array with the following keys: endpoint_types: (string) Set tolegacy
orregional
, defaults tolegacy
- 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
ResultabortMultipartUploadAsync()
public
abortMultipartUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecompleteMultipartUpload()
public
completeMultipartUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcompleteMultipartUploadAsync()
public
completeMultipartUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promisecopy()
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
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
copyObject()
public
copyObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcopyObjectAsync()
public
copyObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateBucket()
public
createBucket(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateBucketAsync()
public
createBucketAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateMultipartUpload()
public
createMultipartUpload(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateMultipartUploadAsync()
public
createMultipartUploadAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePresignedRequest()
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
RequestInterfacecreateSession()
public
createSession(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSessionAsync()
public
createSessionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucket()
public
deleteBucket(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketAnalyticsConfiguration()
public
deleteBucketAnalyticsConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketAnalyticsConfigurationAsync()
public
deleteBucketAnalyticsConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketAsync()
public
deleteBucketAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketCors()
public
deleteBucketCors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketCorsAsync()
public
deleteBucketCorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketEncryption()
public
deleteBucketEncryption(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketEncryptionAsync()
public
deleteBucketEncryptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketIntelligentTieringConfiguration()
public
deleteBucketIntelligentTieringConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketIntelligentTieringConfigurationAsync()
public
deleteBucketIntelligentTieringConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketInventoryConfiguration()
public
deleteBucketInventoryConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketInventoryConfigurationAsync()
public
deleteBucketInventoryConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketLifecycle()
public
deleteBucketLifecycle(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketLifecycleAsync()
public
deleteBucketLifecycleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketMetricsConfiguration()
public
deleteBucketMetricsConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketMetricsConfigurationAsync()
public
deleteBucketMetricsConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketOwnershipControls()
public
deleteBucketOwnershipControls(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketOwnershipControlsAsync()
public
deleteBucketOwnershipControlsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketPolicy()
public
deleteBucketPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketPolicyAsync()
public
deleteBucketPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketReplication()
public
deleteBucketReplication(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketReplicationAsync()
public
deleteBucketReplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketTagging()
public
deleteBucketTagging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketTaggingAsync()
public
deleteBucketTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteBucketWebsite()
public
deleteBucketWebsite(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteBucketWebsiteAsync()
public
deleteBucketWebsiteAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteMatchingObjects()
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
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
deleteObject()
public
deleteObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteObjectAsync()
public
deleteObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteObjects()
public
deleteObjects(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteObjectsAsync()
public
deleteObjectsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteObjectTagging()
public
deleteObjectTagging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteObjectTaggingAsync()
public
deleteObjectTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePublicAccessBlock()
public
deletePublicAccessBlock(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePublicAccessBlockAsync()
public
deletePublicAccessBlockAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetermineBucketRegion()
public
determineBucketRegion(mixed $bucketName) : mixed
Parameters
- $bucketName : mixed
Tags
determineBucketRegionAsync()
public
determineBucketRegionAsync(string $bucketName) : PromiseInterface
Parameters
- $bucketName : string
Tags
Return values
PromiseInterfacedoesBucketExist()
public
doesBucketExist(mixed $bucket) : mixed
Parameters
- $bucket : mixed
Tags
doesBucketExistV2()
public
doesBucketExistV2(mixed $bucket[, mixed $accept403 = false ]) : mixed
Parameters
- $bucket : mixed
- $accept403 : mixed = false
Tags
doesObjectExist()
public
doesObjectExist(mixed $bucket, mixed $key[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $bucket : mixed
- $key : mixed
- $options : array<string|int, mixed> = []
Tags
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
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
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
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
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
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
ResultgetBucketAccelerateConfigurationAsync()
public
getBucketAccelerateConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketAcl()
public
getBucketAcl(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketAclAsync()
public
getBucketAclAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketAnalyticsConfiguration()
public
getBucketAnalyticsConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketAnalyticsConfigurationAsync()
public
getBucketAnalyticsConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketCors()
public
getBucketCors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketCorsAsync()
public
getBucketCorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketEncryption()
public
getBucketEncryption(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketEncryptionAsync()
public
getBucketEncryptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketIntelligentTieringConfiguration()
public
getBucketIntelligentTieringConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketIntelligentTieringConfigurationAsync()
public
getBucketIntelligentTieringConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketInventoryConfiguration()
public
getBucketInventoryConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketInventoryConfigurationAsync()
public
getBucketInventoryConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketLifecycle()
public
getBucketLifecycle(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketLifecycleAsync()
public
getBucketLifecycleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketLifecycleConfiguration()
public
getBucketLifecycleConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketLifecycleConfigurationAsync()
public
getBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketLocation()
public
getBucketLocation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketLocationAsync()
public
getBucketLocationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketLogging()
public
getBucketLogging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketLoggingAsync()
public
getBucketLoggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketMetricsConfiguration()
public
getBucketMetricsConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketMetricsConfigurationAsync()
public
getBucketMetricsConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketNotification()
public
getBucketNotification(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketNotificationAsync()
public
getBucketNotificationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketNotificationConfiguration()
public
getBucketNotificationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketNotificationConfigurationAsync()
public
getBucketNotificationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketOwnershipControls()
public
getBucketOwnershipControls(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketOwnershipControlsAsync()
public
getBucketOwnershipControlsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketPolicy()
public
getBucketPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketPolicyAsync()
public
getBucketPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketPolicyStatus()
public
getBucketPolicyStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketPolicyStatusAsync()
public
getBucketPolicyStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketReplication()
public
getBucketReplication(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketReplicationAsync()
public
getBucketReplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketRequestPayment()
public
getBucketRequestPayment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketRequestPaymentAsync()
public
getBucketRequestPaymentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketTagging()
public
getBucketTagging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketTaggingAsync()
public
getBucketTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketVersioning()
public
getBucketVersioning(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketVersioningAsync()
public
getBucketVersioningAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetBucketWebsite()
public
getBucketWebsite(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetBucketWebsiteAsync()
public
getBucketWebsiteAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetClientBuiltIns()
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
CommandInterfacegetConfig()
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|nullgetCredentials()
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
PromiseInterfacegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
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
HandlerListgetIterator()
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
ResultgetObjectAcl()
public
getObjectAcl(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectAclAsync()
public
getObjectAclAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectAsync()
public
getObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectAttributes()
public
getObjectAttributes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectAttributesAsync()
public
getObjectAttributesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectLegalHold()
public
getObjectLegalHold(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectLegalHoldAsync()
public
getObjectLegalHoldAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectLockConfiguration()
public
getObjectLockConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectLockConfigurationAsync()
public
getObjectLockConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectRetention()
public
getObjectRetention(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectRetentionAsync()
public
getObjectRetentionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectTagging()
public
getObjectTagging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectTaggingAsync()
public
getObjectTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectTorrent()
public
getObjectTorrent(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetObjectTorrentAsync()
public
getObjectTorrentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetObjectUrl()
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
ResultgetPublicAccessBlockAsync()
public
getPublicAccessBlockAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetWaiter()
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
ResultheadBucketAsync()
public
headBucketAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseheadObject()
public
headObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultheadObjectAsync()
public
headObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseisBucketDnsCompatible()
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.,
"
Parameters
- $bucket : string
-
Bucket name to check.
Return values
boollistBucketAnalyticsConfigurations()
public
listBucketAnalyticsConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistBucketAnalyticsConfigurationsAsync()
public
listBucketAnalyticsConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistBucketIntelligentTieringConfigurations()
public
listBucketIntelligentTieringConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistBucketIntelligentTieringConfigurationsAsync()
public
listBucketIntelligentTieringConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistBucketInventoryConfigurations()
public
listBucketInventoryConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistBucketInventoryConfigurationsAsync()
public
listBucketInventoryConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistBucketMetricsConfigurations()
public
listBucketMetricsConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistBucketMetricsConfigurationsAsync()
public
listBucketMetricsConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistBuckets()
public
listBuckets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistBucketsAsync()
public
listBucketsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDirectoryBuckets()
public
listDirectoryBuckets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDirectoryBucketsAsync()
public
listDirectoryBucketsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistMultipartUploads()
public
listMultipartUploads(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistMultipartUploadsAsync()
public
listMultipartUploadsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjects()
public
listObjects(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectsAsync()
public
listObjectsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectsV2()
public
listObjectsV2(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectsV2Async()
public
listObjectsV2Async(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistObjectVersions()
public
listObjectVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistObjectVersionsAsync()
public
listObjectVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistParts()
public
listParts(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistPartsAsync()
public
listPartsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketAccelerateConfiguration()
public
putBucketAccelerateConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketAccelerateConfigurationAsync()
public
putBucketAccelerateConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketAcl()
public
putBucketAcl(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketAclAsync()
public
putBucketAclAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketAnalyticsConfiguration()
public
putBucketAnalyticsConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketAnalyticsConfigurationAsync()
public
putBucketAnalyticsConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketCors()
public
putBucketCors(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketCorsAsync()
public
putBucketCorsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketEncryption()
public
putBucketEncryption(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketEncryptionAsync()
public
putBucketEncryptionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketIntelligentTieringConfiguration()
public
putBucketIntelligentTieringConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketIntelligentTieringConfigurationAsync()
public
putBucketIntelligentTieringConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketInventoryConfiguration()
public
putBucketInventoryConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketInventoryConfigurationAsync()
public
putBucketInventoryConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketLifecycle()
public
putBucketLifecycle(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketLifecycleAsync()
public
putBucketLifecycleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketLifecycleConfiguration()
public
putBucketLifecycleConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketLifecycleConfigurationAsync()
public
putBucketLifecycleConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketLogging()
public
putBucketLogging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketLoggingAsync()
public
putBucketLoggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketMetricsConfiguration()
public
putBucketMetricsConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketMetricsConfigurationAsync()
public
putBucketMetricsConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketNotification()
public
putBucketNotification(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketNotificationAsync()
public
putBucketNotificationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketNotificationConfiguration()
public
putBucketNotificationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketNotificationConfigurationAsync()
public
putBucketNotificationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketOwnershipControls()
public
putBucketOwnershipControls(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketOwnershipControlsAsync()
public
putBucketOwnershipControlsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketPolicy()
public
putBucketPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketPolicyAsync()
public
putBucketPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketReplication()
public
putBucketReplication(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketReplicationAsync()
public
putBucketReplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketRequestPayment()
public
putBucketRequestPayment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketRequestPaymentAsync()
public
putBucketRequestPaymentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketTagging()
public
putBucketTagging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketTaggingAsync()
public
putBucketTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketVersioning()
public
putBucketVersioning(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketVersioningAsync()
public
putBucketVersioningAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputBucketWebsite()
public
putBucketWebsite(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputBucketWebsiteAsync()
public
putBucketWebsiteAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputObject()
public
putObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputObjectAcl()
public
putObjectAcl(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputObjectAclAsync()
public
putObjectAclAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputObjectAsync()
public
putObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputObjectLegalHold()
public
putObjectLegalHold(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputObjectLegalHoldAsync()
public
putObjectLegalHoldAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputObjectLockConfiguration()
public
putObjectLockConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputObjectLockConfigurationAsync()
public
putObjectLockConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputObjectRetention()
public
putObjectRetention(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputObjectRetentionAsync()
public
putObjectRetentionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputObjectTagging()
public
putObjectTagging(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputObjectTaggingAsync()
public
putObjectTaggingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputPublicAccessBlock()
public
putPublicAccessBlock(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputPublicAccessBlockAsync()
public
putPublicAccessBlockAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseregisterStreamWrapper()
public
registerStreamWrapper() : mixed
Tags
registerStreamWrapperV2()
public
registerStreamWrapperV2() : mixed
Tags
restoreObject()
public
restoreObject(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrestoreObjectAsync()
public
restoreObjectAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseselectObjectContent()
public
selectObjectContent(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultselectObjectContentAsync()
public
selectObjectContentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promiseupload()
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
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
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
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
uploadPart()
public
uploadPart(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuploadPartAsync()
public
uploadPartAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuploadPartCopy()
public
uploadPartCopy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuploadPartCopyAsync()
public
uploadPartCopyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
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
ResultwriteGetObjectResponseAsync()
public
writeGetObjectResponseAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>