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 SummaryEach 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 */).
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:
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:
Operations AbortMultipartUpload$result = $client->abortMultipartUpload([/* ... */]); $promise = $client->abortMultipartUploadAsync([/* ... */]);
This operation 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 and prevent getting charged for the part storage, you should call the ListParts API operation and ensure that the parts list is empty.
Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the ListMultipartUploads operation to list the in-progress multipart uploads in the bucket and use the AbortMultipartUpload operation to abort all the in-progress multipart uploads.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to AbortMultipartUpload:
$result = $client->abortMultipartUpload([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'IfMatchInitiatedTime' => <integer || string || DateTime>,
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'UploadId' => '<string>', // REQUIRED
]);
Parameter Details Members
The bucket name to which the upload was taking place.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed error. If the initiated timestamp matches or if the multipart upload doesnât exist, the operation returns a 204 Success (No Content) response.
This functionality is only supported for directory buckets.
Key of the object for which the multipart upload was initiated.
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 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.
This functionality is not supported for directory buckets.
Upload ID that identifies the multipart upload.
[
'RequestCharged' => 'requester',
]Result Details Errors
The specified multipart upload does not exist.
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 or the UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you call this CompleteMultipartUpload operation 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 CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the PartNumber value and the ETag value that are returned after that part was uploaded.
The processing of a CompleteMultipartUpload request could take several minutes to finalize. 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. The error response might be embedded in the 200 OK response. If you call this API operation 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 throw an exception (or, for the SDKs that don't use exceptions, they return an error).
Note that if CompleteMultipartUpload fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see Amazon S3 Error Best Practices.
You can't use Content-Type: application/x-www-form-urlencoded for the CompleteMultipartUpload requests. Also, if you don't provide a Content-Type header, CompleteMultipartUpload can still return a 200 OK response.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
If you provide an additional checksum value in your MultipartUpload requests and the object is encrypted with Key Management Service, you must have permission to use the kms:Decrypt action for the CompleteMultipartUpload request to succeed.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
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.
HTTP Status Code: 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 ETag might not have matched the uploaded part's ETag.
HTTP Status Code: 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.
HTTP Status Code: 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.
HTTP Status Code: 404 Not Found
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
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.
$result = $client->completeMultipartUpload([
'Bucket' => '<string>', // REQUIRED
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'ExpectedBucketOwner' => '<string>',
'IfMatch' => '<string>',
'IfNoneMatch' => '<string>',
'Key' => '<string>', // REQUIRED
'MpuObjectSize' => <integer>,
'MultipartUpload' => [
'Parts' => [
[
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ETag' => '<string>',
'PartNumber' => <integer>,
],
// ...
],
],
'RequestPayer' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKey' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'UploadId' => '<string>', // REQUIRED
]);
Parameter Details Members
Name of the bucket to which the multipart upload was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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.
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.
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, 64-bit CRC64NVME checksum of the object. The CRC64NVME checksum is always a full object checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. If the checksum type doesnât match the checksum type that was specified for the object during the CreateMultipartUpload request, itâll result in a BadDigest error. For more information, see Checking object integrity in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag, re-initiate the multipart upload with CreateMultipartUpload, and re-upload each part.
Expects the ETag value as a string.
For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.
Expects the '*' (asterisk) character.
For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
Object key for which the multipart upload was initiated.
The expected total object size of the multipart upload request. If thereâs a mismatch between the specified object size value and the actual object size value, it results in an HTTP 400 InvalidRequest error.
The container for the multipart upload request information.
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 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.
This functionality is not supported for directory buckets.
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported for directory buckets.
ID for the initiated multipart upload.
[
'Bucket' => '<string>',
'BucketKeyEnabled' => true || false,
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'ETag' => '<string>',
'Expiration' => '<string>',
'Key' => '<string>',
'Location' => '<string>',
'ObjectURL' => '<string>',
'RequestCharged' => 'requester',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
'VersionId' => '<string>',
]Result Details Members
The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.
Access points are not supported by directory buckets.
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
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, 64-bit CRC64NVME checksum of the object. The CRC64NVME checksum is always a full object checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum type that was specified during the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
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.
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.
This functionality is not supported for directory buckets.
The object key of the newly created object.
The URI that identifies the newly created object.
The URI of the created object.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when storing this object in Amazon S3.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
Version ID of the newly created object, in case the bucket has versioning turned on.
This functionality is not supported for directory buckets.
There are no errors described for this operation.
Examples Example 1: To complete multipart uploadThe 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([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
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.
You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.
Amazon S3 supports copy operations using Multi-Region Access Points only as a destination when using the Multi-Region Access Point ARN.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
VPC endpoints don't support cross-Region requests (including copies). If you're using VPC endpoints, your source and destination buckets should be in the same Amazon Web Services Region as your VPC endpoint.
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. For more information about how to enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services Account Management Guide.
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.
All CopyObject requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.
Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject API operation, instead of using the temporary security credentials through the CreateSession API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
You must have read access to the source object and write access to the destination bucket.
General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a CopyObject operation.
If the source object is in a general purpose bucket, you must have s3:GetObject permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have s3:PutObject permission to write the object copy to the destination bucket.
Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a CopyObject operation.
If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.
If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key can't be set to ReadOnly on the copy destination bucket.
If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the Content-Length. You always need to read the entire response body to check if the copy succeeds.
If the copy is successful, you receive a response with information about the copied object.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A 200 OK response can contain either a success or an error.
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. For example, in a cross-region copy, you may encounter throttling and receive a 200 OK response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The 200 OK status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.
If you call this API operation directly, make sure to design your application to parse the content 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 throw an exception (or, for the SDKs that don't use exceptions, they return an error).
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. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see Amazon S3 pricing.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
Amazon S3 on Outposts - When you use this action with S3 on Outposts through the REST API, 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. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.
The following operations are related to CopyObject:
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.
$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|CRC64NVME',
'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:fsx|aws:kms|aws:kms:dsse',
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'Tagging' => '<string>',
'TaggingDirective' => 'COPY|REPLACE',
'WebsiteRedirectLocation' => '<string>',
]);
Parameter Details Members
The canned access control list (ACL) to apply to the object.
When you copy an object, the ACL metadata is not preserved and is set to private by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.
If the destination 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 destination 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.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
The name of the destination bucket.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP 400 Bad Request error with the error code InvalidRequest.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with S3 on Outposts, you must use the Outpost bucket access point ARN or the access point alias for the destination bucket. You can only copy objects within the same Outpost bucket. It's not supported to copy objects across different Amazon Web Services Outposts, between buckets on the same Outposts, or between Outposts buckets and any other bucket types. For more information about S3 on Outposts, see What is S3 on Outposts? in the S3 on Outposts guide. When you use this action with S3 on Outposts through the REST API, you must direct requests to the S3 on Outposts hostname, in the format AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. The hostname isn't required when you use the Amazon Web Services CLI or SDKs.
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). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.
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.
For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
Directory buckets - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
Specifies the caching behavior along the request/reply chain.
Indicates the algorithm that 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.
When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject request does not include this x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request.
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
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.
For directory buckets, only the aws-chunked value is supported in this header field.
The language the content is in.
A standard MIME type that describes the format of the object data.
Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.
You specify the value of the copy source 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 general purpose bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3, use awsexamplebucket--use1-az5--x-s3/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.
Access points are not supported by directory buckets.
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.
If your source bucket versioning is enabled, the x-amz-copy-source header by default 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 query parameter. Specifically, 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.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id response header is always null.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
Copies the object if its entity tag (ETag) matches the specified tag.
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
Copies the object if it has been modified since the specified time.
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
Copies the object if its entity tag (ETag) is different than the specified ETag.
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
Copies the object if it hasn't been modified since the specified time.
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
Specifies the algorithm to use when decrypting the source object (for example, AES256).
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.
This functionality is not supported when the source object is in a directory bucket.
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 the same one that was used when the source object was created.
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.
This functionality is not supported when the source object is in a directory bucket.
This value will be base64 encoded on your behalf.
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.
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.
This functionality is not supported when the source object is in a directory bucket.
The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The date and time at which the object is no longer cacheable.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to read the object data and its metadata.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to read the object ACL.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to write the ACL for the applicable object.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
The key of the destination object.
A map of metadata to store with the object in S3.
Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isnât specified, COPY is the default behavior.
General purpose bucket - For general purpose buckets, 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 Amazon S3 condition key examples in the Amazon S3 User Guide.
x-amz-website-redirect-location is unique to each object and is not copied when using the x-amz-metadata-directive header. To copy the value, you must specify x-amz-website-redirect-location in the request header.
Specifies whether you want to apply a legal hold to the object copy.
This functionality is not supported for directory buckets.
The Object Lock mode that you want to apply to the object copy.
This functionality is not supported for directory buckets.
The date and time when you want the Object Lock of the object copy to expire.
This functionality is not supported for directory buckets.
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 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.
This functionality is not supported for directory buckets.
Specifies the algorithm to use when encrypting the object (for example, AES256).
When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS 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.
This functionality is not supported when the destination bucket is a directory bucket.
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 functionality is not supported when the destination bucket is a directory bucket.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported when the destination bucket is a directory bucket.
Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
General purpose buckets - This value must be explicitly added to specify encryption context for CopyObject requests if you want an additional encryption context for your destination object. The additional encryption context of the source object won't be copied to the destination object. For more information, see Encryption context in the Amazon S3 User Guide.
Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
Specifies the KMS key 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.
Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the x-amz-server-side-encryption header to aws:kms. Then, the x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported. Incorrect key specification results in an HTTP 400 Bad Request error.
The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values wonât write a destination object and will receive a 400 Bad Request response.
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 different default encryption configuration, Amazon S3 uses the corresponding encryption key to encrypt the target object copy.
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. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.
General purpose buckets
For general purpose buckets, there are the following supported options for server-side encryption: server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and 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 specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS 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.
Directory buckets
For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS configuration. Then, when you perform a CopyObject operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration.
S3 access points for Amazon FSx - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.
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.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.
Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:
The storage class of the source object is GLACIER or DEEP_ARCHIVE.
The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.
For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.
The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don't need to set the x-amz-tagging header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.
The default value is the empty value.
Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:
When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.
When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.
Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:
When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.
When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.
When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.
When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.
Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.
The default value is COPY.
Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:
When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
When you attempt to REPLACE the tag-set of a source object and set a non-empty value to x-amz-tagging.
When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive is COPY.
Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:
When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.
When you attempt to REPLACE the tag-set of a directory bucket source object and set the x-amz-tagging value of the directory bucket destination object to empty.
When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging value of the directory bucket destination object to empty.
When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the x-amz-tagging value of the directory bucket destination object. This is because the default value of x-amz-tagging is the empty value.
If the destination bucket is configured as a website, redirects requests for this object copy 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 x-amz-metadata-directive header.
This functionality is not supported for directory buckets.
[
'BucketKeyEnabled' => true || false,
'CopyObjectResult' => [
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'ETag' => '<string>',
'LastModified' => <DateTime>,
],
'CopySourceVersionId' => '<string>',
'Expiration' => '<string>',
'ObjectURL' => '<string>',
'RequestCharged' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SSEKMSEncryptionContext' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
'VersionId' => '<string>',
]Result Details Members
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
Container for all response elements.
Version ID of the source object that was copied.
This functionality is not supported when the source object is in a directory bucket.
If the object expiration is configured, the response includes this header.
Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.
The URI of the created object.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates 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.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
Version ID of the newly created copy.
This functionality is not supported for directory buckets.
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
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([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket .
Creates a new S3 bucket. To create a bucket, you must set up 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.
There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.
General purpose buckets - If you send your CreateBucket request to the s3.amazonaws.com global endpoint, the request goes to the us-east-1 Region. So 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 in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - In addition to the s3:CreateBucket permission, the following permissions are required in a policy when your CreateBucket request includes specific headers:
Access control lists (ACLs) - In your CreateBucket request, if you specify an access control list (ACL) and set it to public-read, public-read-write, authenticated-read, or if you explicitly specify any other custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your CreateBucket request, if you set the ACL to private, or if you don't specify any ACLs, only the s3:CreateBucket permission is required.
Object Lock - In your CreateBucket request, if you set x-amz-bucket-object-lock-enabled to true, the 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.
To set an ACL on a bucket as part of a CreateBucket request, you must explicitly set S3 Object Ownership for the bucket to a different value than the default, BucketOwnerEnforced. Additionally, if your desired bucket ACL grants public access, you must first create the bucket (without the bucket ACL) and then explicitly disable Block Public Access on the bucket before using PutBucketAcl to set the ACL. If you try to create a bucket with a public ACL, the request will fail.
For the majority of modern use cases in S3, we recommend that you keep all Block Public Access settings enabled and keep ACLs disabled. If you would like to share data with users outside of your account, you can use bucket policies as needed. For more information, see Controlling ownership of objects and disabling ACLs for your bucket and Blocking public access to your Amazon S3 storage 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. Specifically, 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. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.
Directory bucket permissions - You must have the s3express:CreateBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.
For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to CreateBucket:
$result = $client->createBucket([
'ACL' => 'private|public-read|public-read-write|authenticated-read',
'Bucket' => '<string>', // REQUIRED
'CreateBucketConfiguration' => [
'Bucket' => [
'DataRedundancy' => 'SingleAvailabilityZone|SingleLocalZone',
'Type' => 'Directory',
],
'Location' => [
'Name' => '<string>',
'Type' => 'AvailabilityZone|LocalZone',
],
'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',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
'GrantFullControl' => '<string>',
'GrantRead' => '<string>',
'GrantReadACP' => '<string>',
'GrantWrite' => '<string>',
'GrantWriteACP' => '<string>',
'ObjectLockEnabledForBucket' => true || false,
'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced',
]);
Parameter Details Members
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
The name of the bucket to create.
General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
The configuration information for the bucket.
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for directory buckets.
Allows grantee to list the objects in the bucket.
This functionality is not supported for directory buckets.
Allows grantee to read the bucket ACL.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This functionality is not supported for directory buckets.
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 specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).
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. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
[
'BucketArn' => '<string>',
'Location' => '<string>',
]Result Details Members
The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.
This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.
A forward slash followed by the name of the bucket.
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.
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).
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/',
]Example 2: To create a bucket
The following example creates a bucket.
$result = $client->createBucket([
'Bucket' => 'examplebucket',
]);
Result syntax:
[
'Location' => '/examplebucket',
] CreateBucketMetadataConfiguration
$result = $client->createBucketMetadataConfiguration([/* ... */]); $promise = $client->createBucketMetadataConfigurationAsync([/* ... */]);
Creates an S3 Metadata V2 metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
If you want to encrypt your metadata tables with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with Amazon Web Services analytics services in the Amazon S3 User Guide.
To query your metadata tables, you need additional permissions. For more information, see Permissions for querying metadata tables in the Amazon S3 User Guide.
s3:CreateBucketMetadataTableConfiguration
The IAM policy action name is the same for the V1 and V2 API operations.
s3tables:CreateTableBucket
s3tables:CreateNamespace
s3tables:GetTable
s3tables:CreateTable
s3tables:PutTablePolicy
s3tables:PutTableEncryption
kms:DescribeKey
The following operations are related to CreateBucketMetadataConfiguration:
$result = $client->createBucketMetadataConfiguration([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'MetadataConfiguration' => [ // REQUIRED
'InventoryTableConfiguration' => [
'ConfigurationState' => 'ENABLED|DISABLED', // REQUIRED
'EncryptionConfiguration' => [
'KmsKeyArn' => '<string>',
'SseAlgorithm' => 'aws:kms|AES256', // REQUIRED
],
],
'JournalTableConfiguration' => [ // REQUIRED
'EncryptionConfiguration' => [
'KmsKeyArn' => '<string>',
'SseAlgorithm' => 'aws:kms|AES256', // REQUIRED
],
'RecordExpiration' => [ // REQUIRED
'Days' => <integer>,
'Expiration' => 'ENABLED|DISABLED', // REQUIRED
],
],
],
]);
Parameter Details Members
The general purpose bucket that you want to create the metadata configuration for.
The checksum algorithm to use with your metadata configuration.
The Content-MD5 header for the metadata configuration.
The value will be computed on your behalf.
The expected owner of the general purpose bucket that corresponds to your metadata configuration.
The contents of your metadata configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
CreateBucketMetadataTableConfiguration$result = $client->createBucketMetadataTableConfiguration([/* ... */]); $promise = $client->createBucketMetadataTableConfigurationAsync([/* ... */]);
We recommend that you create your S3 Metadata configurations by using the V2 CreateBucketMetadataConfiguration API operation. We no longer recommend using the V1 CreateBucketMetadataTableConfiguration API operation.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
Creates a V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
If you want to encrypt your metadata tables with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
If you also want to integrate your table bucket with Amazon Web Services analytics services so that you can query your metadata table, you need additional permissions. For more information, see Integrating Amazon S3 Tables with Amazon Web Services analytics services in the Amazon S3 User Guide.
s3:CreateBucketMetadataTableConfiguration
s3tables:CreateNamespace
s3tables:GetTable
s3tables:CreateTable
s3tables:PutTablePolicy
The following operations are related to CreateBucketMetadataTableConfiguration:
$result = $client->createBucketMetadataTableConfiguration([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'MetadataTableConfiguration' => [ // REQUIRED
'S3TablesDestination' => [ // REQUIRED
'TableBucketArn' => '<string>', // REQUIRED
'TableName' => '<string>', // REQUIRED
],
],
]);
Parameter Details Members
The general purpose bucket that you want to create the metadata table configuration for.
The checksum algorithm to use with your metadata table configuration.
The Content-MD5 header for the metadata table configuration.
The value will be computed on your behalf.
The expected owner of the general purpose bucket that corresponds to your metadata table configuration.
The contents of your metadata table configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
CreateMultipartUpload$result = $client->createMultipartUpload([/* ... */]); $promise = $client->createMultipartUploadAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
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 in the Amazon S3 User Guide.
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 stops charging you for storing them only after you either complete or abort a multipart upload.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed 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.
Directory buckets - S3 Lifecycle is not supported by directory buckets.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
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) in the Amazon S3 User Guide.
General purpose bucket permissions - To perform a multipart upload with encryption using an Key Management Service (KMS) KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. 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.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
General purpose buckets - 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 different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When 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 CreateMultipartUpload request.
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.
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 is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.
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 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.
For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.
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) in the Amazon S3 User Guide.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to CreateMultipartUpload:
$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|CRC64NVME',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'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:fsx|aws:kms|aws:kms:dsse',
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'Tagging' => '<string>',
'WebsiteRedirectLocation' => '<string>',
]);
Parameter Details Members
The canned ACL to apply to the object. 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 in the Amazon S3 User Guide.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access 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 new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
The name of the bucket where the multipart upload is initiated and where the object is uploaded.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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).
General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.
Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and canât be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
Specifies caching behavior along the request/reply chain.
Indicates the algorithm that 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.
Indicates the checksum type that you want Amazon S3 to use to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
Specifies presentational information for the object.
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.
For directory buckets, only the aws-chunked value is supported in this header field.
The language that the content is in.
A standard MIME type describing the format of the object data.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The date and time at which the object is no longer cacheable.
Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
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"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Specify access permissions explicitly to allow grantee to read the object data and its metadata.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
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"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Specify access permissions explicitly to allows grantee to read the object ACL.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
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"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
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"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Object key for which the multipart upload is to be initiated.
A map of metadata to store with the object in S3.
Specifies whether you want to apply a legal hold to the uploaded object.
This functionality is not supported for directory buckets.
Specifies the Object Lock mode that you want to apply to the uploaded object.
This functionality is not supported for directory buckets.
Specifies the date and time when you want the Object Lock to expire.
This functionality is not supported for directory buckets.
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 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.
This functionality is not supported for directory buckets.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
Specifies the 128-bit MD5 digest of the customer-provided 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.
This functionality is not supported for directory buckets.
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.
Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the x-amz-server-side-encryption header to aws:kms. Then, the x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported. Incorrect key specification results in an HTTP 400 Bad Request error.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
S3 access points for Amazon FSx - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.
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. For more information, see Storage Classes in the Amazon S3 User Guide.
Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
[
'AbortDate' => <DateTime>,
'AbortRuleId' => '<string>',
'Bucket' => '<string>',
'BucketKeyEnabled' => true || false,
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'Key' => '<string>',
'RequestCharged' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SSEKMSEncryptionContext' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
'UploadId' => '<string>',
]Result Details Members
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 in the Amazon S3 User Guide.
The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines the abort action.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
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.
Access points are not supported by directory buckets.
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
The algorithm that was used to create a checksum of the object.
Indicates the checksum type that you want Amazon S3 to use to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
Object key for which the multipart upload was initiated.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
ID for the initiated multipart upload.
There are no errors described for this operation.
Examples Example 1: To initiate a multipart uploadThe 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--',
] CreateSession
$result = $client->createSession([/* ... */]); $promise = $client->createSessionAsync([/* ... */]);
Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide.
To make Zonal endpoint API requests on a directory bucket, use the CreateSession API operation. Specifically, you grant s3express:CreateSession permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the CreateSession API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After the session is created, you donât need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the x-amz-s3session-token request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a CreateSession API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval.
If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the Amazon S3 User Guide.
You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
CopyObject API operation - Unlike other Zonal endpoint API operations, the CopyObject API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the CopyObject API operation on directory buckets, see CopyObject.
HeadBucket API operation - Unlike other Zonal endpoint API operations, the HeadBucket API operation doesn't use the temporary security credentials returned from the CreateSession API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket API operation on directory buckets, see HeadBucket.
To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that grants s3express:CreateSession permission to the bucket. In a policy, you can have the s3express:SessionMode condition key to control who can create a ReadWrite or ReadOnly session. For more information about ReadWrite or ReadOnly sessions, see x-amz-create-session-mode . For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the s3express:CreateSession permission.
If you want to encrypt objects with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.
For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
For Zonal endpoint (object-level) API operations except CopyObject and UploadPartCopy, you authenticate and authorize requests through CreateSession for low latency. To encrypt new objects in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). Then, when a session is created for Zonal endpoint API operations, new objects are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during the session.
Only 1 customer managed key is supported per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn't supported. After you specify SSE-KMS as your bucket's default encryption configuration with a customer managed key, you can't change the customer managed key for the bucket's SSE-KMS configuration.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, you can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) from the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), it's not supported to override the values of the encryption settings from the CreateSession request.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
$result = $client->createSession([
'Bucket' => '<string>', // REQUIRED
'BucketKeyEnabled' => true || false,
'SSEKMSEncryptionContext' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
'SessionMode' => 'ReadOnly|ReadWrite',
]);
Parameter Details Members
The name of the bucket that you create a session for.
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using KMS keys (SSE-KMS).
S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and canât be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.
Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
If you specify x-amz-server-side-encryption with aws:kms, you must specify the x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Also, if the KMS key doesn't exist in the same account that't issuing the command, you must use the full Key ARN not the Key ID.
Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported.
The server-side encryption algorithm to use when you store objects in the directory bucket.
For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). By default, Amazon S3 encrypts data with SSE-S3. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
S3 access points for Amazon FSx - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.
Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint API operations on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint API operations: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.
[
'BucketKeyEnabled' => true || false,
'Credentials' => [
'AccessKeyId' => '<string>',
'Expiration' => <DateTime>,
'SecretAccessKey' => '<string>',
'SessionToken' => '<string>',
],
'SSEKMSEncryptionContext' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
]Result Details Members
Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).
The established temporary security credentials for the created session.
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
If you specify x-amz-server-side-encryption with aws:kms, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption.
The server-side encryption algorithm used when you store objects in the directory bucket.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
The specified bucket does not exist.
$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.
Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - You must have the s3:DeleteBucket permission on the specified bucket in a policy.
Directory bucket permissions - You must have the s3express:DeleteBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to DeleteBucket:
$result = $client->deleteBucket([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
Specifies the bucket being deleted.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: To delete a bucketThe following example deletes the specified bucket.
$result = $client->deleteBucket([
'Bucket' => 'forrandall2',
]); DeleteBucketAnalyticsConfiguration
$result = $client->deleteBucketAnalyticsConfiguration([/* ... */]); $promise = $client->deleteBucketAnalyticsConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketAnalyticsConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket from which an analytics configuration is deleted.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID that identifies the analytics configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketCors$result = $client->deleteBucketCors([/* ... */]); $promise = $client->deleteBucketCorsAsync([/* ... */]);
This operation is not supported for directory buckets.
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
Specifies the bucket whose cors configuration is being deleted.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere 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).
General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in directory buckets, see Setting default server-side encryption behavior for directory buckets.
General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to DeleteBucketEncryption:
$result = $client->deleteBucketEncryption([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket containing the server-side encryption configuration to delete.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketIntelligentTieringConfiguration$result = $client->deleteBucketIntelligentTieringConfiguration([/* ... */]); $promise = $client->deleteBucketIntelligentTieringConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketIntelligentTieringConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID used to identify the S3 Intelligent-Tiering configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketInventoryConfiguration$result = $client->deleteBucketInventoryConfiguration([/* ... */]); $promise = $client->deleteBucketInventoryConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
Deletes an S3 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:
$result = $client->deleteBucketInventoryConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket containing the inventory configuration to delete.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID used to identify the inventory configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere 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.
General purpose bucket 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 have the s3:PutLifecycleConfiguration permission.
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
Directory bucket permissions - You must have the s3express:PutLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn't supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.
For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
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
The bucket name of the lifecycle to delete.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
[]Result Details
The results for this operation are always empty.
ErrorsThere 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',
]); DeleteBucketMetadataConfiguration
$result = $client->deleteBucketMetadataConfiguration([/* ... */]); $promise = $client->deleteBucketMetadataConfigurationAsync([/* ... */]);
Deletes an S3 Metadata configuration from a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
You can use the V2 DeleteBucketMetadataConfiguration API operation with V1 or V2 metadata configurations. However, if you try to use the V1 DeleteBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error.
To use this operation, you must have the s3:DeleteBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
The IAM policy action name is the same for the V1 and V2 API operations.
The following operations are related to DeleteBucketMetadataConfiguration:
$result = $client->deleteBucketMetadataConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The general purpose bucket that you want to remove the metadata configuration from.
The expected bucket owner of the general purpose bucket that you want to remove the metadata table configuration from.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketMetadataTableConfiguration$result = $client->deleteBucketMetadataTableConfiguration([/* ... */]); $promise = $client->deleteBucketMetadataTableConfigurationAsync([/* ... */]);
We recommend that you delete your S3 Metadata configurations by using the V2 DeleteBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 DeleteBucketMetadataTableConfiguration API operation.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
Deletes a V1 S3 Metadata configuration from a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
You can use the V2 DeleteBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 DeleteBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error.
Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations.
To use this operation, you must have the s3:DeleteBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
The following operations are related to DeleteBucketMetadataTableConfiguration:
$result = $client->deleteBucketMetadataTableConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The general purpose bucket that you want to remove the metadata table configuration from.
The expected bucket owner of the general purpose bucket that you want to remove the metadata table configuration from.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketMetricsConfiguration$result = $client->deleteBucketMetricsConfiguration([/* ... */]); $promise = $client->deleteBucketMetricsConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketMetricsConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket containing the metrics configuration to delete.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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 Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketOwnershipControls$result = $client->deleteBucketOwnershipControls([/* ... */]); $promise = $client->deleteBucketOwnershipControlsAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketOwnershipControls([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The Amazon S3 bucket whose OwnershipControls you want to delete.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
DeleteBucketPolicy$result = $client->deleteBucketPolicy([/* ... */]); $promise = $client->deleteBucketPolicyAsync([/* ... */]);
Deletes the policy of a specified bucket.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
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 both have the DeleteBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order 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.
General purpose bucket permissions - The s3:DeleteBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:DeleteBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to DeleteBucketPolicy
$result = $client->deleteBucketPolicy([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: To delete bucket policyThe following example deletes bucket policy on the specified bucket.
$result = $client->deleteBucketPolicy([
'Bucket' => 'examplebucket',
]); DeleteBucketReplication
$result = $client->deleteBucketReplication([/* ... */]); $promise = $client->deleteBucketReplicationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketReplication([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: To delete bucket replication configurationThe following example deletes replication configuration set on bucket.
$result = $client->deleteBucketReplication([
'Bucket' => 'example',
]); DeleteBucketTagging
$result = $client->deleteBucketTagging([/* ... */]); $promise = $client->deleteBucketTaggingAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketTagging([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket that has the tag set to be removed.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: To delete bucket tagsThe following example deletes bucket tags.
$result = $client->deleteBucketTagging([
'Bucket' => 'examplebucket',
]); DeleteBucketWebsite
$result = $client->deleteBucketWebsite([/* ... */]); $promise = $client->deleteBucketWebsiteAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteBucketWebsite([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name for which you want to remove the website configuration.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: To delete bucket website configurationThe following example deletes bucket website configuration.
$result = $client->deleteBucketWebsite([
'Bucket' => 'examplebucket',
]); DeleteObject
$result = $client->deleteObject([/* ... */]); $promise = $client->deleteObjectAsync([/* ... */]);
Removes an object from a bucket. The behavior depends on the bucket's versioning state:
If bucket versioning is not enabled, the operation permanently deletes the object.
If bucket versioning is enabled, the operation inserts a delete marker, which becomes the current version of the object. To permanently delete an object in a versioned bucket, you must include the objectâs versionId in the request. For more information about versioning-enabled buckets, see Deleting object versions from a versioning-enabled bucket.
If bucket versioning is suspended, the operation removes the object that has a null versionId, if there is one, and inserts a delete marker that becomes the current version of the object. If there isn't an object with a null versionId, and all versions of the object have a versionId, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has a versionId, you must include the objectâs versionId in the request. For more information about versioning-suspended buckets, see Deleting objects from versioning-suspended buckets.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
To remove a specific version, you must use the versionId query parameter. Using this query parameter 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 in the Amazon S3 User Guide. To see sample requests that use versioning, see Sample Request.
Directory buckets - MFA delete is not supported by directory buckets.
You can delete objects by explicitly calling DELETE Object or calling (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.
Directory buckets - S3 Lifecycle is not supported by directory buckets.
General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.
s3:DeleteObject - To delete an object from a bucket, you must always have the s3:DeleteObject permission.
s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following action is related to DeleteObject:
$result = $client->deleteObject([
'Bucket' => '<string>', // REQUIRED
'BypassGovernanceRetention' => true || false,
'ExpectedBucketOwner' => '<string>',
'IfMatch' => '<string>',
'IfMatchLastModifiedTime' => <integer || string || DateTime>,
'IfMatchSize' => <integer>,
'Key' => '<string>', // REQUIRED
'MFA' => '<string>',
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name of the bucket containing the object.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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.
This functionality is not supported for directory buckets.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a 412 Precondition Failed error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No Content) response.
For more information about conditional requests, see RFC 7232.
This functionality is only supported for directory buckets.
If present, the object is deleted only if its modification times matches the provided Timestamp. If the Timestamp values do not match, the operation returns a 412 Precondition Failed error. If the Timestamp matches or if the object doesnât exist, the operation returns a 204 Success (No Content) response.
This functionality is only supported for directory buckets.
If present, the object is deleted only if its size matches the provided size in bytes. If the Size value does not match, the operation returns a 412 Precondition Failed error. If the Size matches or if the object doesnât exist, the operation returns a 204 Success (No Content) response.
This functionality is only supported for directory buckets.
You can use the If-Match, x-amz-if-match-last-modified-time and x-amz-if-match-size conditional headers in conjunction with each-other or individually.
Key name of the object to delete.
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.
This functionality is not supported for directory buckets.
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 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.
This functionality is not supported for directory buckets.
Version ID used to reference a specific version of the object.
For directory buckets in this API operation, only the null value of the version ID is supported.
[
'DeleteMarker' => true || false,
'RequestCharged' => 'requester',
'VersionId' => '<string>',
]Result Details Members
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. To learn more about delete markers, see Working with delete markers.
This functionality is not supported for directory buckets.
Returns the version ID of the delete marker created as a result of the DELETE operation.
This functionality is not supported for directory buckets.
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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deleteObjectTagging([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the objects from which to remove the tags.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The key that identifies the object in the bucket from which to remove all tags.
The versionId of the object that the tag-set will be removed from.
[
'VersionId' => '<string>',
]Result Details Members
The versionId of the object the tag-set was removed from.
There are no errors described for this operation.
Examples Example 1: To remove tag set from an objectThe 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',
]Example 2: 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',
] DeleteObjects
$result = $client->deleteObjects([/* ... */]); $promise = $client->deleteObjectsAsync([/* ... */]);
This operation 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 operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request can contain a list of up to 1,000 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 operation and returns the result of that delete, success or failure, in the response. If the object specified in the request isn't found, Amazon S3 confirms the deletion by returning the result as deleted.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
The operation supports two modes for the response: verbose and quiet. By default, the operation 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 operation encountered an error. For a successful deletion in a quiet mode, the operation 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 in the Amazon S3 User Guide.
Directory buckets - MFA delete is not supported by directory buckets.
General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.
s3:DeleteObject - To delete an object from a bucket, you must always specify the s3:DeleteObject permission.
s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must specify the s3:DeleteObjectVersion permission.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
General purpose bucket - The Content-MD5 request 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.
Directory bucket - The Content-MD5 request header or a additional checksum request header (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is required for all Multi-Object Delete requests.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to DeleteObjects:
$result = $client->deleteObjects([
'Bucket' => '<string>', // REQUIRED
'BypassGovernanceRetention' => true || false,
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'Delete' => [ // REQUIRED
'Objects' => [ // REQUIRED
[
'ETag' => '<string>',
'Key' => '<string>', // REQUIRED
'LastModifiedTime' => <integer || string || DateTime>,
'Size' => <integer>,
'VersionId' => '<string>',
],
// ...
],
'Quiet' => true || false,
],
'ExpectedBucketOwner' => '<string>',
'MFA' => '<string>',
'RequestPayer' => 'requester',
]);
Parameter Details Members
The bucket name containing the objects to delete.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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.
This functionality is not supported for directory buckets.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
CRC64NVME
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
Container for the request.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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.
When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
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 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.
This functionality is not supported for directory buckets.
[
'Deleted' => [
[
'DeleteMarker' => true || false,
'DeleteMarkerVersionId' => '<string>',
'Key' => '<string>',
'VersionId' => '<string>',
],
// ...
],
'Errors' => [
[
'Code' => '<string>',
'Key' => '<string>',
'Message' => '<string>',
'VersionId' => '<string>',
],
// ...
],
'RequestCharged' => 'requester',
]Result Details Members
Container element for a successful delete. It identifies the object that was successfully deleted.
Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.
There are no errors described for this operation.
Examples Example 1: To delete multiple objects from a versioned bucketThe 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',
],
],
]Example 2: 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',
],
],
] DeletePublicAccessBlock
$result = $client->deletePublicAccessBlock([/* ... */]); $promise = $client->deletePublicAccessBlockAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->deletePublicAccessBlock([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
GetBucketAccelerateConfiguration$result = $client->getBucketAccelerateConfiguration([/* ... */]); $promise = $client->getBucketAccelerateConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketAccelerateConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'RequestPayer' => 'requester',
]);
Parameter Details Members
The name of the bucket for which the accelerate configuration is retrieved.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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 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.
This functionality is not supported for directory buckets.
[
'RequestCharged' => 'requester',
'Status' => 'Enabled|Suspended',
]Result Details Members
The accelerate configuration of the bucket.
There are no errors described for this operation.
GetBucketAcl$result = $client->getBucketAcl([/* ... */]); $promise = $client->getBucketAclAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
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 the 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.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
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:
$result = $client->getBucketAcl([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
Specifies the S3 bucket whose ACL is being requested.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
A list of grants.
Container for the bucket owner's display name and ID.
There are no errors described for this operation.
GetBucketAnalyticsConfiguration$result = $client->getBucketAnalyticsConfiguration([/* ... */]); $promise = $client->getBucketAnalyticsConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketAnalyticsConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket from which an analytics configuration is retrieved.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID that identifies the analytics configuration.
[
'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
The configuration and any analyses for the analytics filter.
There are no errors described for this operation.
GetBucketCors$result = $client->getBucketCors([/* ... */]); $promise = $client->getBucketCorsAsync([/* ... */]);
This operation is not supported for directory buckets.
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.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
For more information about CORS, see Enabling Cross-Origin Resource Sharing.
The following operations are related to GetBucketCors:
$result = $client->getBucketCors([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name for which to get the cors configuration.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'CORSRules' => [
[
'AllowedHeaders' => ['<string>', ...],
'AllowedMethods' => ['<string>', ...],
'AllowedOrigins' => ['<string>', ...],
'ExposeHeaders' => ['<string>', ...],
'ID' => '<string>',
'MaxAgeSeconds' => <integer>,
],
// ...
],
]Result Details Members
A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
There are no errors described for this operation.
Examples Example 1: To get cors configuration set on a bucketThe 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).
General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption configuration in directory buckets, see Setting default server-side encryption behavior for directory buckets.
General purpose bucket permissions - The s3:GetEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to GetBucketEncryption:
$result = $client->getBucketEncryption([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket from which the server-side encryption configuration is retrieved.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
[
'ServerSideEncryptionConfiguration' => [
'Rules' => [
[
'ApplyServerSideEncryptionByDefault' => [
'KMSMasterKeyID' => '<string>',
'SSEAlgorithm' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
],
'BucketKeyEnabled' => true || false,
],
// ...
],
],
]Result Details Members
Specifies the default server-side-encryption configuration.
There are no errors described for this operation.
GetBucketIntelligentTieringConfiguration$result = $client->getBucketIntelligentTieringConfiguration([/* ... */]); $promise = $client->getBucketIntelligentTieringConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
Gets 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 GetBucketIntelligentTieringConfiguration include:
$result = $client->getBucketIntelligentTieringConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID used to identify the S3 Intelligent-Tiering configuration.
[
'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
Container for S3 Intelligent-Tiering configuration.
There are no errors described for this operation.
GetBucketInventoryConfiguration$result = $client->getBucketInventoryConfiguration([/* ... */]); $promise = $client->getBucketInventoryConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
Returns an S3 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:
$result = $client->getBucketInventoryConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket containing the inventory configuration to retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID used to identify the inventory configuration.
[
'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
Specifies the inventory configuration.
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.
This operation is not supported for directory buckets.
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:
$result = $client->getBucketLifecycle([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the lifecycle information.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
Container for a lifecycle rule.
There are no errors described for this operation.
Examples Example 1: To get a bucket aclThe 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([/* ... */]);
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API, which is compatible with the new functionality. The previous version of the API supported filtering based only on an object key name prefix, which is supported for general purpose buckets for backward compatibility. For the related API description, see GetBucketLifecycle.
Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters are not supported.
General purpose bucket 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 have the s3:GetLifecycleConfiguration permission.
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
Directory bucket permissions - You must have the s3express:GetLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn't supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.
For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
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:
$result = $client->getBucketLifecycleConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the lifecycle information.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
[
'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',
],
// ...
],
],
// ...
],
'TransitionDefaultMinimumObjectSize' => 'varies_by_storage_class|all_storage_classes_128K',
]Result Details Members
Container for a lifecycle rule.
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
This parameter applies to general purpose buckets only. It isn't supported for directory bucket lifecycle configurations.
all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
There are no errors described for this operation.
Examples Example 1: To get lifecycle configuration on a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
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:
$result = $client->getBucketLocation([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the location.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
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. Buckets with a LocationConstraint of EU reside in eu-west-1.
There are no errors described for this operation.
Examples Example 1: To get bucket locationThe following example returns bucket location.
$result = $client->getBucketLocation([
'Bucket' => 'examplebucket',
]);
Result syntax:
[
'LocationConstraint' => 'us-west-2',
] GetBucketLogging
$result = $client->getBucketLogging([/* ... */]); $promise = $client->getBucketLoggingAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
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:
$result = $client->getBucketLogging([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name for which to get the logging information.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'LoggingEnabled' => [
'TargetBucket' => '<string>',
'TargetGrants' => [
[
'Grantee' => [
'DisplayName' => '<string>',
'EmailAddress' => '<string>',
'ID' => '<string>',
'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group',
'URI' => '<string>',
],
'Permission' => 'FULL_CONTROL|READ|WRITE',
],
// ...
],
'TargetObjectKeyFormat' => [
'PartitionedPrefix' => [
'PartitionDateSource' => 'EventTime|DeliveryTime',
],
'SimplePrefix' => [
],
],
'TargetPrefix' => '<string>',
],
]Result Details Members
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.
There are no errors described for this operation.
GetBucketMetadataConfiguration$result = $client->getBucketMetadataConfiguration([/* ... */]); $promise = $client->getBucketMetadataConfigurationAsync([/* ... */]);
Retrieves the S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
You can use the V2 GetBucketMetadataConfiguration API operation with V1 or V2 metadata configurations. However, if you try to use the V1 GetBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error.
To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
The IAM policy action name is the same for the V1 and V2 API operations.
The following operations are related to GetBucketMetadataConfiguration:
$result = $client->getBucketMetadataConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The general purpose bucket that corresponds to the metadata configuration that you want to retrieve.
The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration for.
[
'GetBucketMetadataConfigurationResult' => [
'MetadataConfigurationResult' => [
'DestinationResult' => [
'TableBucketArn' => '<string>',
'TableBucketType' => 'aws|customer',
'TableNamespace' => '<string>',
],
'InventoryTableConfigurationResult' => [
'ConfigurationState' => 'ENABLED|DISABLED',
'Error' => [
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
],
'TableArn' => '<string>',
'TableName' => '<string>',
'TableStatus' => '<string>',
],
'JournalTableConfigurationResult' => [
'Error' => [
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
],
'RecordExpiration' => [
'Days' => <integer>,
'Expiration' => 'ENABLED|DISABLED',
],
'TableArn' => '<string>',
'TableName' => '<string>',
'TableStatus' => '<string>',
],
],
],
]Result Details Members
The metadata configuration for the general purpose bucket.
There are no errors described for this operation.
GetBucketMetadataTableConfiguration$result = $client->getBucketMetadataTableConfiguration([/* ... */]); $promise = $client->getBucketMetadataTableConfigurationAsync([/* ... */]);
We recommend that you retrieve your S3 Metadata configurations by using the V2 GetBucketMetadataTableConfiguration API operation. We no longer recommend using the V1 GetBucketMetadataTableConfiguration API operation.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
Retrieves the V1 S3 Metadata configuration for a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
You can use the V2 GetBucketMetadataConfiguration API operation with V1 or V2 metadata table configurations. However, if you try to use the V1 GetBucketMetadataTableConfiguration API operation with V2 configurations, you will receive an HTTP 405 Method Not Allowed error.
Make sure that you update your processes to use the new V2 API operations (CreateBucketMetadataConfiguration, GetBucketMetadataConfiguration, and DeleteBucketMetadataConfiguration) instead of the V1 API operations.
To use this operation, you must have the s3:GetBucketMetadataTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
The following operations are related to GetBucketMetadataTableConfiguration:
$result = $client->getBucketMetadataTableConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The general purpose bucket that corresponds to the metadata table configuration that you want to retrieve.
The expected owner of the general purpose bucket that you want to retrieve the metadata table configuration for.
[
'GetBucketMetadataTableConfigurationResult' => [
'Error' => [
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
],
'MetadataTableConfigurationResult' => [
'S3TablesDestinationResult' => [
'TableArn' => '<string>',
'TableBucketArn' => '<string>',
'TableName' => '<string>',
'TableNamespace' => '<string>',
],
],
'Status' => '<string>',
],
]Result Details Members
The metadata table configuration for the general purpose bucket.
There are no errors described for this operation.
GetBucketMetricsConfiguration$result = $client->getBucketMetricsConfiguration([/* ... */]); $promise = $client->getBucketMetricsConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketMetricsConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Id' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket containing the metrics configuration to retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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' => [
'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
Specifies the metrics configuration.
There are no errors described for this operation.
GetBucketNotification$result = $client->getBucketNotification([/* ... */]); $promise = $client->getBucketNotificationAsync([/* ... */]);
This operation is not supported for directory buckets.
No longer used, see GetBucketNotificationConfiguration.
Parameter Syntax$result = $client->getBucketNotification([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the notification configuration.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
Container for specifying the Lambda notification configuration.
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.
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.
There are no errors described for this operation.
Examples Example 1: To get notification configuration set on a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
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:
$result = $client->getBucketNotificationConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the notification configuration.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
Enables delivery of events to Amazon EventBridge.
Describes the Lambda functions to invoke and the events for which to invoke them.
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
The topic to which notifications are sent and the events for which notifications are generated.
There are no errors described for this operation.
GetBucketOwnershipControls$result = $client->getBucketOwnershipControls([/* ... */]); $promise = $client->getBucketOwnershipControlsAsync([/* ... */]);
This operation is not supported for directory buckets.
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.
A bucket doesn't have OwnershipControls settings in the following cases:
The bucket was created before the BucketOwnerEnforced ownership setting was introduced and you've never explicitly applied this value
You've manually deleted the bucket ownership control value using the DeleteBucketOwnershipControls API operation.
By default, Amazon S3 sets OwnershipControls for all newly created buckets.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to GetBucketOwnershipControls:
$result = $client->getBucketOwnershipControls([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'OwnershipControls' => [
'Rules' => [
[
'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced',
],
// ...
],
],
]Result Details Members
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.
There are no errors described for this operation.
GetBucketPolicy$result = $client->getBucketPolicy([/* ... */]); $promise = $client->getBucketPolicyAsync([/* ... */]);
Returns the policy of a specified bucket.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
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 both 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 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.
General purpose bucket permissions - The s3:GetBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following action is related to GetBucketPolicy:
$result = $client->getBucketPolicy([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name to get the bucket policy for.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
Object Lambda access points - When you use this API operation 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.
Object Lambda access points are not supported by directory buckets.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
[
'Policy' => '<string>',
]Result Details Members
The bucket policy as a JSON document.
There are no errors described for this operation.
Examples Example 1: To get bucket policyThe 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketPolicyStatus([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the Amazon S3 bucket whose policy status you want to retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'PolicyStatus' => [
'IsPublic' => true || false,
],
]Result Details Members
The policy status for the specified bucket.
There are no errors described for this operation.
GetBucketReplication$result = $client->getBucketReplication([/* ... */]); $promise = $client->getBucketReplicationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketReplication([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name for which to get the replication information.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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|EXPRESS_ONEZONE|FSX_OPENZFS',
],
'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
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
There are no errors described for this operation.
Examples Example 1: To get replication configuration set on a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketRequestPayment([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the payment request configuration
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'Payer' => 'Requester|BucketOwner',
]Result Details Members
Specifies who pays for the download and request fees.
There are no errors described for this operation.
Examples Example 1: To get bucket versioning configurationThe following example retrieves bucket versioning configuration.
$result = $client->getBucketRequestPayment([
'Bucket' => 'examplebucket',
]);
Result syntax:
[
'Payer' => 'BucketOwner',
] GetBucketTagging
$result = $client->getBucketTagging([/* ... */]); $promise = $client->getBucketTaggingAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketTagging([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the tagging information.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'TagSet' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]Result Details Members
Contains the tag set.
There are no errors described for this operation.
Examples Example 1: To get tag set associated with a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketVersioning([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to get the versioning information.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'MFADelete' => 'Enabled|Disabled',
'Status' => 'Enabled|Suspended',
]Result Details Members
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.
The versioning state of the bucket.
There are no errors described for this operation.
Examples Example 1: To get bucket versioning configurationThe following example retrieves bucket versioning configuration.
$result = $client->getBucketVersioning([
'Bucket' => 'examplebucket',
]);
Result syntax:
[
'MFADelete' => 'Disabled',
'Status' => 'Enabled',
] GetBucketWebsite
$result = $client->getBucketWebsite([/* ... */]); $promise = $client->getBucketWebsiteAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getBucketWebsite([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name for which to get the website configuration.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
The object key name of the website error document to use for 4XX class errors.
The name of the index document for the website (for example index.html).
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
Rules that define when a redirect is applied and the redirect behavior.
There are no errors described for this operation.
Examples Example 1: To get bucket website configurationThe 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 an object from Amazon S3.
In the GetObject request, specify the full key name for the object.
General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name 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 object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.
Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named amzn-s3-demo-bucket--usw2-az1--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.
If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.
If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.
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.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If the object is encrypted using SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), 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 include the header in your GetObject requests for the object that uses these types of keys, youâll get an HTTP 400 Bad Request error.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.
You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.
The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.
To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.
response-cache-control
response-content-disposition
response-content-encoding
response-content-language
response-content-type
response-expires
When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to GetObject:
$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
The bucket name containing the object.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
To retrieve the checksum, this mode must be enabled.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.
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.
For more information about conditional requests, see RFC 7232.
Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.
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 status code.
For more information about conditional requests, see RFC 7232.
Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.
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 HTTP status code.
For more information about conditional requests, see RFC 7232.
Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.
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.
For more information about conditional requests, see RFC 7232.
Key of the object to get.
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.
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 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.
This functionality is not supported for directory buckets.
Sets the Cache-Control header of the response.
Sets the Content-Disposition header of the response.
Sets the Content-Encoding header of the response.
Sets the Content-Language header of the response.
Sets the Content-Type header of the response.
Sets the Expires header of the response.
Specifies the algorithm to use when decrypting the object (for example, AES256).
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) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. 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.
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) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
Specifies the 128-bit MD5 digest of the customer-provided 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.
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) in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
The path to a file on disk to save the object data.
Version ID used to reference a specific version of the object.
By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.
If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.
If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
For more information about versioning, see PutBucketVersioning.
[
'AcceptRanges' => '<string>',
'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
'BucketKeyEnabled' => true || false,
'CacheControl' => '<string>',
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'ContentDisposition' => '<string>',
'ContentEncoding' => '<string>',
'ContentLanguage' => '<string>',
'ContentLength' => <integer>,
'ContentRange' => '<string>',
'ContentType' => '<string>',
'DeleteMarker' => true || false,
'ETag' => '<string>',
'Expiration' => '<string>',
'Expires' => <DateTime>,
'ExpiresString' => '<string>',
'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:fsx|aws:kms|aws:kms:dsse',
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'TagCount' => <integer>,
'VersionId' => '<string>',
'WebsiteRedirectLocation' => '<string>',
]Result Details Members
Indicates that a range of bytes was specified in the request.
Object data.
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
Specifies caching behavior along the request/reply chain.
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
Specifies presentational information for the object.
Indicates 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.
The language the content is in.
Size of the body in bytes.
The portion of the object returned in the response.
A standard MIME type describing the format of the object data.
Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
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.
If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.
Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.
The date and time at which the object is no longer cacheable.
This output shape has been deprecated. Please refer to ExpiresString instead.
.
The unparsed string value of the Expires output member.
Date and time when the object was last modified.
General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
A map of metadata to store with the object in S3.
This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. 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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
The Object Lock mode that's currently in place for this object.
This functionality is not supported for directory buckets.
The date and time when this object's Object Lock will expire.
This functionality is not supported for directory buckets.
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.
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
This functionality is not supported for directory buckets.
Provides information about object restoration action and expiration time of the restored object copy.
This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
The number of tags, if any, on the object, when you have the relevant permission to read object tags.
You can use GetObjectTagging to retrieve the tag set associated with an object.
This functionality is not supported for directory buckets.
Version ID of the object.
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
The specified key does not exist.
Object is archived and inaccessible until restored.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.
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([/* ... */]);
This operation is not supported for directory buckets.
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 functionality is not supported for 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.
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 GetObjectAcl:
$result = $client->getObjectAcl([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name that contains the object for which to get the ACL information.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The key of the object for which to get the ACL information.
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 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.
This functionality is not supported for directory buckets.
Version ID used to reference a specific version of the object.
This functionality is not supported for directory buckets.
[
'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
A list of grants.
Container for the bucket owner's display name and ID.
The specified key does not exist.
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 of the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with both of those individual calls can be returned with a single call to GetObjectAttributes.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object.
The other permissions that you need to use this operation depend on whether the bucket is versioned and if a version ID is passed in the GetObjectAttributes request.
If you pass a version ID in your request, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions.
If you do not pass a version ID in your request, 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.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD 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). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a GET request for an object that uses these types of keys, youâll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.
If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption with customer-provided encryption keys (SSE-C), then when you retrieve the metadata from the object, you must use the following headers. These headers provide the server with the encryption key required to retrieve the object's metadata. The headers are:
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.
Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
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.
For more information about conditional requests, see RFC 7232.
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.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following actions are related to GetObjectAttributes:
$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
The name of the bucket that contains the object.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The object key.
Sets the maximum number of parts to return. For more information, see Uploading and copying objects using multipart upload in Amazon S3 in the Amazon Simple Storage Service user guide.
Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. For more information, see Uploading and copying objects using multipart upload in Amazon S3 in the Amazon Simple Storage Service user guide.
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 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.
This functionality is not supported for directory buckets.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported for directory buckets.
The version ID used to reference a specific version of the object.
S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
[
'Checksum' => [
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
],
'DeleteMarker' => true || false,
'ETag' => '<string>',
'LastModified' => <DateTime>,
'ObjectParts' => [
'IsTruncated' => true || false,
'MaxParts' => <integer>,
'NextPartNumberMarker' => <integer>,
'PartNumberMarker' => <integer>,
'Parts' => [
[
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<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|EXPRESS_ONEZONE|FSX_OPENZFS',
'VersionId' => '<string>',
]Result Details Members
The checksum or digest of the object.
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. To learn more about delete markers, see Working with delete markers.
This functionality is not supported for directory buckets.
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
Date and time when the object was last modified.
A collection of parts associated with a multipart upload.
The size of the object in bytes.
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.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
The version ID of the object.
This functionality is not supported for directory buckets.
The specified key does not exist.
$result = $client->getObjectLegalHold([/* ... */]); $promise = $client->getObjectLegalHoldAsync([/* ... */]);
This operation is not supported for directory buckets.
Gets an object's current legal hold status. For more information, see Locking Objects.
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectLegalHold:
$result = $client->getObjectLegalHold([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the object whose legal hold status you want to retrieve.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The key name for the object whose legal hold status you want to retrieve.
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 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.
This functionality is not supported for directory buckets.
The version ID of the object whose legal hold status you want to retrieve.
[
'LegalHold' => [
'Status' => 'ON|OFF',
],
]Result Details Members
The current legal hold status for the specified object.
There are no errors described for this operation.
GetObjectLockConfiguration$result = $client->getObjectLockConfiguration([/* ... */]); $promise = $client->getObjectLockConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getObjectLockConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket whose Object Lock configuration you want to retrieve.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'ObjectLockConfiguration' => [
'ObjectLockEnabled' => 'Enabled',
'Rule' => [
'DefaultRetention' => [
'Days' => <integer>,
'Mode' => 'GOVERNANCE|COMPLIANCE',
'Years' => <integer>,
],
],
],
]Result Details Members
The specified bucket's Object Lock configuration.
There are no errors described for this operation.
GetObjectRetention$result = $client->getObjectRetention([/* ... */]); $promise = $client->getObjectRetentionAsync([/* ... */]);
This operation is not supported for directory buckets.
Retrieves an object's retention settings. For more information, see Locking Objects.
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectRetention:
$result = $client->getObjectRetention([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the object whose retention settings you want to retrieve.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The key name for the object whose retention settings you want to retrieve.
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 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.
This functionality is not supported for directory buckets.
The version ID for the object whose retention settings you want to retrieve.
[
'Retention' => [
'Mode' => 'GOVERNANCE|COMPLIANCE',
'RetainUntilDate' => <DateTime>,
],
]Result Details Members
The container element for an object's retention settings.
There are no errors described for this operation.
GetObjectTagging$result = $client->getObjectTagging([/* ... */]); $promise = $client->getObjectTaggingAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getObjectTagging([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the object for which to get the tagging information.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Object key for which to get the tagging information.
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 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.
This functionality is not supported for directory buckets.
The versionId of the object for which to get the tagging information.
[
'TagSet' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
'VersionId' => '<string>',
]Result Details Members
Contains the tag set.
The versionId of the object for which you got the tagging information.
There are no errors described for this operation.
Examples Example 1: To retrieve tag set of a specific object versionThe 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',
]Example 2: 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',
] GetObjectTorrent
$result = $client->getObjectTorrent([/* ... */]); $promise = $client->getObjectTorrentAsync([/* ... */]);
This operation is not supported for directory buckets.
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 functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectTorrent:
$result = $client->getObjectTorrent([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
]);
Parameter Details Members
The name of the bucket containing the object for which to get the torrent files.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The object key for which to get the information.
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 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.
This functionality is not supported for directory buckets.
[
'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
'RequestCharged' => 'requester',
]Result Details Members
A Bencoded dictionary as defined by the BitTorrent specification
There are no errors described for this operation.
Examples Example 1: To retrieve torrent files for an objectThe 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->getPublicAccessBlock([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'PublicAccessBlockConfiguration' => [
'BlockPublicAcls' => true || false,
'BlockPublicPolicy' => true || false,
'IgnorePublicAcls' => true || false,
'RestrictPublicBuckets' => true || false,
],
]Result Details Members
The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.
There are no errors described for this operation.
HeadBucket$result = $client->headBucket([/* ... */]); $promise = $client->headBucketAsync([/* ... */]);
You can use this operation to determine if a bucket exists and if 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 HTTP response codes.
General purpose buckets - Request to public buckets that grant the s3:ListBucket permission publicly do not need to be signed. All other HeadBucket requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.
Directory buckets - You must use IAM credentials to authenticate and authorize your access to the HeadBucket API operation, instead of using the temporary security credentials through the CreateSession API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
General purpose bucket permissions - 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 Managing access permissions to your Amazon S3 resources in the Amazon S3 User Guide.
Directory bucket permissions - You must have the s3express:CreateSession permission in the Action element of a policy. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the bucket.
For more information about example bucket policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
$result = $client->headBucket([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The bucket name.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points - When you use this API operation 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'AccessPointAlias' => true || false,
'BucketArn' => '<string>',
'BucketLocationName' => '<string>',
'BucketLocationType' => 'AvailabilityZone|LocalZone',
'BucketRegion' => '<string>',
]Result Details Members
Indicates whether the bucket name used in the request is an access point alias.
For directory buckets, the value of this field is false.
The Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.
This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.
The name of the location where the bucket will be created.
For directory buckets, the Zone ID of the Availability Zone or the Local Zone where the bucket is created. An example Zone ID value for an Availability Zone is usw2-az1.
This functionality is only supported by directory buckets.
The type of location where the bucket is created.
This functionality is only supported by directory buckets.
The Region that the bucket is located.
The specified bucket does not exist.
This operation checks to see if a bucket exists.
$result = $client->headBucket([
'Bucket' => 'acl1',
]); HeadObject
$result = $client->headObject([/* ... */]); $promise = $client->headObjectAsync([/* ... */]);
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
A HEAD request has the same options as a GET operation 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 code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It's not possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.
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 Not Found error.
If you donât have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If you enable x-amz-checksum-mode in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD 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). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, youâll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.
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 to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
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.
Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
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.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.
Directory buckets - Delete marker is not supported for directory buckets.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
The following actions are related to HeadObject:
$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',
'ResponseCacheControl' => '<string>',
'ResponseContentDisposition' => '<string>',
'ResponseContentEncoding' => '<string>',
'ResponseContentLanguage' => '<string>',
'ResponseContentType' => '<string>',
'ResponseExpires' => <integer || string || DateTime>,
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKey' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'VersionId' => '<string>',
]);
Parameter Details Members
The name of the bucket that contains the object.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
To retrieve the checksum, this parameter must be enabled.
General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.
Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
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.
For more information about conditional requests, see RFC 7232.
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
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.
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
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.
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
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.
For more information about conditional requests, see RFC 7232.
The object key.
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.
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.
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 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.
This functionality is not supported for directory buckets.
Sets the Cache-Control header of the response.
Sets the Content-Disposition header of the response.
Sets the Content-Encoding header of the response.
Sets the Content-Language header of the response.
Sets the Content-Type header of the response.
Sets the Expires header of the response.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported for directory buckets.
Version ID used to reference a specific version of the object.
For directory buckets in this API operation, only the null value of the version ID is supported.
[
'AcceptRanges' => '<string>',
'ArchiveStatus' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS',
'BucketKeyEnabled' => true || false,
'CacheControl' => '<string>',
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'ContentDisposition' => '<string>',
'ContentEncoding' => '<string>',
'ContentLanguage' => '<string>',
'ContentLength' => <integer>,
'ContentRange' => '<string>',
'ContentType' => '<string>',
'DeleteMarker' => true || false,
'ETag' => '<string>',
'Expiration' => '<string>',
'Expires' => <DateTime>,
'ExpiresString' => '<string>',
'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:fsx|aws:kms|aws:kms:dsse',
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'TagCount' => <integer>,
'VersionId' => '<string>',
'WebsiteRedirectLocation' => '<string>',
]Result Details Members
Indicates that a range of bytes was specified.
The archive state of the head object.
This functionality is not supported for directory buckets.
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
Specifies caching behavior along the request/reply chain.
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
Specifies presentational information for the object.
Indicates 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.
The language the content is in.
Size of the body in bytes.
The portion of the object returned in the response for a GET request.
A standard MIME type describing the format of the object data.
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.
This functionality is not supported for directory buckets.
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.
Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.
The date and time at which the object is no longer cacheable.
This output shape has been deprecated. Please refer to ExpiresString instead.
.
The unparsed string value of the Expires output member.
Date and time when the object was last modified.
A map of metadata to store with the object in S3.
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.
This functionality is not supported for directory buckets.
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.
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
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.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
The number of tags, if any, on the object, when you have the relevant permission to read object tags.
You can use GetObjectTagging to retrieve the tag set associated with an object.
This functionality is not supported for directory buckets.
Version ID of the object.
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
The specified key does not exist.
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([/* ... */]);
This operation is not supported for directory buckets.
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.
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.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics â Storage Class Analysis.
The following operations are related to ListBucketAnalyticsConfigurations:
$result = $client->listBucketAnalyticsConfigurations([
'Bucket' => '<string>', // REQUIRED
'ContinuationToken' => '<string>',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket from which analytics configurations are retrieved.
The ContinuationToken that represents a placeholder from where this request should begin.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
The list of analytics configurations for a bucket.
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.
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 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.
There are no errors described for this operation.
ListBucketIntelligentTieringConfigurations$result = $client->listBucketIntelligentTieringConfigurations([/* ... */]); $promise = $client->listBucketIntelligentTieringConfigurationsAsync([/* ... */]);
This operation is not supported for directory buckets.
Lists 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 ListBucketIntelligentTieringConfigurations include:
$result = $client->listBucketIntelligentTieringConfigurations([
'Bucket' => '<string>', // REQUIRED
'ContinuationToken' => '<string>',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
The ContinuationToken that represents a placeholder from where this request should begin.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
The ContinuationToken that represents a placeholder from where this request should begin.
The list of S3 Intelligent-Tiering configurations for a bucket.
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.
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.
There are no errors described for this operation.
ListBucketInventoryConfigurations$result = $client->listBucketInventoryConfigurations([/* ... */]); $promise = $client->listBucketInventoryConfigurationsAsync([/* ... */]);
This operation is not supported for directory buckets.
Returns a list of S3 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:
$result = $client->listBucketInventoryConfigurations([
'Bucket' => '<string>', // REQUIRED
'ContinuationToken' => '<string>',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket containing the inventory configurations to retrieve.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
The list of inventory configurations for a bucket.
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.
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.
There are no errors described for this operation.
ListBucketMetricsConfigurations$result = $client->listBucketMetricsConfigurations([/* ... */]); $promise = $client->listBucketMetricsConfigurationsAsync([/* ... */]);
This operation is not supported for directory buckets.
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.
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 more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to ListBucketMetricsConfigurations:
$result = $client->listBucketMetricsConfigurations([
'Bucket' => '<string>', // REQUIRED
'ContinuationToken' => '<string>',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket containing the metrics configurations to retrieve.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[
'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
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.
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.
The list of metrics configurations for a bucket.
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.
There are no errors described for this operation.
ListBuckets$result = $client->listBuckets([/* ... */]); $promise = $client->listBucketsAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the s3:ListAllMyBuckets policy action.
For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.
We strongly recommend using only paginated ListBuckets requests. Unpaginated ListBuckets requests are only supported for Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved general purpose bucket quota above 10,000, you must send paginated ListBuckets requests to list your accountâs buckets. All unpaginated ListBuckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota greater than 10,000.
$result = $client->listBuckets([
'BucketRegion' => '<string>',
'ContinuationToken' => '<string>',
'MaxBuckets' => <integer>,
'Prefix' => '<string>',
]);
Parameter Details Members
Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.
Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.
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. You can use this ContinuationToken for pagination of the list results.
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No.
If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.
Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.
Limits the response to bucket names that begin with the specified bucket name prefix.
[
'Buckets' => [
[
'BucketArn' => '<string>',
'BucketRegion' => '<string>',
'CreationDate' => <DateTime>,
'Name' => '<string>',
],
// ...
],
'ContinuationToken' => '<string>',
'Owner' => [
'DisplayName' => '<string>',
'ID' => '<string>',
],
'Prefix' => '<string>',
]Result Details Members
The list of buckets owned by the requester.
ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.
The owner of the buckets listed.
If Prefix was sent with the request, it is included in the response.
All bucket names in the response begin with the specified bucket name prefix.
There are no errors described for this operation.
Examples Example 1: To list all bucketsThe 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',
],
] ListDirectoryBuckets
$result = $client->listDirectoryBuckets([/* ... */]); $promise = $client->listDirectoryBucketsAsync([/* ... */]);
Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
The BucketRegion response element is not part of the ListDirectoryBuckets Response Syntax.
$result = $client->listDirectoryBuckets([
'ContinuationToken' => '<string>',
'MaxDirectoryBuckets' => <integer>,
]);
Parameter Details Members
ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken is obfuscated and is not a real bucket name. You can use this ContinuationToken for the pagination of the list results.
Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.
[
'Buckets' => [
[
'BucketArn' => '<string>',
'BucketRegion' => '<string>',
'CreationDate' => <DateTime>,
'Name' => '<string>',
],
// ...
],
'ContinuationToken' => '<string>',
]Result Details Members
The list of buckets owned by the requester.
If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.
There are no errors described for this operation.
ListMultipartUploads$result = $client->listMultipartUploads([/* ... */]); $promise = $client->listMultipartUploadsAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload request, but has not yet been completed or aborted.
Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the ListMultipartUploads operation to list the in-progress multipart uploads in the bucket and use the AbortMultipartUpload operation to abort all the in-progress multipart uploads.
The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads request parameter. If there are more than 1,000 multipart uploads that satisfy your ListMultipartUploads request, the response returns an IsTruncated element with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element. To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads requests. In these requests, include two query parameters: key-marker and upload-id-marker. Set the value of key-marker to the NextKeyMarker value from the previous response. Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the previous response.
Directory buckets - The upload-id-marker element and the NextUploadIdMarker element aren't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
General purpose bucket - In the ListMultipartUploads response, the multipart uploads are sorted based on two criteria:
Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.
Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.
Directory bucket - In the ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based on the object keys.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to ListMultipartUploads:
$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
The name of the bucket to which the multipart upload was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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.
CommonPrefixes is filtered out from results if it is not lexicographically greater than the key-marker.
Directory buckets - For directory buckets, / is the only supported delimiter.
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Specifies the multipart upload after which listing should begin.
General purpose buckets - For general purpose buckets, key-marker is an object key. 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.
Directory buckets - For directory buckets, key-marker is obfuscated and isn't a real object key. The upload-id-marker parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.
In the ListMultipartUploads response, the multipart uploads aren't sorted lexicographically based on the object keys.
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.
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.)
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
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 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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
[
'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|CRC64NVME',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'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|EXPRESS_ONEZONE|FSX_OPENZFS',
'UploadId' => '<string>',
],
// ...
],
]Result Details Members
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.
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.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
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.
Directory buckets - For directory buckets, / is the only supported delimiter.
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.
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.
The key at or after which the listing began.
Maximum number of multipart uploads that could have been included in the response.
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
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.
This functionality is not supported for directory buckets.
When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
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.
This functionality is not supported for directory buckets.
Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.
There are no errors described for this operation.
Examples Example 1: List next set of multipart uploads when previous result is truncatedThe 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--',
],
],
]Example 2: 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--',
],
],
] ListObjectVersions
$result = $client->listObjectVersions([/* ... */]); $promise = $client->listObjectVersionsAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
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.
The following operations are related to ListObjectVersions:
$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
The bucket name that contains the objects.
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.
CommonPrefixes is filtered out from results if it is not lexicographically greater than the key-marker.
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Specifies the key to start with when listing objects in a bucket.
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.
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
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.
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 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.
This functionality is not supported for directory buckets.
Specifies the object version you want to start listing from.
[
'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>', ...],
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'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
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
Container for an object that is a delete marker. To learn more about delete markers, see Working with delete markers.
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.
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.
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.
Marks the last key returned in a truncated response.
Specifies the maximum number of objects to return.
The bucket name.
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.
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.
Selects objects that start with the value supplied by this parameter.
Marks the last version of the key returned in a truncated response.
Container for version information.
There are no errors described for this operation.
Examples Example 1: To list object versionsThe following example returns versions of an object with specific key name prefix.
$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([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
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:
$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
The name of the bucket containing the objects.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
A delimiter is a character that you use to group keys.
CommonPrefixes is filtered out from results if it is not lexicographically greater than the key-marker.
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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.
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.
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
Limits the response to keys that begin with the specified prefix.
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.
[
'CommonPrefixes' => [
[
'Prefix' => '<string>',
],
// ...
],
'Contents' => [
[
'ChecksumAlgorithm' => ['<string>', ...],
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'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|EXPRESS_ONEZONE|FSX_OPENZFS',
],
// ...
],
'Delimiter' => '<string>',
'EncodingType' => 'url',
'IsTruncated' => true || false,
'Marker' => '<string>',
'MaxKeys' => <integer>,
'Name' => '<string>',
'NextMarker' => '<string>',
'Prefix' => '<string>',
'RequestCharged' => 'requester',
]Result Details Members
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.
Metadata about each object returned.
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.
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
The maximum number of keys returned in the response body.
The bucket name.
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.
Keys that begin with the indicated prefix.
The specified bucket does not exist.
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. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.
General purpose bucket - For general purpose buckets, ListObjectsV2 doesn't return prefixes that are related only to in-progress multipart uploads.
Directory buckets - For directory buckets, ListObjectsV2 response includes the prefixes that are related only to in-progress multipart uploads.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - To use this operation, you must have READ access to the bucket. 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.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
General purpose bucket - For general purpose buckets, ListObjectsV2 returns objects in lexicographical order based on their key names.
Directory bucket - For directory buckets, ListObjectsV2 does not return objects in lexicographical order.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
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.
The following operations are related to ListObjectsV2:
$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
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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. You can use this ContinuationToken for pagination of the list results.
A delimiter is a character that you use to group keys.
CommonPrefixes is filtered out from results if it is not lexicographically greater than the StartAfter value.
Directory buckets - For directory buckets, / is the only supported delimiter.
Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can't parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.
When using the URL encoding type, non-ASCII characters that are used in an object's key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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.
Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
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.
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
Limits the response to keys that begin with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
[
'CommonPrefixes' => [
[
'Prefix' => '<string>',
],
// ...
],
'Contents' => [
[
'ChecksumAlgorithm' => ['<string>', ...],
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'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|EXPRESS_ONEZONE|FSX_OPENZFS',
],
// ...
],
'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
All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.
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.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
Directory buckets - When you query ListObjectsV2 with a delimiter during in-progress multipart uploads, the CommonPrefixes response parameter contains the prefixes that are associated with the in-progress multipart uploads. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
Metadata about each object returned.
If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.
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.
Directory buckets - For directory buckets, / is the only supported delimiter.
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.
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 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.
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.
The bucket name.
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
Keys that begin with the indicated prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.
If StartAfter was sent with the request, it is included in the response.
This functionality is not supported for directory buckets.
The specified bucket does not exist.
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([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
Lists the parts that have been uploaded for a specific multipart upload.
To use this operation, you must provide the upload ID in the request. You obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload.
The ListParts request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response 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. To list remaining uploaded parts, in subsequent ListParts requests, include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
If the upload was created 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), you must have permission to the kms:Decrypt action for the ListParts request to succeed.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to ListParts:
$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
The name of the bucket to which the parts are being uploaded.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Object key for which the multipart upload was initiated.
Sets the maximum number of parts to return.
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
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 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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported for directory buckets.
Upload ID identifying the multipart upload whose parts are being listed.
[
'AbortDate' => <DateTime>,
'AbortRuleId' => '<string>',
'Bucket' => '<string>',
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'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>',
'ChecksumCRC64NVME' => '<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|EXPRESS_ONEZONE|FSX_OPENZFS',
'UploadId' => '<string>',
]Result Details Members
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.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
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.
The algorithm that was used to create a checksum of the object.
The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
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.
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.
Object key for which the multipart upload was initiated.
Maximum number of parts that were allowed in the response.
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.
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.
Directory buckets - The bucket owner is returned as the object owner for all the parts.
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
Container for elements related to a particular part. A response can contain zero or more Part elements.
The class of storage used to store the uploaded object.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Upload ID identifying the multipart upload whose parts are being listed.
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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->putBucketAccelerateConfiguration([
'AccelerateConfiguration' => [ // REQUIRED
'Status' => 'Enabled|Suspended',
],
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
Container for setting the transfer acceleration state.
The name of the bucket for which the accelerate configuration is set.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketAcl$result = $client->putBucketAcl([/* ... */]); $promise = $client->putBucketAclAsync([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
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 the 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.
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.
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways. For examples of how to specify these grantee values in JSON format, see the Amazon Web Services CLI example in Enabling Amazon S3 server access logging in the Amazon S3 User Guide.
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:
$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|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'GrantFullControl' => '<string>',
'GrantRead' => '<string>',
'GrantReadACP' => '<string>',
'GrantWrite' => '<string>',
'GrantWriteACP' => '<string>',
]);
Parameter Details Members
The canned ACL to apply to the bucket.
Contains the elements that set the ACL permissions for an object per grantee.
The bucket to which to apply the ACL.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
Allows grantee to list the objects in the bucket.
Allows grantee to read the bucket ACL.
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.
Allows grantee to write the ACL for the applicable bucket.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Put bucket aclThe 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([/* ... */]);
This operation is not supported for directory buckets.
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.
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.
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:
$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
The configuration and any analyses for the analytics filter.
The name of the bucket to which an analytics configuration is stored.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID that identifies the analytics configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketCors$result = $client->putBucketCors([/* ... */]); $promise = $client->putBucketCorsAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$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|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
Specifies the bucket impacted by the corsconfiguration.
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.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere 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 operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).
General purpose buckets
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. For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.
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 doesn't validate the KMS key ID provided in PutBucketEncryption requests.
Directory buckets - You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported.
S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and canât be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
For directory buckets, if you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, Amazon S3 validates the KMS key ID provided in PutBucketEncryption requests.
If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requesterâs account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
Also, this action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).
General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to PutBucketEncryption:
$result = $client->putBucketEncryption([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'ServerSideEncryptionConfiguration' => [ // REQUIRED
'Rules' => [ // REQUIRED
[
'ApplyServerSideEncryptionByDefault' => [
'KMSMasterKeyID' => '<string>',
'SSEAlgorithm' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse', // REQUIRED
],
'BucketKeyEnabled' => true || false,
],
// ...
],
],
]);
Parameter Details Members
Specifies default encryption for a bucket using server-side encryption with different key options.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
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.
This functionality is not supported for directory buckets.
The value will be computed on your behalf.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
Specifies the default server-side-encryption configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketIntelligentTieringConfiguration$result = $client->putBucketIntelligentTieringConfiguration([/* ... */]); $promise = $client->putBucketIntelligentTieringConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per 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 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:
Code: InvalidArgument
Cause: Invalid Argument
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
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.
$result = $client->putBucketIntelligentTieringConfiguration([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'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
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID used to identify the S3 Intelligent-Tiering configuration.
Container for S3 Intelligent-Tiering configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketInventoryConfiguration$result = $client->putBucketInventoryConfiguration([/* ... */]); $promise = $client->putBucketInventoryConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
This implementation of the PUT action adds an S3 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.
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:
Code: InvalidArgument
Cause: Invalid Argument
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
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:
$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
The name of the bucket where the inventory configuration will be stored.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The ID used to identify the inventory configuration.
Specifies the inventory configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketLifecycle$result = $client->putBucketLifecycle([/* ... */]); $promise = $client->putBucketLifecycleAsync([/* ... */]);
This operation is not supported for directory buckets.
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.
This operation is not supported for directory buckets.
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)
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:
$result = $client->putBucketLifecycle([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'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
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere 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, object size, or any combination of these. 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.
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.
Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. 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 general purpose buckets. For the related API description, see PutBucketLifecycle.
Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects,transitions and tag filters are not supported.
A lifecycle 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, object size, or any combination of these.
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.
General purpose bucket 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 have 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.
Directory bucket permissions - You must have the s3express:PutLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn't supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.
For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.
The following operations are related to PutBucketLifecycleConfiguration:
$result = $client->putBucketLifecycleConfiguration([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'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',
],
// ...
],
],
// ...
],
],
'TransitionDefaultMinimumObjectSize' => 'varies_by_storage_class|all_storage_classes_128K',
]);
Parameter Details Members
The name of the bucket for which to set the configuration.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Container for lifecycle rules. You can add as many as 1,000 rules.
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
[
'TransitionDefaultMinimumObjectSize' => 'varies_by_storage_class|all_storage_classes_128K',
]Result Details Members
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
all_storage_classes_128K - Objects smaller than 128 KB will not transition to any storage class by default.
varies_by_storage_class - Objects smaller than 128 KB will transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By default, all other storage classes will prevent transitions smaller than 128 KB.
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
There are no errors described for this operation.
Examples Example 1: Put bucket lifecycleThe 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([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
This operation is not supported for directory buckets.
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.
You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways. For examples of how to specify these grantee values in JSON format, see the Amazon Web Services CLI example in Enabling Amazon S3 server access logging in the Amazon S3 User Guide.
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:
$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',
],
// ...
],
'TargetObjectKeyFormat' => [
'PartitionedPrefix' => [
'PartitionDateSource' => 'EventTime|DeliveryTime',
],
'SimplePrefix' => [
],
],
'TargetPrefix' => '<string>', // REQUIRED
],
],
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
]);
Parameter Details Members
The name of the bucket for which to set the logging parameters.
Container for logging status information.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set logging configuration for a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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.
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 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
$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
The name of the bucket for which the metrics configuration is set.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
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.
Specifies the metrics configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketNotification$result = $client->putBucketNotification([/* ... */]); $promise = $client->putBucketNotificationAsync([/* ... */]);
This operation is not supported for directory buckets.
No longer used, see the PutBucketNotificationConfiguration operation.
Parameter Syntax$result = $client->putBucketNotification([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'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
The name of the bucket.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The container for the configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
PutBucketNotificationConfiguration$result = $client->putBucketNotificationConfiguration([/* ... */]); $promise = $client->putBucketNotificationConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
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:
$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
The name of the bucket.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set notification configuration for a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->putBucketOwnershipControls([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'OwnershipControls' => [ // REQUIRED
'Rules' => [ // REQUIRED
[
'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced', // REQUIRED
],
// ...
],
],
]);
Parameter Details Members
The name of the Amazon S3 bucket whose OwnershipControls you want to set.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.
[]Result Details
The results for this operation are always empty.
ErrorsThere 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.
Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
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 both 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.
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.
General purpose bucket permissions - The s3:PutBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is s3express-control.region-code.amazonaws.com.
The following operations are related to PutBucketPolicy:
$result = $client->putBucketPolicy([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ConfirmRemoveSelfBucketAccess' => true || false,
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'Policy' => '<string>', // REQUIRED
]);
Parameter Details Members
The name of the bucket.
Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
CRC64NVME
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
This functionality is not supported for directory buckets.
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.
This functionality is not supported for directory buckets.
The value will be computed on your behalf.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
The bucket policy as a JSON document.
For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set bucket policyThe 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([/* ... */]);
This operation is not supported for directory buckets.
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.
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
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:
$result = $client->putBucketReplication([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'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|EXPRESS_ONEZONE|FSX_OPENZFS',
],
'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
The name of the bucket
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
A token to allow Object Lock to be enabled for an existing bucket.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set replication configuration on a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->putBucketRequestPayment([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'RequestPaymentConfiguration' => [ // REQUIRED
'Payer' => 'Requester|BucketOwner', // REQUIRED
],
]);
Parameter Details Members
The bucket name.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Container for Payer.
[]Result Details
The results for this operation are always empty.
ErrorsThere 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([/* ... */]);
This operation is not supported for directory buckets.
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:
$result = $client->putBucketTagging([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'Tagging' => [ // REQUIRED
'TagSet' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
]);
Parameter Details Members
The bucket name.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Container for the TagSet and Tag elements.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set tags on a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you might encounter intermittent HTTP 404 NoSuchKey errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.
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:
$result = $client->putBucketVersioning([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'MFA' => '<string>',
'VersioningConfiguration' => [ // REQUIRED
'MFADelete' => 'Enabled|Disabled',
'Status' => 'Enabled|Suspended',
],
]);
Parameter Details Members
The bucket name.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
>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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
Container for setting the versioning state.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set versioning configuration on a bucketThe 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([/* ... */]);
This operation is not supported for directory buckets.
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|CRC64NVME',
'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
The bucket name.
Indicates the algorithm used to create the checksum for the request when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Container for the request.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Examples Example 1: Set website configuration on a bucketThe 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([/* ... */]);
End of support notice: Beginning October 1, 2025, Amazon S3 will discontinue support for creating new Email Grantee Access Control Lists (ACL). Email Grantee ACLs created prior to this date will continue to work and remain accessible through the Amazon Web Services Management Console, Command Line Interface (CLI), SDKs, and REST API. However, you will no longer be able to create new Email Grantee ACLs.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
Adds an object to a bucket.
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.
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
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. However, Amazon S3 provides features that can modify this behavior:
S3 Object Lock - To prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
If-None-Match - Uploads the object only if the object key name does not already exist in the specified bucket. Otherwise, Amazon S3 returns a 412 Precondition Failed error. If a conflicting operation occurs during the upload, S3 returns a 409 ConditionalRequestConflict response. On a 409 failure, retry the upload.
Expects the * character (asterisk).
For more information, see Add preconditions to S3 operations with conditional requests in the Amazon S3 User Guide or RFC 7232.
This functionality is not supported for S3 on Outposts.
S3 Versioning - When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID of that object being stored in Amazon S3. You can retrieve, replace, or delete any version of the object. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
This functionality is not supported for directory buckets.
General purpose bucket permissions - The following permissions are required in your policies when your PutObject request includes specific headers.
s3:PutObject - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object to it.
s3:PutObjectAcl - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl.
s3:PutObjectTagging - To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
General purpose bucket - 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, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory bucket - This functionality is not supported for directory buckets.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
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.
$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|CRC64NVME',
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<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>',
'IfMatch' => '<string>',
'IfNoneMatch' => '<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:fsx|aws:kms|aws:kms:dsse',
'SourceFile' => '<string>',
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'Tagging' => '<string>',
'WebsiteRedirectLocation' => '<string>',
'WriteOffsetBytes' => <integer>,
]);
Parameter Details Members
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.
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 in the Amazon S3 User Guide.
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.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Set to true to calculate the ContentMD5 for the upload.
Object data.
The bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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).
General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.
Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and canât be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
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.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
CRC32
CRC32C
CRC64NVME
SHA1
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
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.
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.
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, 64-bit CRC64NVME checksum of the object. The CRC64NVME checksum is always a full object checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
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. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
The language the content is in.
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
The Base64 encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
This value is required if uploading to a bucket which has Object Lock enabled. It will not be calculated for you automatically. If you wish to have the value calculated for you, use the `AddContentMD5` parameter.
A SHA256 hash of the body content of the request.
This value will be computed for you it is not supplied.
A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to read the object data and its metadata.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to read the object ACL.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to write the ACL for the applicable object.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag and retry the upload.
Expects the ETag value as a string.
For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should retry the upload.
Expects the '*' (asterisk) character.
For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
Object key for which the PUT action was initiated.
A map of metadata to store with the object in S3.
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
The Object Lock mode that you want to apply to this object.
This functionality is not supported for directory buckets.
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
This functionality is not supported for directory buckets.
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 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.
This functionality is not supported for directory buckets.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
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 functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported for directory buckets.
Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.
Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.
Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the x-amz-server-side-encryption header to aws:kms. Then, the x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default KMS customer managed key ID. If you want to explicitly set the x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported. Incorrect key specification results in an HTTP 400 Bad Request error.
The server-side encryption algorithm that was used when you store this object in Amazon S3 or Amazon FSx.
General purpose buckets - 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 in the Amazon S3 User Guide.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can't override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the CreateSession request. It's not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
S3 access points for Amazon FSx - When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx. All Amazon FSx file systems have encryption configured by default and are encrypted at rest. Data is automatically encrypted before being written to the file system, and automatically decrypted as it is read. These processes are handled transparently by Amazon FSx.
The path to a file on disk to use instead of the Body parameter.
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. For more information, see Storage Classes in the Amazon S3 User Guide.
Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
This functionality is not supported for directory buckets.
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. For information about object metadata, see Object Key and Metadata in the Amazon S3 User Guide.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.
This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
[
'BucketKeyEnabled' => true || false,
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ChecksumType' => 'COMPOSITE|FULL_OBJECT',
'ETag' => '<string>',
'Expiration' => '<string>',
'ObjectURL' => '<string>',
'RequestCharged' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SSEKMSEncryptionContext' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
'Size' => <integer>,
'VersionId' => '<string>',
]Result Details Members
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the object. This header is present if the object was uploaded with the CRC64NVME checksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see Checking object integrity in the Amazon S3 User Guide.
Entity tag for the uploaded object.
General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.
Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.
The URI of the created object.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
The size of the object in bytes. This value is only be present if you append to an object.
This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
Version ID of the object.
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 in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
This functionality is not supported for directory buckets.
You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:
Cannot specify both a write offset value and user-defined object metadata for existing objects.
Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.
Request body cannot be empty when 'write offset' is specified.
The write offset value that you specified does not match the current object size.
You have attempted to add more parts than the maximum of 10000 that are allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object.
The existing object was created with a different encryption type. Subsequent write requests must include the appropriate encryption parameters in the request or while creating the session.
The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.
$result = $client->putObject([
'ACL' => 'authenticated-read',
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'exampleobject',
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'VersionId' => 'Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr',
]Example 2: To upload an object
The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.
$result = $client->putObject([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'HappyFace.jpg',
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'VersionId' => 'tpf3zF08nBplQK1XLOefGskR7mGDwcDk',
]Example 3: To upload an object (specify optional headers)
The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.
$result = $client->putObject([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'HappyFace.jpg',
'ServerSideEncryption' => 'AES256',
'StorageClass' => 'STANDARD_IA',
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'ServerSideEncryption' => 'AES256',
'VersionId' => 'CG612hodqujkf8FaaNfp8U..FIhLROcp',
]Example 4: To upload an object and specify optional tags
The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.
$result = $client->putObject([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'HappyFace.jpg',
'Tagging' => 'key1=value1&key2=value2',
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'VersionId' => 'psM2sYY4.o1501dSx8wMvnkOzSBB.V4a',
]Example 5: To upload an object and specify server-side encryption and object tags
The following example uploads an object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.
$result = $client->putObject([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'exampleobject',
'ServerSideEncryption' => 'AES256',
'Tagging' => 'key1=value1&key2=value2',
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'ServerSideEncryption' => 'AES256',
'VersionId' => 'Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt',
]Example 6: To upload object and specify user-defined metadata
The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.
$result = $client->putObject([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'exampleobject',
'Metadata' => [
'metadata1' => 'value1',
'metadata2' => 'value2',
],
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'VersionId' => 'pSKidl4pHBiNwukdbcPXAIs.sshFFOc0',
]Example 7: To create an object.
The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.
$result = $client->putObject([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'objectkey',
]);
Result syntax:
[
'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"',
'VersionId' => 'Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ',
]Example 8: To upload an object via an S3 access point ARN
The following example uploads an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.
$result = $client->putObject([
'Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint',
'Key' => 'my-key',
'Body' => <BLOB>,
]);
Result syntax:
[
'ObjectURL' => 'https://my-bucket.s3.us-east-1.amazonaws.com/my-key',
] PutObjectAcl
$result = $client->putObjectAcl([/* ... */]); $promise = $client->putObjectAclAsync([/* ... */]);
This operation is not supported for directory buckets.
Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have the WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.
This functionality is not supported for Amazon S3 on Outposts.
Depending on your application needs, you can choose to set the ACL on an object 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, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
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.
You can set access permissions 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 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-read header grants list objects permission to the two Amazon Web Services accounts identified by their email addresses.
x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways. For examples of how to specify these grantee values in JSON format, see the Amazon Web Services CLI example in Enabling Amazon S3 server access logging in the Amazon S3 User Guide.
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>lt;/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 ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId subresource.
The following operations are related to PutObjectAcl:
$result = $client->putObjectAcl([
'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
'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|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'GrantFullControl' => '<string>',
'GrantRead' => '<string>',
'GrantReadACP' => '<string>',
'GrantWrite' => '<string>',
'GrantWriteACP' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The canned ACL to apply to the object. For more information, see Canned ACL.
Contains the elements that set the ACL permissions for an object per grantee.
The bucket name that contains the object to which you want to attach the ACL.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to list the objects in the bucket.
This functionality is not supported for Amazon S3 on Outposts.
Allows grantee to read the bucket ACL.
This functionality is not supported for Amazon S3 on Outposts.
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.
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for Amazon S3 on Outposts.
Key for which the PUT action was initiated.
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 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.
This functionality is not supported for directory buckets.
Version ID used to reference a specific version of the object.
This functionality is not supported for directory buckets.
[
'RequestCharged' => 'requester',
]Result Details Errors
The specified key does not exist.
The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.
$result = $client->putObjectAcl([
'AccessControlPolicy' => [
],
'Bucket' => 'examplebucket',
'GrantFullControl' => 'emailaddress=user1@example.com,emailaddress=user2@example.com',
'GrantRead' => 'uri=http://acs.amazonaws.com/groups/global/AllUsers',
'Key' => 'HappyFace.jpg',
]);
Result syntax:
[ ]PutObjectLegalHold
$result = $client->putObjectLegalHold([/* ... */]); $promise = $client->putObjectLegalHoldAsync([/* ... */]);
This operation is not supported for directory buckets.
Applies a legal hold configuration to the specified object. For more information, see Locking Objects.
This functionality is not supported for Amazon S3 on Outposts.
Parameter Syntax$result = $client->putObjectLegalHold([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'LegalHold' => [
'Status' => 'ON|OFF',
],
'RequestPayer' => 'requester',
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the object that you want to place a legal hold on.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The MD5 hash for 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The key name for the object that you want to place a legal hold on.
Container element for the legal hold configuration you want to apply to the specified object.
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 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.
This functionality is not supported for directory buckets.
The version ID of the object that you want to place a legal hold on.
[
'RequestCharged' => 'requester',
]Result Details Errors
There are no errors described for this operation.
PutObjectLockConfiguration$result = $client->putObjectLockConfiguration([/* ... */]); $promise = $client->putObjectLockConfigurationAsync([/* ... */]);
This operation is not supported for directory buckets.
Places an Object Lock configuration on the specified 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 DefaultRetention settings require both a mode and a period.
The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.
$result = $client->putObjectLockConfiguration([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'ObjectLockConfiguration' => [
'ObjectLockEnabled' => 'Enabled',
'Rule' => [
'DefaultRetention' => [
'Days' => <integer>,
'Mode' => 'GOVERNANCE|COMPLIANCE',
'Years' => <integer>,
],
],
],
'RequestPayer' => 'requester',
'Token' => '<string>',
]);
Parameter Details Members
The bucket whose Object Lock configuration you want to create or replace.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The MD5 hash for 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The Object Lock configuration that you want to apply to the specified bucket.
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 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.
This functionality is not supported for directory buckets.
A token to allow Object Lock to be enabled for an existing bucket.
[
'RequestCharged' => 'requester',
]Result Details Errors
There are no errors described for this operation.
PutObjectRetention$result = $client->putObjectRetention([/* ... */]); $promise = $client->putObjectRetentionAsync([/* ... */]);
This operation is not supported for directory buckets.
Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.
This functionality is not supported for Amazon S3 on Outposts.
Parameter Syntax$result = $client->putObjectRetention([
'Bucket' => '<string>', // REQUIRED
'BypassGovernanceRetention' => true || false,
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'Retention' => [
'Mode' => 'GOVERNANCE|COMPLIANCE',
'RetainUntilDate' => <integer || string || DateTime>,
],
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name that contains the object you want to apply this Object Retention configuration to.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Indicates whether this action should bypass Governance-mode restrictions.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The MD5 hash for 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The key name for the object that you want to apply this Object Retention configuration to.
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 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.
This functionality is not supported for directory buckets.
The container element for the Object Retention configuration.
The version ID for the object that you want to apply this Object Retention configuration to.
[
'RequestCharged' => 'requester',
]Result Details Errors
There are no errors described for this operation.
PutObjectTagging$result = $client->putObjectTagging([/* ... */]); $promise = $client->putObjectTaggingAsync([/* ... */]);
This operation is not supported for directory buckets.
Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.
You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.
For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.
To use this operation, you must have permission to perform the s3:PutObjectTagging action. By default, the bucket owner has this permission and can grant this permission to others.
To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.
PutObjectTagging 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 Object Tagging.
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 object.
The following operations are related to PutObjectTagging:
$result = $client->putObjectTagging([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'Tagging' => [ // REQUIRED
'TagSet' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the object.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The MD5 hash for 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Name of the object key.
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 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.
This functionality is not supported for directory buckets.
Container for the TagSet and Tag elements
The versionId of the object that the tag-set will be added to.
[
'VersionId' => '<string>',
]Result Details Members
The versionId of the object the tag-set was added to.
There are no errors described for this operation.
Examples Example 1: To add tags to an existing objectThe following example adds tags to an existing object.
$result = $client->putObjectTagging([
'Bucket' => 'examplebucket',
'Key' => 'HappyFace.jpg',
'Tagging' => [
'TagSet' => [
[
'Key' => 'Key3',
'Value' => 'Value3',
],
[
'Key' => 'Key4',
'Value' => 'Value4',
],
],
],
]);
Result syntax:
[
'VersionId' => 'null',
] PutPublicAccessBlock
$result = $client->putPublicAccessBlock([/* ... */]); $promise = $client->putPublicAccessBlockAsync([/* ... */]);
This operation is not supported for directory buckets.
Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock 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 configurations 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 PutPublicAccessBlock:
$result = $client->putPublicAccessBlock([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'PublicAccessBlockConfiguration' => [ // REQUIRED
'BlockPublicAcls' => true || false,
'BlockPublicPolicy' => true || false,
'IgnorePublicAcls' => true || false,
'RestrictPublicBuckets' => true || false,
],
]);
Parameter Details Members
The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
RenameObject$result = $client->renameObject([/* ... */]); $promise = $client->renameObjectAsync([/* ... */]);
Renames an existing object in a directory bucket that uses the S3 Express One Zone storage class. You can use RenameObject by specifying an existing objectâs name as the source and the new name of the object as the destination within the same directory bucket.
RenameObject is only supported for objects stored in the S3 Express One Zone storage class.
To prevent overwriting an object, you can use the If-None-Match conditional header.
If-None-Match - Renames the object only if an object with the specified name does not already exist in the directory bucket. If you don't want to overwrite an existing object, you can add the If-None-Match conditional header with the value â*â in the RenameObject request. Amazon S3 then returns a 412 Precondition Failed error if the object with the specified name already exists. For more information, see RFC 7232.
To grant access to the RenameObject operation on a directory bucket, we recommend that you use the CreateSession operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the directory bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. The Amazon Web Services CLI and SDKs will create and manage your session including refreshing the session token automatically to avoid service interruptions when a session expires. In your bucket policy, you can specify the s3express:SessionMode condition key to control who can create a ReadWrite or ReadOnly session. A ReadWrite session is required for executing all the Zonal endpoint API operations, including RenameObject. For more information about authorization, see CreateSession . To learn more about Zonal endpoint API operations, see Authorizing Zonal endpoint API operations with CreateSession in the Amazon S3 User Guide.
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
$result = $client->renameObject([
'Bucket' => '<string>', // REQUIRED
'ClientToken' => '<string>',
'DestinationIfMatch' => '<string>',
'DestinationIfModifiedSince' => <integer || string || DateTime>,
'DestinationIfNoneMatch' => '<string>',
'DestinationIfUnmodifiedSince' => <integer || string || DateTime>,
'Key' => '<string>', // REQUIRED
'RenameSource' => '<string>', // REQUIRED
'SourceIfMatch' => '<string>',
'SourceIfModifiedSince' => <integer || string || DateTime>,
'SourceIfNoneMatch' => '<string>',
'SourceIfUnmodifiedSince' => <integer || string || DateTime>,
]);
Parameter Details Members
The bucket name of the directory bucket containing the object.
You must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.
RenameObject supports idempotency using a client token. To make an idempotent API request using RenameObject, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an IdempotentParameterMismatch error is returned.
Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3. The If-Match header field makes the request method conditional on ETags. If the ETag values do not match, the operation returns a 412 Precondition Failed error.
Expects the ETag value as a string.
Renames the object if the destination exists and if it has been modified since the specified time.
Renames the object only if the destination does not already exist in the specified directory bucket. If the object does exist when you send a request with If-None-Match:*, the S3 API will return a 412 Precondition Failed error, preventing an overwrite. The If-None-Match header prevents overwrites of existing data by validating that there's not an object with the same key name already in your directory bucket.
Expects the * character (asterisk).
Renames the object if it hasn't been modified since the specified time.
Key name of the object to rename.
Specifies the source for the rename operation. The value must be URL encoded.
Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.
Renames the object if the source exists and if it has been modified since the specified time.
Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag. If an asterisk (*) character is provided, the operation will fail and return a 412 Precondition Failed error.
Renames the object if the source exists and hasn't been modified since the specified time.
[]Result Details
The results for this operation are always empty.
ErrorsParameters on this idempotent request are inconsistent with parameters used in previous request(s).
For a list of error codes and more information on Amazon S3 errors, see Error codes.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
$result = $client->restoreObject([/* ... */]); $promise = $client->restoreObjectAsync([/* ... */]);
This operation is not supported for directory buckets.
Restores an archived copy of an object back into Amazon S3
This functionality is not supported for Amazon S3 on Outposts.
This action performs the following types of requests:
restore an archive - Restore an archived object
For more information about the S3 structure in the request body, see the following:
Managing Access with ACLs in the Amazon S3 User Guide
Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide
To use this operation, you must have permissions to perform the s3:RestoreObject 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.
Objects that you archive to the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
When restoring an archived object, you can specify one of the following data access tier options in the Tier element of the request body:
Expedited - Expedited retrievals allow you to quickly access your data stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is typically made available within 1â5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3â5 hours for objects stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.
Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5â12 hours for objects stored in the S3 Glacier Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
To get the status of object restoration, you can send a HEAD request. Operations return the x-amz-restore header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.
A successful action returns either the 200 OK or 202 Accepted status code.
If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.
If the object is previously restored, Amazon S3 returns 200 OK in the response.
Special errors:
Code: RestoreAlreadyInProgress
Cause: Object restore is already in progress.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: GlacierExpeditedRetrievalNotAvailable
Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
HTTP Status Code: 503
SOAP Fault Code Prefix: N/A
The following operations are related to RestoreObject:
$result = $client->restoreObject([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'RequestPayer' => 'requester',
'RestoreRequest' => [
'Days' => <integer>,
'Description' => '<string>',
'GlacierJobParameters' => [
'Tier' => 'Standard|Bulk|Expedited', // REQUIRED
],
'OutputLocation' => [
'S3' => [
'AccessControlList' => [
[
'Grantee' => [
'DisplayName' => '<string>',
'EmailAddress' => '<string>',
'ID' => '<string>',
'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED
'URI' => '<string>',
],
'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP',
],
// ...
],
'BucketName' => '<string>', // REQUIRED
'CannedACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control',
'Encryption' => [
'EncryptionType' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse', // REQUIRED
'KMSContext' => '<string>',
'KMSKeyId' => '<string>',
],
'Prefix' => '<string>', // REQUIRED
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'Tagging' => [
'TagSet' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
],
'UserMetadata' => [
[
'Name' => '<string>',
'Value' => '<string>',
],
// ...
],
],
],
'SelectParameters' => [
'Expression' => '<string>', // REQUIRED
'ExpressionType' => 'SQL', // REQUIRED
'InputSerialization' => [ // REQUIRED
'CSV' => [
'AllowQuotedRecordDelimiter' => true || false,
'Comments' => '<string>',
'FieldDelimiter' => '<string>',
'FileHeaderInfo' => 'USE|IGNORE|NONE',
'QuoteCharacter' => '<string>',
'QuoteEscapeCharacter' => '<string>',
'RecordDelimiter' => '<string>',
],
'CompressionType' => 'NONE|GZIP|BZIP2',
'JSON' => [
'Type' => 'DOCUMENT|LINES',
],
'Parquet' => [
],
],
'OutputSerialization' => [ // REQUIRED
'CSV' => [
'FieldDelimiter' => '<string>',
'QuoteCharacter' => '<string>',
'QuoteEscapeCharacter' => '<string>',
'QuoteFields' => 'ALWAYS|ASNEEDED',
'RecordDelimiter' => '<string>',
],
'JSON' => [
'RecordDelimiter' => '<string>',
],
],
],
'Tier' => 'Standard|Bulk|Expedited',
'Type' => 'SELECT',
],
'VersionId' => '<string>',
]);
Parameter Details Members
The bucket name containing the object to restore.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Object key for which the action was initiated.
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 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.
This functionality is not supported for directory buckets.
Container for restore job parameters.
VersionId used to reference a specific version of the object.
[
'RequestCharged' => 'requester',
'RestoreOutputPath' => '<string>',
]Result Details Members
Indicates the path in the provided S3 output location where Select results will be restored to.
This action is not allowed against this storage tier.
The following example restores for one day an archived copy of an object back into Amazon S3 bucket.
$result = $client->restoreObject([
'Bucket' => 'examplebucket',
'Key' => 'archivedobjectkey',
'RestoreRequest' => [
'Days' => 1,
'GlacierJobParameters' => [
'Tier' => 'Expedited',
],
],
]);
Result syntax:
[ ]SelectObjectContent
$result = $client->selectObjectContent([/* ... */]); $promise = $client->selectObjectContentAsync([/* ... */]);
This operation is not supported for directory buckets.
This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.
This functionality is not supported for Amazon S3 on Outposts.
For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.
You must have the s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format properties:
CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.
UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.
Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.
Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.
The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.
Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.
The GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For more information about storage classes, see Using Amazon S3 storage classes in the Amazon S3 User Guide.
For a list of special errors for this operation, see List of SELECT Object Content Error Codes
The following operations are related to SelectObjectContent:
$result = $client->selectObjectContent([
'Bucket' => '<string>', // REQUIRED
'ExpectedBucketOwner' => '<string>',
'Expression' => '<string>', // REQUIRED
'ExpressionType' => 'SQL', // REQUIRED
'InputSerialization' => [ // REQUIRED
'CSV' => [
'AllowQuotedRecordDelimiter' => true || false,
'Comments' => '<string>',
'FieldDelimiter' => '<string>',
'FileHeaderInfo' => 'USE|IGNORE|NONE',
'QuoteCharacter' => '<string>',
'QuoteEscapeCharacter' => '<string>',
'RecordDelimiter' => '<string>',
],
'CompressionType' => 'NONE|GZIP|BZIP2',
'JSON' => [
'Type' => 'DOCUMENT|LINES',
],
'Parquet' => [
],
],
'Key' => '<string>', // REQUIRED
'OutputSerialization' => [ // REQUIRED
'CSV' => [
'FieldDelimiter' => '<string>',
'QuoteCharacter' => '<string>',
'QuoteEscapeCharacter' => '<string>',
'QuoteFields' => 'ALWAYS|ASNEEDED',
'RecordDelimiter' => '<string>',
],
'JSON' => [
'RecordDelimiter' => '<string>',
],
],
'RequestProgress' => [
'Enabled' => true || false,
],
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKey' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'ScanRange' => [
'End' => <integer>,
'Start' => <integer>,
],
]);
Parameter Details Members
The S3 bucket.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The expression that is used to query the object.
The type of the provided expression (for example, SQL).
Describes the format of the data in the object that is being queried.
The object key.
Describes the format of the data that you want Amazon S3 to return in response.
Specifies if periodic request progress information should be enabled.
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.
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.
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.
Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
ScanRangemay be used in the following ways:
<scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)
<scanrange><start>50</start></scanrange> - process only the records starting after the byte 50
<scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.
[
'Payload' => [ // EventParsingIterator
'Cont' => [
],
'End' => [
],
'Progress' => [
'Details' => [
'BytesProcessed' => <integer>,
'BytesReturned' => <integer>,
'BytesScanned' => <integer>,
],
],
'Records' => [
'Payload' => <string || resource || Psr\Http\Message\StreamInterface>,
],
'Stats' => [
'Details' => [
'BytesProcessed' => <integer>,
'BytesReturned' => <integer>,
'BytesScanned' => <integer>,
],
],
],
]Result Details Members
The array of results.
To use an EventParsingIterator, you will need to loop over the events it will generate and check the top-level field to determine which type of event it is.
foreach($result['Payload'] as $event) {
if (isset($event['Cont'])) {
// Handle the 'Cont' event.
} else if (isset($event['End'])) {
// Handle the 'End' event.
} else if (isset($event['Progress'])) {
// Handle the 'Progress' event.
} else if (isset($event['Records'])) {
// Handle the 'Records' event.
} else if (isset($event['Stats'])) {
// Handle the 'Stats' event.
}
}Errors
There are no errors described for this operation.
UpdateBucketMetadataInventoryTableConfiguration$result = $client->updateBucketMetadataInventoryTableConfiguration([/* ... */]); $promise = $client->updateBucketMetadataInventoryTableConfigurationAsync([/* ... */]);
Enables or disables a live inventory table for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
To use this operation, you must have the following permissions. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
If you want to encrypt your inventory table with server-side encryption with Key Management Service (KMS) keys (SSE-KMS), you need additional permissions in your KMS key policy. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
s3:UpdateBucketMetadataInventoryTableConfiguration
s3tables:CreateTableBucket
s3tables:CreateNamespace
s3tables:GetTable
s3tables:CreateTable
s3tables:PutTablePolicy
s3tables:PutTableEncryption
kms:DescribeKey
The following operations are related to UpdateBucketMetadataInventoryTableConfiguration:
$result = $client->updateBucketMetadataInventoryTableConfiguration([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'InventoryTableConfiguration' => [ // REQUIRED
'ConfigurationState' => 'ENABLED|DISABLED', // REQUIRED
'EncryptionConfiguration' => [
'KmsKeyArn' => '<string>',
'SseAlgorithm' => 'aws:kms|AES256', // REQUIRED
],
],
]);
Parameter Details Members
The general purpose bucket that corresponds to the metadata configuration that you want to enable or disable an inventory table for.
The checksum algorithm to use with your inventory table configuration.
The Content-MD5 header for the inventory table configuration.
The value will be computed on your behalf.
The expected owner of the general purpose bucket that corresponds to the metadata table configuration that you want to enable or disable an inventory table for.
The contents of your inventory table configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
UpdateBucketMetadataJournalTableConfiguration$result = $client->updateBucketMetadataJournalTableConfiguration([/* ... */]); $promise = $client->updateBucketMetadataJournalTableConfigurationAsync([/* ... */]);
Enables or disables journal table record expiration for an S3 Metadata configuration on a general purpose bucket. For more information, see Accelerating data discovery with S3 Metadata in the Amazon S3 User Guide.
To use this operation, you must have the s3:UpdateBucketMetadataJournalTableConfiguration permission. For more information, see Setting up permissions for configuring metadata tables in the Amazon S3 User Guide.
The following operations are related to UpdateBucketMetadataJournalTableConfiguration:
$result = $client->updateBucketMetadataJournalTableConfiguration([
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ContentMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'JournalTableConfiguration' => [ // REQUIRED
'RecordExpiration' => [ // REQUIRED
'Days' => <integer>,
'Expiration' => 'ENABLED|DISABLED', // REQUIRED
],
],
]);
Parameter Details Members
The general purpose bucket that corresponds to the metadata configuration that you want to enable or disable journal table record expiration for.
The checksum algorithm to use with your journal table configuration.
The Content-MD5 header for the journal table configuration.
The value will be computed on your behalf.
The expected owner of the general purpose bucket that corresponds to the metadata table configuration that you want to enable or disable journal table record expiration for.
The contents of your journal table configuration.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
UploadPart$result = $client->uploadPart([/* ... */]); $promise = $client->uploadPartAsync([/* ... */]);
Uploads a part in a multipart upload.
In this operation, you provide new data as a part of an object in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide .
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
General purpose bucket permissions - To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs.
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 about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .
If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
General purpose bucket - To ensure that data is not corrupted traversing the network, specify the Content-MD5 header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
General purpose bucket - 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 have 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), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest 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 key (SSE-C).
Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.
If you request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request 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, see Using Server-Side Encryption in the Amazon S3 User Guide.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms).
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.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to UploadPart:
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.
$result = $client->uploadPart([
'AddContentMD5' => true || false,
'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
'Bucket' => '<string>', // REQUIRED
'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256|CRC64NVME',
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ContentLength' => <integer>,
'ContentMD5' => '<string>',
'ContentSHA256' => '<string>',
'ExpectedBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'PartNumber' => <integer>, // REQUIRED
'RequestPayer' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKey' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SourceFile' => '<string>',
'UploadId' => '<string>', // REQUIRED
]);
Parameter Details Members
Set to true to calculate the ContentMD5 for the upload.
Object data.
The name of the bucket to which the multipart upload was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send 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.
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.
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.
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, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
The Base64 encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
This functionality is not supported for directory buckets.
This value is required if uploading to a bucket which has Object Lock enabled. It will not be calculated for you automatically. If you wish to have the value calculated for you, use the `AddContentMD5` parameter.
A SHA256 hash of the body content of the request.
This value will be computed for you it is not supplied.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Object key for which the multipart upload was initiated.
Part number of part being uploaded. This is a positive integer between 1 and 10,000.
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 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.
This functionality is not supported for directory buckets.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
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 must be the same encryption key specified in the initiate multipart upload request.
This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported for directory buckets.
The path to a file on disk to use instead of the Body parameter.
Upload ID identifying the multipart upload whose part is being uploaded.
[
'BucketKeyEnabled' => true || false,
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ETag' => '<string>',
'RequestCharged' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
]Result Details Members
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
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, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
Entity tag for the uploaded object.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
There are no errors described for this operation.
Examples Example 1: To upload a partThe following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.
$result = $client->uploadPart([
'Body' => <BLOB>,
'Bucket' => 'examplebucket',
'Key' => 'examplelargeobject',
'PartNumber' => 1,
'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--',
]);
Result syntax:
[
'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"',
] UploadPartCopy
$result = $client->uploadPartCopy([/* ... */]); $promise = $client->uploadPartCopyAsync([/* ... */]);
Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your request. To specify a byte range, you add the request header x-amz-copy-source-range in your request.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.
For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.
All UploadPartCopy requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.
Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy API operation, instead of using the temporary security credentials through the CreateSession API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
You must have READ access to the source object and WRITE access to the destination bucket.
General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an UploadPartCopy operation.
If the source object is in a general purpose bucket, you must have the s3:GetObject permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have the s3:PutObject permission to write the object copy to the destination bucket.
To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. 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 about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.
Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an UploadPartCopy operation.
If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.
If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key cannot be set to ReadOnly on the copy destination.
If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
General purpose buckets - For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.
S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
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.
HTTP Status Code: 404 Not Found
Error Code: InvalidRequest
Description: The specified copy source is not supported as a byte-range copy source.
HTTP Status Code: 400 Bad Request
Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.
The following operations are related to UploadPartCopy:
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.
$result = $client->uploadPartCopy([
'Bucket' => '<string>', // REQUIRED
'CopySource' => '<string>', // REQUIRED
'CopySourceIfMatch' => '<string>',
'CopySourceIfModifiedSince' => <integer || string || DateTime>,
'CopySourceIfNoneMatch' => '<string>',
'CopySourceIfUnmodifiedSince' => <integer || string || DateTime>,
'CopySourceRange' => '<string>',
'CopySourceSSECustomerAlgorithm' => '<string>',
'CopySourceSSECustomerKey' => '<string>',
'CopySourceSSECustomerKeyMD5' => '<string>',
'ExpectedBucketOwner' => '<string>',
'ExpectedSourceBucketOwner' => '<string>',
'Key' => '<string>', // REQUIRED
'PartNumber' => <integer>, // REQUIRED
'RequestPayer' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKey' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'UploadId' => '<string>', // REQUIRED
]);
Parameter Details Members
The bucket name.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP 400 Bad Request error with the error code InvalidRequest.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 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.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.
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 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.
Access points are not supported by directory buckets.
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.
If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source identifies the current version of the source object to copy. To copy a specific version of the source object to copy, append ?versionId=<version-id> to the x-amz-copy-source request header (for example, x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).
If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found error, because the object does not exist. If you specify versionId in the x-amz-copy-source and the versionId is a delete marker, Amazon S3 returns an HTTP 400 Bad Request error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
Copies the object if its entity tag (ETag) matches the specified tag.
If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:
x-amz-copy-source-if-match condition evaluates to true, and;
x-amz-copy-source-if-unmodified-since condition evaluates to false;
Amazon S3 returns 200 OK and copies the data.
Copies the object if it has been modified since the specified time.
If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:
x-amz-copy-source-if-none-match condition evaluates to false, and;
x-amz-copy-source-if-modified-since condition evaluates to true;
Amazon S3 returns 412 Precondition Failed response code.
Copies the object if its entity tag (ETag) is different than the specified ETag.
If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request as follows:
x-amz-copy-source-if-none-match condition evaluates to false, and;
x-amz-copy-source-if-modified-since condition evaluates to true;
Amazon S3 returns 412 Precondition Failed response code.
Copies the object if it hasn't been modified since the specified time.
If both of the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request as follows:
x-amz-copy-source-if-match condition evaluates to true, and;
x-amz-copy-source-if-unmodified-since condition evaluates to false;
Amazon S3 returns 200 OK and copies the data.
The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.
Specifies the algorithm to use when decrypting the source object (for example, AES256).
This functionality is not supported when the source object is in a directory bucket.
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 functionality is not supported when the source object is in a directory bucket.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported when the source object is in a directory bucket.
The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
Object key for which the multipart upload was initiated.
Part number of part being copied. This is a positive integer between 1 and 10,000.
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 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.
This functionality is not supported for directory buckets.
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported when the destination bucket is a directory bucket.
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 must be the same encryption key specified in the initiate multipart upload request.
This functionality is not supported when the destination bucket is a directory bucket.
This value will be base64 encoded on your behalf.
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.
This functionality is not supported when the destination bucket is a directory bucket.
Upload ID identifying the multipart upload whose part is being copied.
[
'BucketKeyEnabled' => true || false,
'CopyPartResult' => [
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ETag' => '<string>',
'LastModified' => <DateTime>,
],
'CopySourceVersionId' => '<string>',
'RequestCharged' => 'requester',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
]Result Details Members
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
Container for all response elements.
The version of the source object that was copied, if you have enabled versioning on the source bucket.
This functionality is not supported when the source object is in a directory bucket.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
If present, indicates the ID of the KMS key that was used for object encryption.
The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
There are no errors described for this operation.
Examples Example 1: To upload a part by copying data from an existing object as data sourceThe following example uploads a part of a multipart upload by copying data from an existing object as data source.
$result = $client->uploadPartCopy([
'Bucket' => 'examplebucket',
'CopySource' => '/bucketname/sourceobjectkey',
'Key' => 'examplelargeobject',
'PartNumber' => 1,
'UploadId' => 'exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--',
]);
Result syntax:
[
'CopyPartResult' => [
'ETag' => '"b0c6f0e7e054ab8fa2536a2677f8734d"',
'LastModified' => ,
],
]Example 2: To upload a part by copying byte range from an existing object as data source
The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.
$result = $client->uploadPartCopy([
'Bucket' => 'examplebucket',
'CopySource' => '/bucketname/sourceobjectkey',
'CopySourceRange' => 'bytes=1-100000',
'Key' => 'examplelargeobject',
'PartNumber' => 2,
'UploadId' => 'exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--',
]);
Result syntax:
[
'CopyPartResult' => [
'ETag' => '"65d16d19e65a7508a51f043180edcc36"',
'LastModified' => ,
],
] WriteGetObjectResponse
$result = $client->writeGetObjectResponse([/* ... */]); $promise = $client->writeGetObjectResponseAsync([/* ... */]);
This operation is not supported for directory buckets.
Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.
Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.
For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.
Parameter Syntax$result = $client->writeGetObjectResponse([
'AcceptRanges' => '<string>',
'Body' => <string || resource || Psr\Http\Message\StreamInterface>,
'BucketKeyEnabled' => true || false,
'CacheControl' => '<string>',
'ChecksumCRC32' => '<string>',
'ChecksumCRC32C' => '<string>',
'ChecksumCRC64NVME' => '<string>',
'ChecksumSHA1' => '<string>',
'ChecksumSHA256' => '<string>',
'ContentDisposition' => '<string>',
'ContentEncoding' => '<string>',
'ContentLanguage' => '<string>',
'ContentLength' => <integer>,
'ContentRange' => '<string>',
'ContentType' => '<string>',
'DeleteMarker' => true || false,
'ETag' => '<string>',
'ErrorCode' => '<string>',
'ErrorMessage' => '<string>',
'Expiration' => '<string>',
'Expires' => <integer || string || DateTime>,
'LastModified' => <integer || string || DateTime>,
'Metadata' => ['<string>', ...],
'MissingMeta' => <integer>,
'ObjectLockLegalHoldStatus' => 'ON|OFF',
'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE',
'ObjectLockRetainUntilDate' => <integer || string || DateTime>,
'PartsCount' => <integer>,
'ReplicationStatus' => 'COMPLETE|PENDING|FAILED|REPLICA|COMPLETED',
'RequestCharged' => 'requester',
'RequestRoute' => '<string>', // REQUIRED
'RequestToken' => '<string>', // REQUIRED
'Restore' => '<string>',
'SSECustomerAlgorithm' => '<string>',
'SSECustomerKeyMD5' => '<string>',
'SSEKMSKeyId' => '<string>',
'ServerSideEncryption' => 'AES256|aws:fsx|aws:kms|aws:kms:dsse',
'StatusCode' => <integer>,
'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE|FSX_OPENZFS',
'TagCount' => <integer>,
'VersionId' => '<string>',
]);
Parameter Details Members
Indicates that a range of bytes was specified.
The object data.
Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
Specifies caching behavior along the request/reply chain.
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 specifies the Base64 encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
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 specifies the Base64 encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
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, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 specifies the Base64 encoded, 160-bit SHA1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
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 specifies the Base64 encoded, 256-bit SHA256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
Specifies presentational information for the object.
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.
The language the content is in.
The size of the content body in bytes.
The portion of the object returned in the response.
A standard MIME type describing the format of the object data.
Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. To learn more about delete markers, see Working with delete markers.
An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".
Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.
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 that provide the object expiration information. The value of the rule-id is URL-encoded.
The date and time at which the object is no longer cacheable.
The date and time that the object was last modified.
A map of metadata to store with the object in S3.
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.
Indicates whether an object stored in Amazon S3 has an active legal hold.
Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
The date and time when Object Lock is configured to expire.
The count of parts this object has.
Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
Route prefix to the HTTP URL generated.
A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.
Provides information about object restoration operation and expiration time of the restored object copy.
Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.
The server-side encryption algorithm used when storing requested object in Amazon S3 or Amazon FSx.
When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.
The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.
200 - OK
206 - Partial Content
304 - Not Modified
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
411 - Length Required
412 - Precondition Failed
416 - Range Not Satisfiable
500 - Internal Server Error
503 - Service Unavailable
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.
The number of tags, if any, on the object.
An ID used to reference a specific version of the object.
[]Result Details
The results for this operation are always empty.
ErrorsThere are no errors described for this operation.
Shapes AbortIncompleteMultipartUpload DescriptionSpecifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.
MembersSpecifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.
MembersSpecifies the transfer acceleration status of the bucket.
Contains the elements that set the ACL permissions for an object per grantee.
MembersA list of grants.
Container for the bucket owner's display name and ID.
A container for information about access control for replicas.
MembersSpecifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon S3 API Reference.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.
MembersThe prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.
The list of tags to use when evaluating an AND predicate.
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
MembersThe filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
The ID that identifies the analytics configuration.
Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.
Where to publish the analytics results.
MembersA destination signifying output to an S3 bucket.
The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
MembersA conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.
The prefix to use when evaluating an analytics filter.
The tag to use when evaluating an analytics filter.
Contains information about where to publish the analytics results.
MembersThe Amazon Resource Name (ARN) of the bucket to which data is exported.
The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
Specifies the file format used when exporting data to Amazon S3.
The prefix to use when exporting data. The prefix is prepended to all results.
In terms of implementation, a Bucket is a resource.
MembersThe Amazon Resource Name (ARN) of the S3 bucket. ARNs uniquely identify Amazon Web Services resources across all of Amazon Web Services.
This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.
BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.
Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.
The name of the bucket.
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.
MembersThe 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).
MembersSpecifies the information about the bucket that will be created. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.
This functionality is only supported by directory buckets.
MembersThe number of Zone (Availability Zone or Local Zone) that's used for redundancy for the bucket.
The type of bucket.
Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.
MembersA lifecycle rule for individual objects in an Amazon S3 bucket.
Container for logging status information.
MembersDescribes 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.
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.
MembersA set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
Specifies a cross-origin access rule for an Amazon S3 bucket.
MembersHeaders that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.
An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.
One or more origins you want customers to be able to access the bucket from.
One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
Unique identifier for the rule. The value cannot be longer than 255 characters.
The time in seconds that your browser is to cache the preflight response for the specified resource.
Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
MembersSpecifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.
Default: #
A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
Describes the first line of input. Valid values are:
NONE: First line is not a header.
IGNORE: First line is a header, but you can't use the header values to indicate the column in an expression. You can use column position (such as _1, _2, â¦) to indicate the column (SELECT s._1 FROM OBJECT s).
Use: First line is a header, and you can use the header value to identify a column in an expression (SELECT "name" FROM OBJECT).
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".
Type: String
Default: "
Ancestors: CSV
A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".
A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
MembersThe value used to separate individual fields in a record. You can specify an arbitrary delimiter.
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".
The single character used for escaping the quote character inside an already escaped value.
Indicates whether to use quotation marks around output fields.
ALWAYS: Always use quotation marks for output fields.
ASNEEDED: Use quotation marks for output fields when needed.
A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
Contains all the possible checksum or digest values for an object.
MembersThe Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the object. This checksum is present if the object was uploaded with the CRC64NVME checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
The checksum type that is used to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
Container for specifying the Lambda notification configuration.
MembersLambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.
The bucket event for which to send notifications.
Bucket events for which to send notifications.
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
The role supporting the invocation of the Lambda function
Container for 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/.
MembersContainer for the specified common prefix.
The container for the completed multipart upload details.
MembersArray of CompletedPart data types.
If you do not supply a valid Part with your request, the service sends back an HTTP 400 response.
Details of the parts that were uploaded.
MembersThe Base64 encoded, 32-bit CRC32 checksum of the part. This checksum is present if the multipart upload request was created with the CRC32 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the part. This checksum is present if the multipart upload request was created with the CRC32C checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the part. This checksum is present if the multipart upload request was created with the CRC64NVME checksum algorithm to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 checksum of the part. This checksum is present if the multipart upload request was created with the SHA1 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 checksum of the part. This checksum is present if the multipart upload request was created with the SHA256 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
Entity tag returned when the part was uploaded.
Part number that identifies the part. This is a positive integer between 1 and 10,000.
General purpose buckets - In CompleteMultipartUpload, when a additional checksum (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is applied to each part, the PartNumber must start at 1 and the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad Request status code and an InvalidPartOrder error code.
Directory buckets - In CompleteMultipartUpload, the PartNumber must start at 1 and the part numbers must be consecutive.
A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.
The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Container for all response elements.
MembersThe Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the object. This checksum is present if the object being copied was uploaded with the CRC64NVME checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
The checksum type that is used to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.
Creation date of the object.
Container for all response elements.
MembersThis 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 part. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 part. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the part. This checksum is present if the multipart upload request was created with the CRC64NVME checksum algorithm to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA1 checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.
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 SHA256 checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.
Entity tag of the object.
Date and time at which the object was uploaded.
The configuration information for the bucket.
MembersSpecifies the information about the bucket that will be created.
This functionality is only supported by directory buckets.
Specifies the location where the bucket will be created.
Directory buckets - The location type is Availability Zone or Local Zone. To use the Local Zone location type, your account must be enabled for Local Zones. Otherwise, you get an HTTP 403 Forbidden error with the error code AccessDenied. To learn more, see Enable accounts for Local Zones in the Amazon S3 User Guide.
This functionality is only supported by directory buckets.
Specifies the Region where the bucket will be created. 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.
If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default. Configurations using the value EU will create a bucket in eu-west-1.
For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.
This functionality is not supported for directory buckets.
An array of tags that you can apply to the bucket that you're creating. Tags are key-value pairs of metadata used to categorize and organize your buckets, track costs, and control access.
This parameter is only supported for S3 directory buckets. For more information, see Using tags with directory buckets.
The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.
The DefaultRetention settings require both a mode and a period.
The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
The number of days that you want to specify for the default retention period. Must be used with Mode.
The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.
The number of years that you want to specify for the default retention period. Must be used with Mode.
Container for the objects to delete.
MembersThe object to delete.
Directory buckets - For directory buckets, an object that's composed entirely of whitespace characters is not supported by the DeleteObjects API operation. The request will receive a 400 Bad Request error and none of the objects in the request will be deleted.
Element to enable quiet mode for the request. When you add this element, you must set its value to true.
Information about the delete marker.
MembersSpecifies whether the object is (true) or is not (false) the latest version of an object.
The object key.
Date and time when the object was last modified.
The account that created the delete marker.
Version ID of an object.
Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.
For more information about delete marker replication, see Basic Rule Configuration.
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.
MembersIndicates whether to replicate delete markers.
Indicates whether to replicate delete markers.
Information about the deleted object.
MembersIndicates 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. To learn more about delete markers, see Working with delete markers.
This functionality is not supported for directory buckets.
The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.
This functionality is not supported for directory buckets.
The name of the deleted object.
The version ID of the deleted object.
This functionality is not supported for directory buckets.
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
MembersSpecify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.
Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon S3 User Guide.
The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.
A container specifying replication metrics-related settings enabling replication metrics and events.
A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.
The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.
For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference.
FSX_OPENZFS is not an accepted value when replicating objects.
The destination information for the S3 Metadata configuration.
MembersThe Amazon Resource Name (ARN) of the table bucket where the metadata configuration is stored.
The type of the table bucket where the metadata configuration is stored. The aws value indicates an Amazon Web Services managed table bucket, and the customer value indicates a customer-managed table bucket. V2 metadata configurations are stored in Amazon Web Services managed table buckets, and V1 metadata configurations are stored in customer-managed table buckets.
The namespace in the table bucket where the metadata tables for a metadata configuration are stored.
Contains the type of server-side encryption used.
MembersThe server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.
If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.
Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requesterâs account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
MembersSpecifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
The existing object was created with a different encryption type. Subsequent write requests must include the appropriate encryption parameters in the request or while creating the session.
MembersA message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent.
Container for all error elements.
MembersThe error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type. The following is a list of Amazon S3 error codes. For more information, see Error responses.
Code: AccessDenied
Description: Access Denied
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AccountProblem
Description: There is a problem with your Amazon Web Services account that prevents the action from completing successfully. Contact Amazon Web Services Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AllAccessDisabled
Description: All access to this Amazon S3 resource has been disabled. Contact Amazon Web Services Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AmbiguousGrantByEmailAddress
Description: The email address you provided is associated with more than one account.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: AuthorizationHeaderMalformed
Description: The authorization header you provided is invalid.
HTTP Status Code: 400 Bad Request
HTTP Status Code: N/A
Code: BadDigest
Description: The Content-MD5 you specified did not match what we received.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: BucketAlreadyExists
Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: BucketAlreadyOwnedByYou
Description: 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).
Code: 409 Conflict (in all Regions except the North Virginia Region)
SOAP Fault Code Prefix: Client
Code: BucketNotEmpty
Description: The bucket you tried to delete is not empty.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: CredentialsNotSupported
Description: This request does not support credentials.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: CrossLocationLoggingProhibited
Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: EntityTooLarge
Description: Your proposed upload exceeds the maximum allowed object size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: ExpiredToken
Description: The provided token has expired.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IllegalVersioningConfigurationException
Description: Indicates that the versioning configuration specified in the request is invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IncompleteBody
Description: You did not provide the number of bytes specified by the Content-Length HTTP header
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IncorrectNumberOfFilesInPostRequest
Description: POST requires exactly one file upload per request.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InlineDataTooLarge
Description: Inline data exceeds the maximum allowed size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InternalError
Description: We encountered an internal error. Please try again.
HTTP Status Code: 500 Internal Server Error
SOAP Fault Code Prefix: Server
Code: InvalidAccessKeyId
Description: The Amazon Web Services access key ID you provided does not exist in our records.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidAddressingHeader
Description: You must specify the Anonymous role.
HTTP Status Code: N/A
SOAP Fault Code Prefix: Client
Code: InvalidArgument
Description: Invalid Argument
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidBucketName
Description: The specified bucket is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidBucketState
Description: The request is not valid with the current state of the bucket.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: InvalidDigest
Description: The Content-MD5 you specified is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidEncryptionAlgorithmError
Description: The encryption request you specified is not valid. The valid value is AES256.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidLocationConstraint
Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidObjectState
Description: The action is not valid for the current state of the object.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
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.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidPartOrder
Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidPayer
Description: All access to this object has been disabled. Please contact Amazon Web Services Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidPolicyDocument
Description: The content of the form does not meet the conditions specified in the policy document.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidRange
Description: The requested range cannot be satisfied.
HTTP Status Code: 416 Requested Range Not Satisfiable
SOAP Fault Code Prefix: Client
Code: InvalidRequest
Description: Please use AWS4-HMAC-SHA256.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: SOAP requests must be made over an HTTPS connection.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate is not configured on this bucket.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate is disabled on this bucket.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact Amazon Web Services Support for more information.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact Amazon Web Services Support for more information.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidSecurity
Description: The provided security credentials are not valid.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidSOAPRequest
Description: The SOAP request body is invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidStorageClass
Description: The storage class you specified is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidTargetBucketForLogging
Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidToken
Description: The provided token is malformed or otherwise invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidURI
Description: Couldn't parse the specified URI.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: KeyTooLongError
Description: Your key is too long.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedACLError
Description: The XML you provided was not well-formed or did not validate against our published schema.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedPOSTRequest
Description: The body of your POST request is not well-formed multipart/form-data.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedXML
Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, "The XML you provided was not well-formed or did not validate against our published schema."
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MaxMessageLengthExceeded
Description: Your request was too big.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MaxPostPreDataLengthExceededError
Description: Your POST request fields preceding the upload file were too large.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MetadataTooLarge
Description: Your metadata headers exceed the maximum allowed metadata size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MethodNotAllowed
Description: The specified method is not allowed against this resource.
HTTP Status Code: 405 Method Not Allowed
SOAP Fault Code Prefix: Client
Code: MissingAttachment
Description: A SOAP attachment was expected, but none were found.
HTTP Status Code: N/A
SOAP Fault Code Prefix: Client
Code: MissingContentLength
Description: You must provide the Content-Length HTTP header.
HTTP Status Code: 411 Length Required
SOAP Fault Code Prefix: Client
Code: MissingRequestBodyError
Description: This happens when the user sends an empty XML document as a request. The error message is, "Request body is empty."
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MissingSecurityElement
Description: The SOAP 1.1 request is missing a security element.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MissingSecurityHeader
Description: Your request is missing a required header.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: NoLoggingStatusForKey
Description: There is no such thing as a logging status subresource for a key.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: NoSuchBucket
Description: The specified bucket does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchBucketPolicy
Description: The specified bucket does not have a bucket policy.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchKey
Description: The specified key does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
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.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchVersion
Description: Indicates that the version ID specified in the request does not match an existing version.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NotImplemented
Description: A header you provided implies functionality that is not implemented.
HTTP Status Code: 501 Not Implemented
SOAP Fault Code Prefix: Server
Code: NotSignedUp
Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: Amazon S3
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: OperationAborted
Description: A conflicting conditional action is currently in progress against this resource. Try again.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: PermanentRedirect
Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.
HTTP Status Code: 301 Moved Permanently
SOAP Fault Code Prefix: Client
Code: PreconditionFailed
Description: At least one of the preconditions you specified did not hold.
HTTP Status Code: 412 Precondition Failed
SOAP Fault Code Prefix: Client
Code: Redirect
Description: Temporary redirect.
HTTP Status Code: 307 Moved Temporarily
SOAP Fault Code Prefix: Client
Code: RestoreAlreadyInProgress
Description: Object restore is already in progress.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: RequestIsNotMultiPartContent
Description: Bucket POST must be of the enclosure-type multipart/form-data.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: RequestTimeout
Description: Your socket connection to the server was not read from or written to within the timeout period.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: RequestTimeTooSkewed
Description: The difference between the request time and the server's time is too large.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: RequestTorrentOfBucketError
Description: Requesting the torrent file of a bucket is not permitted.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: SignatureDoesNotMatch
Description: The request signature we calculated does not match the signature you provided. Check your Amazon Web Services secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: ServiceUnavailable
Description: Service is unable to handle request.
HTTP Status Code: 503 Service Unavailable
SOAP Fault Code Prefix: Server
Code: SlowDown
Description: Reduce your request rate.
HTTP Status Code: 503 Slow Down
SOAP Fault Code Prefix: Server
Code: TemporaryRedirect
Description: You are being redirected to the bucket while DNS updates.
HTTP Status Code: 307 Moved Temporarily
SOAP Fault Code Prefix: Client
Code: TokenRefreshRequired
Description: The provided token must be refreshed.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: TooManyBuckets
Description: You have attempted to create more buckets than allowed.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UnexpectedContent
Description: This request does not support content.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UnresolvableGrantByEmailAddress
Description: The email address you provided does not match any account on record.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UserKeyMustBeSpecified
Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
The error key.
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
The version ID of the error.
This functionality is not supported for directory buckets.
If an S3 Metadata V1 CreateBucketMetadataTableConfiguration or V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
MembersIf the V1 CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this Amazon Web Services Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
If the V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateTableBucket, s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable, s3tables:PutTablePolicy, kms:DescribeKey, and s3tables:PutTableEncryption permissions. Additionally, ensure that the KMS key used to encrypt the table still exists, is active and has a resource policy granting access to the S3 service principals 'maintenance.s3tables.amazonaws.com' and 'metadata.s3.amazonaws.com'. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
JournalTableAlreadyExists - A journal table already exists in the Amazon Web Services managed table bucket's namespace. Delete the journal table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
InventoryTableAlreadyExists - An inventory table already exists in the Amazon Web Services managed table bucket's namespace. Delete the inventory table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
JournalTableNotAvailable - The journal table that the inventory table relies on has a FAILED status. An inventory table requires a journal table with an ACTIVE status. To create a new journal or inventory table, you must delete the metadata configuration for this bucket, along with any journal or inventory tables, and then create a new metadata configuration.
NoSuchBucket - The specified general purpose bucket does not exist.
If the V1 CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error message. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable and s3tables:PutTablePolicy permissions, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableAlreadyExists - The table that you specified already exists in the table bucket's namespace. Specify a different table name. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
TableBucketNotFound - The table bucket that you specified doesn't exist in this Amazon Web Services Region and account. Create or choose a different table bucket. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
If the V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code. The possible error codes and error messages are as follows:
AccessDeniedCreatingResources - You don't have sufficient permissions to create the required resources. Make sure that you have s3tables:CreateTableBucket, s3tables:CreateNamespace, s3tables:CreateTable, s3tables:GetTable, s3tables:PutTablePolicy, kms:DescribeKey, and s3tables:PutTableEncryption permissions. Additionally, ensure that the KMS key used to encrypt the table still exists, is active and has a resource policy granting access to the S3 service principals 'maintenance.s3tables.amazonaws.com' and 'metadata.s3.amazonaws.com'. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
AccessDeniedWritingToTable - Unable to write to the metadata table because of missing resource permissions. To fix the resource policy, Amazon S3 needs to create a new metadata table. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
DestinationTableNotFound - The destination table doesn't exist. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
ServerInternalError - An internal error has occurred. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
JournalTableAlreadyExists - A journal table already exists in the Amazon Web Services managed table bucket's namespace. Delete the journal table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
InventoryTableAlreadyExists - An inventory table already exists in the Amazon Web Services managed table bucket's namespace. Delete the inventory table, and then try again. To create a new metadata table, you must delete the metadata configuration for this bucket, and then create a new metadata configuration.
JournalTableNotAvailable - The journal table that the inventory table relies on has a FAILED status. An inventory table requires a journal table with an ACTIVE status. To create a new journal or inventory table, you must delete the metadata configuration for this bucket, along with any journal or inventory tables, and then create a new metadata configuration.
NoSuchBucket - The specified general purpose bucket does not exist.
The error information.
MembersThe object key name to use when a 4XX class error occurs.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
A container for specifying the configuration for Amazon EventBridge.
MembersSpecifies whether Amazon S3 replicates existing source bucket objects.
Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/. Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.
The value that the filter searches for in object key names.
The S3 Metadata configuration for a general purpose bucket.
MembersThe metadata configuration for a general purpose bucket.
The V1 S3 Metadata configuration for a general purpose bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
MembersIf the CreateBucketMetadataTableConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.
The V1 S3 Metadata configuration for a general purpose bucket.
The status of the metadata table. The status values are:
CREATING - The metadata table is in the process of being created in the specified table bucket.
ACTIVE - The metadata table has been created successfully, and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the metadata table, or Amazon S3 is unable to deliver records. See ErrorDetails for details.
A collection of parts associated with a multipart upload.
MembersIndicates whether the returned list of parts is truncated. A value of true indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
The maximum number of parts allowed in the response.
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the PartNumberMarker request parameter in a subsequent request.
The marker for the current part.
A container for elements related to a particular part. A response can contain zero or more Parts elements.
General purpose buckets - For GetObjectAttributes, if an additional checksum (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) isn't applied to the object specified in the request, the response doesn't return the Part element.
Directory buckets - For GetObjectAttributes, regardless of whether an additional checksum is applied to the object specified in the request, the response returns the Part element.
The total number of parts.
Container for S3 Glacier job parameters.
MembersRetrieval tier at which the restore will be processed.
Container for grant information.
MembersThe person being granted permissions.
Specifies the permission given to the grantee.
Container for the person being granted permissions.
MembersScreen name of the grantee.
Email address of the grantee.
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 canonical user ID of the grantee.
Type of grantee
URI of the grantee group.
Parameters on this idempotent request are inconsistent with parameters used in previous request(s).
For a list of error codes and more information on Amazon S3 errors, see Error codes.
Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.
MembersContainer for the Suffix element.
A suffix that is appended to a request that is for a directory on the website endpoint. (For example, if the suffix is index.html and you make a request to samplebucket/images/, the data that is returned will be for the object with the key name images/index.html.) The suffix must not be empty and must not include a slash character.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Container element that identifies who initiated the multipart upload.
MembersName of the Principal.
This functionality is not supported for directory buckets.
If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it provides a user ARN value.
Describes the serialization format of the object.
MembersDescribes the serialization of a CSV-encoded object.
Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.
Specifies JSON as object's input serialization format.
Specifies Parquet as object's input serialization format.
A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.
MembersAn object key name prefix that identifies the subset of objects to which the configuration applies.
All of these tags must exist in the object's tag set in order for the configuration to apply.
Specifies a bucket filter. The configuration only includes objects that meet the filter's criteria.
The ID used to identify the S3 Intelligent-Tiering configuration.
Specifies the status of the configuration.
Specifies the S3 Intelligent-Tiering storage class tier of the configuration.
The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
An object key name prefix that identifies the subset of objects to which the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
A container of a key value name pair.
Object is archived and inaccessible until restored.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.
You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:
Cannot specify both a write offset value and user-defined object metadata for existing objects.
Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.
Request body cannot be empty when 'write offset' is specified.
The write offset value that you specified does not match the current object size.
MembersSpecifies the S3 Inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.
MembersContains information about where to publish the inventory results.
Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
The ID used to identify the inventory configuration.
Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.
Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.
Contains the optional fields that are included in the inventory results.
Specifies the schedule for generating inventory results.
Specifies the S3 Inventory configuration for an Amazon S3 bucket.
MembersContains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
Contains the type of server-side encryption used to encrypt the S3 Inventory results.
MembersSpecifies the use of SSE-KMS to encrypt delivered inventory reports.
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
Specifies an S3 Inventory filter. The inventory only includes objects that meet the filter's criteria.
MembersThe prefix that an object must have to be included in the inventory results.
Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where S3 Inventory results are published.
MembersThe account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.
Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.
The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
Contains the type of server-side encryption used to encrypt the inventory results.
Specifies the output format of the inventory results.
The prefix that is prepended to all inventory results.
Specifies the schedule for generating S3 Inventory results.
MembersSpecifies how frequently inventory results are produced.
The inventory table configuration for an S3 Metadata configuration.
MembersThe configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.
The encryption configuration for the inventory table.
The inventory table configuration for an S3 Metadata configuration.
MembersThe configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.
If an S3 Metadata V1 CreateBucketMetadataTableConfiguration or V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
The Amazon Resource Name (ARN) for the inventory table.
The name of the inventory table.
The status of the inventory table. The status values are:
CREATING - The inventory table is in the process of being created in the specified Amazon Web Services managed table bucket.
BACKFILLING - The inventory table is in the process of being backfilled. When you enable the inventory table for your metadata configuration, the table goes through a process known as backfilling, during which Amazon S3 scans your general purpose bucket to retrieve the initial metadata for all objects in the bucket. Depending on the number of objects in your bucket, this process can take several hours. When the backfilling process is finished, the status of your inventory table changes from BACKFILLING to ACTIVE. After backfilling is completed, updates to your objects are reflected in the inventory table within one hour.
ACTIVE - The inventory table has been created successfully, and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the inventory table, or Amazon S3 is unable to deliver records.
The specified updates to the S3 Metadata inventory table configuration.
MembersThe configuration state of the inventory table, indicating whether the inventory table is enabled or disabled.
The encryption configuration for the inventory table.
Specifies JSON as object's input serialization format.
MembersThe type of JSON. Valid values: Document, Lines.
Specifies JSON as request's output serialization format.
MembersThe value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character ('\n').
The journal table configuration for an S3 Metadata configuration.
MembersThe encryption configuration for the journal table.
The journal table record expiration settings for the journal table.
The journal table configuration for the S3 Metadata configuration.
MembersIf an S3 Metadata V1 CreateBucketMetadataTableConfiguration or V2 CreateBucketMetadataConfiguration request succeeds, but S3 Metadata was unable to create the table, this structure contains the error code and error message.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
The journal table record expiration settings for the journal table.
The Amazon Resource Name (ARN) for the journal table.
The name of the journal table.
The status of the journal table. The status values are:
CREATING - The journal table is in the process of being created in the specified table bucket.
ACTIVE - The journal table has been created successfully, and records are being delivered to the table.
FAILED - Amazon S3 is unable to create the journal table, or Amazon S3 is unable to deliver records.
The specified updates to the S3 Metadata journal table configuration.
MembersThe journal table record expiration settings for the journal table.
A container for specifying the configuration for Lambda notifications.
MembersThe Amazon S3 bucket event for which to invoke the Lambda function. For more information, see Supported Event Types in the Amazon S3 User Guide.
Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.
Specifies lifecycle configuration rules for an Amazon S3 bucket.
Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.
Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. Filter is required if the LifecycleRule does not contain a Prefix element.
For more information about Tag filters, see Adding filters to Lifecycle rules in the Amazon S3 User Guide.
Tag filters are not supported for directory buckets.
Unique identifier for the rule. The value cannot be longer than 255 characters.
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
Specifies when an Amazon S3 object transitions to a specified storage class.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
MembersMinimum object size to which the rule applies.
Maximum object size to which the rule applies.
Prefix identifying one or more objects to which the rule applies.
All of these tags must exist in the object's tag set in order for the rule to apply.
The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter can have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. If the Filter element is left empty, the Lifecycle Rule applies to all objects in the bucket.
This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
Minimum object size to which the rule applies.
Maximum object size to which the rule applies.
Prefix identifying one or more objects to which the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
This tag must exist in the object's tag set in order for the rule to apply.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Specifies the location where the bucket will be created.
For directory buckets, the location type is Availability Zone or Local Zone. For more information about directory buckets, see Working with directory buckets in the Amazon S3 User Guide.
This functionality is only supported by directory buckets.
MembersThe name of the location where the bucket will be created.
For directory buckets, the name of the location is the Zone ID of the Availability Zone (AZ) or Local Zone (LZ) where the bucket will be created. An example AZ ID value is usw2-az1.
The type of location where the bucket will be created.
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.
MembersSpecifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
Container for granting information.
Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
Amazon S3 key format for log objects.
A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.
The S3 Metadata configuration for a general purpose bucket.
MembersThe inventory table configuration for a metadata configuration.
The journal table configuration for a metadata configuration.
The S3 Metadata configuration for a general purpose bucket.
MembersThe destination settings for a metadata configuration.
The inventory table configuration for a metadata configuration.
The journal table configuration for a metadata configuration.
A metadata key-value pair to store with an object.
MembersName of the object.
Value of the object.
The V1 S3 Metadata configuration for a general purpose bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
MembersThe destination information for the metadata table configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
The V1 S3 Metadata configuration for a general purpose bucket. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
MembersThe destination information for the metadata table configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
The encryption settings for an S3 Metadata journal table or inventory table configuration.
MembersIf server-side encryption with Key Management Service (KMS) keys (SSE-KMS) is specified, you must also specify the KMS key Amazon Resource Name (ARN). You must specify a customer-managed KMS key that's located in the same Region as the general purpose bucket that corresponds to the metadata table configuration.
The encryption type specified for a metadata table. To specify server-side encryption with Key Management Service (KMS) keys (SSE-KMS), use the aws:kms value. To specify server-side encryption with Amazon S3 managed keys (SSE-S3), use the AES256 value.
A container specifying replication metrics-related settings enabling replication metrics and events.
MembersA container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.
Specifies whether the replication metrics are enabled.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
MembersThe access point ARN used when evaluating an AND predicate.
The prefix used when evaluating an AND predicate.
The list of tags used when evaluating an AND predicate.
Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 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 more information, see PutBucketMetricsConfiguration.
MembersSpecifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).
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.
Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
MembersThe access point ARN used when evaluating a metrics filter.
A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
The prefix used when evaluating a metrics filter.
The tag used when evaluating a metrics filter.
Container for the MultipartUpload for the Amazon S3 object.
The algorithm that was used to create a checksum of the object.
The checksum type that is used to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
Date and time at which the multipart upload was initiated.
Identifies who initiated the multipart upload.
Key of the object for which the multipart upload was initiated.
Specifies the owner of the object that is part of the multipart upload.
Directory buckets - The bucket owner is returned as the object owner for all the objects.
The class of storage used to store the object.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Upload ID that identifies the multipart upload.
The specified bucket does not exist.
MembersThe specified key does not exist.
MembersThe specified multipart upload does not exist.
MembersSpecifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
MembersSpecifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.
Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon S3 User Guide.
The class of storage used to store the object.
An object consists of data and its descriptive metadata.
MembersThe algorithm that was used to create a checksum of the object.
The checksum type that is used to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.
Directory buckets - MD5 is not supported by directory buckets.
The name that you assign to an object. You use the object key to retrieve the object.
Creation date of the object.
The owner of the object
Directory buckets - The bucket owner is returned as the object owner.
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Size in bytes of the object
The class of storage used to store the object.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
This action is not allowed against this storage tier.
MembersObject Identifier is unique value to identify objects.
MembersAn entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on ETags.
Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.
Key name of the object.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
If present, the objects are deleted only if its modification times matches the provided Timestamp.
This functionality is only supported for directory buckets.
If present, the objects are deleted only if its size matches the provided size in bytes.
This functionality is only supported for directory buckets.
Version ID for the specific version of the object to delete.
This functionality is not supported for directory buckets.
The container element for Object Lock configuration parameters.
MembersIndicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.
Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
A legal hold configuration for an object.
MembersIndicates whether the specified object has a legal hold in place.
A Retention configuration for an object.
MembersIndicates the Retention mode for the specified object.
The date on which this Object Lock Retention will expire.
The container element for an Object Lock rule.
MembersThe default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
MembersA container for elements related to an individual part.
MembersThe Base64 encoded, 32-bit CRC32 checksum of the part. This checksum is present if the multipart upload request was created with the CRC32 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the part. This checksum is present if the multipart upload request was created with the CRC32C checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the part. This checksum is present if the multipart upload request was created with the CRC64NVME checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 checksum of the part. This checksum is present if the multipart upload request was created with the SHA1 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 checksum of the part. This checksum is present if the multipart upload request was created with the SHA256 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The part number identifying the part. This value is a positive integer between 1 and 10,000.
The size of the uploaded part in bytes.
The version of an object.
MembersThe algorithm that was used to create a checksum of the object.
The checksum type that is used to calculate the objectâs checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
The entity tag is an MD5 hash of that version of the object.
Specifies whether the object is (true) or is not (false) the latest version of an object.
The object key.
Date and time when the object was last modified.
Specifies the owner of the object.
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.
Size in bytes of the object.
The class of storage used to store the object.
Version ID of an object.
Describes the location where the restore job's output is stored.
MembersDescribes an S3 location that will receive the results of the restore request.
Describes how results of the Select job are serialized.
MembersDescribes the serialization of CSV-encoded Select results.
Specifies JSON as request's output serialization format.
End of support notice: Beginning October 1, 2025, Amazon S3 will stop returning DisplayName. Update your applications to use canonical IDs (unique identifier for Amazon Web Services accounts), Amazon Web Services account ID (12 digit identifier) or IAM ARNs (full resource naming) as a direct replacement of DisplayName.
This change affects the following Amazon Web Services Regions: US East (N. Virginia) Region, US West (N. California) Region, US West (Oregon) Region, Asia Pacific (Singapore) Region, Asia Pacific (Sydney) Region, Asia Pacific (Tokyo) Region, Europe (Ireland) Region, and South America (São Paulo) Region.
Container for the owner's display name and ID.
MembersContainer for the display name of the owner. This value 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)
This functionality is not supported for directory buckets.
Container for the ID of the owner.
The container element for a bucket's ownership controls.
MembersThe container element for an ownership control rule.
The container element for an ownership control rule.
MembersThe 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 specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).
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. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
Container for Parquet.
MembersContainer for elements related to a part.
MembersThe Base64 encoded, 32-bit CRC32 checksum of the part. This checksum is present if the object was uploaded with the CRC32 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 32-bit CRC32C checksum of the part. This checksum is present if the object was uploaded with the CRC32C checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 64-bit CRC64NVME checksum of the part. This checksum is present if the multipart upload request was created with the CRC64NVME checksum algorithm, or if the object was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 160-bit SHA1 checksum of the part. This checksum is present if the object was uploaded with the SHA1 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
The Base64 encoded, 256-bit SHA256 checksum of the part. This checksum is present if the object was uploaded with the SHA256 checksum algorithm. For more information, see Checking object integrity in the Amazon S3 User Guide.
Entity tag returned when the part was uploaded.
Date and time at which the part was uploaded.
Part number identifying the part. This is a positive integer between 1 and 10,000.
Size in bytes of the uploaded part data.
Amazon S3 keys for log objects are partitioned in the following format:
[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.
MembersSpecifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.
For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.
For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.
The container element for a bucket's policy status.
MembersThe policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.
This data type contains information about progress of an operation.
MembersThe current number of uncompressed object bytes processed.
The current number of bytes of records payload data returned.
The current number of object bytes scanned.
This data type contains information about the progress event of an operation.
MembersThe Progress event details.
The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public" in the Amazon S3 User Guide.
MembersSpecifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:
PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Services service principals and authorized users within this account if the bucket has a public policy.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
MembersA collection of bucket events for which to send notifications
Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.
This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
MembersThe bucket event for which to send notifications.
A collection of bucket events for which to send notifications.
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.
The journal table record expiration settings for a journal table in an S3 Metadata configuration.
MembersIf you enable journal table record expiration, you can set the number of days to retain your journal table records. Journal table records must be retained for a minimum of 7 days. To set this value, specify any whole number from 7 to 2147483647. For example, to retain your journal table records for one year, set this value to 365.
Specifies whether journal table record expiration is enabled or disabled.
The container for the records event.
MembersThe byte array of partial, one or more result records. S3 Select doesn't guarantee that a record will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might split the same record across multiple record frames instead of aggregating the results in memory. Some S3 clients (for example, the SDKforJava) handle this behavior by creating a ByteStream out of the response by default. Other clients might not handle this behavior by default. In those cases, you must aggregate the results on the client side and parse the response.
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
MembersThe host name to use in the redirect request.
The HTTP redirect code to use on the response. Not required if one of the siblings is present.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
MembersName of the host where requests are redirected.
Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed.
Specifies whether Amazon S3 replicates modifications on replicas.
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
MembersThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon S3 User Guide.
A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.
Specifies which Amazon S3 objects to replicate and where to store the replicas.
MembersSpecifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.
For more information about delete marker replication, see Basic Rule Configuration.
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.
A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.
A unique identifier for the rule. The maximum value is 255 characters.
An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.
For more information, see Replication in the Amazon S3 User Guide.
A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
Specifies whether the rule is enabled.
A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.
For example:
If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.
An object key name prefix that identifies the subset of objects to which the rule applies.
An array of tags containing key and value pairs.
A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.
A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:
If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.
An object key name prefix that identifies the subset of objects to which the rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
A container for specifying a tag key and value.
The rule applies only to objects that have the tag in their tag set.
A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics block.
Specifies whether the replication time is enabled.
A container specifying the time by which replication should be complete for all objects and operations on objects.
A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.
Contains an integer specifying time in minutes.
Valid value: 15
Container for Payer.
MembersSpecifies who pays for the download and request fees.
Container for specifying if periodic QueryProgress messages should be sent.
Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.
Container for restore job parameters.
MembersLifetime of the active copy in days. Do not use with restores that specify OutputLocation.
The Days element is required for regular restores, and must not be provided for select requests.
The optional description for the job.
S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.
Describes the location where the restore job's output is stored.
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more
Describes the parameters for Select job types.
Retrieval tier at which the restore will be processed.
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more
Type of restore request.
Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:
x-amz-optional-object-attributes: IsRestoreInProgress="true"
If the object restoration has completed, the header returns the value FALSE. For example:
x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"
If the object hasn't been restored, there is no header response.
Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:
x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"
Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon S3 User Guide.
MembersA container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.
Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference. For examples, see Put Bucket Lifecycle Configuration Examples.
MembersSpecifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.
Specifies the expiration for the lifecycle of the object.
Unique identifier for the rule. The value can't be longer than 255 characters.
Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.
Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.
Object key prefix that identifies one or more objects to which this rule applies.
Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.
If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.
Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.
A container for object key name prefix and suffix filtering rules.
MembersA list of containers for the key-value pair that defines the criteria for the filter rule.
Describes an Amazon S3 location that will receive the results of the restore request.
MembersA list of grants that control access to the staged results.
The name of the bucket where the restore results will be placed.
The canned ACL to apply to the restore results.
Contains the type of server-side encryption used.
The prefix that is prepended to the restore results for this request.
The class of storage used to store the restore results.
The tag-set that is applied to the restore results.
A list of metadata to store with the restore results in S3.
The destination information for a V1 S3 Metadata configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
MembersThe Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket.
The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
The destination information for a V1 S3 Metadata configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
If you created your S3 Metadata configuration before July 15, 2025, we recommend that you delete and re-create your configuration by using CreateBucketMetadataConfiguration so that you can expire journal table records and create a live inventory table.
MembersThe Amazon Resource Name (ARN) for the metadata table in the metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
The Amazon Resource Name (ARN) for the table bucket that's specified as the destination in the metadata table configuration. The destination table bucket must be in the same Region and Amazon Web Services account as the general purpose bucket.
The name for the metadata table in your metadata table configuration. The specified metadata table name must be unique within the aws_s3_metadata namespace in the destination table bucket.
The table bucket namespace for the metadata table in your metadata table configuration. This value is always aws_s3_metadata.
Specifies the use of SSE-KMS to encrypt delivered inventory reports.
MembersSpecifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for encrypting inventory reports.
Specifies the use of SSE-S3 to encrypt delivered inventory reports.
MembersSpecifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
MembersSpecifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange> means scan the last 50 bytes.
Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file. For example, <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.
The container for selecting objects from a content event stream.
MembersThe Continuation Event.
The End Event.
The Progress Event.
The Records Event.
The Stats Event.
Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more
Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.
MembersThe S3 bucket.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
The expression that is used to query the object.
The type of the provided expression (for example, SQL).
Describes the format of the data in the object that is being queried.
The object key.
Describes the format of the data that you want Amazon S3 to return in response.
Specifies if periodic request progress information should be enabled.
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.
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.
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.
Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
ScanRangemay be used in the following ways:
<scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)
<scanrange><start>50</start></scanrange> - process only the records starting after the byte 50
<scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.
Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more
The expression that is used to query the object.
The type of the provided expression (for example, SQL).
Describes the serialization format of the object.
Describes how the results of the Select job are serialized.
Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PutBucketEncryption.
General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key (aws/s3) in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS.
Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The Amazon Web Services managed key (aws/s3) isn't supported.
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.
Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default encryption.
General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse.
Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.
You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Key Alias: alias/alias-name
If you are using encryption with cross-account or Amazon Web Services service operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requesterâs account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
Server-side encryption algorithm to use for the default encryption.
For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.
Specifies the default server-side-encryption configuration.
MembersContainer for information about a particular server-side encryption configuration rule.
Specifies the default server-side encryption configuration.
General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requesterâs account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner.
Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key.
General purpose buckets - By default, S3 Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and canât be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
The established temporary security credentials of the session.
Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.
MembersA unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.
Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.
A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.
A part of the temporary security credentials. The session token is used to validate the temporary security credentials.
To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).
MembersA filter that you can specify for selections for modifications on replicas. Amazon S3 doesn't replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.
If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed
A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.
A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.
MembersSpecifies whether Amazon S3 replicates objects created with server-side encryption using an Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.
Container for the stats details.
MembersThe total number of uncompressed object bytes processed.
The total number of bytes of records payload data returned.
The total number of object bytes scanned.
Container for the Stats Event.
MembersThe Stats event details.
Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
MembersSpecifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
MembersThe place to store the data for an analysis.
The version of the output schema to use when exporting data. Must be V_1.
A container of a key value name pair.
MembersName of the object key.
Value of the tag.
Container for TagSet elements.
A collection for a set of tags
Container for granting information.
Buckets that use the bucket owner enforced setting for Object Ownership don't support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide.
MembersContainer for the person being granted permissions.
Logging permissions assigned to the grantee for the bucket.
Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.
MembersPartitioned S3 key for log objects.
To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.
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 additional operational overhead.
MembersS3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.
The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).
You have attempted to add more parts than the maximum of 10000 that are allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object.
MembersA container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
MembersThe Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.
Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.
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. This data type is deprecated. Use TopicConfiguration instead.
MembersBucket event for which to send notifications.
A collection of events related to objects
An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.
Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.
MembersIndicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
Indicates the number of days after creation when objects are transitioned to the specified storage class. If the specified storage class is INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE, valid values are 0 or positive integers. If the specified storage class is STANDARD_IA or ONEZONE_IA, valid values are positive integers greater than 30. Be aware that some storage classes have a minimum storage duration and that you're charged for transitioning objects before their minimum storage duration. For more information, see Constraints and considerations for transitions in the Amazon S3 User Guide.
The storage class to which you want the object to transition.
Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.
MembersSpecifies 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.
The versioning state of the bucket.
Specifies website configuration parameters for an Amazon S3 bucket.
MembersThe name of the error document for the website.
The name of the index document for the website.
The redirect behavior for every request to this bucket's website endpoint.
If you specify this property, you can't specify any other property.
Rules that define when a redirect is applied and the redirect behavior.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4