AWS SDK for PHP 3.x

Service ID: s3

Version: 2006-03-01

This page describes the parameters and results for the operations of the Amazon Simple Storage Service (2006-03-01), and shows how to use the Aws\S3\S3Client object to call the described operations. This documentation is specific to the 2006-03-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AbortMultipartUpload ( array $params = [] )
This action aborts a multipart upload.
CompleteMultipartUpload ( array $params = [] )
Completes a multipart upload by assembling previously uploaded parts.
CopyObject ( array $params = [] )
Creates a copy of an object that is already stored in Amazon S3.
CreateBucket ( array $params = [] )
Creates a new S3 bucket.
CreateMultipartUpload ( array $params = [] )
This action initiates a multipart upload and returns an upload ID.
DeleteBucket ( array $params = [] )
Deletes the S3 bucket.
DeleteBucketAnalyticsConfiguration ( array $params = [] )
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
DeleteBucketCors ( array $params = [] )
Deletes the cors configuration information set for the bucket.
DeleteBucketEncryption ( array $params = [] )
This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).
DeleteBucketIntelligentTieringConfiguration ( array $params = [] )
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
DeleteBucketInventoryConfiguration ( array $params = [] )
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
DeleteBucketLifecycle ( array $params = [] )
Deletes the lifecycle configuration from the specified bucket.
DeleteBucketMetricsConfiguration ( array $params = [] )
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket.
DeleteBucketOwnershipControls ( array $params = [] )
Removes OwnershipControls for an Amazon S3 bucket.
DeleteBucketPolicy ( array $params = [] )
This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket.
DeleteBucketReplication ( array $params = [] )
Deletes the replication configuration from the bucket.
DeleteBucketTagging ( array $params = [] )
Deletes the tags from the bucket.
DeleteBucketWebsite ( array $params = [] )
This action removes the website configuration for a bucket.
DeleteObject ( array $params = [] )
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object.
DeleteObjectTagging ( array $params = [] )
Removes the entire tag set from the specified object.
DeleteObjects ( array $params = [] )
This action enables you to delete multiple objects from a bucket using a single HTTP request.
DeletePublicAccessBlock ( array $params = [] )
Removes the PublicAccessBlock configuration for an Amazon S3 bucket.
GetBucketAccelerateConfiguration ( array $params = [] )
This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended.
GetBucketAcl ( array $params = [] )
This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket.
GetBucketAnalyticsConfiguration ( array $params = [] )
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
GetBucketCors ( array $params = [] )
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
GetBucketEncryption ( array $params = [] )
Returns the default encryption configuration for an Amazon S3 bucket.
GetBucketIntelligentTieringConfiguration ( array $params = [] )
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
GetBucketInventoryConfiguration ( array $params = [] )
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
GetBucketLifecycle ( array $params = [] )
For an updated version of this API, see GetBucketLifecycleConfiguration.
GetBucketLifecycleConfiguration ( array $params = [] )
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both.
GetBucketLocation ( array $params = [] )
Returns the Region the bucket resides in.
GetBucketLogging ( array $params = [] )
Returns the logging status of a bucket and the permissions users have to view and modify that status.
GetBucketMetricsConfiguration ( array $params = [] )
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
GetBucketNotification ( array $params = [] )
No longer used, see GetBucketNotificationConfiguration.
GetBucketNotificationConfiguration ( array $params = [] )
Returns the notification configuration of a bucket.
GetBucketOwnershipControls ( array $params = [] )
Retrieves OwnershipControls for an Amazon S3 bucket.
GetBucketPolicy ( array $params = [] )
Returns the policy of a specified bucket.
GetBucketPolicyStatus ( array $params = [] )
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
GetBucketReplication ( array $params = [] )
Returns the replication configuration of a bucket.
GetBucketRequestPayment ( array $params = [] )
Returns the request payment configuration of a bucket.
GetBucketTagging ( array $params = [] )
Returns the tag set associated with the bucket.
GetBucketVersioning ( array $params = [] )
Returns the versioning state of a bucket.
GetBucketWebsite ( array $params = [] )
Returns the website configuration for a bucket.
GetObject ( array $params = [] )
Retrieves objects from Amazon S3.
GetObjectAcl ( array $params = [] )
Returns the access control list (ACL) of an object.
GetObjectAttributes ( array $params = [] )
Retrieves all the metadata from an object without returning the object itself.
GetObjectLegalHold ( array $params = [] )
Gets an object's current legal hold status.
GetObjectLockConfiguration ( array $params = [] )
Gets the Object Lock configuration for a bucket.
GetObjectRetention ( array $params = [] )
Retrieves an object's retention settings.
GetObjectTagging ( array $params = [] )
Returns the tag-set of an object.
GetObjectTorrent ( array $params = [] )
Returns torrent files from a bucket.
GetPublicAccessBlock ( array $params = [] )
Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.
HeadBucket ( array $params = [] )
This action is useful to determine if a bucket exists and you have permission to access it.
HeadObject ( array $params = [] )
The HEAD action retrieves metadata from an object without returning the object itself.
ListBucketAnalyticsConfigurations ( array $params = [] )
Lists the analytics configurations for the bucket.
ListBucketIntelligentTieringConfigurations ( array $params = [] )
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
ListBucketInventoryConfigurations ( array $params = [] )
Returns a list of inventory configurations for the bucket.
ListBucketMetricsConfigurations ( array $params = [] )
Lists the metrics configurations for the bucket.
ListBuckets ( array $params = [] )
Returns a list of all buckets owned by the authenticated sender of the request.
ListMultipartUploads ( array $params = [] )
This action lists in-progress multipart uploads.
ListObjectVersions ( array $params = [] )
Returns metadata about all versions of the objects in a bucket.
ListObjects ( array $params = [] )
Returns some or all (up to 1,000) of the objects in a bucket.
ListObjectsV2 ( array $params = [] )
Returns some or all (up to 1,000) of the objects in a bucket with each request.
ListParts ( array $params = [] )
Lists the parts that have been uploaded for a specific multipart upload.
PutBucketAccelerateConfiguration ( array $params = [] )
Sets the accelerate configuration of an existing bucket.
PutBucketAcl ( array $params = [] )
Sets the permissions on an existing bucket using access control lists (ACL).
PutBucketAnalyticsConfiguration ( array $params = [] )
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
PutBucketCors ( array $params = [] )
Sets the cors configuration for your bucket.
PutBucketEncryption ( array $params = [] )
This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Keys for an existing bucket.
PutBucketIntelligentTieringConfiguration ( array $params = [] )
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
PutBucketInventoryConfiguration ( array $params = [] )
This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket.
PutBucketLifecycle ( array $params = [] )
For an updated version of this API, see PutBucketLifecycleConfiguration.
PutBucketLifecycleConfiguration ( array $params = [] )
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration.
PutBucketLogging ( array $params = [] )
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters.
PutBucketMetricsConfiguration ( array $params = [] )
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
PutBucketNotification ( array $params = [] )
No longer used, see the PutBucketNotificationConfiguration operation.
PutBucketNotificationConfiguration ( array $params = [] )
Enables notifications of specified events for a bucket.
PutBucketOwnershipControls ( array $params = [] )
Creates or modifies OwnershipControls for an Amazon S3 bucket.
PutBucketPolicy ( array $params = [] )
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
PutBucketReplication ( array $params = [] )
Creates a replication configuration or replaces an existing one.
PutBucketRequestPayment ( array $params = [] )
Sets the request payment configuration for a bucket.
PutBucketTagging ( array $params = [] )
Sets the tags for a bucket.
PutBucketVersioning ( array $params = [] )
Sets the versioning state of an existing bucket.
PutBucketWebsite ( array $params = [] )
Sets the configuration of the website that is specified in the website subresource.
PutObject ( array $params = [] )
Adds an object to a bucket.
PutObjectAcl ( array $params = [] )
Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket.
PutObjectLegalHold ( array $params = [] )
Applies a legal hold configuration to the specified object.
PutObjectLockConfiguration ( array $params = [] )
Places an Object Lock configuration on the specified bucket.
PutObjectRetention ( array $params = [] )
Places an Object Retention configuration on an object.
PutObjectTagging ( array $params = [] )
Sets the supplied tag-set to an object that already exists in a bucket.
PutPublicAccessBlock ( array $params = [] )
Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.
RestoreObject ( array $params = [] )
Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts.
SelectObjectContent ( array $params = [] )
This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement.
UploadPart ( array $params = [] )
Uploads a part in a multipart upload.
UploadPartCopy ( array $params = [] )
Uploads a part by copying data from an existing object as data source.
WriteGetObjectResponse ( array $params = [] )
Passes transformed objects to a GetObject operation when using Object Lambda access points.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListBuckets
ListMultipartUploads
ListObjectVersions
ListObjects
ListObjectsV2
ListParts

Waiters

Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:

Waiter name	API Operation	Delay	Max Attempts
BucketExists	HeadBucket	5	20
BucketNotExists	HeadBucket	5	20
ObjectExists	HeadObject	5	20
ObjectNotExists	HeadObject	5	20

Operations

AbortMultipartUpload

$result = $client->abortMultipartUpload([/* ... */]);
$promise = $client->abortMultipartUploadAsync([/* ... */]);

This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.

To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts action and ensure that the parts list is empty.

For information about permissions required to use the multipart upload, see Multipart Upload and Permissions.

The following operations are related to AbortMultipartUpload:

Parameter Syntax

$result = $client->abortMultipartUpload([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'UploadId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name to which the upload was taking place.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

Key of the object for which the multipart upload was initiated.

RequestPayer

Type: string

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

UploadId

Required: Yes
Type: string

Upload ID that identifies the multipart upload.

Result Syntax

[
    'RequestCharged' => 'requester',
]

Result Details

Members

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

NoSuchUpload:
The specified multipart upload does not exist.

Examples

Example 1: To abort a multipart upload

The following example aborts a multipart upload.

$result = $client->abortMultipartUpload([
    'Bucket' => 'examplebucket',
    'Key' => 'bigobject',
    'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--',
]);

Result syntax:

[
]

CompleteMultipartUpload

$result = $client->completeMultipartUpload([/* ... */]);
$promise = $client->completeMultipartUploadAsync([/* ... */]);

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag value, returned after that part was uploaded.

Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK response can contain either a success or an error. If you call the S3 API directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the error).

Note that if CompleteMultipartUpload fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.

You cannot use Content-Type: application/x-www-form-urlencoded with Complete Multipart Upload requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload returns a 200 OK response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload.

For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions.

CompleteMultipartUpload has the following special errors:

Error code: EntityTooSmall
- Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
- 400 Bad Request
Error code: InvalidPart
- Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
- 400 Bad Request
Error code: InvalidPartOrder
- Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
- 400 Bad Request
Error code: NoSuchUpload
- Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
- 404 Not Found

The following operations are related to CompleteMultipartUpload:

Additional info on response behavior: if there is an internal error in S3 after the request was successfully recieved, a 200 response will be returned with an S3Exception embedded in it; this will still be caught and retried by RetryMiddleware.

Parameter Syntax

$result = $client->completeMultipartUpload([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumCRC32' => '<string>',
    'ChecksumCRC32C' => '<string>',
    'ChecksumSHA1' => '<string>',
    'ChecksumSHA256' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'MultipartUpload' => [
        'Parts' => [
            [
                'ChecksumCRC32' => '<string>',
                'ChecksumCRC32C' => '<string>',
                'ChecksumSHA1' => '<string>',
                'ChecksumSHA256' => '<string>',
                'ETag' => '<string>',
                'PartNumber' => <integer>,
            ],
            // ...
        ],
    ],
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'UploadId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Name of the bucket to which the multipart upload was initiated.

ChecksumCRC32

Type: string

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumCRC32C

Type: string

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA1

Type: string

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA256

Type: string

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

Object key for which the multipart upload was initiated.

MultipartUpload

Type: CompletedMultipartUpload structure

The container for the multipart upload request information.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

SSECustomerKey

Type: string

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

UploadId

Required: Yes
Type: string

ID for the initiated multipart upload.

Result Syntax

[
    'Bucket' => '<string>',
    'BucketKeyEnabled' => true || false,
    'ChecksumCRC32' => '<string>',
    'ChecksumCRC32C' => '<string>',
    'ChecksumSHA1' => '<string>',
    'ChecksumSHA256' => '<string>',
    'ETag' => '<string>',
    'Expiration' => '<string>',
    'Key' => '<string>',
    'Location' => '<string>',
    'ObjectURL' => '<string>',
    'RequestCharged' => 'requester',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'VersionId' => '<string>',
]

Result Details

Members

Bucket

Type: string

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

BucketKeyEnabled

Type: boolean

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

ChecksumCRC32

Type: string

The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

ChecksumCRC32C

Type: string

The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA1

Type: string

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA256

Type: string

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

ETag

Type: string

Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.

Expiration

Type: string

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

Key

Type: string

The object key of the newly created object.

Location

Type: string

The URI that identifies the newly created object.

ObjectURL

Type: string

The URI of the created object.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

SSEKMSKeyId

Type: string

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

VersionId

Type: string

Version ID of the newly created object, in case the bucket has versioning turned on.

Errors

There are no errors described for this operation.

Examples

Example 1: To complete multipart upload

The following example completes a multipart upload.

$result = $client->completeMultipartUpload([
    'Bucket' => 'examplebucket',
    'Key' => 'bigobject',
    'MultipartUpload' => [
        'Parts' => [
            [
                'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
                'PartNumber' => 1,
            ],
            [
                'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
                'PartNumber' => 2,
            ],
        ],
    ],
    'UploadId' => '7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--',
]);

Result syntax:

[
    'Bucket' => 'acexamplebucket',
    'ETag' => '"4d9031c7644d8081c2829f4ea23c55f7-2"',
    'Key' => 'bigobject',
    'Location' => 'https://examplebucket.s3..amazonaws.com/bigobject',
]

CopyObject

$result = $client->copyObject([/* ... */]);
$promise = $client->copyObjectAsync([/* ... */]);

Creates a copy of an object that is already stored in Amazon S3.

You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.

All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.

A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK response can contain either a success or an error. If you call the S3 API directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the error).

If the copy is successful, you receive a response with information about the copied object.

If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.

The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. For pricing information, see Amazon S3 pricing.

Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request error. For more information, see Transfer Acceleration.

Metadata

When copying an object, you can preserve all metadata (the default) or specify new metadata. However, the access control list (ACL) is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.

To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive header. When you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.

x-amz-website-redirect-location is unique to each object and must be specified in the request headers to copy the value.

x-amz-copy-source-if Headers

To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the following request parameters:

x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since

If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:

x-amz-copy-source-if-match condition evaluates to true
x-amz-copy-source-if-unmodified-since condition evaluates to false

If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:

x-amz-copy-source-if-none-match condition evaluates to false
x-amz-copy-source-if-modified-since condition evaluates to true

All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.

Server-side encryption

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don't specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.

When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can use other appropriate encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side Encryption.

If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Access Control List (ACL)-Specific Request Headers

When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups that are defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.

Checksums

When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header.

Storage Class Options

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 by using the StorageClass parameter. For more information, see Storage Classes in the Amazon S3 User Guide.

If the source object's storage class is GLACIER or DEEP_ARCHIVE, or the object's storage class is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject. For more information, see Copying Objects.

Versioning

By default, x-amz-copy-source header identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId subresource.

If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.

If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.

The following operations are related to CopyObject:

Parameter Syntax

$result = $client->copyObject([
    'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
    'Bucket' => '<string>', // REQUIRED
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentType' => '<string>',
    'CopySource' => '<string>', // REQUIRED
    'CopySourceIfMatch' => '<string>',
    'CopySourceIfModifiedSince' => <integer || string || DateTime>,
    'CopySourceIfNoneMatch' => '<string>',
    'CopySourceIfUnmodifiedSince' => <integer || string || DateTime>,
    'CopySourceSSECustomerAlgorithm' => '<string>',
    'CopySourceSSECustomerKey' => '<string>',
    'CopySourceSSECustomerKeyMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'ExpectedSourceBucketOwner' => '<string>',
    'Expires' => <integer || string || DateTime>,
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWriteACP' => '<string>',
    'Key' => '<string>', // REQUIRED
    'Metadata' => ['<string>', ...],
    'MetadataDirective' => 'COPY|REPLACE',
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <integer || string || DateTime>,
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'Tagging' => '<string>',
    'TaggingDirective' => 'COPY|REPLACE',
    'WebsiteRedirectLocation' => '<string>',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Bucket

Required: Yes
Type: string

The name of the destination bucket.

BucketKeyEnabled

Type: boolean

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

CacheControl

Type: string

Specifies caching behavior along the request/reply chain.

ChecksumAlgorithm

Type: string

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ContentDisposition

Type: string

Specifies presentational information for the object.

ContentEncoding

Type: string

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

ContentLanguage

Type: string

The language the content is in.

ContentType

Type: string

A standard MIME type describing the format of the object data.

CopySource

Required: Yes
Type: string

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL-encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

CopySourceIfMatch

Type: string

Copies the object if its entity tag (ETag) matches the specified tag.

CopySourceIfModifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Copies the object if it has been modified since the specified time.

CopySourceIfNoneMatch

Type: string

Copies the object if its entity tag (ETag) is different than the specified ETag.

CopySourceIfUnmodifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Copies the object if it hasn't been modified since the specified time.

CopySourceSSECustomerAlgorithm

Type: string

Specifies the algorithm to use when decrypting the source object (for example, AES256).

CopySourceSSECustomerKey

Type: string

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

This value will be base64 encoded on your behalf.

CopySourceSSECustomerKeyMD5

Type: string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

ExpectedBucketOwner

Type: string

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

ExpectedSourceBucketOwner

Type: string

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the object is no longer cacheable.

GrantFullControl

Type: string

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

GrantRead

Type: string

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP

Type: string

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP

Type: string

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Key

Required: Yes
Type: string

The key of the destination object.

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

A map of metadata to store with the object in S3.

MetadataDirective

Type: string

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

ObjectLockLegalHoldStatus

Type: string

Specifies whether you want to apply a legal hold to the copied object.

ObjectLockMode

Type: string

The Object Lock mode that you want to apply to the copied object.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when you want the copied object's Object Lock to expire.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey

Type: string

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

SSEKMSEncryptionContext

Type: string

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

SSEKMSKeyId

Type: string

Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

StorageClass

Type: string

If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Tagging

Type: string

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

TaggingDirective

Type: string

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

WebsiteRedirectLocation

Type: string

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the directive.

Result Syntax

[
    'BucketKeyEnabled' => true || false,
    'CopyObjectResult' => [
        'ChecksumCRC32' => '<string>',
        'ChecksumCRC32C' => '<string>',
        'ChecksumSHA1' => '<string>',
        'ChecksumSHA256' => '<string>',
        'ETag' => '<string>',
        'LastModified' => <DateTime>,
    ],
    'CopySourceVersionId' => '<string>',
    'Expiration' => '<string>',
    'ObjectURL' => '<string>',
    'RequestCharged' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'VersionId' => '<string>',
]

Result Details

Members

BucketKeyEnabled

Type: boolean

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

CopyObjectResult

Type: CopyObjectResult structure

Container for all response elements.

CopySourceVersionId

Type: string

Version of the copied object in the destination bucket.

Expiration

Type: string

If the object expiration is configured, the response includes this header.

ObjectURL

Type: string

The URI of the created object.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

SSECustomerAlgorithm

Type: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

SSECustomerKeyMD5

Type: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

SSEKMSEncryptionContext

Type: string

If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

SSEKMSKeyId

Type: string

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

VersionId

Type: string

Version ID of the newly created copy.

Errors

ObjectNotInActiveTierError:
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.

Examples

Example 1: To copy an object

The following example copies an object from one bucket to another.

$result = $client->copyObject([
    'Bucket' => 'destinationbucket',
    'CopySource' => '/sourcebucket/HappyFacejpg',
    'Key' => 'HappyFaceCopyjpg',
]);

Result syntax:

[
    'CopyObjectResult' => [
        'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
        'LastModified' => ,
    ],
]

CreateBucket

$result = $client->createBucket([/* ... */]);
$promise = $client->createBucketAsync([/* ... */]);

Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules.

If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.

By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. To constrain the bucket creation to a specific Region, you can use LocationConstraint condition key. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.

If you send your create bucket request to the s3.amazonaws.com endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets.

Permissions

In addition to s3:CreateBucket, the following permissions are required when your CreateBucket request includes specific headers:

Access control lists (ACLs) - If your CreateBucket request specifies access control list (ACL) permissions and the ACL is public-read, public-read-write, authenticated-read, or if you specify access permissions explicitly through any other ACL, both s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL for the CreateBucket request is private or if the request doesn't specify any ACLs, only s3:CreateBucket permission is needed.
Object Lock - If ObjectLockEnabledForBucket is set to true in your CreateBucket request, s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.
S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required. By default, ObjectOwnership is set to BucketOWnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. If you want to change the ObjectOwnership setting, you can use the x-amz-object-ownership header in your CreateBucket request to set the ObjectOwnership setting of your choice. For more information about S3 Object Ownership, see Controlling object ownership in the Amazon S3 User Guide.
S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. You can create a new bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. By default, all Block Public Access settings are enabled for new buckets. To avoid inadvertent exposure of your resources, we recommend keeping the S3 Block Public Access settings enabled. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

If your CreateBucket request sets BucketOwnerEnforced for Amazon S3 Object Ownership and specifies a bucket ACL that provides access to an external Amazon Web Services account, your request fails with a 400 error and returns the InvalidBucketAcLWithObjectOwnership error code. For more information, see Setting Object Ownership on an existing bucket in the Amazon S3 User Guide.

The following operations are related to CreateBucket:

Parameter Syntax

$result = $client->createBucket([
    'ACL' => 'private|public-read|public-read-write|authenticated-read',
    'Bucket' => '<string>', // REQUIRED
    'CreateBucketConfiguration' => [
        'LocationConstraint' => 'ap-northeast-1|ap-southeast-2|ap-southeast-1|cn-north-1|eu-central-1|eu-west-1|us-east-1|us-west-1|us-west-2|sa-east-1',
    ],
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWrite' => '<string>',
    'GrantWriteACP' => '<string>',
    'ObjectLockEnabledForBucket' => true || false,
    'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the bucket.

Bucket

Required: Yes
Type: string

The name of the bucket to create.

CreateBucketConfiguration

Type: CreateBucketConfiguration structure

The configuration information for the bucket.

GrantFullControl

Type: string

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

GrantRead

Type: string

Allows grantee to list the objects in the bucket.

GrantReadACP

Type: string

Allows grantee to read the bucket ACL.

GrantWrite

Type: string

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

GrantWriteACP

Type: string

Allows grantee to write the ACL for the applicable bucket.

ObjectLockEnabledForBucket

Type: boolean

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

ObjectOwnership

Type: string

The container element for object ownership for a bucket's ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format.

Result Syntax

[
    'Location' => '<string>',
]

Result Details

Members

Location

Type: string

A forward slash followed by the name of the bucket.

Errors

BucketAlreadyExists:
The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.
BucketAlreadyOwnedByYou:
The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).

Examples

Example 1: To create a bucket

The following example creates a bucket.

$result = $client->createBucket([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'Location' => '/examplebucket',
]

Example 2: To create a bucket in a specific region

The following example creates a bucket. The request specifies an AWS region where to create the bucket.

$result = $client->createBucket([
    'Bucket' => 'examplebucket',
    'CreateBucketConfiguration' => [
        'LocationConstraint' => 'eu-west-1',
    ],
]);

Result syntax:

[
    'Location' => 'http://examplebucket..s3.amazonaws.com/',
]

CreateMultipartUpload

$result = $client->createMultipartUpload([/* ... */]);
$promise = $client->createMultipartUploadAsync([/* ... */]);

This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.

For more information about multipart uploads, see Multipart Upload Overview.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions.

For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).

After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.

Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don't specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. You can request that Amazon S3 save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C).

To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.

For more information, see Protecting Data Using Server-Side Encryption.

Access Permissions

When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:

Specify a canned ACL with the x-amz-acl request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Server-Side- Encryption-Specific Request Headers

Amazon S3 encrypts data by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can request that Amazon S3 encrypts data at rest by using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys (SSE-C).

Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data, specify the following headers in the request.
- x-amz-server-side-encryption
- x-amz-server-side-encryption-aws-kms-key-id
- x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to protect the data.

All GET and PUT requests for an object protected by KMS fail if you don't make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4.

For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys.
Use customer-provided encryption keys (SSE-C) – If you want to manage your own encryption keys, provide all the following headers in the request.
- x-amz-server-side-encryption-customer-algorithm
- x-amz-server-side-encryption-customer-key
- x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

Access-Control-List (ACL)-Specific Request Headers

You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:

Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific Amazon Web Services accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
- x-amz-grant-read
- x-amz-grant-write
- x-amz-grant-read-acp
- x-amz-grant-write-acp
- x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
- id – if the value specified is the canonical user ID of an Amazon Web Services account
- uri – if you are granting permissions to a predefined group
- emailAddress – if the value specified is the email address of an Amazon Web Services account
  Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
  - US East (N. Virginia)
  - US West (N. California)
  - US West (Oregon)
  - Asia Pacific (Singapore)
  - Asia Pacific (Sydney)
  - Asia Pacific (Tokyo)
  - Europe (Ireland)
  - South America (São Paulo)
  For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

The following operations are related to CreateMultipartUpload:

Parameter Syntax

$result = $client->createMultipartUpload([
    'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
    'Bucket' => '<string>', // REQUIRED
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentType' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Expires' => <integer || string || DateTime>,
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWriteACP' => '<string>',
    'Key' => '<string>', // REQUIRED
    'Metadata' => ['<string>', ...],
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <integer || string || DateTime>,
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'Tagging' => '<string>',
    'WebsiteRedirectLocation' => '<string>',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Bucket

Required: Yes
Type: string

The name of the bucket to which to initiate the upload

BucketKeyEnabled

Type: boolean

Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.

CacheControl

Type: string

Specifies caching behavior along the request/reply chain.

ChecksumAlgorithm

Type: string

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ContentDisposition

Type: string

Specifies presentational information for the object.

ContentEncoding

Type: string

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

ContentLanguage

Type: string

The language the content is in.

ContentType

Type: string

A standard MIME type describing the format of the object data.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the object is no longer cacheable.

GrantFullControl

Type: string

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

GrantRead

Type: string

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP

Type: string

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP

Type: string

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Key

Required: Yes
Type: string

Object key for which the multipart upload is to be initiated.

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

A map of metadata to store with the object in S3.

ObjectLockLegalHoldStatus

Type: string

Specifies whether you want to apply a legal hold to the uploaded object.

ObjectLockMode

Type: string

Specifies the Object Lock mode that you want to apply to the uploaded object.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

Specifies the date and time when you want the Object Lock to expire.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey

Type: string

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

SSEKMSEncryptionContext

Type: string

SSEKMSKeyId

Type: string

Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

StorageClass

Type: string

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Tagging

Type: string

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

WebsiteRedirectLocation

Type: string

Result Syntax

[
    'AbortDate' => <DateTime>,
    'AbortRuleId' => '<string>',
    'Bucket' => '<string>',
    'BucketKeyEnabled' => true || false,
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'Key' => '<string>',
    'RequestCharged' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'UploadId' => '<string>',
]

Result Details

Members

AbortDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

AbortRuleId

Type: string

This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

Bucket

Type: string

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

BucketKeyEnabled

Type: boolean

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

ChecksumAlgorithm

Type: string

The algorithm that was used to create a checksum of the object.

Key

Type: string

Object key for which the multipart upload was initiated.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

SSECustomerAlgorithm

Type: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

SSECustomerKeyMD5

Type: string

SSEKMSEncryptionContext

Type: string

SSEKMSKeyId

Type: string

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

UploadId

Type: string

ID for the initiated multipart upload.

Errors

There are no errors described for this operation.

Examples

Example 1: To initiate a multipart upload

The following example initiates a multipart upload.

$result = $client->createMultipartUpload([
    'Bucket' => 'examplebucket',
    'Key' => 'largeobject',
]);

Result syntax:

[
    'Bucket' => 'examplebucket',
    'Key' => 'largeobject',
    'UploadId' => 'ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--',
]

DeleteBucket

$result = $client->deleteBucket([/* ... */]);
$promise = $client->deleteBucketAsync([/* ... */]);

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

The following operations are related to DeleteBucket:

Parameter Syntax

$result = $client->deleteBucket([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies the bucket being deleted.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete a bucket

The following example deletes the specified bucket.

$result = $client->deleteBucket([
    'Bucket' => 'forrandall2',
]);

DeleteBucketAnalyticsConfiguration

$result = $client->deleteBucketAnalyticsConfiguration([/* ... */]);
$promise = $client->deleteBucketAnalyticsConfigurationAsync([/* ... */]);

Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to DeleteBucketAnalyticsConfiguration:

Parameter Syntax

$result = $client->deleteBucketAnalyticsConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket from which an analytics configuration is deleted.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID that identifies the analytics configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketCors

$result = $client->deleteBucketCors([/* ... */]);
$promise = $client->deleteBucketCorsAsync([/* ... */]);

Deletes the cors configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:PutBucketCORS action. The bucket owner has this permission by default and can grant this permission to others.

For information about cors, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

Related Resources

Parameter Syntax

$result = $client->deleteBucketCors([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies the bucket whose cors configuration is being deleted.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete cors configuration on a bucket.

The following example deletes CORS configuration on a bucket.

$result = $client->deleteBucketCors([
    'Bucket' => 'examplebucket',
]);

DeleteBucketEncryption

$result = $client->deleteBucketEncryption([/* ... */]);
$promise = $client->deleteBucketEncryptionAsync([/* ... */]);

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

The following operations are related to DeleteBucketEncryption:

Parameter Syntax

$result = $client->deleteBucketEncryption([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the server-side encryption configuration to delete.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketIntelligentTieringConfiguration

$result = $client->deleteBucketIntelligentTieringConfiguration([/* ... */]);
$promise = $client->deleteBucketIntelligentTieringConfigurationAsync([/* ... */]);

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to DeleteBucketIntelligentTieringConfiguration include:

Parameter Syntax

$result = $client->deleteBucketIntelligentTieringConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

Id

Required: Yes
Type: string

The ID used to identify the S3 Intelligent-Tiering configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketInventoryConfiguration

$result = $client->deleteBucketInventoryConfiguration([/* ... */]);
$promise = $client->deleteBucketInventoryConfigurationAsync([/* ... */]);

Deletes an inventory configuration (identified by the inventory ID) from the bucket.

To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

Operations related to DeleteBucketInventoryConfiguration include:

Parameter Syntax

$result = $client->deleteBucketInventoryConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the inventory configuration to delete.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID used to identify the inventory configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketLifecycle

$result = $client->deleteBucketLifecycle([/* ... */]);
$promise = $client->deleteBucketLifecycleAsync([/* ... */]);

Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.

To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.

There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.

For more information about the object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

Parameter Syntax

$result = $client->deleteBucketLifecycle([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name of the lifecycle to delete.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete lifecycle configuration on a bucket.

The following example deletes lifecycle configuration on a bucket.

$result = $client->deleteBucketLifecycle([
    'Bucket' => 'examplebucket',
]);

DeleteBucketMetricsConfiguration

$result = $client->deleteBucketMetricsConfiguration([/* ... */]);
$promise = $client->deleteBucketMetricsConfigurationAsync([/* ... */]);

Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to DeleteBucketMetricsConfiguration:

Parameter Syntax

$result = $client->deleteBucketMetricsConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the metrics configuration to delete.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketOwnershipControls

$result = $client->deleteBucketOwnershipControls([/* ... */]);
$promise = $client->deleteBucketOwnershipControlsAsync([/* ... */]);

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

GetBucketOwnershipControls
PutBucketOwnershipControls

Parameter Syntax

$result = $client->deleteBucketOwnershipControls([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The Amazon S3 bucket whose OwnershipControls you want to delete.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

DeleteBucketPolicy

$result = $client->deleteBucketPolicy([/* ... */]);
$promise = $client->deleteBucketPolicyAsync([/* ... */]);

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account to use this operation.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

For more information about bucket policies, see Using Bucket Policies and UserPolicies.

The following operations are related to DeleteBucketPolicy

Parameter Syntax

$result = $client->deleteBucketPolicy([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete bucket policy

The following example deletes bucket policy on the specified bucket.

$result = $client->deleteBucketPolicy([
    'Bucket' => 'examplebucket',
]);

DeleteBucketReplication

$result = $client->deleteBucketReplication([/* ... */]);
$promise = $client->deleteBucketReplicationAsync([/* ... */]);

Deletes the replication configuration from the bucket.

To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

It can take a while for the deletion of a replication configuration to fully propagate.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

The following operations are related to DeleteBucketReplication:

Parameter Syntax

$result = $client->deleteBucketReplication([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete bucket replication configuration

The following example deletes replication configuration set on bucket.

$result = $client->deleteBucketReplication([
    'Bucket' => 'example',
]);

DeleteBucketTagging

$result = $client->deleteBucketTagging([/* ... */]);
$promise = $client->deleteBucketTaggingAsync([/* ... */]);

Deletes the tags from the bucket.

To use this operation, you must have permission to perform the s3:PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

The following operations are related to DeleteBucketTagging:

Parameter Syntax

$result = $client->deleteBucketTagging([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket that has the tag set to be removed.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete bucket tags

The following example deletes bucket tags.

$result = $client->deleteBucketTagging([
    'Bucket' => 'examplebucket',
]);

DeleteBucketWebsite

$result = $client->deleteBucketWebsite([/* ... */]);
$promise = $client->deleteBucketWebsiteAsync([/* ... */]);

This action removes the website configuration for a bucket. Amazon S3 returns a 200 OK response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404 response if the bucket specified in the request does not exist.

This DELETE action requires the S3:DeleteBucketWebsite permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite permission.

For more information about hosting websites, see Hosting Websites on Amazon S3.

The following operations are related to DeleteBucketWebsite:

Parameter Syntax

$result = $client->deleteBucketWebsite([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name for which you want to remove the website configuration.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete bucket website configuration

The following example deletes bucket website configuration.

$result = $client->deleteBucketWebsite([
    'Bucket' => 'examplebucket',
]);

DeleteObject

$result = $client->deleteObject([/* ... */]);
$promise = $client->deleteObjectAsync([/* ... */]);

Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.

To remove a specific version, you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.

If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.

For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.

You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject, s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration actions.

The following action is related to DeleteObject:

PutObject

Parameter Syntax

$result = $client->deleteObject([
    'Bucket' => '<string>', // REQUIRED
    'BypassGovernanceRetention' => true || false,
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'MFA' => '<string>',
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name of the bucket containing the object.

BypassGovernanceRetention

Type: boolean

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

Key name of the object to delete.

MFA

Type: string

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

RequestPayer

Type: string

VersionId

Type: string

VersionId used to reference a specific version of the object.

Result Syntax

[
    'DeleteMarker' => true || false,
    'RequestCharged' => 'requester',
    'VersionId' => '<string>',
]

Result Details

Members

DeleteMarker

Type: boolean

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

VersionId

Type: string

Returns the version ID of the delete marker created as a result of the DELETE operation.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete an object (from a non-versioned bucket)

The following example deletes an object from a non-versioned bucket.

$result = $client->deleteObject([
    'Bucket' => 'ExampleBucket',
    'Key' => 'HappyFace.jpg',
]);

Example 2: To delete an object

The following example deletes an object from an S3 bucket.

$result = $client->deleteObject([
    'Bucket' => 'examplebucket',
    'Key' => 'objectkey.jpg',
]);

Result syntax:

[
]

DeleteObjectTagging

$result = $client->deleteObjectTagging([/* ... */]);
$promise = $client->deleteObjectTaggingAsync([/* ... */]);

Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.

To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.

To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.

The following operations are related to DeleteObjectTagging:

Parameter Syntax

$result = $client->deleteObjectTagging([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the objects from which to remove the tags.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

The key that identifies the object in the bucket from which to remove all tags.

VersionId

Type: string

The versionId of the object that the tag-set will be removed from.

Result Syntax

[
    'VersionId' => '<string>',
]

Result Details

Members

VersionId

Type: string

The versionId of the object the tag-set was removed from.

Errors

There are no errors described for this operation.

Examples

Example 1: To remove tag set from an object version

The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.

$result = $client->deleteObjectTagging([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
    'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI',
]);

Result syntax:

[
    'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI',
]

Example 2: To remove tag set from an object

The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.

$result = $client->deleteObjectTagging([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'VersionId' => 'null',
]

DeleteObjects

$result = $client->deleteObjects([/* ... */]);
$promise = $client->deleteObjectsAsync([/* ... */]);

This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead.

The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.

The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body.

When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.

Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.

The following operations are related to DeleteObjects:

Parameter Syntax

$result = $client->deleteObjects([
    'Bucket' => '<string>', // REQUIRED
    'BypassGovernanceRetention' => true || false,
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'Delete' => [ // REQUIRED
        'Objects' => [ // REQUIRED
            [
                'Key' => '<string>', // REQUIRED
                'VersionId' => '<string>',
            ],
            // ...
        ],
        'Quiet' => true || false,
    ],
    'ExpectedBucketOwner' => '<string>',
    'MFA' => '<string>',
    'RequestPayer' => 'requester',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the objects to delete.

BypassGovernanceRetention

Type: boolean

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

ChecksumAlgorithm

Type: string

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

Delete

Required: Yes
Type: Delete structure

Container for the request.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

MFA

Type: string

RequestPayer

Type: string

Result Syntax

[
    'Deleted' => [
        [
            'DeleteMarker' => true || false,
            'DeleteMarkerVersionId' => '<string>',
            'Key' => '<string>',
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'Errors' => [
        [
            'Code' => '<string>',
            'Key' => '<string>',
            'Message' => '<string>',
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'RequestCharged' => 'requester',
]

Result Details

Members

Deleted

Type: Array of DeletedObject structures

Container element for a successful delete. It identifies the object that was successfully deleted.

Errors

Type: Array of Error structures

Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

There are no errors described for this operation.

Examples

Example 1: To delete multiple object versions from a versioned bucket

The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.

$result = $client->deleteObjects([
    'Bucket' => 'examplebucket',
    'Delete' => [
        'Objects' => [
            [
                'Key' => 'HappyFace.jpg',
                'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b',
            ],
            [
                'Key' => 'HappyFace.jpg',
                'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd',
            ],
        ],
        'Quiet' => ,
    ],
]);

Result syntax:

[
    'Deleted' => [
        [
            'Key' => 'HappyFace.jpg',
            'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd',
        ],
        [
            'Key' => 'HappyFace.jpg',
            'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b',
        ],
    ],
]

Example 2: To delete multiple objects from a versioned bucket

The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.

$result = $client->deleteObjects([
    'Bucket' => 'examplebucket',
    'Delete' => [
        'Objects' => [
            [
                'Key' => 'objectkey1',
            ],
            [
                'Key' => 'objectkey2',
            ],
        ],
        'Quiet' => ,
    ],
]);

Result syntax:

[
    'Deleted' => [
        [
            'DeleteMarker' => true,
            'DeleteMarkerVersionId' => 'A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F',
            'Key' => 'objectkey1',
        ],
        [
            'DeleteMarker' => true,
            'DeleteMarkerVersionId' => 'iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt',
            'Key' => 'objectkey2',
        ],
    ],
]

DeletePublicAccessBlock

$result = $client->deletePublicAccessBlock([/* ... */]);
$promise = $client->deletePublicAccessBlockAsync([/* ... */]);

Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to DeletePublicAccessBlock:

Parameter Syntax

$result = $client->deletePublicAccessBlock([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

GetBucketAccelerateConfiguration

$result = $client->getBucketAccelerateConfiguration([/* ... */]);
$promise = $client->getBucketAccelerateConfigurationAsync([/* ... */]);

This implementation of the GET action uses the accelerate subresource to return the Transfer Acceleration state of a bucket, which is either Enabled or Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.

To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

You set the Transfer Acceleration state of an existing bucket to Enabled or Suspended by using the PutBucketAccelerateConfiguration operation.

A GET accelerate request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.

For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.

The following operations are related to GetBucketAccelerateConfiguration:

PutBucketAccelerateConfiguration

Parameter Syntax

$result = $client->getBucketAccelerateConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'RequestPayer' => 'requester',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which the accelerate configuration is retrieved.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

RequestPayer

Type: string

Result Syntax

[
    'RequestCharged' => 'requester',
    'Status' => 'Enabled|Suspended',
]

Result Details

Members

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Status

Type: string

The accelerate configuration of the bucket.

Errors

There are no errors described for this operation.

GetBucketAcl

$result = $client->getBucketAcl([/* ... */]);
$promise = $client->getBucketAclAsync([/* ... */]);

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

To use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetBucketAcl:

ListObjects

Parameter Syntax

$result = $client->getBucketAcl([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies the S3 bucket whose ACL is being requested.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'Grants' => [
        [
            'Grantee' => [
                'DisplayName' => '<string>',
                'EmailAddress' => '<string>',
                'ID' => '<string>',
                'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group',
                'URI' => '<string>',
            ],
            'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
        ],
        // ...
    ],
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
]

Result Details

Members

Grants

Type: Array of Grant structures

A list of grants.

Owner

Type: Owner structure

Container for the bucket owner's display name and ID.

Errors

There are no errors described for this operation.

GetBucketAnalyticsConfiguration

$result = $client->getBucketAnalyticsConfiguration([/* ... */]);
$promise = $client->getBucketAnalyticsConfigurationAsync([/* ... */]);

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

The following operations are related to GetBucketAnalyticsConfiguration:

Parameter Syntax

$result = $client->getBucketAnalyticsConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket from which an analytics configuration is retrieved.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID that identifies the analytics configuration.

Result Syntax

[
    'AnalyticsConfiguration' => [
        'Filter' => [
            'And' => [
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'StorageClassAnalysis' => [
            'DataExport' => [
                'Destination' => [
                    'S3BucketDestination' => [
                        'Bucket' => '<string>',
                        'BucketAccountId' => '<string>',
                        'Format' => 'CSV',
                        'Prefix' => '<string>',
                    ],
                ],
                'OutputSchemaVersion' => 'V_1',
            ],
        ],
    ],
]

Result Details

Members

AnalyticsConfiguration

Type: AnalyticsConfiguration structure

The configuration and any analyses for the analytics filter.

Errors

There are no errors described for this operation.

GetBucketCors

$result = $client->getBucketCors([/* ... */]);
$promise = $client->getBucketCorsAsync([/* ... */]);

Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.

To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

Parameter Syntax

$result = $client->getBucketCors([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name for which to get the cors configuration.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'CORSRules' => [
        [
            'AllowedHeaders' => ['<string>', ...],
            'AllowedMethods' => ['<string>', ...],
            'AllowedOrigins' => ['<string>', ...],
            'ExposeHeaders' => ['<string>', ...],
            'ID' => '<string>',
            'MaxAgeSeconds' => <integer>,
        ],
        // ...
    ],
]

Result Details

Members

CORSRules

Type: Array of CORSRule structures

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

Errors

There are no errors described for this operation.

Examples

Example 1: To get cors configuration set on a bucket

The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.

$result = $client->getBucketCors([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'CORSRules' => [
        [
            'AllowedHeaders' => [
                'Authorization',
            ],
            'AllowedMethods' => [
                'GET',
            ],
            'AllowedOrigins' => [
                '*',
            ],
            'MaxAgeSeconds' => 3000,
        ],
    ],
]

GetBucketEncryption

$result = $client->getBucketEncryption([/* ... */]);
$promise = $client->getBucketEncryptionAsync([/* ... */]);

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to GetBucketEncryption:

Parameter Syntax

$result = $client->getBucketEncryption([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket from which the server-side encryption configuration is retrieved.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'ServerSideEncryptionConfiguration' => [
        'Rules' => [
            [
                'ApplyServerSideEncryptionByDefault' => [
                    'KMSMasterKeyID' => '<string>',
                    'SSEAlgorithm' => 'AES256|aws:kms|aws:kms:dsse',
                ],
                'BucketKeyEnabled' => true || false,
            ],
            // ...
        ],
    ],
]

Result Details

Members

ServerSideEncryptionConfiguration

Type: ServerSideEncryptionConfiguration structure

Specifies the default server-side-encryption configuration.

Errors

There are no errors described for this operation.

GetBucketIntelligentTieringConfiguration

$result = $client->getBucketIntelligentTieringConfiguration([/* ... */]);
$promise = $client->getBucketIntelligentTieringConfigurationAsync([/* ... */]);

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

Parameter Syntax

$result = $client->getBucketIntelligentTieringConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

Id

Required: Yes
Type: string

The ID used to identify the S3 Intelligent-Tiering configuration.

Result Syntax

[
    'IntelligentTieringConfiguration' => [
        'Filter' => [
            'And' => [
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'Status' => 'Enabled|Disabled',
        'Tierings' => [
            [
                'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS',
                'Days' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

IntelligentTieringConfiguration

Type: IntelligentTieringConfiguration structure

Container for S3 Intelligent-Tiering configuration.

Errors

There are no errors described for this operation.

GetBucketInventoryConfiguration

$result = $client->getBucketInventoryConfiguration([/* ... */]);
$promise = $client->getBucketInventoryConfigurationAsync([/* ... */]);

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

Parameter Syntax

$result = $client->getBucketInventoryConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the inventory configuration to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID used to identify the inventory configuration.

Result Syntax

[
    'InventoryConfiguration' => [
        'Destination' => [
            'S3BucketDestination' => [
                'AccountId' => '<string>',
                'Bucket' => '<string>',
                'Encryption' => [
                    'SSEKMS' => [
                        'KeyId' => '<string>',
                    ],
                    'SSES3' => [
                    ],
                ],
                'Format' => 'CSV|ORC|Parquet',
                'Prefix' => '<string>',
            ],
        ],
        'Filter' => [
            'Prefix' => '<string>',
        ],
        'Id' => '<string>',
        'IncludedObjectVersions' => 'All|Current',
        'IsEnabled' => true || false,
        'OptionalFields' => ['<string>', ...],
        'Schedule' => [
            'Frequency' => 'Daily|Weekly',
        ],
    ],
]

Result Details

Members

InventoryConfiguration

Type: InventoryConfiguration structure

Specifies the inventory configuration.

Errors

There are no errors described for this operation.

GetBucketLifecycle

$result = $client->getBucketLifecycle([/* ... */]);
$promise = $client->getBucketLifecycleAsync([/* ... */]);

For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter element, you should see the updated version of this topic. This topic is provided for backward compatibility.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycle has the following special error:

Error code: NoSuchLifecycleConfiguration
- Description: The lifecycle configuration does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycle:

Parameter Syntax

$result = $client->getBucketLifecycle([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the lifecycle information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'Rules' => [
        [
            'AbortIncompleteMultipartUpload' => [
                'DaysAfterInitiation' => <integer>,
            ],
            'Expiration' => [
                'Date' => <DateTime>,
                'Days' => <integer>,
                'ExpiredObjectDeleteMarker' => true || false,
            ],
            'ID' => '<string>',
            'NoncurrentVersionExpiration' => [
                'NewerNoncurrentVersions' => <integer>,
                'NoncurrentDays' => <integer>,
            ],
            'NoncurrentVersionTransition' => [
                'NewerNoncurrentVersions' => <integer>,
                'NoncurrentDays' => <integer>,
                'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
            ],
            'Prefix' => '<string>',
            'Status' => 'Enabled|Disabled',
            'Transition' => [
                'Date' => <DateTime>,
                'Days' => <integer>,
                'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
            ],
        ],
        // ...
    ],
]

Result Details

Members

Rules

Type: Array of Rule structures

Container for a lifecycle rule.

Errors

There are no errors described for this operation.

Examples

Example 1: To get a bucket acl

The following example gets ACL on the specified bucket.

$result = $client->getBucketLifecycle([
    'Bucket' => 'acl1',
]);

Result syntax:

[
    'Rules' => [
        [
            'Expiration' => [
                'Days' => 1,
            ],
            'ID' => 'delete logs',
            'Prefix' => '123/',
            'Status' => 'Enabled',
        ],
    ],
]

GetBucketLifecycleConfiguration

$result = $client->getBucketLifecycleConfiguration([/* ... */]);
$promise = $client->getBucketLifecycleConfigurationAsync([/* ... */]);

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle.

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

GetBucketLifecycleConfiguration has the following special error:

Error code: NoSuchLifecycleConfiguration
- Description: The lifecycle configuration does not exist.
- HTTP Status Code: 404 Not Found
- SOAP Fault Code Prefix: Client

The following operations are related to GetBucketLifecycleConfiguration:

Parameter Syntax

$result = $client->getBucketLifecycleConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the lifecycle information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'Rules' => [
        [
            'AbortIncompleteMultipartUpload' => [
                'DaysAfterInitiation' => <integer>,
            ],
            'Expiration' => [
                'Date' => <DateTime>,
                'Days' => <integer>,
                'ExpiredObjectDeleteMarker' => true || false,
            ],
            'Filter' => [
                'And' => [
                    'ObjectSizeGreaterThan' => <integer>,
                    'ObjectSizeLessThan' => <integer>,
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ObjectSizeGreaterThan' => <integer>,
                'ObjectSizeLessThan' => <integer>,
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'ID' => '<string>',
            'NoncurrentVersionExpiration' => [
                'NewerNoncurrentVersions' => <integer>,
                'NoncurrentDays' => <integer>,
            ],
            'NoncurrentVersionTransitions' => [
                [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                    'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                ],
                // ...
            ],
            'Prefix' => '<string>',
            'Status' => 'Enabled|Disabled',
            'Transitions' => [
                [
                    'Date' => <DateTime>,
                    'Days' => <integer>,
                    'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

Rules

Type: Array of LifecycleRule structures

Container for a lifecycle rule.

Errors

There are no errors described for this operation.

Examples

Example 1: To get lifecycle configuration on a bucket

The following example retrieves lifecycle configuration on set on a bucket.

$result = $client->getBucketLifecycleConfiguration([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'Rules' => [
        [
            'ID' => 'Rule for TaxDocs/',
            'Prefix' => 'TaxDocs',
            'Status' => 'Enabled',
            'Transitions' => [
                [
                    'Days' => 365,
                    'StorageClass' => 'STANDARD_IA',
                ],
            ],
        ],
    ],
]

GetBucketLocation

$result = $client->getBucketLocation([/* ... */]);
$promise = $client->getBucketLocationAsync([/* ... */]);

Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint request parameter in a CreateBucket request. For more information, see CreateBucket.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

The following operations are related to GetBucketLocation:

Parameter Syntax

$result = $client->getBucketLocation([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the location.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'LocationConstraint' => 'ap-northeast-1|ap-southeast-2|ap-southeast-1|cn-north-1|eu-central-1|eu-west-1|us-east-1|us-west-1|us-west-2|sa-east-1',
]

Result Details

Members

LocationConstraint

Type: string

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region us-east-1 have a LocationConstraint of null.

Errors

There are no errors described for this operation.

Examples

Example 1: To get bucket location

The following example returns bucket location.

$result = $client->getBucketLocation([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'LocationConstraint' => 'us-west-2',
]

GetBucketLogging

$result = $client->getBucketLogging([/* ... */]);
$promise = $client->getBucketLoggingAsync([/* ... */]);

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

Parameter Syntax

$result = $client->getBucketLogging([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name for which to get the logging information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'LoggingEnabled' => [
        'TargetBucket' => '<string>',
        'TargetGrants' => [
            [
                'Grantee' => [
                    'DisplayName' => '<string>',
                    'EmailAddress' => '<string>',
                    'ID' => '<string>',
                    'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group',
                    'URI' => '<string>',
                ],
                'Permission' => 'FULL_CONTROL|READ|WRITE',
            ],
            // ...
        ],
        'TargetPrefix' => '<string>',
    ],
]

Result Details

Members

LoggingEnabled

Type: LoggingEnabled structure

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

Errors

There are no errors described for this operation.

GetBucketMetricsConfiguration

$result = $client->getBucketMetricsConfiguration([/* ... */]);
$promise = $client->getBucketMetricsConfigurationAsync([/* ... */]);

Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to GetBucketMetricsConfiguration:

Parameter Syntax

$result = $client->getBucketMetricsConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the metrics configuration to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

Result Syntax

[
    'MetricsConfiguration' => [
        'Filter' => [
            'AccessPointArn' => '<string>',
            'And' => [
                'AccessPointArn' => '<string>',
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>',
                'Value' => '<string>',
            ],
        ],
        'Id' => '<string>',
    ],
]

Result Details

Members

MetricsConfiguration

Type: MetricsConfiguration structure

Specifies the metrics configuration.

Errors

There are no errors described for this operation.

GetBucketNotification

$result = $client->getBucketNotification([/* ... */]);
$promise = $client->getBucketNotificationAsync([/* ... */]);

No longer used, see GetBucketNotificationConfiguration.

Parameter Syntax

$result = $client->getBucketNotification([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the notification configuration.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'CloudFunctionConfiguration' => [
        'CloudFunction' => '<string>',
        'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
        'Events' => ['<string>', ...],
        'Id' => '<string>',
        'InvocationRole' => '<string>',
    ],
    'QueueConfiguration' => [
        'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
        'Events' => ['<string>', ...],
        'Id' => '<string>',
        'Queue' => '<string>',
    ],
    'TopicConfiguration' => [
        'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
        'Events' => ['<string>', ...],
        'Id' => '<string>',
        'Topic' => '<string>',
    ],
]

Result Details

Members

CloudFunctionConfiguration

Type: CloudFunctionConfiguration structure

Container for specifying the Lambda notification configuration.

QueueConfiguration

Type: QueueConfigurationDeprecated structure

This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

TopicConfiguration

Type: TopicConfigurationDeprecated structure

This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

Errors

There are no errors described for this operation.

Examples

Example 1: To get notification configuration set on a bucket

The following example returns notification configuration set on a bucket.

$result = $client->getBucketNotification([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'QueueConfiguration' => [
        'Event' => 's3:ObjectCreated:Put',
        'Events' => [
            's3:ObjectCreated:Put',
        ],
        'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx',
        'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue',
    ],
    'TopicConfiguration' => [
        'Event' => 's3:ObjectCreated:Copy',
        'Events' => [
            's3:ObjectCreated:Copy',
        ],
        'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi',
        'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic',
    ],
]

Example 2: To get notification configuration set on a bucket

The following example returns notification configuration set on a bucket.

$result = $client->getBucketNotification([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'QueueConfiguration' => [
        'Event' => 's3:ObjectCreated:Put',
        'Events' => [
            's3:ObjectCreated:Put',
        ],
        'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx',
        'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue',
    ],
    'TopicConfiguration' => [
        'Event' => 's3:ObjectCreated:Copy',
        'Events' => [
            's3:ObjectCreated:Copy',
        ],
        'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi',
        'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic',
    ],
]

GetBucketNotificationConfiguration

$result = $client->getBucketNotificationConfiguration([/* ... */]);
$promise = $client->getBucketNotificationConfigurationAsync([/* ... */]);

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following action is related to GetBucketNotification:

PutBucketNotification

Parameter Syntax

$result = $client->getBucketNotificationConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the notification configuration.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'EventBridgeConfiguration' => [
    ],
    'LambdaFunctionConfigurations' => [
        [
            'Events' => ['<string>', ...],
            'Filter' => [
                'Key' => [
                    'FilterRules' => [
                        [
                            'Name' => 'prefix|suffix',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'Id' => '<string>',
            'LambdaFunctionArn' => '<string>',
        ],
        // ...
    ],
    'QueueConfigurations' => [
        [
            'Events' => ['<string>', ...],
            'Filter' => [
                'Key' => [
                    'FilterRules' => [
                        [
                            'Name' => 'prefix|suffix',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'Id' => '<string>',
            'QueueArn' => '<string>',
        ],
        // ...
    ],
    'TopicConfigurations' => [
        [
            'Events' => ['<string>', ...],
            'Filter' => [
                'Key' => [
                    'FilterRules' => [
                        [
                            'Name' => 'prefix|suffix',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'Id' => '<string>',
            'TopicArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

EventBridgeConfiguration

Type: EventBridgeConfiguration structure

Enables delivery of events to Amazon EventBridge.

LambdaFunctionConfigurations

Type: Array of LambdaFunctionConfiguration structures

Describes the Lambda functions to invoke and the events for which to invoke them.

QueueConfigurations

Type: Array of QueueConfiguration structures

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

TopicConfigurations

Type: Array of TopicConfiguration structures

The topic to which notifications are sent and the events for which notifications are generated.

Errors

There are no errors described for this operation.

GetBucketOwnershipControls

$result = $client->getBucketOwnershipControls([/* ... */]);
$promise = $client->getBucketOwnershipControlsAsync([/* ... */]);

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

PutBucketOwnershipControls
DeleteBucketOwnershipControls

Parameter Syntax

$result = $client->getBucketOwnershipControls([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'OwnershipControls' => [
        'Rules' => [
            [
                'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced',
            ],
            // ...
        ],
    ],
]

Result Details

Members

OwnershipControls

Type: OwnershipControls structure

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

Errors

There are no errors described for this operation.

GetBucketPolicy

$result = $client->getBucketPolicy([/* ... */]);
$promise = $client->getBucketPolicyAsync([/* ... */]);

Returns the policy of a specified bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

For more information about bucket policies, see Using Bucket Policies and User Policies.

The following action is related to GetBucketPolicy:

GetObject

Parameter Syntax

$result = $client->getBucketPolicy([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name for which to get the bucket policy.

To use this API operation against an access point, provide the alias of the access point in place of the bucket name.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'Policy' => '<string>',
]

Result Details

Members

Policy

Type: string

The bucket policy as a JSON document.

Errors

There are no errors described for this operation.

Examples

Example 1: To get bucket policy

The following example returns bucket policy associated with a bucket.

$result = $client->getBucketPolicy([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'Policy' => '{"Version":"2008-10-17","Id":"LogPolicy","Statement":[{"Sid":"Enables the log delivery group to publish logs to your bucket ","Effect":"Allow","Principal":{"AWS":"111122223333"},"Action":["s3:GetBucketAcl","s3:GetObjectAcl","s3:PutObject"],"Resource":["arn:aws:s3:::policytest1/*","arn:aws:s3:::policytest1"]}]}',
]

GetBucketPolicyStatus

$result = $client->getBucketPolicyStatus([/* ... */]);
$promise = $client->getBucketPolicyStatusAsync([/* ... */]);

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

Parameter Syntax

$result = $client->getBucketPolicyStatus([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose policy status you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'PolicyStatus' => [
        'IsPublic' => true || false,
    ],
]

Result Details

Members

PolicyStatus

Type: PolicyStatus structure

The policy status for the specified bucket.

Errors

There are no errors described for this operation.

GetBucketReplication

$result = $client->getBucketReplication([/* ... */]);
$promise = $client->getBucketReplicationAsync([/* ... */]);

Returns the replication configuration of a bucket.

It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

For information about replication configuration, see Replication in the Amazon S3 User Guide.

This action requires permissions for the s3:GetReplicationConfiguration action. For more information about permissions, see Using Bucket Policies and User Policies.

If you include the Filter element in a replication configuration, you must also include the DeleteMarkerReplication and Priority elements. The response also returns those elements.

For information about GetBucketReplication errors, see List of replication-related error codes

The following operations are related to GetBucketReplication:

Parameter Syntax

$result = $client->getBucketReplication([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name for which to get the replication information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'ReplicationConfiguration' => [
        'Role' => '<string>',
        'Rules' => [
            [
                'DeleteMarkerReplication' => [
                    'Status' => 'Enabled|Disabled',
                ],
                'Destination' => [
                    'AccessControlTranslation' => [
                        'Owner' => 'Destination',
                    ],
                    'Account' => '<string>',
                    'Bucket' => '<string>',
                    'EncryptionConfiguration' => [
                        'ReplicaKmsKeyID' => '<string>',
                    ],
                    'Metrics' => [
                        'EventThreshold' => [
                            'Minutes' => <integer>,
                        ],
                        'Status' => 'Enabled|Disabled',
                    ],
                    'ReplicationTime' => [
                        'Status' => 'Enabled|Disabled',
                        'Time' => [
                            'Minutes' => <integer>,
                        ],
                    ],
                    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
                ],
                'ExistingObjectReplication' => [
                    'Status' => 'Enabled|Disabled',
                ],
                'Filter' => [
                    'And' => [
                        'Prefix' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    'Prefix' => '<string>',
                    'Tag' => [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                ],
                'ID' => '<string>',
                'Prefix' => '<string>',
                'Priority' => <integer>,
                'SourceSelectionCriteria' => [
                    'ReplicaModifications' => [
                        'Status' => 'Enabled|Disabled',
                    ],
                    'SseKmsEncryptedObjects' => [
                        'Status' => 'Enabled|Disabled',
                    ],
                ],
                'Status' => 'Enabled|Disabled',
            ],
            // ...
        ],
    ],
]

Result Details

Members

ReplicationConfiguration

Type: ReplicationConfiguration structure

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

Errors

There are no errors described for this operation.

Examples

Example 1: To get replication configuration set on a bucket

The following example returns replication configuration set on a bucket.

$result = $client->getBucketReplication([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'ReplicationConfiguration' => [
        'Role' => 'arn:aws:iam::acct-id:role/example-role',
        'Rules' => [
            [
                'Destination' => [
                    'Bucket' => 'arn:aws:s3:::destination-bucket',
                ],
                'ID' => 'MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy',
                'Prefix' => 'Tax',
                'Status' => 'Enabled',
            ],
        ],
    ],
]

GetBucketRequestPayment

$result = $client->getBucketRequestPayment([/* ... */]);
$promise = $client->getBucketRequestPaymentAsync([/* ... */]);

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

ListObjects

Parameter Syntax

$result = $client->getBucketRequestPayment([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the payment request configuration

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'Payer' => 'Requester|BucketOwner',
]

Result Details

Members

Payer

Type: string

Specifies who pays for the download and request fees.

Errors

There are no errors described for this operation.

Examples

Example 1: To get bucket versioning configuration

The following example retrieves bucket versioning configuration.

$result = $client->getBucketRequestPayment([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'Payer' => 'BucketOwner',
]

GetBucketTagging

$result = $client->getBucketTagging([/* ... */]);
$promise = $client->getBucketTaggingAsync([/* ... */]);

Returns the tag set associated with the bucket.

To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

Error code: NoSuchTagSet
- Description: There is no tag set associated with the bucket.

The following operations are related to GetBucketTagging:

Parameter Syntax

$result = $client->getBucketTagging([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the tagging information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'TagSet' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

TagSet

Required: Yes
Type: Array of Tag structures

Contains the tag set.

Errors

There are no errors described for this operation.

Examples

Example 1: To get tag set associated with a bucket

The following example returns tag set associated with a bucket

$result = $client->getBucketTagging([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'TagSet' => [
        [
            'Key' => 'key1',
            'Value' => 'value1',
        ],
        [
            'Key' => 'key2',
            'Value' => 'value2',
        ],
    ],
]

GetBucketVersioning

$result = $client->getBucketVersioning([/* ... */]);
$promise = $client->getBucketVersioningAsync([/* ... */]);

Returns the versioning state of a bucket.

To retrieve the versioning state of a bucket, you must be the bucket owner.

This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

The following operations are related to GetBucketVersioning:

Parameter Syntax

$result = $client->getBucketVersioning([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to get the versioning information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'MFADelete' => 'Enabled|Disabled',
    'Status' => 'Enabled|Suspended',
]

Result Details

Members

MFADelete

Type: string

Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

Status

Type: string

The versioning state of the bucket.

Errors

There are no errors described for this operation.

Examples

Example 1: To get bucket versioning configuration

The following example retrieves bucket versioning configuration.

$result = $client->getBucketVersioning([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'MFADelete' => 'Disabled',
    'Status' => 'Enabled',
]

GetBucketWebsite

$result = $client->getBucketWebsite([/* ... */]);
$promise = $client->getBucketWebsiteAsync([/* ... */]);

Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.

This GET action requires the S3:GetBucketWebsite permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite permission.

The following operations are related to GetBucketWebsite:

Parameter Syntax

$result = $client->getBucketWebsite([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name for which to get the website configuration.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'ErrorDocument' => [
        'Key' => '<string>',
    ],
    'IndexDocument' => [
        'Suffix' => '<string>',
    ],
    'RedirectAllRequestsTo' => [
        'HostName' => '<string>',
        'Protocol' => 'http|https',
    ],
    'RoutingRules' => [
        [
            'Condition' => [
                'HttpErrorCodeReturnedEquals' => '<string>',
                'KeyPrefixEquals' => '<string>',
            ],
            'Redirect' => [
                'HostName' => '<string>',
                'HttpRedirectCode' => '<string>',
                'Protocol' => 'http|https',
                'ReplaceKeyPrefixWith' => '<string>',
                'ReplaceKeyWith' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Members

ErrorDocument

Type: ErrorDocument structure

The object key name of the website error document to use for 4XX class errors.

IndexDocument

Type: IndexDocument structure

The name of the index document for the website (for example index.html).

RedirectAllRequestsTo

Type: RedirectAllRequestsTo structure

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

RoutingRules

Type: Array of RoutingRule structures

Rules that define when a redirect is applied and the redirect behavior.

Errors

There are no errors described for this operation.

Examples

Example 1: To get bucket website configuration

The following example retrieves website configuration of a bucket.

$result = $client->getBucketWebsite([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'ErrorDocument' => [
        'Key' => 'error.html',
    ],
    'IndexDocument' => [
        'Suffix' => 'index.html',
    ],
]

GetObject

$result = $client->getObject([/* ... */]);
$promise = $client->getObjectAsync([/* ... */]);

Retrieves objects from Amazon S3. To use GET, you must have READ access to the object. If you grant READ access to the anonymous user, you can return the object without using an authorization header.

An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg, you can name it photos/2006/February/sample.jpg.

To get an object from such a logical hierarchy, specify the full key name for the object in the GET operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the resource as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification.

For more information about returning the ACL of an object, see GetObjectAcl.

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this action returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects.

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request error.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:

x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Assuming you have the relevant permission to read object tags, the response also returns the x-amz-tagging-count header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Specifying Permissions in a Policy. If the object that you request doesn’t exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 (Not Found) error.

If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 ("access denied") error.

Versioning

By default, the GET action returns the current version of an object. To return a different version, use the versionId subresource.

If you supply a versionId, you need the s3:GetObjectVersion permission to access a specific version of an object. If you request a specific version, you do not need to have the s3:GetObject permission. If you request the current version without a specific version ID, only s3:GetObject permission is required. s3:GetObjectVersion permission won't be required.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

For more information about versioning, see PutBucketVersioning.

Overriding Response Header Values

There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.

You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type, Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding. To override these header values in the GET response, you use the following request parameters.

You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.

response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding

Overriding Response Header Values

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows: If-None-Match condition evaluates to false, and; If-Modified-Since condition evaluates to true; then, S3 returns 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

The following operations are related to GetObject:

Parameter Syntax

$result = $client->getObject([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumMode' => 'ENABLED',
    'ExpectedBucketOwner' => '<string>',
    'IfMatch' => '<string>',
    'IfModifiedSince' => <integer || string || DateTime>,
    'IfNoneMatch' => '<string>',
    'IfUnmodifiedSince' => <integer || string || DateTime>,
    'Key' => '<string>', // REQUIRED
    'PartNumber' => <integer>,
    'Range' => '<string>',
    'RequestPayer' => 'requester',
    'ResponseCacheControl' => '<string>',
    'ResponseContentDisposition' => '<string>',
    'ResponseContentEncoding' => '<string>',
    'ResponseContentLanguage' => '<string>',
    'ResponseContentType' => '<string>',
    'ResponseExpires' => <integer || string || DateTime>,
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SaveAs' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object.

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

ChecksumMode

Type: string

To retrieve the checksum, this mode must be enabled.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

IfMatch

Type: string

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

IfModifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

IfNoneMatch

Type: string

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

IfUnmodifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

Key

Required: Yes
Type: string

Key of the object to get.

PartNumber

Type: int

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Range

Type: string

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

RequestPayer

Type: string

ResponseCacheControl

Type: string

Sets the Cache-Control header of the response.

ResponseContentDisposition

Type: string

Sets the Content-Disposition header of the response

ResponseContentEncoding

Type: string

Sets the Content-Encoding header of the response.

ResponseContentLanguage

Type: string

Sets the Content-Language header of the response.

ResponseContentType

Type: string

Sets the Content-Type header of the response.

ResponseExpires

Type: timestamp (string|DateTime or anything parsable by strtotime)

Sets the Expires header of the response.

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use to when decrypting the object (for example, AES256).

SSECustomerKey

Type: string

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

SaveAs

Type: string

The path to a file on disk to save the object data.

VersionId

Type: string

VersionId used to reference a specific version of the object.

Result Syntax

[
    'AcceptRanges' => '<string>',
    'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ChecksumCRC32' => '<string>',
    'ChecksumCRC32C' => '<string>',
    'ChecksumSHA1' => '<string>',
    'ChecksumSHA256' => '<string>',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentLength' => <integer>,
    'ContentRange' => '<string>',
    'ContentType' => '<string>',
    'DeleteMarker' => true || false,
    'ETag' => '<string>',
    'Expiration' => '<string>',
    'Expires' => <DateTime>,
    'LastModified' => <DateTime>,
    'Metadata' => ['<string>', ...],
    'MissingMeta' => <integer>,
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <DateTime>,
    'PartsCount' => <integer>,
    'ReplicationStatus' => 'COMPLETE|PENDING|FAILED|REPLICA|COMPLETED',
    'RequestCharged' => 'requester',
    'Restore' => '<string>',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'TagCount' => <integer>,
    'VersionId' => '<string>',
    'WebsiteRedirectLocation' => '<string>',
]

Result Details

Members

AcceptRanges

Type: string

Indicates that a range of bytes was specified.

Body

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Object data.

BucketKeyEnabled

Type: boolean

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

CacheControl

Type: string

Specifies caching behavior along the request/reply chain.

ChecksumCRC32

Type: string

ChecksumCRC32C

Type: string

ChecksumSHA1

Type: string

ChecksumSHA256

Type: string

ContentDisposition

Type: string

Specifies presentational information for the object.

ContentEncoding

Type: string

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

ContentLanguage

Type: string

The language the content is in.

ContentLength

Type: long (int|float)

Size of the body in bytes.

ContentRange

Type: string

The portion of the object returned in the response.

ContentType

Type: string

A standard MIME type describing the format of the object data.

DeleteMarker

Type: boolean

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

ETag

Type: string

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

Expiration

Type: string

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL-encoded.

Expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the object is no longer cacheable.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

Creation date of the object.

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

A map of metadata to store with the object in S3.

MissingMeta

Type: int

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

ObjectLockLegalHoldStatus

Type: string

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

ObjectLockMode

Type: string

The Object Lock mode currently in place for this object.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when this object's Object Lock will expire.

PartsCount

Type: int

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

ReplicationStatus

Type: string

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Restore

Type: string

Provides information about object restoration action and expiration time of the restored object copy.

SSECustomerAlgorithm

Type: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

SSECustomerKeyMD5

Type: string

SSEKMSKeyId

Type: string

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

StorageClass

Type: string

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

TagCount

Type: int

The number of tags, if any, on the object.

VersionId

Type: string

Version of the object.

WebsiteRedirectLocation

Type: string

Errors

NoSuchKey:
The specified key does not exist.
InvalidObjectState:
Object is archived and inaccessible until restored.

Examples

Example 1: To retrieve a byte range of an object

The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.

$result = $client->getObject([
    'Bucket' => 'examplebucket',
    'Key' => 'SampleFile.txt',
    'Range' => 'bytes=0-9',
]);

Result syntax:

[
    'AcceptRanges' => 'bytes',
    'ContentLength' => 10,
    'ContentRange' => 'bytes 0-9/43',
    'ContentType' => 'text/plain',
    'ETag' => '"0d94420ffd0bc68cd3d152506b97a9cc"',
    'LastModified' => ,
    'Metadata' => [
    ],
    'VersionId' => 'null',
]

Example 2: To retrieve an object

The following example retrieves an object for an S3 bucket.

$result = $client->getObject([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'AcceptRanges' => 'bytes',
    'ContentLength' => 3191,
    'ContentType' => 'image/jpeg',
    'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
    'LastModified' => ,
    'Metadata' => [
    ],
    'TagCount' => 2,
    'VersionId' => 'null',
]

Example 3: To get an object via an S3 access point ARN

The following example retrieves an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.

$result = $client->getObject([
    'Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint',
    'Key' => 'my-key',
]);

Result syntax:

[
    'Body' => <BLOB>,
    'ContentLength' => 11,
    'ContentType' => 'application/octet-stream',
]

GetObjectAcl

$result = $client->getObjectAcl([/* ... */]);
$promise = $client->getObjectAclAsync([/* ... */]);

Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide

This action is not supported by Amazon S3 on Outposts.

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

The following operations are related to GetObjectAcl:

Parameter Syntax

$result = $client->getObjectAcl([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name that contains the object for which to get the ACL information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

The key of the object for which to get the ACL information.

RequestPayer

Type: string

VersionId

Type: string

VersionId used to reference a specific version of the object.

Result Syntax

[
    'Grants' => [
        [
            'Grantee' => [
                'DisplayName' => '<string>',
                'EmailAddress' => '<string>',
                'ID' => '<string>',
                'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group',
                'URI' => '<string>',
            ],
            'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
        ],
        // ...
    ],
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
    'RequestCharged' => 'requester',
]

Result Details

Members

Grants

Type: Array of Grant structures

A list of grants.

Owner

Type: Owner structure

Container for the bucket owner's display name and ID.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

NoSuchKey:
The specified key does not exist.

Examples

Example 1: To retrieve object ACL

The following example retrieves access control list (ACL) of an object.

$result = $client->getObjectAcl([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'Grants' => [
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'WRITE',
        ],
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'WRITE_ACP',
        ],
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'READ',
        ],
        [
            'Grantee' => [
                'DisplayName' => 'owner-display-name',
                'ID' => '852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
                'Type' => 'CanonicalUser',
            ],
            'Permission' => 'READ_ACP',
        ],
    ],
    'Owner' => [
        'DisplayName' => 'owner-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
    ],
]

GetObjectAttributes

$result = $client->getObjectAttributes([/* ... */]);
$promise = $client->getObjectAttributesAsync([/* ... */]);

Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error.
The last modified property in this case is the creation date of the object.

Consider the following when using request headers:

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:
- If-Match condition evaluates to true.
- If-Unmodified-Since condition evaluates to false.
If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:
- If-None-Match condition evaluates to false.
- If-Modified-Since condition evaluates to true.

For more information about conditional requests, see RFC 7232.

Permissions

The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error.
If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

The following actions are related to GetObjectAttributes:

Parameter Syntax

$result = $client->getObjectAttributes([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'MaxParts' => <integer>,
    'ObjectAttributes' => ['<string>', ...], // REQUIRED
    'PartNumberMarker' => <integer>,
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket that contains the object.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

The object key.

MaxParts

Type: int

Sets the maximum number of parts to return.

ObjectAttributes

Required: Yes
Type: Array of strings

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

PartNumberMarker

Type: int

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use when encrypting the object (for example, AES256).

SSECustomerKey

Type: string

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

VersionId

Type: string

The version ID used to reference a specific version of the object.

Result Syntax

[
    'Checksum' => [
        'ChecksumCRC32' => '<string>',
        'ChecksumCRC32C' => '<string>',
        'ChecksumSHA1' => '<string>',
        'ChecksumSHA256' => '<string>',
    ],
    'DeleteMarker' => true || false,
    'ETag' => '<string>',
    'LastModified' => <DateTime>,
    'ObjectParts' => [
        'IsTruncated' => true || false,
        'MaxParts' => <integer>,
        'NextPartNumberMarker' => <integer>,
        'PartNumberMarker' => <integer>,
        'Parts' => [
            [
                'ChecksumCRC32' => '<string>',
                'ChecksumCRC32C' => '<string>',
                'ChecksumSHA1' => '<string>',
                'ChecksumSHA256' => '<string>',
                'PartNumber' => <integer>,
                'Size' => <integer>,
            ],
            // ...
        ],
        'TotalPartsCount' => <integer>,
    ],
    'ObjectSize' => <integer>,
    'RequestCharged' => 'requester',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'VersionId' => '<string>',
]

Result Details

Members

Checksum

Type: Checksum structure

The checksum or digest of the object.

DeleteMarker

Type: boolean

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

ETag

Type: string

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date of the object.

ObjectParts

Type: GetObjectAttributesParts structure

A collection of parts associated with a multipart upload.

ObjectSize

Type: long (int|float)

The size of the object in bytes.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

StorageClass

Type: string

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

VersionId

Type: string

The version ID of the object.

Errors

NoSuchKey:
The specified key does not exist.

GetObjectLegalHold

$result = $client->getObjectLegalHold([/* ... */]);
$promise = $client->getObjectLegalHoldAsync([/* ... */]);

Gets an object's current legal hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

GetObjectAttributes

Parameter Syntax

$result = $client->getObjectLegalHold([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object whose legal hold status you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

The key name for the object whose legal hold status you want to retrieve.

RequestPayer

Type: string

VersionId

Type: string

The version ID of the object whose legal hold status you want to retrieve.

Result Syntax

[
    'LegalHold' => [
        'Status' => 'ON|OFF',
    ],
]

Result Details

Members

LegalHold

Type: ObjectLockLegalHold structure

The current legal hold status for the specified object.

Errors

There are no errors described for this operation.

GetObjectLockConfiguration

$result = $client->getObjectLockConfiguration([/* ... */]);
$promise = $client->getObjectLockConfigurationAsync([/* ... */]);

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

The following action is related to GetObjectLockConfiguration:

GetObjectAttributes

Parameter Syntax

$result = $client->getObjectLockConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket whose Object Lock configuration you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'ObjectLockConfiguration' => [
        'ObjectLockEnabled' => 'Enabled',
        'Rule' => [
            'DefaultRetention' => [
                'Days' => <integer>,
                'Mode' => 'GOVERNANCE|COMPLIANCE',
                'Years' => <integer>,
            ],
        ],
    ],
]

Result Details

Members

ObjectLockConfiguration

Type: ObjectLockConfiguration structure

The specified bucket's Object Lock configuration.

Errors

There are no errors described for this operation.

GetObjectRetention

$result = $client->getObjectRetention([/* ... */]);
$promise = $client->getObjectRetentionAsync([/* ... */]);

Retrieves an object's retention settings. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

GetObjectAttributes

Parameter Syntax

$result = $client->getObjectRetention([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object whose retention settings you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

The key name for the object whose retention settings you want to retrieve.

RequestPayer

Type: string

VersionId

Type: string

The version ID for the object whose retention settings you want to retrieve.

Result Syntax

[
    'Retention' => [
        'Mode' => 'GOVERNANCE|COMPLIANCE',
        'RetainUntilDate' => <DateTime>,
    ],
]

Result Details

Members

Retention

Type: ObjectLockRetention structure

The container element for an object's retention settings.

Errors

There are no errors described for this operation.

GetObjectTagging

$result = $client->getObjectTagging([/* ... */]);
$promise = $client->getObjectTaggingAsync([/* ... */]);

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following actions are related to GetObjectTagging:

Parameter Syntax

$result = $client->getObjectTagging([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name containing the object for which to get the tagging information.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

Object key for which to get the tagging information.

RequestPayer

Type: string

VersionId

Type: string

The versionId of the object for which to get the tagging information.

Result Syntax

[
    'TagSet' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'VersionId' => '<string>',
]

Result Details

Members

TagSet

Required: Yes
Type: Array of Tag structures

Contains the tag set.

VersionId

Type: string

The versionId of the object for which you got the tagging information.

Errors

There are no errors described for this operation.

Examples

Example 1: To retrieve tag set of an object

The following example retrieves tag set of an object.

$result = $client->getObjectTagging([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'TagSet' => [
        [
            'Key' => 'Key4',
            'Value' => 'Value4',
        ],
        [
            'Key' => 'Key3',
            'Value' => 'Value3',
        ],
    ],
    'VersionId' => 'null',
]

Example 2: To retrieve tag set of a specific object version

The following example retrieves tag set of an object. The request specifies object version.

$result = $client->getObjectTagging([
    'Bucket' => 'examplebucket',
    'Key' => 'exampleobject',
    'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI',
]);

Result syntax:

[
    'TagSet' => [
        [
            'Key' => 'Key1',
            'Value' => 'Value1',
        ],
    ],
    'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI',
]

GetObjectTorrent

$result = $client->getObjectTorrent([/* ... */]);
$promise = $client->getObjectTorrentAsync([/* ... */]);

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This action is not supported by Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

GetObject

Parameter Syntax

$result = $client->getObjectTorrent([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'RequestPayer' => 'requester',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the object for which to get the torrent files.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

The object key for which to get the information.

RequestPayer

Type: string

Result Syntax

[
    'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'RequestCharged' => 'requester',
]

Result Details

Members

Body

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

A Bencoded dictionary as defined by the BitTorrent specification

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

There are no errors described for this operation.

Examples

Example 1: To retrieve torrent files for an object

The following example retrieves torrent files of an object.

$result = $client->getObjectTorrent([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
]

GetPublicAccessBlock

$result = $client->getPublicAccessBlock([/* ... */]);
$promise = $client->getPublicAccessBlockAsync([/* ... */]);

Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.

For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".

The following operations are related to GetPublicAccessBlock:

Parameter Syntax

$result = $client->getPublicAccessBlock([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'PublicAccessBlockConfiguration' => [
        'BlockPublicAcls' => true || false,
        'BlockPublicPolicy' => true || false,
        'IgnorePublicAcls' => true || false,
        'RestrictPublicBuckets' => true || false,
    ],
]

Result Details

Members

PublicAccessBlockConfiguration

Type: PublicAccessBlockConfiguration structure

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

Errors

There are no errors described for this operation.

HeadBucket

$result = $client->headBucket([/* ... */]);
$promise = $client->headBucketAsync([/* ... */]);

This action is useful to determine if a bucket exists and you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message body is not included, so you cannot determine the exception beyond these error codes.

To use this operation, you must have permissions to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

To use this API operation against an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more information, see Using access points.

Parameter Syntax

$result = $client->headBucket([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

When you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NoSuchBucket:
The specified bucket does not exist.

Examples

Example 1: To determine if bucket exists

This operation checks to see if a bucket exists.

$result = $client->headBucket([
    'Bucket' => 'acl1',
]);

HeadObject

$result = $client->headObject([/* ... */]);
$promise = $client->headObjectAsync([/* ... */]);

The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

A HEAD request has the same options as a GET action on an object. The response is identical to the GET response except that there is no response body. Because of this, if the HEAD request generates an error, it returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. It is not possible to retrieve the exact exception beyond these error codes.

x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).

Encryption request headers, like x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 Bad Request error.
The last modified property in this case is the creation date of the object.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Consider the following when using request headers:

Consideration 1 – If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:
- If-Match condition evaluates to true, and;
- If-Unmodified-Since condition evaluates to false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:
- If-None-Match condition evaluates to false, and;
- If-Modified-Since condition evaluates to true;
Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Permissions

You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3. If the object you request doesn't exist, the error that Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 error.

The following actions are related to HeadObject:

Parameter Syntax

$result = $client->headObject([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumMode' => 'ENABLED',
    'ExpectedBucketOwner' => '<string>',
    'IfMatch' => '<string>',
    'IfModifiedSince' => <integer || string || DateTime>,
    'IfNoneMatch' => '<string>',
    'IfUnmodifiedSince' => <integer || string || DateTime>,
    'Key' => '<string>', // REQUIRED
    'PartNumber' => <integer>,
    'Range' => '<string>',
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'VersionId' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the object.

ChecksumMode

Type: string

To retrieve the checksum, this parameter must be enabled.

In addition, if you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt action for the request to succeed.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

IfMatch

Type: string

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

IfModifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

IfNoneMatch

Type: string

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

IfUnmodifiedSince

Type: timestamp (string|DateTime or anything parsable by strtotime)

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

Key

Required: Yes
Type: string

The object key.

PartNumber

Type: int

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Range

Type: string

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey

Type: string

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

VersionId

Type: string

VersionId used to reference a specific version of the object.

Result Syntax

[
    'AcceptRanges' => '<string>',
    'ArchiveStatus' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS',
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ChecksumCRC32' => '<string>',
    'ChecksumCRC32C' => '<string>',
    'ChecksumSHA1' => '<string>',
    'ChecksumSHA256' => '<string>',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentLength' => <integer>,
    'ContentType' => '<string>',
    'DeleteMarker' => true || false,
    'ETag' => '<string>',
    'Expiration' => '<string>',
    'Expires' => <DateTime>,
    'LastModified' => <DateTime>,
    'Metadata' => ['<string>', ...],
    'MissingMeta' => <integer>,
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <DateTime>,
    'PartsCount' => <integer>,
    'ReplicationStatus' => 'COMPLETE|PENDING|FAILED|REPLICA|COMPLETED',
    'RequestCharged' => 'requester',
    'Restore' => '<string>',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'VersionId' => '<string>',
    'WebsiteRedirectLocation' => '<string>',
]

Result Details

Members

AcceptRanges

Type: string

Indicates that a range of bytes was specified.

ArchiveStatus

Type: string

The archive state of the head object.

BucketKeyEnabled

Type: boolean

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

CacheControl

Type: string

Specifies caching behavior along the request/reply chain.

ChecksumCRC32

Type: string

ChecksumCRC32C

Type: string

ChecksumSHA1

Type: string

ChecksumSHA256

Type: string

ContentDisposition

Type: string

Specifies presentational information for the object.

ContentEncoding

Type: string

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

ContentLanguage

Type: string

The language the content is in.

ContentLength

Type: long (int|float)

Size of the body in bytes.

ContentType

Type: string

A standard MIME type describing the format of the object data.

DeleteMarker

Type: boolean

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

ETag

Type: string

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

Expiration

Type: string

Expires

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time at which the object is no longer cacheable.

LastModified

Type: timestamp (string|DateTime or anything parsable by strtotime)

Creation date of the object.

Metadata

Type: Associative array of custom strings keys (MetadataKey) to strings

A map of metadata to store with the object in S3.

MissingMeta

Type: int

ObjectLockLegalHoldStatus

Type: string

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

ObjectLockMode

Type: string

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

ObjectLockRetainUntilDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

PartsCount

Type: int

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

ReplicationStatus

Type: string

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Restore

Type: string

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

SSECustomerAlgorithm

Type: string

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

SSECustomerKeyMD5

Type: string

SSEKMSKeyId

Type: string

If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.

ServerSideEncryption

Type: string

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

StorageClass

Type: string

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

VersionId

Type: string

Version of the object.

WebsiteRedirectLocation

Type: string

Errors

NoSuchKey:
The specified key does not exist.

Examples

Example 1: To retrieve metadata of an object without returning the object itself

The following example retrieves an object metadata.

$result = $client->headObject([
    'Bucket' => 'examplebucket',
    'Key' => 'HappyFace.jpg',
]);

Result syntax:

[
    'AcceptRanges' => 'bytes',
    'ContentLength' => 3191,
    'ContentType' => 'image/jpeg',
    'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
    'LastModified' => ,
    'Metadata' => [
    ],
    'VersionId' => 'null',
]

ListBucketAnalyticsConfigurations

$result = $client->listBucketAnalyticsConfigurations([/* ... */]);
$promise = $client->listBucketAnalyticsConfigurationsAsync([/* ... */]);

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.

The following operations are related to ListBucketAnalyticsConfigurations:

Parameter Syntax

$result = $client->listBucketAnalyticsConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket from which analytics configurations are retrieved.

ContinuationToken

Type: string

The ContinuationToken that represents a placeholder from where this request should begin.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'AnalyticsConfigurationList' => [
        [
            'Filter' => [
                'And' => [
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'Id' => '<string>',
            'StorageClassAnalysis' => [
                'DataExport' => [
                    'Destination' => [
                        'S3BucketDestination' => [
                            'Bucket' => '<string>',
                            'BucketAccountId' => '<string>',
                            'Format' => 'CSV',
                            'Prefix' => '<string>',
                        ],
                    ],
                    'OutputSchemaVersion' => 'V_1',
                ],
            ],
        ],
        // ...
    ],
    'ContinuationToken' => '<string>',
    'IsTruncated' => true || false,
    'NextContinuationToken' => '<string>',
]

Result Details

Members

AnalyticsConfigurationList

Type: Array of AnalyticsConfiguration structures

The list of analytics configurations for a bucket.

ContinuationToken

Type: string

The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

IsTruncated

Type: boolean

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

NextContinuationToken

Type: string

NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

Errors

There are no errors described for this operation.

ListBucketIntelligentTieringConfigurations

$result = $client->listBucketIntelligentTieringConfigurations([/* ... */]);
$promise = $client->listBucketIntelligentTieringConfigurationsAsync([/* ... */]);

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

Parameter Syntax

$result = $client->listBucketIntelligentTieringConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

ContinuationToken

Type: string

The ContinuationToken that represents a placeholder from where this request should begin.

Result Syntax

[
    'ContinuationToken' => '<string>',
    'IntelligentTieringConfigurationList' => [
        [
            'Filter' => [
                'And' => [
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'Id' => '<string>',
            'Status' => 'Enabled|Disabled',
            'Tierings' => [
                [
                    'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS',
                    'Days' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'IsTruncated' => true || false,
    'NextContinuationToken' => '<string>',
]

Result Details

Members

ContinuationToken

Type: string

The ContinuationToken that represents a placeholder from where this request should begin.

IntelligentTieringConfigurationList

Type: Array of IntelligentTieringConfiguration structures

The list of S3 Intelligent-Tiering configurations for a bucket.

IsTruncated

Type: boolean

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

NextContinuationToken

Type: string

The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

Errors

There are no errors described for this operation.

ListBucketInventoryConfigurations

$result = $client->listBucketInventoryConfigurations([/* ... */]);
$promise = $client->listBucketInventoryConfigurationsAsync([/* ... */]);

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory

The following operations are related to ListBucketInventoryConfigurations:

Parameter Syntax

$result = $client->listBucketInventoryConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the inventory configurations to retrieve.

ContinuationToken

Type: string

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'ContinuationToken' => '<string>',
    'InventoryConfigurationList' => [
        [
            'Destination' => [
                'S3BucketDestination' => [
                    'AccountId' => '<string>',
                    'Bucket' => '<string>',
                    'Encryption' => [
                        'SSEKMS' => [
                            'KeyId' => '<string>',
                        ],
                        'SSES3' => [
                        ],
                    ],
                    'Format' => 'CSV|ORC|Parquet',
                    'Prefix' => '<string>',
                ],
            ],
            'Filter' => [
                'Prefix' => '<string>',
            ],
            'Id' => '<string>',
            'IncludedObjectVersions' => 'All|Current',
            'IsEnabled' => true || false,
            'OptionalFields' => ['<string>', ...],
            'Schedule' => [
                'Frequency' => 'Daily|Weekly',
            ],
        ],
        // ...
    ],
    'IsTruncated' => true || false,
    'NextContinuationToken' => '<string>',
]

Result Details

Members

ContinuationToken

Type: string

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

InventoryConfigurationList

Type: Array of InventoryConfiguration structures

The list of inventory configurations for a bucket.

IsTruncated

Type: boolean

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

NextContinuationToken

Type: string

Errors

There are no errors described for this operation.

ListBucketMetricsConfigurations

$result = $client->listBucketMetricsConfigurations([/* ... */]);
$promise = $client->listBucketMetricsConfigurationsAsync([/* ... */]);

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

Parameter Syntax

$result = $client->listBucketMetricsConfigurations([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the metrics configurations to retrieve.

ContinuationToken

Type: string

The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[
    'ContinuationToken' => '<string>',
    'IsTruncated' => true || false,
    'MetricsConfigurationList' => [
        [
            'Filter' => [
                'AccessPointArn' => '<string>',
                'And' => [
                    'AccessPointArn' => '<string>',
                    'Prefix' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'Prefix' => '<string>',
                'Tag' => [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
            ],
            'Id' => '<string>',
        ],
        // ...
    ],
    'NextContinuationToken' => '<string>',
]

Result Details

Members

ContinuationToken

Type: string

The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

IsTruncated

Type: boolean

Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

MetricsConfigurationList

Type: Array of MetricsConfiguration structures

The list of metrics configurations for a bucket.

NextContinuationToken

Type: string

The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

Errors

There are no errors described for this operation.

ListBuckets

$result = $client->listBuckets([/* ... */]);
$promise = $client->listBucketsAsync([/* ... */]);

Returns a list of all buckets owned by the authenticated sender of the request. To use this operation, you must have the s3:ListAllMyBuckets permission.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

Parameter Syntax

$result = $client->listBuckets([
]);

Parameter Details

Members

Result Syntax

[
    'Buckets' => [
        [
            'CreationDate' => <DateTime>,
            'Name' => '<string>',
        ],
        // ...
    ],
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
]

Result Details

Members

Buckets

Type: Array of Bucket structures

The list of buckets owned by the requester.

Owner

Type: Owner structure

The owner of the buckets listed.

Errors

There are no errors described for this operation.

Examples

Example 1: To list all buckets

The following example returns all the buckets owned by the sender of this request.

$result = $client->listBuckets([
]);

Result syntax:

[
    'Buckets' => [
        [
            'CreationDate' => ,
            'Name' => 'examplebucket',
        ],
        [
            'CreationDate' => ,
            'Name' => 'examplebucket2',
        ],
        [
            'CreationDate' => ,
            'Name' => 'examplebucket3',
        ],
    ],
    'Owner' => [
        'DisplayName' => 'own-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31',
    ],
]

ListMultipartUploads

$result = $client->listMultipartUploads([/* ... */]);
$promise = $client->listMultipartUploadsAsync([/* ... */]);

This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.

This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated element with the value true. To list the additional multipart uploads, use the key-marker and upload-id-marker request parameters.

In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListMultipartUploads:

Parameter Syntax

$result = $client->listMultipartUploads([
    'Bucket' => '<string>', // REQUIRED
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'KeyMarker' => '<string>',
    'MaxUploads' => <integer>,
    'Prefix' => '<string>',
    'RequestPayer' => 'requester',
    'UploadIdMarker' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket to which the multipart upload was initiated.

Delimiter

Type: string

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

EncodingType

Type: string

Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key can contain any Unicode character; however, the XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

KeyMarker

Type: string

Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

If upload-id-marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

If upload-id-marker is specified, any multipart uploads for a key equal to the key-marker might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker.

MaxUploads

Type: int

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

Prefix

Type: string

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.)

RequestPayer

Type: string

UploadIdMarker

Type: string

Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.

Result Syntax

[
    'Bucket' => '<string>',
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'KeyMarker' => '<string>',
    'MaxUploads' => <integer>,
    'NextKeyMarker' => '<string>',
    'NextUploadIdMarker' => '<string>',
    'Prefix' => '<string>',
    'RequestCharged' => 'requester',
    'UploadIdMarker' => '<string>',
    'Uploads' => [
        [
            'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
            'Initiated' => <DateTime>,
            'Initiator' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'Key' => '<string>',
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
            'UploadId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Bucket

Type: string

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

CommonPrefixes

Type: Array of CommonPrefix structures

If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.

Delimiter

Type: string

Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

IsTruncated

Type: boolean

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

KeyMarker

Type: string

The key at or after which the listing began.

MaxUploads

Type: int

Maximum number of multipart uploads that could have been included in the response.

NextKeyMarker

Type: string

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

NextUploadIdMarker

Type: string

When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

Prefix

Type: string

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

UploadIdMarker

Type: string

Upload ID after which listing began.

Uploads

Type: Array of MultipartUpload structures

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

Errors

There are no errors described for this operation.

Examples

Example 1: To list in-progress multipart uploads on a bucket

The following example lists in-progress multipart uploads on a specific bucket.

$result = $client->listMultipartUploads([
    'Bucket' => 'examplebucket',
]);

Result syntax:

[
    'Uploads' => [
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--',
        ],
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--',
        ],
    ],
]

Example 2: List next set of multipart uploads when previous result is truncated

The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.

$result = $client->listMultipartUploads([
    'Bucket' => 'examplebucket',
    'KeyMarker' => 'nextkeyfrompreviousresponse',
    'MaxUploads' => 2,
    'UploadIdMarker' => 'valuefrompreviousresponse',
]);

Result syntax:

[
    'Bucket' => 'acl1',
    'IsTruncated' => 1,
    'KeyMarker' => '',
    'MaxUploads' => 2,
    'NextKeyMarker' => 'someobjectkey',
    'NextUploadIdMarker' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--',
    'UploadIdMarker' => '',
    'Uploads' => [
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'ownder-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'mohanataws',
                'ID' => '852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--',
        ],
        [
            'Initiated' => ,
            'Initiator' => [
                'DisplayName' => 'ownder-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Key' => 'JavaFile',
            'Owner' => [
                'DisplayName' => 'ownder-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'StorageClass' => 'STANDARD',
            'UploadId' => 'b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--',
        ],
    ],
]

ListObjectVersions

$result = $client->listObjectVersions([/* ... */]);
$promise = $client->listObjectVersionsAsync([/* ... */]);

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.

To use this operation, you must have READ access to the bucket.

This action is not supported by Amazon S3 on Outposts.

The following operations are related to ListObjectVersions:

Parameter Syntax

$result = $client->listObjectVersions([
    'Bucket' => '<string>', // REQUIRED
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'KeyMarker' => '<string>',
    'MaxKeys' => <integer>,
    'OptionalObjectAttributes' => ['<string>', ...],
    'Prefix' => '<string>',
    'RequestPayer' => 'requester',
    'VersionIdMarker' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name that contains the objects.

Delimiter

Type: string

A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

EncodingType

Type: string

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

KeyMarker

Type: string

Specifies the key to start with when listing objects in a bucket.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

OptionalObjectAttributes

Type: Array of strings

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Prefix

Type: string

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

RequestPayer

Type: string

VersionIdMarker

Type: string

Specifies the object version you want to start listing from.

Result Syntax

[
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'DeleteMarkers' => [
        [
            'IsLatest' => true || false,
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'VersionId' => '<string>',
        ],
        // ...
    ],
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'KeyMarker' => '<string>',
    'MaxKeys' => <integer>,
    'Name' => '<string>',
    'NextKeyMarker' => '<string>',
    'NextVersionIdMarker' => '<string>',
    'Prefix' => '<string>',
    'RequestCharged' => 'requester',
    'VersionIdMarker' => '<string>',
    'Versions' => [
        [
            'ChecksumAlgorithm' => ['<string>', ...],
            'ETag' => '<string>',
            'IsLatest' => true || false,
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'RestoreStatus' => [
                'IsRestoreInProgress' => true || false,
                'RestoreExpiryDate' => <DateTime>,
            ],
            'Size' => <integer>,
            'StorageClass' => 'STANDARD',
            'VersionId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

CommonPrefixes

Type: Array of CommonPrefix structures

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

DeleteMarkers

Type: Array of DeleteMarkerEntry structures

Container for an object that is a delete marker.

Delimiter

Type: string

The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

IsTruncated

Type: boolean

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

KeyMarker

Type: string

Marks the last key returned in a truncated response.

MaxKeys

Type: int

Specifies the maximum number of objects to return.

Name

Type: string

The bucket name.

NextKeyMarker

Type: string

When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.

NextVersionIdMarker

Type: string

When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.

Prefix

Type: string

Selects objects that start with the value supplied by this parameter.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

VersionIdMarker

Type: string

Marks the last version of the key returned in a truncated response.

Versions

Type: Array of ObjectVersion structures

Container for version information.

Errors

There are no errors described for this operation.

Examples

Example 1: To list object versions

The following example return versions of an object with specific key name prefix. The request limits the number of items returned to two. If there are are more than two object version, S3 returns NextToken in the response. You can specify this token value in your next request to fetch next set of object versions.

$result = $client->listObjectVersions([
    'Bucket' => 'examplebucket',
    'Prefix' => 'HappyFace.jpg',
]);

Result syntax:

[
    'Versions' => [
        [
            'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
            'IsLatest' => 1,
            'Key' => 'HappyFace.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 3191,
            'StorageClass' => 'STANDARD',
            'VersionId' => 'null',
        ],
        [
            'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
            'IsLatest' => ,
            'Key' => 'HappyFace.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'owner-display-name',
                'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 3191,
            'StorageClass' => 'STANDARD',
            'VersionId' => 'PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k',
        ],
    ],
]

ListObjects

$result = $client->listObjects([/* ... */]);
$promise = $client->listObjectsAsync([/* ... */]);

Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.

This action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects.

The following operations are related to ListObjects:

Parameter Syntax

$result = $client->listObjects([
    'Bucket' => '<string>', // REQUIRED
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'Marker' => '<string>',
    'MaxKeys' => <integer>,
    'OptionalObjectAttributes' => ['<string>', ...],
    'Prefix' => '<string>',
    'RequestPayer' => 'requester',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket containing the objects.

Delimiter

Type: string

A delimiter is a character that you use to group keys.

EncodingType

Type: string

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Marker

Type: string

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

OptionalObjectAttributes

Type: Array of strings

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Prefix

Type: string

Limits the response to keys that begin with the specified prefix.

RequestPayer

Type: string

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

Result Syntax

[
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'Contents' => [
        [
            'ChecksumAlgorithm' => ['<string>', ...],
            'ETag' => '<string>',
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'RestoreStatus' => [
                'IsRestoreInProgress' => true || false,
                'RestoreExpiryDate' => <DateTime>,
            ],
            'Size' => <integer>,
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
        ],
        // ...
    ],
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'Marker' => '<string>',
    'MaxKeys' => <integer>,
    'Name' => '<string>',
    'NextMarker' => '<string>',
    'Prefix' => '<string>',
    'RequestCharged' => 'requester',
]

Result Details

Members

CommonPrefixes

Type: Array of CommonPrefix structures

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/), as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

Contents

Type: Array of Object structures

Metadata about each object returned.

Delimiter

Type: string

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object keys in the response.

IsTruncated

Type: boolean

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

Marker

Type: string

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

MaxKeys

Type: int

The maximum number of keys returned in the response body.

Name

Type: string

The bucket name.

NextMarker

Type: string

When the response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.

This element is returned only if you have the delimiter request parameter specified. If the response does not include the NextMarker element and it is truncated, you can use the value of the last Key element in the response as the marker parameter in the subsequent request to get the next set of object keys.

Prefix

Type: string

Keys that begin with the indicated prefix.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

Errors

NoSuchBucket:
The specified bucket does not exist.

Examples

Example 1: To list objects in a bucket

The following example list two objects in a bucket.

$result = $client->listObjects([
    'Bucket' => 'examplebucket',
    'MaxKeys' => 2,
]);

Result syntax:

[
    'Contents' => [
        [
            'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"',
            'Key' => 'example1.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'myname',
                'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 11,
            'StorageClass' => 'STANDARD',
        ],
        [
            'ETag' => '"9c8af9a76df052144598c115ef33e511"',
            'Key' => 'example2.jpg',
            'LastModified' => ,
            'Owner' => [
                'DisplayName' => 'myname',
                'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
            ],
            'Size' => 713193,
            'StorageClass' => 'STANDARD',
        ],
    ],
    'NextMarker' => 'eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==',
]

ListObjectsV2

$result = $client->listObjectsV2([/* ... */]);
$promise = $client->listObjectsV2Async([/* ... */]);

Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide.

To use this operation, you must have READ access to the bucket.

To use this action in an Identity and Access Management (IAM) policy, you must have permission to perform the s3:ListBucket action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

To get a list of your buckets, see ListBuckets.

The following operations are related to ListObjectsV2:

Parameter Syntax

$result = $client->listObjectsV2([
    'Bucket' => '<string>', // REQUIRED
    'ContinuationToken' => '<string>',
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'ExpectedBucketOwner' => '<string>',
    'FetchOwner' => true || false,
    'MaxKeys' => <integer>,
    'OptionalObjectAttributes' => ['<string>', ...],
    'Prefix' => '<string>',
    'RequestPayer' => 'requester',
    'StartAfter' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Bucket name to list.

ContinuationToken

Type: string

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.

Delimiter

Type: string

A delimiter is a character that you use to group keys.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object keys in the response.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

FetchOwner

Type: boolean

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

OptionalObjectAttributes

Type: Array of strings

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

Prefix

Type: string

Limits the response to keys that begin with the specified prefix.

RequestPayer

Type: string

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

StartAfter

Type: string

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

Result Syntax

[
    'CommonPrefixes' => [
        [
            'Prefix' => '<string>',
        ],
        // ...
    ],
    'Contents' => [
        [
            'ChecksumAlgorithm' => ['<string>', ...],
            'ETag' => '<string>',
            'Key' => '<string>',
            'LastModified' => <DateTime>,
            'Owner' => [
                'DisplayName' => '<string>',
                'ID' => '<string>',
            ],
            'RestoreStatus' => [
                'IsRestoreInProgress' => true || false,
                'RestoreExpiryDate' => <DateTime>,
            ],
            'Size' => <integer>,
            'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
        ],
        // ...
    ],
    'ContinuationToken' => '<string>',
    'Delimiter' => '<string>',
    'EncodingType' => 'url',
    'IsTruncated' => true || false,
    'KeyCount' => <integer>,
    'MaxKeys' => <integer>,
    'Name' => '<string>',
    'NextContinuationToken' => '<string>',
    'Prefix' => '<string>',
    'RequestCharged' => 'requester',
    'StartAfter' => '<string>',
]

Result Details

Members

CommonPrefixes

Type: Array of CommonPrefix structures

All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

Contents

Type: Array of Object structures

Metadata about each object returned.

ContinuationToken

Type: string

If ContinuationToken was sent with the request, it is included in the response.

Delimiter

Type: string

Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.

EncodingType

Type: string

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key, and StartAfter.

IsTruncated

Type: boolean

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

KeyCount

Type: int

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

MaxKeys

Type: int

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

Name

Type: string

The bucket name.

NextContinuationToken

Type: string

NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

Prefix

Type: string

Keys that begin with the indicated prefix.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

StartAfter

Type: string

If StartAfter was sent with the request, it is included in the response.

Errors

NoSuchBucket:
The specified bucket does not exist.

Examples

Example 1: To get object list

The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.

$result = $client->listObjectsV2([
    'Bucket' => 'DOC-EXAMPLE-BUCKET',
    'MaxKeys' => 2,
]);

Result syntax:

[
    'Contents' => [
        [
            'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"',
            'Key' => 'happyface.jpg',
            'LastModified' => ,
            'Size' => 11,
            'StorageClass' => 'STANDARD',
        ],
        [
            'ETag' => '"becf17f89c30367a9a44495d62ed521a-1"',
            'Key' => 'test.jpg',
            'LastModified' => ,
            'Size' => 4192256,
            'StorageClass' => 'STANDARD',
        ],
    ],
    'IsTruncated' => 1,
    'KeyCount' => 2,
    'MaxKeys' => 2,
    'Name' => 'DOC-EXAMPLE-BUCKET',
    'NextContinuationToken' => '1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==',
    'Prefix' => '',
]

ListParts

$result = $client->listParts([/* ... */]);
$promise = $client->listPartsAsync([/* ... */]);

Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. In subsequent ListParts requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

If the upload was created using a checksum algorithm, you will need to have permission to the kms:Decrypt action for the request to succeed.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload.

For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions.

The following operations are related to ListParts:

Parameter Syntax

$result = $client->listParts([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Key' => '<string>', // REQUIRED
    'MaxParts' => <integer>,
    'PartNumberMarker' => <integer>,
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'UploadId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket to which the parts are being uploaded.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Key

Required: Yes
Type: string

Object key for which the multipart upload was initiated.

MaxParts

Type: int

Sets the maximum number of parts to return.

PartNumberMarker

Type: int

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

RequestPayer

Type: string

SSECustomerAlgorithm

Type: string

SSECustomerKey

Type: string

This value will be base64 encoded on your behalf.

SSECustomerKeyMD5

Type: string

UploadId

Required: Yes
Type: string

Upload ID identifying the multipart upload whose parts are being listed.

Result Syntax

[
    'AbortDate' => <DateTime>,
    'AbortRuleId' => '<string>',
    'Bucket' => '<string>',
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'Initiator' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
    'IsTruncated' => true || false,
    'Key' => '<string>',
    'MaxParts' => <integer>,
    'NextPartNumberMarker' => <integer>,
    'Owner' => [
        'DisplayName' => '<string>',
        'ID' => '<string>',
    ],
    'PartNumberMarker' => <integer>,
    'Parts' => [
        [
            'ChecksumCRC32' => '<string>',
            'ChecksumCRC32C' => '<string>',
            'ChecksumSHA1' => '<string>',
            'ChecksumSHA256' => '<string>',
            'ETag' => '<string>',
            'LastModified' => <DateTime>,
            'PartNumber' => <integer>,
            'Size' => <integer>,
        ],
        // ...
    ],
    'RequestCharged' => 'requester',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'UploadId' => '<string>',
]

Result Details

Members

AbortDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.

AbortRuleId

Type: string

This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.

Bucket

Type: string

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

ChecksumAlgorithm

Type: string

The algorithm that was used to create a checksum of the object.

Initiator

Type: Initiator structure

Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the Owner element. If the initiator is an IAM User, this element provides the user ARN and display name.

IsTruncated

Type: boolean

Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

Key

Type: string

Object key for which the multipart upload was initiated.

MaxParts

Type: int

Maximum number of parts that were allowed in the response.

NextPartNumberMarker

Type: int

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

Owner

Type: Owner structure

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

PartNumberMarker

Type: int

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

Parts

Type: Array of Part structures

Container for elements related to a particular part. A response can contain zero or more Part elements.

RequestCharged

Type: string

If present, indicates that the requester was successfully charged for the request.

StorageClass

Type: string

Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.

UploadId

Type: string

Upload ID identifying the multipart upload whose parts are being listed.

Errors

There are no errors described for this operation.

Examples

Example 1: To list parts of a multipart upload.

The following example lists parts uploaded for a specific multipart upload.

$result = $client->listParts([
    'Bucket' => 'examplebucket',
    'Key' => 'bigobject',
    'UploadId' => 'example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--',
]);

Result syntax:

[
    'Initiator' => [
        'DisplayName' => 'owner-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
    ],
    'Owner' => [
        'DisplayName' => 'owner-display-name',
        'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc',
    ],
    'Parts' => [
        [
            'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
            'LastModified' => ,
            'PartNumber' => 1,
            'Size' => 26246026,
        ],
        [
            'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
            'LastModified' => ,
            'PartNumber' => 2,
            'Size' => 26246026,
        ],
    ],
    'StorageClass' => 'STANDARD',
]

PutBucketAccelerateConfiguration

$result = $client->putBucketAccelerateConfiguration([/* ... */]);
$promise = $client->putBucketAccelerateConfigurationAsync([/* ... */]);

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

Enabled – Enables accelerated data transfers to the bucket.
Suspended – Disables accelerated data transfers to the bucket.

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

Parameter Syntax

$result = $client->putBucketAccelerateConfiguration([
    'AccelerateConfiguration' => [ // REQUIRED
        'Status' => 'Enabled|Suspended',
    ],
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

AccelerateConfiguration

Required: Yes
Type: AccelerateConfiguration structure

Container for setting the transfer acceleration state.

Bucket

Required: Yes
Type: string

The name of the bucket for which the accelerate configuration is set.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketAcl

$result = $client->putBucketAcl([/* ... */]);
$promise = $client->putBucketAclAsync([/* ... */]);

Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.

You can use one of the following two ways to set a bucket's permissions:

Specify the ACL in the request body
Specify permissions using request headers

You cannot specify access permission using both the body and the request headers.

Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.

Permissions

You can set access permissions by using one of the following methods:

Specify a canned ACL with the x-amz-acl request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read, x-amz-grant-read-acp, x-amz-grant-write-acp, and x-amz-grant-full-control headers. When using these headers, you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.

You specify each grantee as a type=value pair, where the type is one of the following:
- id – if the value specified is the canonical user ID of an Amazon Web Services account
- uri – if you are granting permissions to a predefined group
- emailAddress – if the value specified is the email address of an Amazon Web Services account
  Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
  - US East (N. Virginia)
  - US West (N. California)
  - US West (Oregon)
  - Asia Pacific (Singapore)
  - Asia Pacific (Sydney)
  - Asia Pacific (Tokyo)
  - Europe (Ireland)
  - South America (São Paulo)
  For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.

x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

You can use either a canned ACL or specify access permissions explicitly. You cannot do both.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:

By the person's ID:

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

DisplayName is optional and ignored in the request
By URI:

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>

The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
- US East (N. Virginia)
- US West (N. California)
- US West (Oregon)
- Asia Pacific (Singapore)
- Asia Pacific (Sydney)
- Asia Pacific (Tokyo)
- Europe (Ireland)
- South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

The following operations are related to PutBucketAcl:

Parameter Syntax

$result = $client->putBucketAcl([
    'ACL' => 'private|public-read|public-read-write|authenticated-read',
    'AccessControlPolicy' => [
        'Grants' => [
            [
                'Grantee' => [
                    'DisplayName' => '<string>',
                    'EmailAddress' => '<string>',
                    'ID' => '<string>',
                    'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED
                    'URI' => '<string>',
                ],
                'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
            ],
            // ...
        ],
        'Owner' => [
            'DisplayName' => '<string>',
            'ID' => '<string>',
        ],
    ],
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWrite' => '<string>',
    'GrantWriteACP' => '<string>',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the bucket.

AccessControlPolicy

Type: AccessControlPolicy structure

Contains the elements that set the ACL permissions for an object per grantee.

Bucket

Required: Yes
Type: string

The bucket to which to apply the ACL.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

GrantFullControl

Type: string

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

GrantRead

Type: string

Allows grantee to list the objects in the bucket.

GrantReadACP

Type: string

Allows grantee to read the bucket ACL.

GrantWrite

Type: string

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

GrantWriteACP

Type: string

Allows grantee to write the ACL for the applicable bucket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Put bucket acl

The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.

$result = $client->putBucketAcl([
    'Bucket' => 'examplebucket',
    'GrantFullControl' => 'id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484',
    'GrantWrite' => 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery',
]);

PutBucketAnalyticsConfiguration

$result = $client->putBucketAnalyticsConfiguration([/* ... */]);
$promise = $client->putBucketAnalyticsConfigurationAsync([/* ... */]);

Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.

You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.

You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

PutBucketAnalyticsConfiguration has the following special errors:

- HTTP Error: HTTP 400 Bad Request
- Code: InvalidArgument
- Cause: Invalid argument.
- HTTP Error: HTTP 400 Bad Request
- Code: TooManyConfigurations
- Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP Error: HTTP 403 Forbidden
- Code: AccessDenied
- Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketAnalyticsConfiguration:

Parameter Syntax

$result = $client->putBucketAnalyticsConfiguration([
    'AnalyticsConfiguration' => [ // REQUIRED
        'Filter' => [
            'And' => [
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
        ],
        'Id' => '<string>', // REQUIRED
        'StorageClassAnalysis' => [ // REQUIRED
            'DataExport' => [
                'Destination' => [ // REQUIRED
                    'S3BucketDestination' => [ // REQUIRED
                        'Bucket' => '<string>', // REQUIRED
                        'BucketAccountId' => '<string>',
                        'Format' => 'CSV', // REQUIRED
                        'Prefix' => '<string>',
                    ],
                ],
                'OutputSchemaVersion' => 'V_1', // REQUIRED
            ],
        ],
    ],
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
]);

Parameter Details

Members

AnalyticsConfiguration

Required: Yes
Type: AnalyticsConfiguration structure

The configuration and any analyses for the analytics filter.

Bucket

Required: Yes
Type: string

The name of the bucket to which an analytics configuration is stored.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID that identifies the analytics configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketCors

$result = $client->putBucketCors([/* ... */]);
$promise = $client->putBucketCorsAsync([/* ... */]);

Sets the cors configuration for your bucket. If the configuration exists, Amazon S3 replaces it.

To use this operation, you must be allowed to perform the s3:PutBucketCORS action. By default, the bucket owner has this permission and can grant it to others.

You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your Amazon S3 bucket at my.example.bucket.com by using the browser's XMLHttpRequest capability.

To enable cross-origin resource sharing (CORS) on a bucket, you add the cors subresource to the bucket. The cors subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.

When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors configuration on the bucket and uses the first CORSRule rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:

The request's Origin header must match AllowedOrigin elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method header in case of a pre-flight OPTIONS request must be one of the AllowedMethod elements.
Every header specified in the Access-Control-Request-Headers request header of a pre-flight request must match an AllowedHeader element.

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

The following operations are related to PutBucketCors:

Parameter Syntax

$result = $client->putBucketCors([
    'Bucket' => '<string>', // REQUIRED
    'CORSConfiguration' => [ // REQUIRED
        'CORSRules' => [ // REQUIRED
            [
                'AllowedHeaders' => ['<string>', ...],
                'AllowedMethods' => ['<string>', ...], // REQUIRED
                'AllowedOrigins' => ['<string>', ...], // REQUIRED
                'ExposeHeaders' => ['<string>', ...],
                'ID' => '<string>',
                'MaxAgeSeconds' => <integer>,
            ],
            // ...
        ],
    ],
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies the bucket impacted by the corsconfiguration.

CORSConfiguration

Required: Yes
Type: CORSConfiguration structure

Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: To set cors configuration on a bucket.

The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.

$result = $client->putBucketCors([
    'Bucket' => '',
    'CORSConfiguration' => [
        'CORSRules' => [
            [
                'AllowedHeaders' => [
                    '*',
                ],
                'AllowedMethods' => [
                    'PUT',
                    'POST',
                    'DELETE',
                ],
                'AllowedOrigins' => [
                    'http://www.example.com',
                ],
                'ExposeHeaders' => [
                    'x-amz-server-side-encryption',
                ],
                'MaxAgeSeconds' => 3000,
            ],
            [
                'AllowedHeaders' => [
                    'Authorization',
                ],
                'AllowedMethods' => [
                    'GET',
                ],
                'AllowedOrigins' => [
                    '*',
                ],
                'MaxAgeSeconds' => 3000,
            ],
        ],
    ],
    'ContentMD5' => '',
]);

PutBucketEncryption

$result = $client->putBucketEncryption([/* ... */]);
$promise = $client->putBucketEncryptionAsync([/* ... */]);

This action uses the encryption subresource to configure default encryption and Amazon S3 Bucket Keys for an existing bucket.

By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.

This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

To use this operation, you must have permission to perform the s3:PutEncryptionConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

The following operations are related to PutBucketEncryption:

Parameter Syntax

$result = $client->putBucketEncryption([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'ServerSideEncryptionConfiguration' => [ // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'ApplyServerSideEncryptionByDefault' => [
                    'KMSMasterKeyID' => '<string>',
                    'SSEAlgorithm' => 'AES256|aws:kms|aws:kms:dsse', // REQUIRED
                ],
                'BucketKeyEnabled' => true || false,
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

Specifies default encryption for a bucket using server-side encryption with different key options. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

ServerSideEncryptionConfiguration

Required: Yes
Type: ServerSideEncryptionConfiguration structure

Specifies the default server-side-encryption configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketIntelligentTieringConfiguration

$result = $client->putBucketIntelligentTieringConfiguration([/* ... */]);
$promise = $client->putBucketIntelligentTieringConfigurationAsync([/* ... */]);

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

PutBucketIntelligentTieringConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

Parameter Syntax

$result = $client->putBucketIntelligentTieringConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'Id' => '<string>', // REQUIRED
    'IntelligentTieringConfiguration' => [ // REQUIRED
        'Filter' => [
            'And' => [
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
        ],
        'Id' => '<string>', // REQUIRED
        'Status' => 'Enabled|Disabled', // REQUIRED
        'Tierings' => [ // REQUIRED
            [
                'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS', // REQUIRED
                'Days' => <integer>, // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

Id

Required: Yes
Type: string

The ID used to identify the S3 Intelligent-Tiering configuration.

IntelligentTieringConfiguration

Required: Yes
Type: IntelligentTieringConfiguration structure

Container for S3 Intelligent-Tiering configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketInventoryConfiguration

$result = $client->putBucketInventoryConfiguration([/* ... */]);
$promise = $client->putBucketInventoryConfigurationAsync([/* ... */]);

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.

Permissions

To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.

PutBucketInventoryConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketInventoryConfiguration:

Parameter Syntax

$result = $client->putBucketInventoryConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
    'InventoryConfiguration' => [ // REQUIRED
        'Destination' => [ // REQUIRED
            'S3BucketDestination' => [ // REQUIRED
                'AccountId' => '<string>',
                'Bucket' => '<string>', // REQUIRED
                'Encryption' => [
                    'SSEKMS' => [
                        'KeyId' => '<string>', // REQUIRED
                    ],
                    'SSES3' => [
                    ],
                ],
                'Format' => 'CSV|ORC|Parquet', // REQUIRED
                'Prefix' => '<string>',
            ],
        ],
        'Filter' => [
            'Prefix' => '<string>', // REQUIRED
        ],
        'Id' => '<string>', // REQUIRED
        'IncludedObjectVersions' => 'All|Current', // REQUIRED
        'IsEnabled' => true || false, // REQUIRED
        'OptionalFields' => ['<string>', ...],
        'Schedule' => [ // REQUIRED
            'Frequency' => 'Daily|Weekly', // REQUIRED
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket where the inventory configuration will be stored.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID used to identify the inventory configuration.

InventoryConfiguration

Required: Yes
Type: InventoryConfiguration structure

Specifies the inventory configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketLifecycle

$result = $client->putBucketLifecycle([/* ... */]);
$promise = $client->putBucketLifecycleAsync([/* ... */]);

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

The following operations are related to PutBucketLifecycle:

GetBucketLifecycle(Deprecated)
GetBucketLifecycleConfiguration
RestoreObject
By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide:
- Specifying Permissions in a Policy
- Managing Access Permissions to your Amazon S3 Resources

Parameter Syntax

$result = $client->putBucketLifecycle([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'LifecycleConfiguration' => [
        'Rules' => [ // REQUIRED
            [
                'AbortIncompleteMultipartUpload' => [
                    'DaysAfterInitiation' => <integer>,
                ],
                'Expiration' => [
                    'Date' => <integer || string || DateTime>,
                    'Days' => <integer>,
                    'ExpiredObjectDeleteMarker' => true || false,
                ],
                'ID' => '<string>',
                'NoncurrentVersionExpiration' => [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                ],
                'NoncurrentVersionTransition' => [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                    'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                ],
                'Prefix' => '<string>', // REQUIRED
                'Status' => 'Enabled|Disabled', // REQUIRED
                'Transition' => [
                    'Date' => <integer || string || DateTime>,
                    'Days' => <integer>,
                    'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

LifecycleConfiguration

Type: LifecycleConfiguration structure

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketLifecycleConfiguration

$result = $client->putBucketLifecycleConfiguration([/* ... */]);
$promise = $client->putBucketLifecycleConfigurationAsync([/* ... */]);

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.

Rules

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:

A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
A status indicating whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

Permissions

By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration

For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

The following operations are related to PutBucketLifecycleConfiguration:

Parameter Syntax

$result = $client->putBucketLifecycleConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ExpectedBucketOwner' => '<string>',
    'LifecycleConfiguration' => [
        'Rules' => [ // REQUIRED
            [
                'AbortIncompleteMultipartUpload' => [
                    'DaysAfterInitiation' => <integer>,
                ],
                'Expiration' => [
                    'Date' => <integer || string || DateTime>,
                    'Days' => <integer>,
                    'ExpiredObjectDeleteMarker' => true || false,
                ],
                'Filter' => [
                    'And' => [
                        'ObjectSizeGreaterThan' => <integer>,
                        'ObjectSizeLessThan' => <integer>,
                        'Prefix' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'ObjectSizeGreaterThan' => <integer>,
                    'ObjectSizeLessThan' => <integer>,
                    'Prefix' => '<string>',
                    'Tag' => [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                ],
                'ID' => '<string>',
                'NoncurrentVersionExpiration' => [
                    'NewerNoncurrentVersions' => <integer>,
                    'NoncurrentDays' => <integer>,
                ],
                'NoncurrentVersionTransitions' => [
                    [
                        'NewerNoncurrentVersions' => <integer>,
                        'NoncurrentDays' => <integer>,
                        'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                    ],
                    // ...
                ],
                'Prefix' => '<string>',
                'Status' => 'Enabled|Disabled', // REQUIRED
                'Transitions' => [
                    [
                        'Date' => <integer || string || DateTime>,
                        'Days' => <integer>,
                        'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to set the configuration.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

LifecycleConfiguration

Type: BucketLifecycleConfiguration structure

Container for lifecycle rules. You can add as many as 1,000 rules.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Put bucket lifecycle

The following example replaces existing lifecycle configuration, if any, on the specified bucket.

$result = $client->putBucketLifecycleConfiguration([
    'Bucket' => 'examplebucket',
    'LifecycleConfiguration' => [
        'Rules' => [
            [
                'Expiration' => [
                    'Days' => 3650,
                ],
                'Filter' => [
                    'Prefix' => 'documents/',
                ],
                'ID' => 'TestOnly',
                'Status' => 'Enabled',
                'Transitions' => [
                    [
                        'Days' => 365,
                        'StorageClass' => 'GLACIER',
                    ],
                ],
            ],
        ],
    ],
]);

PutBucketLogging

$result = $client->putBucketLogging([/* ... */]);
$promise = $client->putBucketLoggingAsync([/* ... */]);

Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.

The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.

If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can't use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

Grantee Values

You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways:

By the person's ID:

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>

DisplayName is optional and ignored in the request.
By Email address:

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>

The grantee is resolved to the CanonicalUser and, in a response to a GETObjectAcl request, appears as the CanonicalUser.
By URI:

<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>

To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:

<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.

For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.

The following operations are related to PutBucketLogging:

Parameter Syntax

$result = $client->putBucketLogging([
    'Bucket' => '<string>', // REQUIRED
    'BucketLoggingStatus' => [ // REQUIRED
        'LoggingEnabled' => [
            'TargetBucket' => '<string>', // REQUIRED
            'TargetGrants' => [
                [
                    'Grantee' => [
                        'DisplayName' => '<string>',
                        'EmailAddress' => '<string>',
                        'ID' => '<string>',
                        'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED
                        'URI' => '<string>',
                    ],
                    'Permission' => 'FULL_CONTROL|READ|WRITE',
                ],
                // ...
            ],
            'TargetPrefix' => '<string>', // REQUIRED
        ],
    ],
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which to set the logging parameters.

BucketLoggingStatus

Required: Yes
Type: BucketLoggingStatus structure

Container for logging status information.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

The MD5 hash of the PutBucketLogging request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set logging configuration for a bucket

The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.

$result = $client->putBucketLogging([
    'Bucket' => 'sourcebucket',
    'BucketLoggingStatus' => [
        'LoggingEnabled' => [
            'TargetBucket' => 'targetbucket',
            'TargetGrants' => [
                [
                    'Grantee' => [
                        'Type' => 'Group',
                        'URI' => 'http://acs.amazonaws.com/groups/global/AllUsers',
                    ],
                    'Permission' => 'READ',
                ],
            ],
            'TargetPrefix' => 'MyBucketLogs/',
        ],
    ],
]);

PutBucketMetricsConfiguration

$result = $client->putBucketMetricsConfiguration([/* ... */]);
$promise = $client->putBucketMetricsConfigurationAsync([/* ... */]);

Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.

For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to PutBucketMetricsConfiguration:

PutBucketMetricsConfiguration has the following special error:

Error code: TooManyConfigurations
- Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP Status Code: HTTP 400 Bad Request

Parameter Syntax

$result = $client->putBucketMetricsConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'Id' => '<string>', // REQUIRED
    'MetricsConfiguration' => [ // REQUIRED
        'Filter' => [
            'AccessPointArn' => '<string>',
            'And' => [
                'AccessPointArn' => '<string>',
                'Prefix' => '<string>',
                'Tags' => [
                    [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                    // ...
                ],
            ],
            'Prefix' => '<string>',
            'Tag' => [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
        ],
        'Id' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket for which the metrics configuration is set.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Id

Required: Yes
Type: string

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

MetricsConfiguration

Required: Yes
Type: MetricsConfiguration structure

Specifies the metrics configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketNotification

$result = $client->putBucketNotification([/* ... */]);
$promise = $client->putBucketNotificationAsync([/* ... */]);

No longer used, see the PutBucketNotificationConfiguration operation.

Parameter Syntax

$result = $client->putBucketNotification([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'NotificationConfiguration' => [ // REQUIRED
        'CloudFunctionConfiguration' => [
            'CloudFunction' => '<string>',
            'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
            'Events' => ['<string>', ...],
            'Id' => '<string>',
            'InvocationRole' => '<string>',
        ],
        'QueueConfiguration' => [
            'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
            'Events' => ['<string>', ...],
            'Id' => '<string>',
            'Queue' => '<string>',
        ],
        'TopicConfiguration' => [
            'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete',
            'Events' => ['<string>', ...],
            'Id' => '<string>',
            'Topic' => '<string>',
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

NotificationConfiguration

Required: Yes
Type: NotificationConfigurationDeprecated structure

The container for the configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketNotificationConfiguration

$result = $client->putBucketNotificationConfiguration([/* ... */]);
$promise = $client->putBucketNotificationConfigurationAsync([/* ... */]);

Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.

Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.

By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration.

<NotificationConfiguration>

</NotificationConfiguration>

This action replaces the existing notification configuration with the configuration you include in the request body.

After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.

You can disable notifications by adding the empty NotificationConfiguration element.

For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.

By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with the required s3:PutBucketNotification permission.

The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.

If the configuration in the request body includes only one TopicConfiguration specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to the topic.

The following action is related to PutBucketNotificationConfiguration:

GetBucketNotificationConfiguration

Parameter Syntax

$result = $client->putBucketNotificationConfiguration([
    'Bucket' => '<string>', // REQUIRED
    'ExpectedBucketOwner' => '<string>',
    'NotificationConfiguration' => [ // REQUIRED
        'EventBridgeConfiguration' => [
        ],
        'LambdaFunctionConfigurations' => [
            [
                'Events' => ['<string>', ...], // REQUIRED
                'Filter' => [
                    'Key' => [
                        'FilterRules' => [
                            [
                                'Name' => 'prefix|suffix',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Id' => '<string>',
                'LambdaFunctionArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'QueueConfigurations' => [
            [
                'Events' => ['<string>', ...], // REQUIRED
                'Filter' => [
                    'Key' => [
                        'FilterRules' => [
                            [
                                'Name' => 'prefix|suffix',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Id' => '<string>',
                'QueueArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'TopicConfigurations' => [
            [
                'Events' => ['<string>', ...], // REQUIRED
                'Filter' => [
                    'Key' => [
                        'FilterRules' => [
                            [
                                'Name' => 'prefix|suffix',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'Id' => '<string>',
                'TopicArn' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'SkipDestinationValidation' => true || false,
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

NotificationConfiguration

Required: Yes
Type: NotificationConfiguration structure

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

SkipDestinationValidation

Type: boolean

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set notification configuration for a bucket

The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.

$result = $client->putBucketNotificationConfiguration([
    'Bucket' => 'examplebucket',
    'NotificationConfiguration' => [
        'TopicConfigurations' => [
            [
                'Events' => [
                    's3:ObjectCreated:*',
                ],
                'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:s3-notification-topic',
            ],
        ],
    ],
]);

PutBucketOwnershipControls

$result = $client->putBucketOwnershipControls([/* ... */]);
$promise = $client->putBucketOwnershipControlsAsync([/* ... */]);

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using object ownership.

The following operations are related to PutBucketOwnershipControls:

GetBucketOwnershipControls
DeleteBucketOwnershipControls

Parameter Syntax

$result = $client->putBucketOwnershipControls([
    'Bucket' => '<string>', // REQUIRED
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'OwnershipControls' => [ // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

ContentMD5

Type: string

The MD5 hash of the OwnershipControls request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

OwnershipControls

Required: Yes
Type: OwnershipControls structure

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

PutBucketPolicy

$result = $client->putBucketPolicy([/* ... */]);
$promise = $client->putBucketPolicyAsync([/* ... */]);

Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the PutBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

For more information, see Bucket policy examples.

The following operations are related to PutBucketPolicy:

Parameter Syntax

$result = $client->putBucketPolicy([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ConfirmRemoveSelfBucketAccess' => true || false,
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Policy' => '<string>', // REQUIRED
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ConfirmRemoveSelfBucketAccess

Type: boolean

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

ContentMD5

Type: string

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Policy

Required: Yes
Type: string

The bucket policy as a JSON document.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set bucket policy

The following example sets a permission policy on a bucket.

$result = $client->putBucketPolicy([
    'Bucket' => 'examplebucket',
    'Policy' => '{"Version": "2012-10-17", "Statement": [{ "Sid": "id-1","Effect": "Allow","Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Action": [ "s3:PutObject","s3:PutObjectAcl"], "Resource": ["arn:aws:s3:::acl3/*" ] } ]}',
]);

PutBucketReplication

$result = $client->putBucketReplication([/* ... */]);
$promise = $client->putBucketReplicationAsync([/* ... */]);

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services Region by using the aws:RequestedRegion condition key.

A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.

To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication, Status, and Priority.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

Parameter Syntax

$result = $client->putBucketReplication([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'ReplicationConfiguration' => [ // REQUIRED
        'Role' => '<string>', // REQUIRED
        'Rules' => [ // REQUIRED
            [
                'DeleteMarkerReplication' => [
                    'Status' => 'Enabled|Disabled',
                ],
                'Destination' => [ // REQUIRED
                    'AccessControlTranslation' => [
                        'Owner' => 'Destination', // REQUIRED
                    ],
                    'Account' => '<string>',
                    'Bucket' => '<string>', // REQUIRED
                    'EncryptionConfiguration' => [
                        'ReplicaKmsKeyID' => '<string>',
                    ],
                    'Metrics' => [
                        'EventThreshold' => [
                            'Minutes' => <integer>,
                        ],
                        'Status' => 'Enabled|Disabled', // REQUIRED
                    ],
                    'ReplicationTime' => [
                        'Status' => 'Enabled|Disabled', // REQUIRED
                        'Time' => [ // REQUIRED
                            'Minutes' => <integer>,
                        ],
                    ],
                    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
                ],
                'ExistingObjectReplication' => [
                    'Status' => 'Enabled|Disabled', // REQUIRED
                ],
                'Filter' => [
                    'And' => [
                        'Prefix' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>', // REQUIRED
                                'Value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'Prefix' => '<string>',
                    'Tag' => [
                        'Key' => '<string>', // REQUIRED
                        'Value' => '<string>', // REQUIRED
                    ],
                ],
                'ID' => '<string>',
                'Prefix' => '<string>',
                'Priority' => <integer>,
                'SourceSelectionCriteria' => [
                    'ReplicaModifications' => [
                        'Status' => 'Enabled|Disabled', // REQUIRED
                    ],
                    'SseKmsEncryptedObjects' => [
                        'Status' => 'Enabled|Disabled', // REQUIRED
                    ],
                ],
                'Status' => 'Enabled|Disabled', // REQUIRED
            ],
            // ...
        ],
    ],
    'Token' => '<string>',
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The name of the bucket

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

ReplicationConfiguration

Required: Yes
Type: ReplicationConfiguration structure

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

Token

Type: string

A token to allow Object Lock to be enabled for an existing bucket.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set replication configuration on a bucket

The following example sets replication configuration on a bucket.

$result = $client->putBucketReplication([
    'Bucket' => 'examplebucket',
    'ReplicationConfiguration' => [
        'Role' => 'arn:aws:iam::123456789012:role/examplerole',
        'Rules' => [
            [
                'Destination' => [
                    'Bucket' => 'arn:aws:s3:::destinationbucket',
                    'StorageClass' => 'STANDARD',
                ],
                'Prefix' => '',
                'Status' => 'Enabled',
            ],
        ],
    ],
]);

PutBucketRequestPayment

$result = $client->putBucketRequestPayment([/* ... */]);
$promise = $client->putBucketRequestPaymentAsync([/* ... */]);

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

Parameter Syntax

$result = $client->putBucketRequestPayment([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'RequestPaymentConfiguration' => [ // REQUIRED
        'Payer' => 'Requester|BucketOwner', // REQUIRED
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

RequestPaymentConfiguration

Required: Yes
Type: RequestPaymentConfiguration structure

Container for Payer.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set request payment configuration on a bucket.

The following example sets request payment configuration on a bucket so that person requesting the download is charged.

$result = $client->putBucketRequestPayment([
    'Bucket' => 'examplebucket',
    'RequestPaymentConfiguration' => [
        'Payer' => 'Requester',
    ],
]);

PutBucketTagging

$result = $client->putBucketTagging([/* ... */]);
$promise = $client->putBucketTaggingAsync([/* ... */]);

Sets the tags for a bucket.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags.

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

PutBucketTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

InvalidTag - The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.
MalformedXML - The XML provided does not match the schema.
OperationAborted - A conflicting conditional action is currently in progress against this resource. Please try again.
InternalError - The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging:

Parameter Syntax

$result = $client->putBucketTagging([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Tagging' => [ // REQUIRED
        'TagSet' => [ // REQUIRED
            [
                'Key' => '<string>', // REQUIRED
                'Value' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Tagging

Required: Yes
Type: Tagging structure

Container for the TagSet and Tag elements.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set tags on a bucket

The following example sets tags on a bucket. Any existing tags are replaced.

$result = $client->putBucketTagging([
    'Bucket' => 'examplebucket',
    'Tagging' => [
        'TagSet' => [
            [
                'Key' => 'Key1',
                'Value' => 'Value1',
            ],
            [
                'Key' => 'Key2',
                'Value' => 'Value2',
            ],
        ],
    ],
]);

PutBucketVersioning

$result = $client->putBucketVersioning([/* ... */]);
$promise = $client->putBucketVersioningAsync([/* ... */]);

Sets the versioning state of an existing bucket.

You can set the versioning state with one of the following values:

Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.

Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.

If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you must include the x-amz-mfa request header and the Status and the MfaDelete request elements in a request to set the versioning state of the bucket.

If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.

The following operations are related to PutBucketVersioning:

Parameter Syntax

$result = $client->putBucketVersioning([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'MFA' => '<string>',
    'VersioningConfiguration' => [ // REQUIRED
        'MFADelete' => 'Enabled|Disabled',
        'Status' => 'Enabled|Suspended',
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

MFA

Type: string

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

VersioningConfiguration

Required: Yes
Type: VersioningConfiguration structure

Container for setting the versioning state.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set versioning configuration on a bucket

The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.

$result = $client->putBucketVersioning([
    'Bucket' => 'examplebucket',
    'VersioningConfiguration' => [
        'MFADelete' => 'Disabled',
        'Status' => 'Enabled',
    ],
]);

PutBucketWebsite

$result = $client->putBucketWebsite([/* ... */]);
$promise = $client->putBucketWebsiteAsync([/* ... */]);

Sets the configuration of the website that is specified in the website subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.

This PUT action requires the S3:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite permission.

To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.

WebsiteConfiguration
RedirectAllRequestsTo
HostName
Protocol

If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.

WebsiteConfiguration
IndexDocument
Suffix
ErrorDocument
Key
RoutingRules
RoutingRule
Condition
HttpErrorCodeReturnedEquals
KeyPrefixEquals
Redirect
Protocol
HostName
ReplaceKeyPrefixWith
ReplaceKeyWith
HttpRedirectCode

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

The maximum request length is limited to 128 KB.

Parameter Syntax

$result = $client->putBucketWebsite([
    'Bucket' => '<string>', // REQUIRED
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ContentMD5' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'WebsiteConfiguration' => [ // REQUIRED
        'ErrorDocument' => [
            'Key' => '<string>', // REQUIRED
        ],
        'IndexDocument' => [
            'Suffix' => '<string>', // REQUIRED
        ],
        'RedirectAllRequestsTo' => [
            'HostName' => '<string>', // REQUIRED
            'Protocol' => 'http|https',
        ],
        'RoutingRules' => [
            [
                'Condition' => [
                    'HttpErrorCodeReturnedEquals' => '<string>',
                    'KeyPrefixEquals' => '<string>',
                ],
                'Redirect' => [ // REQUIRED
                    'HostName' => '<string>',
                    'HttpRedirectCode' => '<string>',
                    'Protocol' => 'http|https',
                    'ReplaceKeyPrefixWith' => '<string>',
                    'ReplaceKeyWith' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members

Bucket

Required: Yes
Type: string

The bucket name.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5

Type: string

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

The value will be computed on your behalf.

ExpectedBucketOwner

Type: string

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

WebsiteConfiguration

Required: Yes
Type: WebsiteConfiguration structure

Container for the request.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

There are no errors described for this operation.

Examples

Example 1: Set website configuration on a bucket

The following example adds website configuration to a bucket.

$result = $client->putBucketWebsite([
    'Bucket' => 'examplebucket',
    'ContentMD5' => '',
    'WebsiteConfiguration' => [
        'ErrorDocument' => [
            'Key' => 'error.html',
        ],
        'IndexDocument' => [
            'Suffix' => 'index.html',
        ],
    ],
]);

PutObject

$result = $client->putObject([/* ... */]);
$promise = $client->putObjectAsync([/* ... */]);

Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.

Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. You cannot use PutObject to only update a single piece of metadata for an existing object. You must put the entire object with updated metadata if you want to update some values.

Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. To prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock.

To ensure that data is not corrupted traversing the network, use the Content-MD5 header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

To successfully complete the PutObject request, you must have the s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request, you must have the s3:PutObjectAcl in your IAM permissions.
To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging in your IAM permissions.
The Content-MD5 header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon S3 User Guide.

You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption.

When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.

If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.

If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.

For more information about related Amazon S3 APIs, see the following:

Additional info on behavior of the stream parameters: Psr7 takes ownership of streams and will automatically close streams when this method is called with a stream as the Body parameter. To prevent this, set the Body using GuzzleHttp\Psr7\stream_for method with a is an instance of Psr\Http\Message\StreamInterface, and it will be returned unmodified. This will allow you to keep the stream in scope.

Parameter Syntax

$result = $client->putObject([
    'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
    'AddContentMD5' => true || false,
    'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
    'Bucket' => '<string>', // REQUIRED
    'BucketKeyEnabled' => true || false,
    'CacheControl' => '<string>',
    'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256',
    'ChecksumCRC32' => '<string>',
    'ChecksumCRC32C' => '<string>',
    'ChecksumSHA1' => '<string>',
    'ChecksumSHA256' => '<string>',
    'ContentDisposition' => '<string>',
    'ContentEncoding' => '<string>',
    'ContentLanguage' => '<string>',
    'ContentLength' => <integer>,
    'ContentMD5' => '<string>',
    'ContentSHA256' => '<string>',
    'ContentType' => '<string>',
    'ExpectedBucketOwner' => '<string>',
    'Expires' => <integer || string || DateTime>,
    'GrantFullControl' => '<string>',
    'GrantRead' => '<string>',
    'GrantReadACP' => '<string>',
    'GrantWriteACP' => '<string>',
    'Key' => '<string>', // REQUIRED
    'Metadata' => ['<string>', ...],
    'ObjectLockLegalHoldStatus' => 'ON|OFF',
    'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
    'ObjectLockRetainUntilDate' => <integer || string || DateTime>,
    'RequestPayer' => 'requester',
    'SSECustomerAlgorithm' => '<string>',
    'SSECustomerKey' => '<string>',
    'SSECustomerKeyMD5' => '<string>',
    'SSEKMSEncryptionContext' => '<string>',
    'SSEKMSKeyId' => '<string>',
    'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse',
    'SourceFile' => '<string>',
    'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW',
    'Tagging' => '<string>',
    'WebsiteRedirectLocation' => '<string>',
]);

Parameter Details

Members

ACL

Type: string

The canned ACL to apply to the object. For more information, see Canned ACL.

This action is not supported by Amazon S3 on Outposts.

AddContentMD5

Type: boolean

Set to true to calculate the ContentMD5 for the upload.

Body

Type: blob (string|resource|Psr\Http\Message\StreamInterface)

Object data.

Bucket

Required: Yes
Type: string

The bucket name to which the PUT action was initiated.

BucketKeyEnabled

Type: boolean

Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.

CacheControl

Type: string

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

ChecksumAlgorithm

Type: string

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ChecksumCRC32

Type: string

ChecksumCRC32C

Type: string

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

ChecksumSHA1

Type: string

This header can be used as a data integrity check to verify that the data received is the s

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Simple Storage Service 2006-03-01

Operation Summary

Paginators

Waiters

Operations

AbortMultipartUpload

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To abort a multipart upload

CompleteMultipartUpload

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To complete multipart upload

CopyObject

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To copy an object

CreateBucket

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a bucket

Example 2: To create a bucket in a specific region

CreateMultipartUpload

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To initiate a multipart upload

DeleteBucket

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To delete a bucket

DeleteBucketAnalyticsConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteBucketCors

Parameter Syntax