Amazon Simple Storage Service 2006-03-01
- Client: Aws\S3\S3Client
- Service ID: s3
- Version: 2006-03-01
This page describes the parameters and results for the operations of the Amazon Simple Storage Service (2006-03-01), and shows how to use the Aws\S3\S3Client object to call the described operations. This documentation is specific to the 2006-03-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AbortMultipartUpload ( array $params = [] )
- This operation aborts a multipart upload.
- CompleteMultipartUpload ( array $params = [] )
- Completes a multipart upload by assembling previously uploaded parts.
- CopyObject ( array $params = [] )
- Creates a copy of an object that is already stored in Amazon S3.
- CreateBucket ( array $params = [] )
- This action creates an Amazon S3 bucket.
- CreateMultipartUpload ( array $params = [] )
- This action initiates a multipart upload and returns an upload ID.
- CreateSession ( array $params = [] )
- Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets.
- DeleteBucket ( array $params = [] )
- Deletes the S3 bucket.
- DeleteBucketAnalyticsConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketCors ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketEncryption ( array $params = [] )
- This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).
- DeleteBucketIntelligentTieringConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketInventoryConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketLifecycle ( array $params = [] )
- Deletes the lifecycle configuration from the specified bucket.
- DeleteBucketMetricsConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketOwnershipControls ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketPolicy ( array $params = [] )
- Deletes the policy of a specified bucket.
- DeleteBucketReplication ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketTagging ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteBucketWebsite ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteObject ( array $params = [] )
- Removes an object from a bucket.
- DeleteObjectTagging ( array $params = [] )
- This operation is not supported for directory buckets.
- DeleteObjects ( array $params = [] )
- This operation enables you to delete multiple objects from a bucket using a single HTTP request.
- DeletePublicAccessBlock ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketAccelerateConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketAcl ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketAnalyticsConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketCors ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketEncryption ( array $params = [] )
- Returns the default encryption configuration for an Amazon S3 bucket.
- GetBucketIntelligentTieringConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketInventoryConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketLifecycle ( array $params = [] )
- For an updated version of this API, see GetBucketLifecycleConfiguration.
- GetBucketLifecycleConfiguration ( array $params = [] )
- Returns the lifecycle configuration information set on the bucket.
- GetBucketLocation ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketLogging ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketMetricsConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketNotification ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketNotificationConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketOwnershipControls ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketPolicy ( array $params = [] )
- Returns the policy of a specified bucket.
- GetBucketPolicyStatus ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketReplication ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketRequestPayment ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketTagging ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketVersioning ( array $params = [] )
- This operation is not supported for directory buckets.
- GetBucketWebsite ( array $params = [] )
- This operation is not supported for directory buckets.
- GetObject ( array $params = [] )
- Retrieves an object from Amazon S3.
- GetObjectAcl ( array $params = [] )
- This operation is not supported for directory buckets.
- GetObjectAttributes ( array $params = [] )
- Retrieves all the metadata from an object without returning the object itself.
- GetObjectLegalHold ( array $params = [] )
- This operation is not supported for directory buckets.
- GetObjectLockConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- GetObjectRetention ( array $params = [] )
- This operation is not supported for directory buckets.
- GetObjectTagging ( array $params = [] )
- This operation is not supported for directory buckets.
- GetObjectTorrent ( array $params = [] )
- This operation is not supported for directory buckets.
- GetPublicAccessBlock ( array $params = [] )
- This operation is not supported for directory buckets.
- HeadBucket ( array $params = [] )
- You can use this operation to determine if a bucket exists and if you have permission to access it.
- HeadObject ( array $params = [] )
- The HEAD operation retrieves metadata from an object without returning the object itself.
- ListBucketAnalyticsConfigurations ( array $params = [] )
- This operation is not supported for directory buckets.
- ListBucketIntelligentTieringConfigurations ( array $params = [] )
- This operation is not supported for directory buckets.
- ListBucketInventoryConfigurations ( array $params = [] )
- This operation is not supported for directory buckets.
- ListBucketMetricsConfigurations ( array $params = [] )
- This operation is not supported for directory buckets.
- ListBuckets ( array $params = [] )
- This operation is not supported for directory buckets.
- ListDirectoryBuckets ( array $params = [] )
- Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request.
- ListMultipartUploads ( array $params = [] )
- This operation lists in-progress multipart uploads in a bucket.
- ListObjectVersions ( array $params = [] )
- This operation is not supported for directory buckets.
- ListObjects ( array $params = [] )
- This operation is not supported for directory buckets.
- ListObjectsV2 ( array $params = [] )
- Returns some or all (up to 1,000) of the objects in a bucket with each request.
- ListParts ( array $params = [] )
- Lists the parts that have been uploaded for a specific multipart upload.
- PutBucketAccelerateConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketAcl ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketAnalyticsConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketCors ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketEncryption ( array $params = [] )
- This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.
- PutBucketIntelligentTieringConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketInventoryConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketLifecycle ( array $params = [] )
- For an updated version of this API, see PutBucketLifecycleConfiguration.
- PutBucketLifecycleConfiguration ( array $params = [] )
- Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration.
- PutBucketLogging ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketMetricsConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketNotification ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketNotificationConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketOwnershipControls ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketPolicy ( array $params = [] )
- Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
- PutBucketReplication ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketRequestPayment ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketTagging ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketVersioning ( array $params = [] )
- This operation is not supported for directory buckets.
- PutBucketWebsite ( array $params = [] )
- This operation is not supported for directory buckets.
- PutObject ( array $params = [] )
- Adds an object to a bucket.
- PutObjectAcl ( array $params = [] )
- This operation is not supported for directory buckets.
- PutObjectLegalHold ( array $params = [] )
- This operation is not supported for directory buckets.
- PutObjectLockConfiguration ( array $params = [] )
- This operation is not supported for directory buckets.
- PutObjectRetention ( array $params = [] )
- This operation is not supported for directory buckets.
- PutObjectTagging ( array $params = [] )
- This operation is not supported for directory buckets.
- PutPublicAccessBlock ( array $params = [] )
- This operation is not supported for directory buckets.
- RestoreObject ( array $params = [] )
- This operation is not supported for directory buckets.
- SelectObjectContent ( array $params = [] )
- This operation is not supported for directory buckets.
- UploadPart ( array $params = [] )
- Uploads a part in a multipart upload.
- UploadPartCopy ( array $params = [] )
- Uploads a part by copying data from an existing object as data source.
- WriteGetObjectResponse ( array $params = [] )
- This operation is not supported for directory buckets.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
- ListBuckets
- ListDirectoryBuckets
- ListMultipartUploads
- ListObjectVersions
- ListObjects
- ListObjectsV2
- ListParts
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
BucketExists | HeadBucket | 5 | 20 |
BucketNotExists | HeadBucket | 5 | 20 |
ObjectExists | HeadObject | 5 | 20 |
ObjectNotExists | HeadObject | 5 | 20 |
Operations
AbortMultipartUpload
$result = $client->abortMultipartUpload
([/* ... */]); $promise = $client->abortMultipartUploadAsync
([/* ... */]);
This 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 theAbortMultipartUpload
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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following operations are related to AbortMultipartUpload
:
Parameter Syntax
$result = $client->abortMultipartUpload([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'IfMatchInitiatedTime' => <integer || string || DateTime>, 'Key' => '<string>', // REQUIRED 'RequestPayer' => 'requester', 'UploadId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name to which the upload was taking place.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - IfMatchInitiatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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 a204 Success (No Content)
response.This functionality is only supported for directory buckets.
- Key
-
- Required: Yes
- Type: string
Key of the object for which the multipart upload was initiated.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- UploadId
-
- Required: Yes
- Type: string
Upload ID that identifies the multipart upload.
Result Syntax
[ 'RequestCharged' => 'requester', ]
Result Details
Members
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Errors
- NoSuchUpload:
The specified multipart upload does not exist.
Examples
Example 1: To abort a multipart upload
The following example aborts a multipart upload.
$result = $client->abortMultipartUpload([ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ]);
Result syntax:
[ ]
CompleteMultipartUpload
$result = $client->completeMultipartUpload
([/* ... */]); $promise = $client->completeMultipartUploadAsync
([/* ... */]);
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation 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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
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 thekms:Decrypt
action for theCompleteMultipartUpload
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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.If the object is encrypted with SSE-KMS, you must also have the
kms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
-
- Special errors
-
-
Error Code:
EntityTooSmall
-
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
-
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
-
-
- HTTP Host header syntax
-
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.
Parameter Syntax
$result = $client->completeMultipartUpload([ 'Bucket' => '<string>', // REQUIRED 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ExpectedBucketOwner' => '<string>', 'IfMatch' => '<string>', 'IfNoneMatch' => '<string>', 'Key' => '<string>', // REQUIRED 'MultipartUpload' => [ 'Parts' => [ [ 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ETag' => '<string>', 'PartNumber' => <integer>, ], // ... ], ], 'RequestPayer' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKey' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'UploadId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
Name of the bucket to which the multipart upload was initiated.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ChecksumCRC32
-
- Type: string
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ChecksumCRC32C
-
- Type: string
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ChecksumSHA1
-
- Type: string
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ChecksumSHA256
-
- Type: string
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - IfMatch
-
- Type: string
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 withCreateMultipartUpload
, 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.
- IfNoneMatch
-
- Type: string
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 withCreateMultipartUpload
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.
- Key
-
- Required: Yes
- Type: string
Object key for which the multipart upload was initiated.
- MultipartUpload
-
- Type: CompletedMultipartUpload structure
The container for the multipart upload request information.
- RequestPayer
-
- Type: string
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.
- SSECustomerAlgorithm
-
- Type: string
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.
- SSECustomerKey
-
- Type: string
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf. - SSECustomerKeyMD5
-
- Type: string
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- UploadId
-
- Required: Yes
- Type: string
ID for the initiated multipart upload.
Result Syntax
[ 'Bucket' => '<string>', 'BucketKeyEnabled' => true || false, 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ETag' => '<string>', 'Expiration' => '<string>', 'Key' => '<string>', 'Location' => '<string>', 'ObjectURL' => '<string>', 'RequestCharged' => 'requester', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', 'VersionId' => '<string>', ]
Result Details
Members
- Bucket
-
- Type: string
The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.
Access points are not supported by directory buckets.
- BucketKeyEnabled
-
- Type: boolean
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- ChecksumCRC32
-
- Type: string
The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it 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.
- ChecksumCRC32C
-
- Type: string
The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it 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.
- ChecksumSHA1
-
- Type: string
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. 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.
- ChecksumSHA256
-
- Type: string
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. 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.
- ETag
-
- Type: string
Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.
- Expiration
-
- Type: string
If the object expiration is configured, this will contain the expiration date (
expiry-date
) and rule ID (rule-id
). The value ofrule-id
is URL-encoded.This functionality is not supported for directory buckets.
- Key
-
- Type: string
The object key of the newly created object.
- Location
-
- Type: string
The URI that identifies the newly created object.
- ObjectURL
-
- Type: string
The URI of the created object. - RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- SSEKMSKeyId
-
- Type: string
If present, indicates the ID of the KMS key that was used for object encryption.
- ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
,aws:kms
). - VersionId
-
- Type: string
Version ID of the newly created object, in case the bucket has versioning turned on.
This functionality is not supported for directory buckets.
Errors
There are no errors described for this operation.
Examples
Example 1: To complete multipart upload
The following example completes a multipart upload.
$result = $client->completeMultipartUpload([ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'MultipartUpload' => [ 'Parts' => [ [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'PartNumber' => 1, ], [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'PartNumber' => 2, ], ], ], 'UploadId' => '7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ]);
Result syntax:
[ 'Bucket' => 'acexamplebucket', 'ETag' => '"4d9031c7644d8081c2829f4ea23c55f7-2"', 'Key' => 'bigobject', 'Location' => 'https://examplebucket.s3..amazonaws.com/bigobject', ]
CopyObject
$result = $client->copyObject
([/* ... */]); $promise = $client->copyObjectAsync
([/* ... */]);
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.
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://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 Available Local Zone for directory buckets 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.
- Authentication and authorization
-
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 thex-amz-
prefix, includingx-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 theCreateSession
API operation.Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
- Permissions
-
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 theAction
element of a policy to read the object. By default, the session is in theReadWrite
mode. If you want to restrict the access, you can explicitly set thes3express:SessionMode
condition key toReadOnly
on the copy source bucket. -
If the copy destination is a directory bucket, you must have the
s3express:CreateSession
permission in theAction
element of a policy to write the object to the destination. Thes3express:SessionMode
condition key can't be set toReadOnly
on the copy destination bucket.
If the object is encrypted with SSE-KMS, you must also have the
kms:GenerateDataKey
andkms: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.
-
-
- Response and special errors
-
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 a200 OK
response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The200 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 a200 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).
-
-
- Charge
-
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.
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
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.
Parameter Syntax
$result = $client->copyObject([ 'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control', 'Bucket' => '<string>', // REQUIRED 'BucketKeyEnabled' => true || false, 'CacheControl' => '<string>', 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentDisposition' => '<string>', 'ContentEncoding' => '<string>', 'ContentLanguage' => '<string>', 'ContentType' => '<string>', 'CopySource' => '<string>', // REQUIRED 'CopySourceIfMatch' => '<string>', 'CopySourceIfModifiedSince' => <integer || string || DateTime>, 'CopySourceIfNoneMatch' => '<string>', 'CopySourceIfUnmodifiedSince' => <integer || string || DateTime>, 'CopySourceSSECustomerAlgorithm' => '<string>', 'CopySourceSSECustomerKey' => '<string>', 'CopySourceSSECustomerKeyMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', 'ExpectedSourceBucketOwner' => '<string>', 'Expires' => <integer || string || DateTime>, 'GrantFullControl' => '<string>', 'GrantRead' => '<string>', 'GrantReadACP' => '<string>', 'GrantWriteACP' => '<string>', 'Key' => '<string>', // REQUIRED 'Metadata' => ['<string>', ...], 'MetadataDirective' => 'COPY|REPLACE', 'ObjectLockLegalHoldStatus' => 'ON|OFF', 'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE', 'ObjectLockRetainUntilDate' => <integer || string || DateTime>, 'RequestPayer' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKey' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'SSEKMSEncryptionContext' => '<string>', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'Tagging' => '<string>', 'TaggingDirective' => 'COPY|REPLACE', 'WebsiteRedirectLocation' => '<string>', ]);
Parameter Details
Members
- ACL
-
- Type: string
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 orPUT
requests that specify bucket owner full control ACLs, such as thebucket-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.
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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.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 codeInvalidRequest
.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - BucketKeyEnabled
-
- Type: boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). 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.
- CacheControl
-
- Type: string
Specifies the caching behavior along the request/reply chain.
- ChecksumAlgorithm
-
- Type: string
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 thisx-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 thex-amz-checksum-algorithm
header. Unrecognized or unsupported values will respond with the HTTP status code400 Bad Request
.For directory buckets, when you use Amazon Web Services SDKs,
CRC32
is the default checksum algorithm that's used for performance. - ContentDisposition
-
- Type: string
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.
- ContentEncoding
-
- Type: string
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
For directory buckets, only the
aws-chunked
value is supported in this header field. - ContentLanguage
-
- Type: string
The language the content is in.
- ContentType
-
- Type: string
A standard MIME type that describes the format of the object data.
- CopySource
-
- Required: Yes
- Type: string
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 bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. To copy the objectreports/january.pdf
from the directory bucketawsexamplebucket--use1-az5--x-s3
, useawsexamplebucket--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 objectreports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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 objectreports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn: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 theversionId
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.
- CopySourceIfMatch
-
- Type: string
Copies the object if its entity tag (ETag) matches the specified tag.
If both the
x-amz-copy-source-if-match
andx-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns200 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
- CopySourceIfModifiedSince
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Copies the object if it has been modified since the specified time.
If both the
x-amz-copy-source-if-none-match
andx-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the412 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
- CopySourceIfNoneMatch
-
- Type: string
Copies the object if its entity tag (ETag) is different than the specified ETag.
If both the
x-amz-copy-source-if-none-match
andx-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the412 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
- CopySourceIfUnmodifiedSince
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Copies the object if it hasn't been modified since the specified time.
If both the
x-amz-copy-source-if-match
andx-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns200 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
- CopySourceSSECustomerAlgorithm
-
- Type: string
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.
- CopySourceSSECustomerKey
-
- Type: string
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be 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. - CopySourceSSECustomerKeyMD5
-
- Type: string
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
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.
- ExpectedBucketOwner
-
- Type: string
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). - ExpectedSourceBucketOwner
-
- Type: string
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). - Expires
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the object is no longer cacheable.
- GrantFullControl
-
- Type: string
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
- GrantRead
-
- Type: string
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.
- GrantReadACP
-
- Type: string
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.
- GrantWriteACP
-
- Type: string
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.
- Key
-
- Required: Yes
- Type: string
The key of the destination object.
- Metadata
-
- Type: Associative array of custom strings keys (MetadataKey) to strings
A map of metadata to store with the object in S3.
- MetadataDirective
-
- Type: string
Specifies whether the metadata is copied from the source object or replaced with metadata 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 thex-amz-metadata-directive
header. To copy the value, you must specifyx-amz-website-redirect-location
in the request header. - ObjectLockLegalHoldStatus
-
- Type: string
Specifies whether you want to apply a legal hold to the object copy.
This functionality is not supported for directory buckets.
- ObjectLockMode
-
- Type: string
The Object Lock mode that you want to apply to the object copy.
This functionality is not supported for directory buckets.
- ObjectLockRetainUntilDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when you want the Object Lock of the object copy to expire.
This functionality is not supported for directory buckets.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- SSECustomerAlgorithm
-
- Type: string
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.
- SSECustomerKey
-
- Type: string
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded. Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.This functionality is not supported when the destination bucket is a directory bucket.
This value will be base64 encoded on your behalf. - SSECustomerKeyMD5
-
- Type: string
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
This functionality is not supported when the destination bucket is a directory bucket.
- SSEKMSEncryptionContext
-
- Type: string
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.
- SSEKMSKeyId
-
- Type: string
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 - If you specify
x-amz-server-side-encryption
withaws:kms
, thex-amz-server-side-encryption-aws-kms-key-id
header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify thex-amz-server-side-encryption-aws-kms-key-id
header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP400 Bad Request
error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3
) isn't supported. - ServerSideEncryption
-
- Type: string
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 yourCreateSession
requests orPUT
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 aCopyObject
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.
- StorageClass
-
- Type: string
If the
x-amz-storage-class
header is not used, the copied object will be stored in theSTANDARD
Storage Class by default. TheSTANDARD
storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.-
Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. 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 thex-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
orDEEP_ARCHIVE
. -
The storage class of the source object is
INTELLIGENT_TIERING
and it's S3 Intelligent-Tiering access tier isArchive Access
orDeep Archive Access
.
For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.
- Tagging
-
- Type: string
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 chooseREPLACE
for thex-amz-tagging-directive
. If you chooseCOPY
for thex-amz-tagging-directive
, you don't need to set thex-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 a501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a501 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 tox-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 ofx-amz-tagging-directive
isCOPY
.
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 thex-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 thex-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 thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
- TaggingDirective
-
- Type: string
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 a501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a501 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 tox-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 ofx-amz-tagging-directive
isCOPY
.
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 thex-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 thex-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 thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
- WebsiteRedirectLocation
-
- Type: string
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 thex-amz-metadata-directive
header.This functionality is not supported for directory buckets.
Result Syntax
[ 'BucketKeyEnabled' => true || false, 'CopyObjectResult' => [ 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ETag' => '<string>', 'LastModified' => <DateTime>, ], 'CopySourceVersionId' => '<string>', 'Expiration' => '<string>', 'ObjectURL' => '<string>', 'RequestCharged' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'SSEKMSEncryptionContext' => '<string>', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', 'VersionId' => '<string>', ]
Result Details
Members
- BucketKeyEnabled
-
- Type: boolean
Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- CopyObjectResult
-
- Type: CopyObjectResult structure
Container for all response elements.
- CopySourceVersionId
-
- Type: string
Version ID of the source object that was copied.
This functionality is not supported when the source object is in a directory bucket.
- Expiration
-
- Type: string
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. - ObjectURL
-
- Type: string
The URI of the created object. - RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- SSECustomerAlgorithm
-
- Type: string
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.
- SSECustomerKeyMD5
-
- Type: string
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.
- SSEKMSEncryptionContext
-
- Type: string
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.
- SSEKMSKeyId
-
- Type: string
If present, indicates the ID of the KMS key that was used for object encryption.
- ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
). - VersionId
-
- Type: string
Version ID of the newly created copy.
This functionality is not supported for directory buckets.
Errors
- ObjectNotInActiveTierError:
The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.
Examples
Example 1: To copy an object
The following example copies an object from one bucket to another.
$result = $client->copyObject([ 'Bucket' => 'destinationbucket', 'CopySource' => '/sourcebucket/HappyFacejpg', 'Key' => 'HappyFaceCopyjpg', ]);
Result syntax:
[ 'CopyObjectResult' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' =>, ], ]
CreateBucket
$result = $client->createBucket
([/* ... */]); $promise = $client->createBucketAsync
([/* ... */]);
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 thes3.amazonaws.com
global endpoint, the request goes to theus-east-1
Region. So the signature calculations in Signature Version 4 must useus-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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
General purpose bucket permissions - In addition to the
s3:CreateBucket
permission, the following permissions are required in a policy when yourCreateBucket
request includes specific headers:-
Access control lists (ACLs) - In your
CreateBucket
request, if you specify an access control list (ACL) and set it topublic-read
,public-read-write
,authenticated-read
, or if you explicitly specify any other custom ACLs, boths3:CreateBucket
ands3:PutBucketAcl
permissions are required. In yourCreateBucket
request, if you set the ACL toprivate
, or if you don't specify any ACLs, only thes3:CreateBucket
permission is required. -
Object Lock - In your
CreateBucket
request, if you setx-amz-bucket-object-lock-enabled
to true, thes3:PutBucketObjectLockConfiguration
ands3:PutBucketVersioning
permissions are required. -
S3 Object Ownership - If your
CreateBucket
request includes thex-amz-object-ownership
header, then thes3: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 usingPutBucketAcl
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 thes3: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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to CreateBucket
:
Parameter Syntax
$result = $client->createBucket([ 'ACL' => 'private|public-read|public-read-write|authenticated-read', 'Bucket' => '<string>', // REQUIRED 'CreateBucketConfiguration' => [ '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', ], 'GrantFullControl' => '<string>', 'GrantRead' => '<string>', 'GrantReadACP' => '<string>', 'GrantWrite' => '<string>', 'GrantWriteACP' => '<string>', 'ObjectLockEnabledForBucket' => true || false, 'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced', ]);
Parameter Details
Members
- ACL
-
- Type: string
The canned ACL to apply to the bucket.
This functionality is not supported for directory buckets.
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 - CreateBucketConfiguration
-
- Type: CreateBucketConfiguration structure
The configuration information for the bucket.
- GrantFullControl
-
- Type: string
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for directory buckets.
- GrantRead
-
- Type: string
Allows grantee to list the objects in the bucket.
This functionality is not supported for directory buckets.
- GrantReadACP
-
- Type: string
Allows grantee to read the bucket ACL.
This functionality is not supported for directory buckets.
- GrantWrite
-
- Type: string
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
This functionality is not supported for directory buckets.
- GrantWriteACP
-
- Type: string
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for directory buckets.
- ObjectLockEnabledForBucket
-
- Type: boolean
Specifies whether you want S3 Object Lock to be enabled for the new bucket.
This functionality is not supported for directory buckets.
- ObjectOwnership
-
- Type: string
The container element for object ownership for a bucket's ownership controls.
BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with thebucket-owner-full-control
canned ACL.ObjectWriter
- The uploading account will own the object if the object is uploaded with thebucket-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 predefinedbucket-owner-full-control
canned ACL or a custom ACL in XML format that grants the same permissions).By default,
ObjectOwnership
is set toBucketOwnerEnforced
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.
Result Syntax
[ 'Location' => '<string>', ]
Result Details
Members
- Location
-
- Type: string
A forward slash followed by the name of the bucket.
Errors
- BucketAlreadyExists:
The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.
- BucketAlreadyOwnedByYou:
The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
Examples
Example 1: To create a bucket in a specific region
The following example creates a bucket. The request specifies an AWS region where to create the bucket.
$result = $client->createBucket([ 'Bucket' => 'examplebucket', 'CreateBucketConfiguration' => [ 'LocationConstraint' => 'eu-west-1', ], ]);
Result syntax:
[ 'Location' => 'http://examplebucket..s3.amazonaws.com/', ]
Example 2: To create a bucket
The following example creates a bucket.
$result = $client->createBucket([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'Location' => '/examplebucket', ]
CreateMultipartUpload
$result = $client->createMultipartUpload
([/* ... */]); $promise = $client->createMultipartUploadAsync
([/* ... */]);
This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview 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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Request signing
-
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.
- Permissions
-
-
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
andkms:GenerateDataKey
actions on the key. The requester must also have permissions for thekms:GenerateDataKey
action for theCreateMultipartUpload
API. Then, the requester needs permissions for thekms:Decrypt
action on theUploadPart
andUploadPartCopy
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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- Encryption
-
-
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 providex-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
andkms: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
andPUT
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 yourCreateSession
requests orPUT
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
, andx-amz-server-side-encryption-bucket-key-enabled
) that are specified in theCreateSession
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 theCreateSession
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 theCreateSession
request. It's not supported to override the encryption settings values in theCreateSession
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 anUploadPartCopy
operation, the request headers you provide in theCreateMultipartUpload
request must match the default encryption configuration of the destination bucket.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following operations are related to CreateMultipartUpload
:
Parameter Syntax
$result = $client->createMultipartUpload([ 'ACL' => 'private|public-read|public-read-write|authenticated-read|aws-exec-read|bucket-owner-read|bucket-owner-full-control', 'Bucket' => '<string>', // REQUIRED 'BucketKeyEnabled' => true || false, 'CacheControl' => '<string>', 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentDisposition' => '<string>', 'ContentEncoding' => '<string>', 'ContentLanguage' => '<string>', 'ContentType' => '<string>', 'ExpectedBucketOwner' => '<string>', 'Expires' => <integer || string || DateTime>, 'GrantFullControl' => '<string>', 'GrantRead' => '<string>', 'GrantReadACP' => '<string>', 'GrantWriteACP' => '<string>', 'Key' => '<string>', // REQUIRED 'Metadata' => ['<string>', ...], 'ObjectLockLegalHoldStatus' => 'ON|OFF', 'ObjectLockMode' => 'GOVERNANCE|COMPLIANCE', 'ObjectLockRetainUntilDate' => <integer || string || DateTime>, 'RequestPayer' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKey' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'SSEKMSEncryptionContext' => '<string>', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'Tagging' => '<string>', 'WebsiteRedirectLocation' => '<string>', ]);
Parameter Details
Members
- ACL
-
- Type: string
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.
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - BucketKeyEnabled
-
- Type: boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).
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
andPUT
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. - CacheControl
-
- Type: string
Specifies caching behavior along the request/reply chain.
- ChecksumAlgorithm
-
- Type: string
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.
- ContentDisposition
-
- Type: string
Specifies presentational information for the object.
- ContentEncoding
-
- Type: string
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
For directory buckets, only the
aws-chunked
value is supported in this header field. - ContentLanguage
-
- Type: string
The language that the content is in.
- ContentType
-
- Type: string
A standard MIME type describing the format of the object data.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Expires
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the object is no longer cacheable.
- GrantFullControl
-
- Type: string
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 accountUsing 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.
- GrantRead
-
- Type: string
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 accountUsing 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.
- GrantReadACP
-
- Type: string
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 accountUsing 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.
- GrantWriteACP
-
- Type: string
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 accountUsing 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.
- Key
-
- Required: Yes
- Type: string
Object key for which the multipart upload is to be initiated.
- Metadata
-
- Type: Associative array of custom strings keys (MetadataKey) to strings
A map of metadata to store with the object in S3.
- ObjectLockLegalHoldStatus
-
- Type: string
Specifies whether you want to apply a legal hold to the uploaded object.
This functionality is not supported for directory buckets.
- ObjectLockMode
-
- Type: string
Specifies the Object Lock mode that you want to apply to the uploaded object.
This functionality is not supported for directory buckets.
- ObjectLockRetainUntilDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Specifies the date and time when you want the Object Lock to expire.
This functionality is not supported for directory buckets.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- SSECustomerAlgorithm
-
- Type: string
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
- SSECustomerKey
-
- Type: string
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf. - SSECustomerKeyMD5
-
- Type: string
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.
- SSEKMSEncryptionContext
-
- Type: string
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded 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.
- SSEKMSKeyId
-
- Type: string
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
withaws:kms
oraws:kms:dsse
, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specifyx-amz-server-side-encryption:aws:kms
orx-amz-server-side-encryption:aws:kms:dsse
, but do not providex-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 - If you specify
x-amz-server-side-encryption
withaws:kms
, thex-amz-server-side-encryption-aws-kms-key-id
header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify thex-amz-server-side-encryption-aws-kms-key-id
header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP400 Bad Request
error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3
) isn't supported. - ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
).-
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 yourCreateSession
requests orPUT
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
, andx-amz-server-side-encryption-bucket-key-enabled
) that are specified in theCreateSession
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 theCreateSession
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 theCreateSession
request. It's not supported to override the encryption settings values in theCreateSession
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.
- StorageClass
-
- Type: string
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
- Tagging
-
- Type: string
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
This functionality is not supported for directory buckets.
- WebsiteRedirectLocation
-
- Type: string
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
This functionality is not supported for directory buckets.
Result Syntax
[ 'AbortDate' => <DateTime>, 'AbortRuleId' => '<string>', 'Bucket' => '<string>', 'BucketKeyEnabled' => true || false, 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'Key' => '<string>', 'RequestCharged' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'SSEKMSEncryptionContext' => '<string>', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', 'UploadId' => '<string>', ]
Result Details
Members
- AbortDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration 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.
- AbortRuleId
-
- Type: string
This header is returned along with the
x-amz-abort-date
header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.This functionality is not supported for directory buckets.
- Bucket
-
- Type: string
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
Access points are not supported by directory buckets.
- BucketKeyEnabled
-
- Type: boolean
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- ChecksumAlgorithm
-
- Type: string
The algorithm that was used to create a checksum of the object.
- Key
-
- Type: string
Object key for which the multipart upload was initiated.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- SSECustomerAlgorithm
-
- Type: string
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.
- SSECustomerKeyMD5
-
- Type: string
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.
- SSEKMSEncryptionContext
-
- Type: string
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.
- SSEKMSKeyId
-
- Type: string
If present, indicates the ID of the KMS key that was used for object encryption.
- ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
). - UploadId
-
- Type: string
ID for the initiated multipart upload.
Errors
There are no errors described for this operation.
Examples
Example 1: To initiate a multipart upload
The following example initiates a multipart upload.
$result = $client->createMultipartUpload([ 'Bucket' => 'examplebucket', 'Key' => 'largeobject', ]);
Result syntax:
[ 'Bucket' => 'examplebucket', 'Key' => 'largeobject', 'UploadId' => 'ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--', ]
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 Available Local Zone for directory buckets in the Amazon S3 User Guide. -
CopyObject
API operation - Unlike other Zonal endpoint API operations, theCopyObject
API operation doesn't use the temporary security credentials returned from theCreateSession
API operation for authentication and authorization. For information about authentication and authorization of theCopyObject
API operation on directory buckets, see CopyObject. -
HeadBucket
API operation - Unlike other Zonal endpoint API operations, theHeadBucket
API operation doesn't use the temporary security credentials returned from theCreateSession
API operation for authentication and authorization. For information about authentication and authorization of theHeadBucket
API operation on directory buckets, see HeadBucket.
- Permissions
-
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 thes3express:SessionMode
condition key to control who can create aReadWrite
orReadOnly
session. For more information aboutReadWrite
orReadOnly
sessions, seex-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 thekms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the target KMS key. - Encryption
-
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 yourCreateSession
requests orPUT
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
, andx-amz-server-side-encryption-bucket-key-enabled
) from theCreateSession
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 theCreateSession
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 theCreateSession
request. It's not supported to override the encryption settings values in theCreateSession
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 theCreateSession
request. - HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
Parameter Syntax
$result = $client->createSession([ 'Bucket' => '<string>', // REQUIRED 'BucketKeyEnabled' => true || false, 'SSEKMSEncryptionContext' => '<string>', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', 'SessionMode' => 'ReadOnly|ReadWrite', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket that you create a session for.
- BucketKeyEnabled
-
- Type: boolean
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
andPUT
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. - SSEKMSEncryptionContext
-
- Type: string
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.
- SSEKMSKeyId
-
- Type: string
If you specify
x-amz-server-side-encryption
withaws:kms
, you must specify thex-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 HTTP400 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 for the lifetime of the bucket. The Amazon Web Services managed key (
aws/s3
) isn't supported. - ServerSideEncryption
-
- Type: string
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. - SessionMode
-
- Type: string
Specifies the mode of the session that will be created, either
ReadWrite
orReadOnly
. By default, aReadWrite
session is created. AReadWrite
session is capable of executing all the Zonal endpoint API operations on a directory bucket. AReadOnly
session is constrained to execute the following Zonal endpoint API operations:GetObject
,HeadObject
,ListObjectsV2
,GetObjectAttributes
,ListParts
, andListMultipartUploads
.
Result Syntax
[ 'BucketKeyEnabled' => true || false, 'Credentials' => [ 'AccessKeyId' => '<string>', 'Expiration' => <DateTime>, 'SecretAccessKey' => '<string>', 'SessionToken' => '<string>', ], 'SSEKMSEncryptionContext' => '<string>', 'SSEKMSKeyId' => '<string>', 'ServerSideEncryption' => 'AES256|aws:kms|aws:kms:dsse', ]
Result Details
Members
- BucketKeyEnabled
-
- Type: boolean
Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).
- Credentials
-
- Required: Yes
- Type: SessionCredentials structure
The established temporary security credentials for the created session.
- SSEKMSEncryptionContext
-
- Type: string
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. - SSEKMSKeyId
-
- Type: string
If you specify
x-amz-server-side-encryption
withaws:kms
, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption. - ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when you store objects in the directory bucket.
Errors
- NoSuchBucket:
The specified bucket does not exist.
DeleteBucket
$result = $client->deleteBucket
([/* ... */]); $promise = $client->deleteBucketAsync
([/* ... */]);
Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
-
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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to DeleteBucket
:
Parameter Syntax
$result = $client->deleteBucket([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
Specifies the bucket being deleted.
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 formatbucket-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 - ExpectedBucketOwner
-
- Type: string
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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete a bucket
The following example deletes the specified bucket.
$result = $client->deleteBucket([ 'Bucket' => 'forrandall2', ]);
DeleteBucketAnalyticsConfiguration
$result = $client->deleteBucketAnalyticsConfiguration
([/* ... */]); $promise = $client->deleteBucketAnalyticsConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteBucketAnalyticsConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket from which an analytics configuration is deleted.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID that identifies the analytics configuration.
Result Syntax
[]
Result Details
Errors
There 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
- Bucket
-
- Required: Yes
- Type: string
Specifies the bucket whose
cors
configuration is being deleted. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete cors configuration on a bucket.
The following example deletes CORS configuration on a bucket.
$result = $client->deleteBucketCors([ 'Bucket' => 'examplebucket', ]);
DeleteBucketEncryption
$result = $client->deleteBucketEncryption
([/* ... */]); $promise = $client->deleteBucketEncryptionAsync
([/* ... */]);
This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).
-
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.
- Permissions
-
-
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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to DeleteBucketEncryption
:
Parameter Syntax
$result = $client->deleteBucketEncryption([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the server-side encryption configuration to delete.
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 formatbucket-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 - ExpectedBucketOwner
-
- Type: string
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 Syntax
[]
Result Details
Errors
There 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:
Parameter Syntax
$result = $client->deleteBucketIntelligentTieringConfiguration([ 'Bucket' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
- Id
-
- Required: Yes
- Type: string
The ID used to identify the S3 Intelligent-Tiering configuration.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteBucketInventoryConfiguration
$result = $client->deleteBucketInventoryConfiguration
([/* ... */]); $promise = $client->deleteBucketInventoryConfigurationAsync
([/* ... */]);
This operation is not supported for directory buckets.
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to DeleteBucketInventoryConfiguration
include:
Parameter Syntax
$result = $client->deleteBucketInventoryConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the inventory configuration to delete.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID used to identify the inventory configuration.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
DeleteBucketLifecycle
$result = $client->deleteBucketLifecycle
([/* ... */]); $promise = $client->deleteBucketLifecycleAsync
([/* ... */]);
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
- Permissions
-
-
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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
-
- HTTP Host header syntax
-
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
- Bucket
-
- Required: Yes
- Type: string
The bucket name of the lifecycle to delete.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete lifecycle configuration on a bucket.
The following example deletes lifecycle configuration on a bucket.
$result = $client->deleteBucketLifecycle([ 'Bucket' => 'examplebucket', ]);
DeleteBucketMetricsConfiguration
$result = $client->deleteBucketMetricsConfiguration
([/* ... */]); $promise = $client->deleteBucketMetricsConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteBucketMetricsConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the metrics configuration to delete.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
Result Syntax
[]
Result Details
Errors
There 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
:
Parameter Syntax
$result = $client->deleteBucketOwnershipControls([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The Amazon S3 bucket whose
OwnershipControls
you want to delete. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There 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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
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 a403 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 a405 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
, andDeleteBucketPolicy
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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to DeleteBucketPolicy
Parameter Syntax
$result = $client->deleteBucketPolicy([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name.
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 formatbucket-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 - ExpectedBucketOwner
-
- Type: string
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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete bucket policy
The following example deletes bucket policy on the specified bucket.
$result = $client->deleteBucketPolicy([ 'Bucket' => 'examplebucket', ]);
DeleteBucketReplication
$result = $client->deleteBucketReplication
([/* ... */]); $promise = $client->deleteBucketReplicationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteBucketReplication([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete bucket replication configuration
The following example deletes replication configuration set on bucket.
$result = $client->deleteBucketReplication([ 'Bucket' => 'example', ]);
DeleteBucketTagging
$result = $client->deleteBucketTagging
([/* ... */]); $promise = $client->deleteBucketTaggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->deleteBucketTagging([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket that has the tag set to be removed.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete bucket tags
The following example deletes bucket tags.
$result = $client->deleteBucketTagging([ 'Bucket' => 'examplebucket', ]);
DeleteBucketWebsite
$result = $client->deleteBucketWebsite
([/* ... */]); $promise = $client->deleteBucketWebsiteAsync
([/* ... */]);
This 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
:
Parameter Syntax
$result = $client->deleteBucketWebsite([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name for which you want to remove the website configuration.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To delete bucket website configuration
The following example deletes bucket website configuration.
$result = $client->deleteBucketWebsite([ 'Bucket' => 'examplebucket', ]);
DeleteObject
$result = $client->deleteObject
([/* ... */]); $promise = $client->deleteObjectAsync
([/* ... */]);
Removes 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 nullversionId
, and all versions of the object have aversionId
, Amazon S3 does not remove the object and only inserts a delete marker. To permanently delete an object that has aversionId
, you must include the object’sversionId
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 specifynull
to theversionId
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://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 Available Local Zone for directory buckets 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.
- Permissions
-
-
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 thes3:DeleteObject
permission. -
s3:DeleteObjectVersion
- To delete a specific version of an object from a versioning-enabled bucket, you must have thes3: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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following action is related to DeleteObject
:
Parameter Syntax
$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
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - BypassGovernanceRetention
-
- Type: boolean
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the
s3:BypassGovernanceRetention
permission.This functionality is not supported for directory buckets.
- ExpectedBucketOwner
-
- Type: string
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). - IfMatch
-
- Type: string
The
If-Match
header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a412 Precondition Failed
error. If the ETag matches or if the object doesn't exist, the operation will return a204 Success (No Content) response
.For more information about conditional requests, see RFC 7232.
This functionality is only supported for directory buckets.
- IfMatchLastModifiedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If present, the object is deleted only if its modification times matches the provided
Timestamp
. If theTimestamp
values do not match, the operation returns a412 Precondition Failed
error. If theTimestamp
matches or if the object doesn’t exist, the operation returns a204 Success (No Content)
response.This functionality is only supported for directory buckets.
- IfMatchSize
-
- Type: long (int|float)
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 a412 Precondition Failed
error. If theSize
matches or if the object doesn’t exist, the operation returns a204 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
andx-amz-if-match-size
conditional headers in conjunction with each-other or individually. - Key
-
- Required: Yes
- Type: string
Key name of the object to delete.
- MFA
-
- Type: string
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
This functionality is not supported for directory buckets.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- VersionId
-
- Type: string
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.
Result Syntax
[ 'DeleteMarker' => true || false, 'RequestCharged' => 'requester', 'VersionId' => '<string>', ]
Result Details
Members
- DeleteMarker
-
- Type: boolean
Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.
This functionality is not supported for directory buckets.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- VersionId
-
- Type: string
Returns the version ID of the delete marker created as a result of the DELETE operation.
This functionality is not supported for directory buckets.
Errors
There are no errors described for this operation.
Examples
Example 1: To delete an object
The following example deletes an object from an S3 bucket.
$result = $client->deleteObject([ 'Bucket' => 'examplebucket', 'Key' => 'objectkey.jpg', ]);
Result syntax:
[ ]
Example 2: 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', ]);
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
:
Parameter Syntax
$result = $client->deleteObjectTagging([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name containing the objects from which to remove the tags.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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 Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Key
-
- Required: Yes
- Type: string
The key that identifies the object in the bucket from which to remove all tags.
- VersionId
-
- Type: string
The versionId of the object that the tag-set will be removed from.
Result Syntax
[ 'VersionId' => '<string>', ]
Result Details
Members
- VersionId
-
- Type: string
The versionId of the object the tag-set was removed from.
Errors
There are no errors described for this operation.
Examples
Example 1: To remove tag set from an object
The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.
$result = $client->deleteObjectTagging([ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ]);
Result syntax:
[ 'VersionId' => 'null', ]
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 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
-
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://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 Available Local Zone for directory buckets 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.
- Permissions
-
-
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 thes3:DeleteObject
permission. -
s3:DeleteObjectVersion
- To delete a specific version of an object from a versioning-enabled bucket, you must specify thes3: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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- Content-MD5 request header
-
-
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
, orx-amz-checksum-sha256
) is required for all Multi-Object Delete requests.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following operations are related to DeleteObjects
:
Parameter Syntax
$result = $client->deleteObjects([ 'Bucket' => '<string>', // REQUIRED 'BypassGovernanceRetention' => true || false, 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'Delete' => [ // REQUIRED 'Objects' => [ // REQUIRED [ '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
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - BypassGovernanceRetention
-
- Type: boolean
Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the
s3:BypassGovernanceRetention
permission.This functionality is not supported for directory buckets.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
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 throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter. - Delete
-
- Required: Yes
- Type: Delete structure
Container for the request.
- ExpectedBucketOwner
-
- Type: string
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). - MFA
-
- Type: string
The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
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.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
Result Syntax
[ 'Deleted' => [ [ 'DeleteMarker' => true || false, 'DeleteMarkerVersionId' => '<string>', 'Key' => '<string>', 'VersionId' => '<string>', ], // ... ], 'Errors' => [ [ 'Code' => '<string>', 'Key' => '<string>', 'Message' => '<string>', 'VersionId' => '<string>', ], // ... ], 'RequestCharged' => 'requester', ]
Result Details
Members
- Deleted
-
- Type: Array of DeletedObject structures
Container element for a successful delete. It identifies the object that was successfully deleted.
- Errors
-
- Type: Array of Error structures
Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Errors
There are no errors described for this operation.
Examples
Example 1: To delete multiple objects from a versioned bucket
The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.
$result = $client->deleteObjects([ 'Bucket' => 'examplebucket', 'Delete' => [ 'Objects' => [ [ 'Key' => 'objectkey1', ], [ 'Key' => 'objectkey2', ], ], 'Quiet' => , ], ]);
Result syntax:
[ 'Deleted' => [ [ 'DeleteMarker' => true, 'DeleteMarkerVersionId' => 'A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F', 'Key' => 'objectkey1', ], [ 'DeleteMarker' => true, 'DeleteMarkerVersionId' => 'iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt', 'Key' => 'objectkey2', ], ], ]
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
:
Parameter Syntax
$result = $client->deletePublicAccessBlock([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The Amazon S3 bucket whose
PublicAccessBlock
configuration you want to delete. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There 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
:
Parameter Syntax
$result = $client->getBucketAccelerateConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'RequestPayer' => 'requester', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which the accelerate configuration is retrieved.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
Result Syntax
[ 'RequestCharged' => 'requester', 'Status' => 'Enabled|Suspended', ]
Result Details
Members
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- Status
-
- Type: string
The accelerate configuration of the bucket.
Errors
There are no errors described for this operation.
GetBucketAcl
$result = $client->getBucketAcl
([/* ... */]); $promise = $client->getBucketAclAsync
([/* ... */]);
This 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
:
Parameter Syntax
$result = $client->getBucketAcl([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
Specifies the S3 bucket whose ACL is being requested.
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 aboutInvalidAccessPointAliasError
, see List of Error Codes. - ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'EmailAddress' => '<string>', 'ID' => '<string>', 'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', 'URI' => '<string>', ], 'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP', ], // ... ], 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], ]
Result Details
Members
Errors
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
:
Parameter Syntax
$result = $client->getBucketAnalyticsConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket from which an analytics configuration is retrieved.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID that identifies the analytics configuration.
Result Syntax
[ 'AnalyticsConfiguration' => [ 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'Id' => '<string>', 'StorageClassAnalysis' => [ 'DataExport' => [ 'Destination' => [ 'S3BucketDestination' => [ 'Bucket' => '<string>', 'BucketAccountId' => '<string>', 'Format' => 'CSV', 'Prefix' => '<string>', ], ], 'OutputSchemaVersion' => 'V_1', ], ], ], ]
Result Details
Members
- AnalyticsConfiguration
-
- Type: AnalyticsConfiguration structure
The configuration and any analyses for the analytics filter.
Errors
There are no errors described for this operation.
GetBucketCors
$result = $client->getBucketCors
([/* ... */]); $promise = $client->getBucketCorsAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketCors([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name for which to get the cors configuration.
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 aboutInvalidAccessPointAliasError
, see List of Error Codes. - ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'CORSRules' => [ [ 'AllowedHeaders' => ['<string>', ...], 'AllowedMethods' => ['<string>', ...], 'AllowedOrigins' => ['<string>', ...], 'ExposeHeaders' => ['<string>', ...], 'ID' => '<string>', 'MaxAgeSeconds' => <integer>, ], // ... ], ]
Result Details
Members
- CORSRules
-
- Type: Array of CORSRule structures
A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
Errors
There are no errors described for this operation.
Examples
Example 1: To get cors configuration set on a bucket
The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.
$result = $client->getBucketCors([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'CORSRules' => [ [ 'AllowedHeaders' => [ 'Authorization', ], 'AllowedMethods' => [ 'GET', ], 'AllowedOrigins' => [ '*', ], 'MaxAgeSeconds' => 3000, ], ], ]
GetBucketEncryption
$result = $client->getBucketEncryption
([/* ... */]); $promise = $client->getBucketEncryptionAsync
([/* ... */]);
Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).
-
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.
- Permissions
-
-
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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to GetBucketEncryption
:
Parameter Syntax
$result = $client->getBucketEncryption([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket from which the server-side encryption configuration is retrieved.
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 formatbucket-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 - ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'ServerSideEncryptionConfiguration' => [ 'Rules' => [ [ 'ApplyServerSideEncryptionByDefault' => [ 'KMSMasterKeyID' => '<string>', 'SSEAlgorithm' => 'AES256|aws:kms|aws:kms:dsse', ], 'BucketKeyEnabled' => true || false, ], // ... ], ], ]
Result Details
Members
- ServerSideEncryptionConfiguration
-
- Type: ServerSideEncryptionConfiguration structure
Specifies the default server-side-encryption configuration.
Errors
There are no errors described for this operation.
GetBucketIntelligentTieringConfiguration
$result = $client->getBucketIntelligentTieringConfiguration
([/* ... */]); $promise = $client->getBucketIntelligentTieringConfigurationAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->getBucketIntelligentTieringConfiguration([ 'Bucket' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
- Id
-
- Required: Yes
- Type: string
The ID used to identify the S3 Intelligent-Tiering configuration.
Result Syntax
[ 'IntelligentTieringConfiguration' => [ 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'Id' => '<string>', 'Status' => 'Enabled|Disabled', 'Tierings' => [ [ 'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS', 'Days' => <integer>, ], // ... ], ], ]
Result Details
Members
- IntelligentTieringConfiguration
-
- Type: IntelligentTieringConfiguration structure
Container for S3 Intelligent-Tiering configuration.
Errors
There are no errors described for this operation.
GetBucketInventoryConfiguration
$result = $client->getBucketInventoryConfiguration
([/* ... */]); $promise = $client->getBucketInventoryConfigurationAsync
([/* ... */]);
This operation is not supported for directory buckets.
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to GetBucketInventoryConfiguration
:
Parameter Syntax
$result = $client->getBucketInventoryConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the inventory configuration to retrieve.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID used to identify the inventory configuration.
Result Syntax
[ 'InventoryConfiguration' => [ 'Destination' => [ 'S3BucketDestination' => [ 'AccountId' => '<string>', 'Bucket' => '<string>', 'Encryption' => [ 'SSEKMS' => [ 'KeyId' => '<string>', ], 'SSES3' => [ ], ], 'Format' => 'CSV|ORC|Parquet', 'Prefix' => '<string>', ], ], 'Filter' => [ 'Prefix' => '<string>', ], 'Id' => '<string>', 'IncludedObjectVersions' => 'All|Current', 'IsEnabled' => true || false, 'OptionalFields' => ['<string>', ...], 'Schedule' => [ 'Frequency' => 'Daily|Weekly', ], ], ]
Result Details
Members
- InventoryConfiguration
-
- Type: InventoryConfiguration structure
Specifies the inventory configuration.
Errors
There are no errors described for this operation.
GetBucketLifecycle
$result = $client->getBucketLifecycle
([/* ... */]); $promise = $client->getBucketLifecycleAsync
([/* ... */]);
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the This operation is not supported for directory buckets.filter
element, you should see the updated version of this topic. This topic is provided for backward compatibility.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
GetBucketLifecycle
has the following special error:
-
Error code:
NoSuchLifecycleConfiguration
-
Description: The lifecycle configuration does not exist.
-
HTTP Status Code: 404 Not Found
-
SOAP Fault Code Prefix: Client
-
The following operations are related to GetBucketLifecycle
:
Parameter Syntax
$result = $client->getBucketLifecycle([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the lifecycle information.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'Rules' => [ [ 'AbortIncompleteMultipartUpload' => [ 'DaysAfterInitiation' => <integer>, ], 'Expiration' => [ 'Date' => <DateTime>, 'Days' => <integer>, 'ExpiredObjectDeleteMarker' => true || false, ], 'ID' => '<string>', 'NoncurrentVersionExpiration' => [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, ], 'NoncurrentVersionTransition' => [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], 'Prefix' => '<string>', 'Status' => 'Enabled|Disabled', 'Transition' => [ 'Date' => <DateTime>, 'Days' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], ], // ... ], ]
Result Details
Members
- Rules
-
- Type: Array of Rule structures
Container for a lifecycle rule.
Errors
There are no errors described for this operation.
Examples
Example 1: To get a bucket acl
The following example gets ACL on the specified bucket.
$result = $client->getBucketLifecycle([ 'Bucket' => 'acl1', ]);
Result syntax:
[ 'Rules' => [ [ 'Expiration' => [ 'Days' => 1, ], 'ID' => 'delete logs', 'Prefix' => '123/', 'Status' => 'Enabled', ], ], ]
GetBucketLifecycleConfiguration
$result = $client->getBucketLifecycleConfiguration
([/* ... */]); $promise = $client->getBucketLifecycleConfigurationAsync
([/* ... */]);
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.
- Permissions
-
-
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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
-
- HTTP Host header syntax
-
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
:
Parameter Syntax
$result = $client->getBucketLifecycleConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the lifecycle information.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'Rules' => [ [ 'AbortIncompleteMultipartUpload' => [ 'DaysAfterInitiation' => <integer>, ], 'Expiration' => [ 'Date' => <DateTime>, 'Days' => <integer>, 'ExpiredObjectDeleteMarker' => true || false, ], 'Filter' => [ 'And' => [ 'ObjectSizeGreaterThan' => <integer>, 'ObjectSizeLessThan' => <integer>, 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'ObjectSizeGreaterThan' => <integer>, 'ObjectSizeLessThan' => <integer>, 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'ID' => '<string>', 'NoncurrentVersionExpiration' => [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, ], 'NoncurrentVersionTransitions' => [ [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], // ... ], 'Prefix' => '<string>', 'Status' => 'Enabled|Disabled', 'Transitions' => [ [ 'Date' => <DateTime>, 'Days' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], // ... ], ], // ... ], 'TransitionDefaultMinimumObjectSize' => 'varies_by_storage_class|all_storage_classes_128K', ]
Result Details
Members
- Rules
-
- Type: Array of LifecycleRule structures
Container for a lifecycle rule.
- TransitionDefaultMinimumObjectSize
-
- Type: string
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
orObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Errors
There are no errors described for this operation.
Examples
Example 1: To get lifecycle configuration on a bucket
The following example retrieves lifecycle configuration on set on a bucket.
$result = $client->getBucketLifecycleConfiguration([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'Rules' => [ [ 'ID' => 'Rule for TaxDocs/', 'Prefix' => 'TaxDocs', 'Status' => 'Enabled', 'Transitions' => [ [ 'Days' => 365, 'StorageClass' => 'STANDARD_IA', ], ], ], ], ]
GetBucketLocation
$result = $client->getBucketLocation
([/* ... */]); $promise = $client->getBucketLocationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketLocation([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the location.
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 aboutInvalidAccessPointAliasError
, see List of Error Codes. - ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'LocationConstraint' => 'ap-northeast-1|ap-southeast-2|ap-southeast-1|cn-north-1|eu-central-1|eu-west-1|us-east-1|us-west-1|us-west-2|sa-east-1', ]
Result Details
Members
- LocationConstraint
-
- Type: string
Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region
us-east-1
have a LocationConstraint ofnull
.
Errors
There are no errors described for this operation.
Examples
Example 1: To get bucket location
The following example returns bucket location.
$result = $client->getBucketLocation([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'LocationConstraint' => 'us-west-2', ]
GetBucketLogging
$result = $client->getBucketLogging
([/* ... */]); $promise = $client->getBucketLoggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketLogging([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name for which to get the logging information.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ '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
- LoggingEnabled
-
- Type: LoggingEnabled structure
Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.
Errors
There are no errors described for this operation.
GetBucketMetricsConfiguration
$result = $client->getBucketMetricsConfiguration
([/* ... */]); $promise = $client->getBucketMetricsConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketMetricsConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the metrics configuration to retrieve.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
Result Syntax
[ 'MetricsConfiguration' => [ 'Filter' => [ 'AccessPointArn' => '<string>', 'And' => [ 'AccessPointArn' => '<string>', 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'Id' => '<string>', ], ]
Result Details
Members
- MetricsConfiguration
-
- Type: MetricsConfiguration structure
Specifies the metrics configuration.
Errors
There are no errors described for this operation.
GetBucketNotification
$result = $client->getBucketNotification
([/* ... */]); $promise = $client->getBucketNotificationAsync
([/* ... */]);
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
- Bucket
-
- Required: Yes
- Type: string
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 aboutInvalidAccessPointAliasError
, see List of Error Codes. - ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'CloudFunctionConfiguration' => [ 'CloudFunction' => '<string>', 'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete', 'Events' => ['<string>', ...], 'Id' => '<string>', 'InvocationRole' => '<string>', ], 'QueueConfiguration' => [ 'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete', 'Events' => ['<string>', ...], 'Id' => '<string>', 'Queue' => '<string>', ], 'TopicConfiguration' => [ 'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete', 'Events' => ['<string>', ...], 'Id' => '<string>', 'Topic' => '<string>', ], ]
Result Details
Members
- CloudFunctionConfiguration
-
- Type: CloudFunctionConfiguration structure
Container for specifying the Lambda notification configuration.
- QueueConfiguration
-
- Type: QueueConfigurationDeprecated structure
This data type is deprecated. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
- TopicConfiguration
-
- Type: TopicConfigurationDeprecated structure
This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
Errors
There are no errors described for this operation.
Examples
Example 1: To get notification configuration set on a bucket
The following example returns notification configuration set on a bucket.
$result = $client->getBucketNotification([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'QueueConfiguration' => [ 'Event' => 's3:ObjectCreated:Put', 'Events' => [ 's3:ObjectCreated:Put', ], 'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx', 'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue', ], 'TopicConfiguration' => [ 'Event' => 's3:ObjectCreated:Copy', 'Events' => [ 's3:ObjectCreated:Copy', ], 'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi', 'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic', ], ]
Example 2: To get notification configuration set on a bucket
The following example returns notification configuration set on a bucket.
$result = $client->getBucketNotification([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'QueueConfiguration' => [ 'Event' => 's3:ObjectCreated:Put', 'Events' => [ 's3:ObjectCreated:Put', ], 'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx', 'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue', ], 'TopicConfiguration' => [ 'Event' => 's3:ObjectCreated:Copy', 'Events' => [ 's3:ObjectCreated:Copy', ], 'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi', 'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic', ], ]
GetBucketNotificationConfiguration
$result = $client->getBucketNotificationConfiguration
([/* ... */]); $promise = $client->getBucketNotificationConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketNotificationConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the notification configuration.
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 aboutInvalidAccessPointAliasError
, see List of Error Codes. - ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'EventBridgeConfiguration' => [ ], 'LambdaFunctionConfigurations' => [ [ 'Events' => ['<string>', ...], 'Filter' => [ 'Key' => [ 'FilterRules' => [ [ 'Name' => 'prefix|suffix', 'Value' => '<string>', ], // ... ], ], ], 'Id' => '<string>', 'LambdaFunctionArn' => '<string>', ], // ... ], 'QueueConfigurations' => [ [ 'Events' => ['<string>', ...], 'Filter' => [ 'Key' => [ 'FilterRules' => [ [ 'Name' => 'prefix|suffix', 'Value' => '<string>', ], // ... ], ], ], 'Id' => '<string>', 'QueueArn' => '<string>', ], // ... ], 'TopicConfigurations' => [ [ 'Events' => ['<string>', ...], 'Filter' => [ 'Key' => [ 'FilterRules' => [ [ 'Name' => 'prefix|suffix', 'Value' => '<string>', ], // ... ], ], ], 'Id' => '<string>', 'TopicArn' => '<string>', ], // ... ], ]
Result Details
Members
- EventBridgeConfiguration
-
- Type: EventBridgeConfiguration structure
Enables delivery of events to Amazon EventBridge.
- LambdaFunctionConfigurations
-
- Type: Array of LambdaFunctionConfiguration structures
Describes the Lambda functions to invoke and the events for which to invoke them.
- QueueConfigurations
-
- Type: Array of QueueConfiguration structures
The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
- TopicConfigurations
-
- Type: Array of TopicConfiguration structures
The topic to which notifications are sent and the events for which notifications are generated.
Errors
There are no errors described for this operation.
GetBucketOwnershipControls
$result = $client->getBucketOwnershipControls
([/* ... */]); $promise = $client->getBucketOwnershipControlsAsync
([/* ... */]);
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.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to GetBucketOwnershipControls
:
Parameter Syntax
$result = $client->getBucketOwnershipControls([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose
OwnershipControls
you want to retrieve. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'OwnershipControls' => [ 'Rules' => [ [ 'ObjectOwnership' => 'BucketOwnerPreferred|ObjectWriter|BucketOwnerEnforced', ], // ... ], ], ]
Result Details
Members
- OwnershipControls
-
- Type: OwnershipControls structure
The
OwnershipControls
(BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.
Errors
There are no errors described for this operation.
GetBucketPolicy
$result = $client->getBucketPolicy
([/* ... */]); $promise = $client->getBucketPolicyAsync
([/* ... */]);
Returns the policy of a specified bucket.
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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
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 a403 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 a405 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
, andDeleteBucketPolicy
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.
-
- Example bucket policies
-
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.
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following action is related to GetBucketPolicy
:
Parameter Syntax
$result = $client->getBucketPolicy([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 GuideAccess 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 aboutInvalidAccessPointAliasError
, see List of Error Codes.Access points and Object Lambda access points are not supported by directory buckets.
- ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'Policy' => '<string>', ]
Result Details
Members
- Policy
-
- Type: string
The bucket policy as a JSON document.
Errors
There are no errors described for this operation.
Examples
Example 1: To get bucket policy
The following example returns bucket policy associated with a bucket.
$result = $client->getBucketPolicy([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'Policy' => '{"Version":"2008-10-17","Id":"LogPolicy","Statement":[{"Sid":"Enables the log delivery group to publish logs to your bucket ","Effect":"Allow","Principal":{"AWS":"111122223333"},"Action":["s3:GetBucketAcl","s3:GetObjectAcl","s3:PutObject"],"Resource":["arn:aws:s3:::policytest1/*","arn:aws:s3:::policytest1"]}]}', ]
GetBucketPolicyStatus
$result = $client->getBucketPolicyStatus
([/* ... */]); $promise = $client->getBucketPolicyStatusAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketPolicyStatus([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose policy status you want to retrieve.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'PolicyStatus' => [ 'IsPublic' => true || false, ], ]
Result Details
Members
- PolicyStatus
-
- Type: PolicyStatus structure
The policy status for the specified bucket.
Errors
There are no errors described for this operation.
GetBucketReplication
$result = $client->getBucketReplication
([/* ... */]); $promise = $client->getBucketReplicationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketReplication([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name for which to get the replication information.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'ReplicationConfiguration' => [ 'Role' => '<string>', 'Rules' => [ [ 'DeleteMarkerReplication' => [ 'Status' => 'Enabled|Disabled', ], 'Destination' => [ 'AccessControlTranslation' => [ 'Owner' => 'Destination', ], 'Account' => '<string>', 'Bucket' => '<string>', 'EncryptionConfiguration' => [ 'ReplicaKmsKeyID' => '<string>', ], 'Metrics' => [ 'EventThreshold' => [ 'Minutes' => <integer>, ], 'Status' => 'Enabled|Disabled', ], 'ReplicationTime' => [ 'Status' => 'Enabled|Disabled', 'Time' => [ 'Minutes' => <integer>, ], ], 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', ], 'ExistingObjectReplication' => [ 'Status' => 'Enabled|Disabled', ], 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'ID' => '<string>', 'Prefix' => '<string>', 'Priority' => <integer>, 'SourceSelectionCriteria' => [ 'ReplicaModifications' => [ 'Status' => 'Enabled|Disabled', ], 'SseKmsEncryptedObjects' => [ 'Status' => 'Enabled|Disabled', ], ], 'Status' => 'Enabled|Disabled', ], // ... ], ], ]
Result Details
Members
- ReplicationConfiguration
-
- Type: ReplicationConfiguration structure
A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.
Errors
There are no errors described for this operation.
Examples
Example 1: To get replication configuration set on a bucket
The following example returns replication configuration set on a bucket.
$result = $client->getBucketReplication([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'ReplicationConfiguration' => [ 'Role' => 'arn:aws:iam::acct-id:role/example-role', 'Rules' => [ [ 'Destination' => [ 'Bucket' => 'arn:aws:s3:::destination-bucket', ], 'ID' => 'MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy', 'Prefix' => 'Tax', 'Status' => 'Enabled', ], ], ], ]
GetBucketRequestPayment
$result = $client->getBucketRequestPayment
([/* ... */]); $promise = $client->getBucketRequestPaymentAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketRequestPayment([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the payment request configuration
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'Payer' => 'Requester|BucketOwner', ]
Result Details
Members
- Payer
-
- Type: string
Specifies who pays for the download and request fees.
Errors
There are no errors described for this operation.
Examples
Example 1: To get bucket versioning configuration
The following example retrieves bucket versioning configuration.
$result = $client->getBucketRequestPayment([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'Payer' => 'BucketOwner', ]
GetBucketTagging
$result = $client->getBucketTagging
([/* ... */]); $promise = $client->getBucketTaggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketTagging([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the tagging information.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'TagSet' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ]
Result Details
Members
- TagSet
-
- Required: Yes
- Type: Array of Tag structures
Contains the tag set.
Errors
There are no errors described for this operation.
Examples
Example 1: To get tag set associated with a bucket
The following example returns tag set associated with a bucket
$result = $client->getBucketTagging([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'TagSet' => [ [ 'Key' => 'key1', 'Value' => 'value1', ], [ 'Key' => 'key2', 'Value' => 'value2', ], ], ]
GetBucketVersioning
$result = $client->getBucketVersioning
([/* ... */]); $promise = $client->getBucketVersioningAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketVersioning([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to get the versioning information.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'MFADelete' => 'Enabled|Disabled', 'Status' => 'Enabled|Suspended', ]
Result Details
Members
- MFADelete
-
- Type: string
Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
- Status
-
- Type: string
The versioning state of the bucket.
Errors
There are no errors described for this operation.
Examples
Example 1: To get bucket versioning configuration
The following example retrieves bucket versioning configuration.
$result = $client->getBucketVersioning([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'MFADelete' => 'Disabled', 'Status' => 'Enabled', ]
GetBucketWebsite
$result = $client->getBucketWebsite
([/* ... */]); $promise = $client->getBucketWebsiteAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getBucketWebsite([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name for which to get the website configuration.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'ErrorDocument' => [ 'Key' => '<string>', ], 'IndexDocument' => [ 'Suffix' => '<string>', ], 'RedirectAllRequestsTo' => [ 'HostName' => '<string>', 'Protocol' => 'http|https', ], 'RoutingRules' => [ [ 'Condition' => [ 'HttpErrorCodeReturnedEquals' => '<string>', 'KeyPrefixEquals' => '<string>', ], 'Redirect' => [ 'HostName' => '<string>', 'HttpRedirectCode' => '<string>', 'Protocol' => 'http|https', 'ReplaceKeyPrefixWith' => '<string>', 'ReplaceKeyWith' => '<string>', ], ], // ... ], ]
Result Details
Members
- ErrorDocument
-
- Type: ErrorDocument structure
The object key name of the website error document to use for 4XX class errors.
- IndexDocument
-
- Type: IndexDocument structure
The name of the index document for the website (for example
index.html
). - RedirectAllRequestsTo
-
- Type: RedirectAllRequestsTo structure
Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
- RoutingRules
-
- Type: Array of RoutingRule structures
Rules that define when a redirect is applied and the redirect behavior.
Errors
There are no errors described for this operation.
Examples
Example 1: To get bucket website configuration
The following example retrieves website configuration of a bucket.
$result = $client->getBucketWebsite([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'ErrorDocument' => [ 'Key' => 'error.html', ], 'IndexDocument' => [ 'Suffix' => 'index.html', ], ]
GetObject
$result = $client->getObject
([/* ... */]); $promise = $client->getObjectAsync
([/* ... */]);
Retrieves 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 examplebucket--use1-az5--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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
General purpose bucket permissions - You must have the required permissions in a policy. To use
GetObject
, you must have theREAD
access to the object (or version). If you grantREAD
access to the anonymous user, theGetObject
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 thes3:GetObjectVersion
permission to access a specific version of an object. Thes3: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 thes3:GetObject
permission is required. Thes3: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 code404 Not Found
error. -
If you don’t have the
s3:ListBucket
permission, Amazon S3 returns an HTTP status code403 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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.If the object is encrypted using SSE-KMS, you must also have the
kms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
-
- Storage classes
-
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 - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code
400 Bad Request
. - Encryption
-
Encryption request headers, like
x-amz-server-side-encryption
, should not be sent for theGetObject
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 yourGetObject
requests for the object that uses these types of keys, you’ll get an HTTP400 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.
- Overriding response header values through the request
-
There are times when you want to override certain response header values of a
GetObject
response. For example, you might override theContent-Disposition
response header value through yourGetObject
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 areCache-Control
,Content-Disposition
,Content-Encoding
,Content-Language
,Content-Type
, andExpires
.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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following operations are related to GetObject
:
Parameter Syntax
$result = $client->getObject([ 'Bucket' => '<string>', // REQUIRED 'ChecksumMode' => 'ENABLED', 'ExpectedBucketOwner' => '<string>', 'IfMatch' => '<string>', 'IfModifiedSince' => <integer || string || DateTime>, 'IfNoneMatch' => '<string>', 'IfUnmodifiedSince' => <integer || string || DateTime>, 'Key' => '<string>', // REQUIRED 'PartNumber' => <integer>, 'Range' => '<string>', 'RequestPayer' => 'requester', 'ResponseCacheControl' => '<string>', 'ResponseContentDisposition' => '<string>', 'ResponseContentEncoding' => '<string>', 'ResponseContentLanguage' => '<string>', 'ResponseContentType' => '<string>', 'ResponseExpires' => <integer || string || DateTime>, 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKey' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'SaveAs' => '<string>', 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name containing the object.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ChecksumMode
-
- Type: string
To retrieve the checksum, this mode must be enabled.
General purpose buckets - In addition, 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. - ExpectedBucketOwner
-
- Type: string
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). - IfMatch
-
- Type: string
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
andIf-Unmodified-Since
headers are present in the request as follows:If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
; then, S3 returns200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
- IfModifiedSince
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Return the object only if it has been modified since the specified time; otherwise, return a
304 Not Modified
error.If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
; then, S3 returns304 Not Modified
status code.For more information about conditional requests, see RFC 7232.
- IfNoneMatch
-
- Type: string
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
andIf-Modified-Since
headers are present in the request as follows:If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
; then, S3 returns304 Not Modified
HTTP status code.For more information about conditional requests, see RFC 7232.
- IfUnmodifiedSince
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Return the object only if it has not been modified since the specified time; otherwise, return a
412 Precondition Failed
error.If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
; then, S3 returns200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
- Key
-
- Required: Yes
- Type: string
Key of the object to get.
- PartNumber
-
- Type: int
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
- Range
-
- Type: string
Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.
Amazon S3 doesn't support retrieving multiple ranges of data per
GET
request. - RequestPayer
-
- Type: string
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.
- ResponseCacheControl
-
- Type: string
Sets the
Cache-Control
header of the response. - ResponseContentDisposition
-
- Type: string
Sets the
Content-Disposition
header of the response. - ResponseContentEncoding
-
- Type: string
Sets the
Content-Encoding
header of the response. - ResponseContentLanguage
-
- Type: string
Sets the
Content-Language
header of the response. - ResponseContentType
-
- Type: string
Sets the
Content-Type
header of the response. - ResponseExpires
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Sets the
Expires
header of the response. - SSECustomerAlgorithm
-
- Type: string
Specifies the algorithm to use 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.
- SSECustomerKey
-
- Type: string
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. - SSECustomerKeyMD5
-
- Type: string
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.
- SaveAs
-
- Type: string
The path to a file on disk to save the object data. - VersionId
-
- Type: string
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 theversionId
subresource.-
If you include a
versionId
in your request header, you must have thes3:GetObjectVersion
permission to access a specific version of an object. Thes3: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 thes3:GetObject
permission is required. Thes3: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 specifynull
to theversionId
query parameter in the request.
For more information about versioning, see PutBucketVersioning.
Result Syntax
[ 'AcceptRanges' => '<string>', 'Body' => <string || resource || Psr\Http\Message\StreamInterface>, 'BucketKeyEnabled' => true || false, 'CacheControl' => '<string>', 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ContentDisposition' => '<string>', 'ContentEncoding' => '<string>', 'ContentLanguage' => '<string>', 'ContentLength' => <integer>, 'ContentRange' => '<string>', 'ContentType' => '<string>', 'DeleteMarker' => true || false, 'ETag' => '<string>', 'Expiration' => '<string>', 'Expires' => <DateTime>, '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:kms|aws:kms:dsse', 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'TagCount' => <integer>, 'VersionId' => '<string>', 'WebsiteRedirectLocation' => '<string>', ]
Result Details
Members
- AcceptRanges
-
- Type: string
Indicates that a range of bytes was specified in the request.
- Body
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
Object data.
- BucketKeyEnabled
-
- Type: boolean
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- CacheControl
-
- Type: string
Specifies caching behavior along the request/reply chain.
- ChecksumCRC32
-
- Type: string
The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ChecksumCRC32C
-
- Type: string
The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ChecksumSHA1
-
- Type: string
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ChecksumSHA256
-
- Type: string
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- ContentDisposition
-
- Type: string
Specifies presentational information for the object.
- ContentEncoding
-
- Type: string
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.
- ContentLanguage
-
- Type: string
The language the content is in.
- ContentLength
-
- Type: long (int|float)
Size of the body in bytes.
- ContentRange
-
- Type: string
The portion of the object returned in the response.
- ContentType
-
- Type: string
A standard MIME type describing the format of the object data.
- DeleteMarker
-
- Type: boolean
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 theLast-Modified: timestamp
response header.
- ETag
-
- Type: string
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- Expiration
-
- Type: string
If the object expiration is configured (see
PutBucketLifecycleConfiguration
), the response includes this header. It includes theexpiry-date
andrule-id
key-value pairs providing object expiration information. The value of therule-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. - Expires
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the object is no longer cacheable.
This output shape has been deprecated. Please refer to
.ExpiresString
instead. - ExpiresString
-
- Type: string
The unparsed string value of theExpires
output member. - LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
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 a405 Method Not Allowed
error and theLast-Modified: timestamp
response header. - Metadata
-
- Type: Associative array of custom strings keys (MetadataKey) to strings
A map of metadata to store with the object in S3.
- MissingMeta
-
- Type: int
This is set to the number of metadata entries not returned in 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.
- ObjectLockLegalHoldStatus
-
- Type: string
Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
This functionality is not supported for directory buckets.
- ObjectLockMode
-
- Type: string
The Object Lock mode that's currently in place for this object.
This functionality is not supported for directory buckets.
- ObjectLockRetainUntilDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when this object's Object Lock will expire.
This functionality is not supported for directory buckets.
- PartsCount
-
- Type: int
The count of parts this object has. This value is only returned if you specify
partNumber
in your request and the object was uploaded as a multipart upload. - ReplicationStatus
-
- Type: string
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
This functionality is not supported for directory buckets.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- Restore
-
- Type: string
Provides information about object restoration action and expiration time of the restored object copy.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- SSECustomerAlgorithm
-
- Type: string
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.
- SSECustomerKeyMD5
-
- Type: string
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.
- SSEKMSKeyId
-
- Type: string
If present, indicates the ID of the KMS key that was used for object encryption.
- ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when you store this object in Amazon S3.
- StorageClass
-
- Type: string
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- TagCount
-
- Type: int
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.
- VersionId
-
- Type: string
Version ID of the object.
This functionality is not supported for directory buckets.
- WebsiteRedirectLocation
-
- Type: string
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
This functionality is not supported for directory buckets.
Errors
- NoSuchKey:
The specified key does not exist.
- InvalidObjectState:
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.
Examples
Example 1: To retrieve a byte range of an object
The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.
$result = $client->getObject([ 'Bucket' => 'examplebucket', 'Key' => 'SampleFile.txt', 'Range' => 'bytes=0-9', ]);
Result syntax:
[ 'AcceptRanges' => 'bytes', 'ContentLength' => 10, 'ContentRange' => 'bytes 0-9/43', 'ContentType' => 'text/plain', 'ETag' => '"0d94420ffd0bc68cd3d152506b97a9cc"', 'LastModified' =>, 'Metadata' => [ ], 'VersionId' => 'null', ]
Example 2: To retrieve an object
The following example retrieves an object for an S3 bucket.
$result = $client->getObject([ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ]);
Result syntax:
[ 'AcceptRanges' => 'bytes', 'ContentLength' => 3191, 'ContentType' => 'image/jpeg', 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' =>, 'Metadata' => [ ], 'TagCount' => 2, 'VersionId' => 'null', ]
Example 3: To get an object via an S3 access point ARN
The following example retrieves an object by referencing the bucket via an S3 accesss point ARN. Result output is simplified for the example.
$result = $client->getObject([ 'Bucket' => 'arn:aws:s3:us-east-1:123456789012:accesspoint:myaccesspoint', 'Key' => 'my-key', ]);
Result syntax:
[ 'Body' => <BLOB>, 'ContentLength' => 11, 'ContentType' => 'application/octet-stream', ]
GetObjectAcl
$result = $client->getObjectAcl
([/* ... */]); $promise = $client->getObjectAclAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getObjectAcl([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'RequestPayer' => 'requester', 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name that contains the object for which to get the ACL information.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
- ExpectedBucketOwner
-
- Type: string
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). - Key
-
- Required: Yes
- Type: string
The key of the object for which to get the ACL information.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- VersionId
-
- Type: string
Version ID used to reference a specific version of the object.
This functionality is not supported for directory buckets.
Result Syntax
[ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'EmailAddress' => '<string>', 'ID' => '<string>', 'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', 'URI' => '<string>', ], 'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP', ], // ... ], 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'RequestCharged' => 'requester', ]
Result Details
Members
- Grants
-
- Type: Array of Grant structures
A list of grants.
- Owner
-
- Type: Owner structure
Container for the bucket owner's display name and ID.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Errors
- NoSuchKey:
The specified key does not exist.
Examples
Example 1: To retrieve object ACL
The following example retrieves access control list (ACL) of an object.
$result = $client->getObjectAcl([ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ]);
Result syntax:
[ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'WRITE', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'WRITE_ACP', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'READ', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => '852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'READ_ACP', ], ], 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], ]
GetObjectAttributes
$result = $client->getObjectAttributes
([/* ... */]); $promise = $client->getObjectAttributesAsync
([/* ... */]);
Retrieves all the metadata from an object without returning the object itself. This 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 each 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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
General purpose bucket permissions - To use
GetObjectAttributes
, you must have READ access to the object. The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both thes3:GetObjectVersion
ands3:GetObjectVersionAttributes
permissions for this operation. If the bucket is not versioned, you need thes3:GetObject
ands3: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 thes3:ListBucket
permission.-
If you have the
s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code404 Not Found
("no such key") error. -
If you don't have the
s3:ListBucket
permission, Amazon S3 returns an HTTP status code403 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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.If the object is encrypted with SSE-KMS, you must also have the
kms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
-
- Encryption
-
Encryption request headers, like
x-amz-server-side-encryption
, should not be sent forHEAD
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). Thex-amz-server-side-encryption
header is used when youPUT
an object to S3 and want to specify the encryption method. If you include this header in aGET
request for an object that uses these types of keys, you’ll get an HTTP400 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 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 yourCreateSession
requests orPUT
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. -
- Versioning
-
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 specifynull
to theversionId
query parameter in the request. - Conditional request headers
-
Consider the following when using request headers:
-
If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows, then Amazon S3 returns the HTTP status code200 OK
and the data requested:-
If-Match
condition evaluates totrue
. -
If-Unmodified-Since
condition evaluates tofalse
.
For more information about conditional requests, see RFC 7232.
-
-
If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows, then Amazon S3 returns the HTTP status code304 Not Modified
:-
If-None-Match
condition evaluates tofalse
. -
If-Modified-Since
condition evaluates totrue
.
For more information about conditional requests, see RFC 7232.
-
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following actions are related to GetObjectAttributes
:
Parameter Syntax
$result = $client->getObjectAttributes([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'MaxParts' => <integer>, 'ObjectAttributes' => ['<string>', ...], // REQUIRED 'PartNumberMarker' => <integer>, 'RequestPayer' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKey' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket that contains the object.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Key
-
- Required: Yes
- Type: string
The object key.
- MaxParts
-
- Type: int
Sets the maximum number of parts to return.
- ObjectAttributes
-
- Required: Yes
- Type: Array of strings
Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.
- PartNumberMarker
-
- Type: int
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
- RequestPayer
-
- Type: string
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.
- SSECustomerAlgorithm
-
- Type: string
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
- SSECustomerKey
-
- Type: string
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf. - SSECustomerKeyMD5
-
- Type: string
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
This functionality is not supported for directory buckets.
- VersionId
-
- Type: string
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 specifynull
to theversionId
query parameter in the request.
Result Syntax
[ 'Checksum' => [ 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', ], 'DeleteMarker' => true || false, 'ETag' => '<string>', 'LastModified' => <DateTime>, 'ObjectParts' => [ 'IsTruncated' => true || false, 'MaxParts' => <integer>, 'NextPartNumberMarker' => <integer>, 'PartNumberMarker' => <integer>, 'Parts' => [ [ 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'PartNumber' => <integer>, 'Size' => <integer>, ], // ... ], 'TotalPartsCount' => <integer>, ], 'ObjectSize' => <integer>, 'RequestCharged' => 'requester', 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'VersionId' => '<string>', ]
Result Details
Members
- Checksum
-
- Type: Checksum structure
The checksum or digest of the object.
- DeleteMarker
-
- Type: boolean
Specifies whether the object retrieved was (
true
) or was not (false
) a delete marker. Iffalse
, this response header does not appear in the response.This functionality is not supported for directory buckets.
- ETag
-
- Type: string
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Date and time when the object was last modified.
- ObjectParts
-
- Type: GetObjectAttributesParts structure
A collection of parts associated with a multipart upload.
- ObjectSize
-
- Type: long (int|float)
The size of the object in bytes.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- StorageClass
-
- Type: string
Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- VersionId
-
- Type: string
The version ID of the object.
This functionality is not supported for directory buckets.
Errors
- NoSuchKey:
The specified key does not exist.
GetObjectLegalHold
$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
:
Parameter Syntax
$result = $client->getObjectLegalHold([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'RequestPayer' => 'requester', 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name containing the object whose legal hold status you want to retrieve.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
- ExpectedBucketOwner
-
- Type: string
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). - Key
-
- Required: Yes
- Type: string
The key name for the object whose legal hold status you want to retrieve.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- VersionId
-
- Type: string
The version ID of the object whose legal hold status you want to retrieve.
Result Syntax
[ 'LegalHold' => [ 'Status' => 'ON|OFF', ], ]
Result Details
Members
- LegalHold
-
- Type: ObjectLockLegalHold structure
The current legal hold status for the specified object.
Errors
There are no errors described for this operation.
GetObjectLockConfiguration
$result = $client->getObjectLockConfiguration
([/* ... */]); $promise = $client->getObjectLockConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getObjectLockConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket whose Object Lock configuration you want to retrieve.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
- ExpectedBucketOwner
-
- Type: string
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 Syntax
[ 'ObjectLockConfiguration' => [ 'ObjectLockEnabled' => 'Enabled', 'Rule' => [ 'DefaultRetention' => [ 'Days' => <integer>, 'Mode' => 'GOVERNANCE|COMPLIANCE', 'Years' => <integer>, ], ], ], ]
Result Details
Members
- ObjectLockConfiguration
-
- Type: ObjectLockConfiguration structure
The specified bucket's Object Lock configuration.
Errors
There are no errors described for this operation.
GetObjectRetention
$result = $client->getObjectRetention
([/* ... */]); $promise = $client->getObjectRetentionAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getObjectRetention([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'RequestPayer' => 'requester', 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name containing the object whose retention settings you want to retrieve.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
- ExpectedBucketOwner
-
- Type: string
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). - Key
-
- Required: Yes
- Type: string
The key name for the object whose retention settings you want to retrieve.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- VersionId
-
- Type: string
The version ID for the object whose retention settings you want to retrieve.
Result Syntax
[ 'Retention' => [ 'Mode' => 'GOVERNANCE|COMPLIANCE', 'RetainUntilDate' => <DateTime>, ], ]
Result Details
Members
- Retention
-
- Type: ObjectLockRetention structure
The container element for an object's retention settings.
Errors
There are no errors described for this operation.
GetObjectTagging
$result = $client->getObjectTagging
([/* ... */]); $promise = $client->getObjectTaggingAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getObjectTagging([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'RequestPayer' => 'requester', 'VersionId' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name containing the object for which to get the tagging information.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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 Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Key
-
- Required: Yes
- Type: string
Object key for which to get the tagging information.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- VersionId
-
- Type: string
The versionId of the object for which to get the tagging information.
Result Syntax
[ 'TagSet' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'VersionId' => '<string>', ]
Result Details
Members
- TagSet
-
- Required: Yes
- Type: Array of Tag structures
Contains the tag set.
- VersionId
-
- Type: string
The versionId of the object for which you got the tagging information.
Errors
There are no errors described for this operation.
Examples
Example 1: To retrieve tag set of an object
The following example retrieves tag set of an object.
$result = $client->getObjectTagging([ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ]);
Result syntax:
[ 'TagSet' => [ [ 'Key' => 'Key4', 'Value' => 'Value4', ], [ 'Key' => 'Key3', 'Value' => 'Value3', ], ], 'VersionId' => 'null', ]
Example 2: To retrieve tag set of a specific object version
The following example retrieves tag set of an object. The request specifies object version.
$result = $client->getObjectTagging([ 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ]);
Result syntax:
[ 'TagSet' => [ [ 'Key' => 'Key1', 'Value' => 'Value1', ], ], 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ]
GetObjectTorrent
$result = $client->getObjectTorrent
([/* ... */]); $promise = $client->getObjectTorrentAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getObjectTorrent([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'RequestPayer' => 'requester', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the object for which to get the torrent files.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Key
-
- Required: Yes
- Type: string
The object key for which to get the information.
- RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
Result Syntax
[ 'Body' => <string || resource || Psr\Http\Message\StreamInterface>, 'RequestCharged' => 'requester', ]
Result Details
Members
- Body
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
A Bencoded dictionary as defined by the BitTorrent specification
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Errors
There are no errors described for this operation.
Examples
Example 1: To retrieve torrent files for an object
The following example retrieves torrent files of an object.
$result = $client->getObjectTorrent([ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ]);
Result syntax:
[ ]
GetPublicAccessBlock
$result = $client->getPublicAccessBlock
([/* ... */]); $promise = $client->getPublicAccessBlockAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->getPublicAccessBlock([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose
PublicAccessBlock
configuration you want to retrieve. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'PublicAccessBlockConfiguration' => [ 'BlockPublicAcls' => true || false, 'BlockPublicPolicy' => true || false, 'IgnorePublicAcls' => true || false, 'RestrictPublicBuckets' => true || false, ], ]
Result Details
Members
- PublicAccessBlockConfiguration
-
- Type: PublicAccessBlockConfiguration structure
The
PublicAccessBlock
configuration currently in effect for this Amazon S3 bucket.
Errors
There are no errors described for this operation.
HeadBucket
$result = $client->headBucket
([/* ... */]); $promise = $client->headBucketAsync
([/* ... */]);
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.
- Authentication and authorization
-
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 thex-amz-
prefix, includingx-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 theCreateSession
API operation.Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
- Permissions
-
-
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 theAction
element of a policy. By default, the session is in theReadWrite
mode. If you want to restrict the access, you can explicitly set thes3express:SessionMode
condition key toReadOnly
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.
-
- HTTP Host header syntax
-
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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
Parameter Syntax
$result = $client->headBucket([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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 aboutInvalidAccessPointAliasError
, see List of Error Codes.Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'AccessPointAlias' => true || false, 'BucketLocationName' => '<string>', 'BucketLocationType' => 'AvailabilityZone|LocalZone', 'BucketRegion' => '<string>', ]
Result Details
Members
- AccessPointAlias
-
- Type: boolean
Indicates whether the bucket name used in the request is an access point alias.
For directory buckets, the value of this field is
false
. - BucketLocationName
-
- Type: string
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.
- BucketLocationType
-
- Type: string
The type of location where the bucket is created.
This functionality is only supported by directory buckets.
- BucketRegion
-
- Type: string
The Region that the bucket is located.
Errors
- NoSuchBucket:
The specified bucket does not exist.
Examples
Example 1: To determine if bucket exists
This operation checks to see if a bucket exists.
$result = $client->headBucket([ 'Bucket' => 'acl1', ]);
HeadObject
$result = $client->headObject
([/* ... */]); $promise = $client->headObjectAsync
([/* ... */]);
The HEAD
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.
- Permissions
-
-
General purpose bucket permissions - To use
HEAD
, you must have thes3: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 code404 Not Found
error. -
If you don’t have the
s3:ListBucket
permission, Amazon S3 returns an HTTP status code403 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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.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 thekms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
-
- Encryption
-
Encryption request headers, like
x-amz-server-side-encryption
, should not be sent forHEAD
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). Thex-amz-server-side-encryption
header is used when youPUT
an object to S3 and want to specify the encryption method. If you include this header in aHEAD
request for an object that uses these types of keys, you’ll get an HTTP400 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.
-
- Versioning
-
-
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 theLast-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 specifynull
to theversionId
query parameter in the request.
-
- HTTP Host header syntax
-
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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
The following actions are related to HeadObject
:
Parameter Syntax
$result = $client->headObject([ 'Bucket' => '<string>', // REQUIRED 'ChecksumMode' => 'ENABLED', 'ExpectedBucketOwner' => '<string>', 'IfMatch' => '<string>', 'IfModifiedSince' => <integer || string || DateTime>, 'IfNoneMatch' => '<string>', 'IfUnmodifiedSince' => <integer || string || DateTime>, 'Key' => '<string>', // REQUIRED 'PartNumber' => <integer>, 'Range' => '<string>', 'RequestPayer' => 'requester', '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
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ChecksumMode
-
- Type: string
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 thekms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object. - ExpectedBucketOwner
-
- Type: string
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). - IfMatch
-
- Type: string
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:-
If-Match
condition evaluates totrue
, and; -
If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
- IfModifiedSince
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:-
If-None-Match
condition evaluates tofalse
, and; -
If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.For more information about conditional requests, see RFC 7232.
- IfNoneMatch
-
- Type: string
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
If both of the
If-None-Match
andIf-Modified-Since
headers are present in the request as follows:-
If-None-Match
condition evaluates tofalse
, and; -
If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.For more information about conditional requests, see RFC 7232.
- IfUnmodifiedSince
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
If both of the
If-Match
andIf-Unmodified-Since
headers are present in the request as follows:-
If-Match
condition evaluates totrue
, and; -
If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
- Key
-
- Required: Yes
- Type: string
The object key.
- PartNumber
-
- Type: int
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
- Range
-
- Type: string
HeadObject returns only the metadata for an object. If the Range is satisfiable, only the
ContentLength
is affected in the response. If the Range is not satisfiable, S3 returns a416 - Requested Range Not Satisfiable
error. - RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- ResponseCacheControl
-
- Type: string
Sets the
Cache-Control
header of the response. - ResponseContentDisposition
-
- Type: string
Sets the
Content-Disposition
header of the response. - ResponseContentEncoding
-
- Type: string
Sets the
Content-Encoding
header of the response. - ResponseContentLanguage
-
- Type: string
Sets the
Content-Language
header of the response. - ResponseContentType
-
- Type: string
Sets the
Content-Type
header of the response. - ResponseExpires
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Sets the
Expires
header of the response. - SSECustomerAlgorithm
-
- Type: string
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
- SSECustomerKey
-
- Type: string
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf. - SSECustomerKeyMD5
-
- Type: string
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
This functionality is not supported for directory buckets.
- VersionId
-
- Type: string
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.
Result Syntax
[ 'AcceptRanges' => '<string>', 'ArchiveStatus' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS', 'BucketKeyEnabled' => true || false, 'CacheControl' => '<string>', 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ContentDisposition' => '<string>', 'ContentEncoding' => '<string>', 'ContentLanguage' => '<string>', 'ContentLength' => <integer>, 'ContentType' => '<string>', 'DeleteMarker' => true || false, 'ETag' => '<string>', 'Expiration' => '<string>', 'Expires' => <DateTime>, '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:kms|aws:kms:dsse', 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'VersionId' => '<string>', 'WebsiteRedirectLocation' => '<string>', ]
Result Details
Members
- AcceptRanges
-
- Type: string
Indicates that a range of bytes was specified.
- ArchiveStatus
-
- Type: string
The archive state of the head object.
This functionality is not supported for directory buckets.
- BucketKeyEnabled
-
- Type: boolean
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
- CacheControl
-
- Type: string
Specifies caching behavior along the request/reply chain.
- ChecksumCRC32
-
- Type: string
The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it 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.
- ChecksumCRC32C
-
- Type: string
The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it 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.
- ChecksumSHA1
-
- Type: string
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. 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.
- ChecksumSHA256
-
- Type: string
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. 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.
- ContentDisposition
-
- Type: string
Specifies presentational information for the object.
- ContentEncoding
-
- Type: string
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.
- ContentLanguage
-
- Type: string
The language the content is in.
- ContentLength
-
- Type: long (int|float)
Size of the body in bytes.
- ContentType
-
- Type: string
A standard MIME type describing the format of the object data.
- DeleteMarker
-
- Type: boolean
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
This functionality is not supported for directory buckets.
- ETag
-
- Type: string
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- Expiration
-
- Type: string
If the object expiration is configured (see
PutBucketLifecycleConfiguration
), the response includes this header. It includes theexpiry-date
andrule-id
key-value pairs providing object expiration information. The value of therule-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. - Expires
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time at which the object is no longer cacheable.
This output shape has been deprecated. Please refer to
.ExpiresString
instead. - ExpiresString
-
- Type: string
The unparsed string value of theExpires
output member. - LastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Date and time when the object was last modified.
- Metadata
-
- Type: Associative array of custom strings keys (MetadataKey) to strings
A map of metadata to store with the object in S3.
- MissingMeta
-
- Type: int
This is set to the number of metadata entries not returned in
x-amz-meta
headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.This functionality is not supported for directory buckets.
- ObjectLockLegalHoldStatus
-
- Type: string
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the
s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.This functionality is not supported for directory buckets.
- ObjectLockMode
-
- Type: string
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the
s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.This functionality is not supported for directory buckets.
- ObjectLockRetainUntilDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time when the Object Lock retention period expires. This header is only returned if the requester has the
s3:GetObjectRetention
permission.This functionality is not supported for directory buckets.
- PartsCount
-
- Type: int
The count of parts this object has. This value is only returned if you specify
partNumber
in your request and the object was uploaded as a multipart upload. - ReplicationStatus
-
- Type: string
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (
GetObject
) or object metadata (HeadObject
) from these buckets, Amazon S3 will return thex-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 prefixTaxDocs
. Any objects you upload with this key name prefix, for exampleTaxDocs/document1.pdf
, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return thex-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.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- Restore
-
- Type: string
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value
ongoing-request="true"
.For more information about archiving objects, see Transitioning Objects: General Considerations.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- SSECustomerAlgorithm
-
- Type: string
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.
- SSECustomerKeyMD5
-
- Type: string
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.
- SSEKMSKeyId
-
- Type: string
If present, indicates the ID of the KMS key that was used for object encryption.
- ServerSideEncryption
-
- Type: string
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
). - StorageClass
-
- Type: string
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- VersionId
-
- Type: string
Version ID of the object.
This functionality is not supported for directory buckets.
- WebsiteRedirectLocation
-
- Type: string
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
This functionality is not supported for directory buckets.
Errors
- NoSuchKey:
The specified key does not exist.
Examples
Example 1: To retrieve metadata of an object without returning the object itself
The following example retrieves an object metadata.
$result = $client->headObject([ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ]);
Result syntax:
[ 'AcceptRanges' => 'bytes', 'ContentLength' => 3191, 'ContentType' => 'image/jpeg', 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' =>, 'Metadata' => [ ], 'VersionId' => 'null', ]
ListBucketAnalyticsConfigurations
$result = $client->listBucketAnalyticsConfigurations
([/* ... */]); $promise = $client->listBucketAnalyticsConfigurationsAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->listBucketAnalyticsConfigurations([ 'Bucket' => '<string>', // REQUIRED 'ContinuationToken' => '<string>', 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket from which analytics configurations are retrieved.
- ContinuationToken
-
- Type: string
The
ContinuationToken
that represents a placeholder from where this request should begin. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'AnalyticsConfigurationList' => [ [ 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'Id' => '<string>', 'StorageClassAnalysis' => [ 'DataExport' => [ 'Destination' => [ 'S3BucketDestination' => [ 'Bucket' => '<string>', 'BucketAccountId' => '<string>', 'Format' => 'CSV', 'Prefix' => '<string>', ], ], 'OutputSchemaVersion' => 'V_1', ], ], ], // ... ], 'ContinuationToken' => '<string>', 'IsTruncated' => true || false, 'NextContinuationToken' => '<string>', ]
Result Details
Members
- AnalyticsConfigurationList
-
- Type: Array of AnalyticsConfiguration structures
The list of analytics configurations for a bucket.
- ContinuationToken
-
- Type: string
The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.
- IsTruncated
-
- Type: boolean
Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
- NextContinuationToken
-
- Type: string
NextContinuationToken
is sent whenisTruncated
is true, which indicates that there are more analytics configurations to list. The next request must include thisNextContinuationToken
. The token is obfuscated and is not a usable value.
Errors
There are no errors described for this operation.
ListBucketIntelligentTieringConfigurations
$result = $client->listBucketIntelligentTieringConfigurations
([/* ... */]); $promise = $client->listBucketIntelligentTieringConfigurationsAsync
([/* ... */]);
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:
Parameter Syntax
$result = $client->listBucketIntelligentTieringConfigurations([ 'Bucket' => '<string>', // REQUIRED 'ContinuationToken' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
- ContinuationToken
-
- Type: string
The
ContinuationToken
that represents a placeholder from where this request should begin.
Result Syntax
[ 'ContinuationToken' => '<string>', 'IntelligentTieringConfigurationList' => [ [ 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'Id' => '<string>', 'Status' => 'Enabled|Disabled', 'Tierings' => [ [ 'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS', 'Days' => <integer>, ], // ... ], ], // ... ], 'IsTruncated' => true || false, 'NextContinuationToken' => '<string>', ]
Result Details
Members
- ContinuationToken
-
- Type: string
The
ContinuationToken
that represents a placeholder from where this request should begin. - IntelligentTieringConfigurationList
-
- Type: Array of IntelligentTieringConfiguration structures
The list of S3 Intelligent-Tiering configurations for a bucket.
- IsTruncated
-
- Type: boolean
Indicates whether the returned list of analytics configurations is complete. A value of
true
indicates that the list is not complete and theNextContinuationToken
will be provided for a subsequent request. - NextContinuationToken
-
- Type: string
The marker used to continue this inventory configuration listing. Use the
NextContinuationToken
from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
Errors
There are no errors described for this operation.
ListBucketInventoryConfigurations
$result = $client->listBucketInventoryConfigurations
([/* ... */]); $promise = $client->listBucketInventoryConfigurationsAsync
([/* ... */]);
This operation is not supported for directory buckets.
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated
element in the response. If there are no more configurations to list, IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is set to true, and there is a value in NextContinuationToken
. You use the NextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to ListBucketInventoryConfigurations
:
Parameter Syntax
$result = $client->listBucketInventoryConfigurations([ 'Bucket' => '<string>', // REQUIRED 'ContinuationToken' => '<string>', 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the inventory configurations to retrieve.
- ContinuationToken
-
- Type: string
The marker used to continue an inventory configuration listing that has been truncated. Use the
NextContinuationToken
from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'ContinuationToken' => '<string>', 'InventoryConfigurationList' => [ [ 'Destination' => [ 'S3BucketDestination' => [ 'AccountId' => '<string>', 'Bucket' => '<string>', 'Encryption' => [ 'SSEKMS' => [ 'KeyId' => '<string>', ], 'SSES3' => [ ], ], 'Format' => 'CSV|ORC|Parquet', 'Prefix' => '<string>', ], ], 'Filter' => [ 'Prefix' => '<string>', ], 'Id' => '<string>', 'IncludedObjectVersions' => 'All|Current', 'IsEnabled' => true || false, 'OptionalFields' => ['<string>', ...], 'Schedule' => [ 'Frequency' => 'Daily|Weekly', ], ], // ... ], 'IsTruncated' => true || false, 'NextContinuationToken' => '<string>', ]
Result Details
Members
- ContinuationToken
-
- Type: string
If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
- InventoryConfigurationList
-
- Type: Array of InventoryConfiguration structures
The list of inventory configurations for a bucket.
- IsTruncated
-
- Type: boolean
Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.
- NextContinuationToken
-
- Type: string
The marker used to continue this inventory configuration listing. Use the
NextContinuationToken
from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
Errors
There are no errors described for this operation.
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
:
Parameter Syntax
$result = $client->listBucketMetricsConfigurations([ 'Bucket' => '<string>', // REQUIRED 'ContinuationToken' => '<string>', 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the metrics configurations to retrieve.
- ContinuationToken
-
- Type: string
The marker that is used to continue a metrics configuration listing that has been truncated. Use the
NextContinuationToken
from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[ 'ContinuationToken' => '<string>', 'IsTruncated' => true || false, 'MetricsConfigurationList' => [ [ 'Filter' => [ 'AccessPointArn' => '<string>', 'And' => [ 'AccessPointArn' => '<string>', 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', 'Value' => '<string>', ], ], 'Id' => '<string>', ], // ... ], 'NextContinuationToken' => '<string>', ]
Result Details
Members
- ContinuationToken
-
- Type: string
The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.
- IsTruncated
-
- Type: boolean
Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
- MetricsConfigurationList
-
- Type: Array of MetricsConfiguration structures
The list of metrics configurations for a bucket.
- NextContinuationToken
-
- Type: string
The marker used to continue a metrics configuration listing that has been truncated. Use the
NextContinuationToken
from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
Errors
There are no errors described for this operation.
ListBuckets
$result = $client->listBuckets
([/* ... */]); $promise = $client->listBucketsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listBuckets([ 'BucketRegion' => '<string>', 'ContinuationToken' => '<string>', 'MaxBuckets' => <integer>, 'Prefix' => '<string>', ]);
Parameter Details
Members
- BucketRegion
-
- Type: string
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 Regionus-west-2
, the request must be made to an endpoint in Regionus-west-2
. - ContinuationToken
-
- Type: string
ContinuationToken
indicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationToken
is obfuscated and is not a real key. You can use thisContinuationToken
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
, orcontinuation-token
query parameters without usingmax-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. - MaxBuckets
-
- Type: int
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.
- Prefix
-
- Type: string
Limits the response to bucket names that begin with the specified bucket name prefix.
Result Syntax
[ 'Buckets' => [ [ 'BucketRegion' => '<string>', 'CreationDate' => <DateTime>, 'Name' => '<string>', ], // ... ], 'ContinuationToken' => '<string>', 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'Prefix' => '<string>', ]
Result Details
Members
- Buckets
-
- Type: Array of Bucket structures
The list of buckets owned by the requester.
- ContinuationToken
-
- Type: string
ContinuationToken
is included in the response when there are more buckets that can be listed with pagination. The nextListBuckets
request to Amazon S3 can be continued with thisContinuationToken
.ContinuationToken
is obfuscated and is not a real bucket. - Owner
-
- Type: Owner structure
The owner of the buckets listed.
- Prefix
-
- Type: string
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.
Errors
There are no errors described for this operation.
Examples
Example 1: To list all buckets
The following example returns all the buckets owned by the sender of this request.
$result = $client->listBuckets([ ]);
Result syntax:
[ 'Buckets' => [ [ 'CreationDate' =>, 'Name' => 'examplebucket', ], [ 'CreationDate' => , 'Name' => 'examplebucket2', ], [ 'CreationDate' => , 'Name' => 'examplebucket3', ], ], 'Owner' => [ 'DisplayName' => 'own-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31', ], ]
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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
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. - HTTP Host header syntax
-
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.
Parameter Syntax
$result = $client->listDirectoryBuckets([ 'ContinuationToken' => '<string>', 'MaxDirectoryBuckets' => <integer>, ]);
Parameter Details
Members
- ContinuationToken
-
- Type: string
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 thisContinuationToken
for the pagination of the list results. - MaxDirectoryBuckets
-
- Type: int
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.
Result Syntax
[ 'Buckets' => [ [ 'BucketRegion' => '<string>', 'CreationDate' => <DateTime>, 'Name' => '<string>', ], // ... ], 'ContinuationToken' => '<string>', ]
Result Details
Members
- Buckets
-
- Type: Array of Bucket structures
The list of buckets owned by the requester.
- ContinuationToken
-
- Type: string
If
ContinuationToken
was sent with the request, it is included in the response. You can use the returnedContinuationToken
for pagination of the list response.
Errors
There are no errors described for this operation.
ListMultipartUploads
$result = $client->listMultipartUploads
([/* ... */]); $promise = $client->listMultipartUploadsAsync
([/* ... */]);
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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- Sorting of multipart uploads in response
-
-
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.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following operations are related to ListMultipartUploads
:
Parameter Syntax
$result = $client->listMultipartUploads([ 'Bucket' => '<string>', // REQUIRED 'Delimiter' => '<string>', 'EncodingType' => 'url', 'ExpectedBucketOwner' => '<string>', 'KeyMarker' => '<string>', 'MaxUploads' => <integer>, 'Prefix' => '<string>', 'RequestPayer' => 'requester', 'UploadIdMarker' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket to which the multipart upload was initiated.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - Delimiter
-
- Type: string
Character you use to group keys.
All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element,
CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped underCommonPrefixes
result element are not returned elsewhere in the response.Directory buckets - For directory buckets,
/
is the only supported delimiter. - EncodingType
-
- Type: string
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 astest_file%283%29.png
. - ExpectedBucketOwner
-
- Type: string
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). - KeyMarker
-
- Type: string
Specifies the multipart upload after which listing should begin.
-
General purpose buckets - For general purpose buckets,
key-marker
is an object key. Together withupload-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 specifiedkey-marker
will be included in the list.If
upload-id-marker
is specified, any multipart uploads for a key equal to thekey-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specifiedupload-id-marker
. -
Directory buckets - For directory buckets,
key-marker
is obfuscated and isn't a real object key. Theupload-id-marker
parameter isn't supported by directory buckets. To list the additional multipart uploads, you only need to set the value ofkey-marker
to theNextKeyMarker
value from the previous response.In the
ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
- MaxUploads
-
- Type: int
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
- Prefix
-
- Type: string
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using
prefix
to make groups in the same way that you'd use a folder in a file system.)Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. - RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- UploadIdMarker
-
- Type: string
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified
upload-id-marker
.This functionality is not supported for directory buckets.
Result Syntax
[ 'Bucket' => '<string>', 'CommonPrefixes' => [ [ 'Prefix' => '<string>', ], // ... ], 'Delimiter' => '<string>', 'EncodingType' => 'url', 'IsTruncated' => true || false, 'KeyMarker' => '<string>', 'MaxUploads' => <integer>, 'NextKeyMarker' => '<string>', 'NextUploadIdMarker' => '<string>', 'Prefix' => '<string>', 'RequestCharged' => 'requester', 'UploadIdMarker' => '<string>', 'Uploads' => [ [ 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'Initiated' => <DateTime>, 'Initiator' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'Key' => '<string>', 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'UploadId' => '<string>', ], // ... ], ]
Result Details
Members
- Bucket
-
- Type: string
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
- CommonPrefixes
-
- Type: Array of CommonPrefix structures
If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a
CommonPrefixes
element. The distinct key prefixes are returned in thePrefix
child element.Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. - Delimiter
-
- Type: string
Contains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.
Directory buckets - For directory buckets,
/
is the only supported delimiter. - EncodingType
-
- Type: string
Encoding type used by Amazon S3 to encode object keys in the response.
If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter
,KeyMarker
,Prefix
,NextKeyMarker
,Key
. - IsTruncated
-
- Type: boolean
Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
- KeyMarker
-
- Type: string
The key at or after which the listing began.
- MaxUploads
-
- Type: int
Maximum number of multipart uploads that could have been included in the response.
- NextKeyMarker
-
- Type: string
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
- NextUploadIdMarker
-
- Type: string
When a list is truncated, this element specifies the value that should be used for the
upload-id-marker
request parameter in a subsequent request.This functionality is not supported for directory buckets.
- Prefix
-
- Type: string
When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. - RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- UploadIdMarker
-
- Type: string
Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified
upload-id-marker
.This functionality is not supported for directory buckets.
- Uploads
-
- Type: Array of MultipartUpload structures
Container for elements related to a particular multipart upload. A response can contain zero or more
Upload
elements.
Errors
There are no errors described for this operation.
Examples
Example 1: To list in-progress multipart uploads on a bucket
The following example lists in-progress multipart uploads on a specific bucket.
$result = $client->listMultipartUploads([ 'Bucket' => 'examplebucket', ]);
Result syntax:
[ 'Uploads' => [ [ 'Initiated' =>, 'Initiator' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--', ], [ 'Initiated' => , 'Initiator' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', ], ], ]
Example 2: List next set of multipart uploads when previous result is truncated
The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.
$result = $client->listMultipartUploads([ 'Bucket' => 'examplebucket', 'KeyMarker' => 'nextkeyfrompreviousresponse', 'MaxUploads' => 2, 'UploadIdMarker' => 'valuefrompreviousresponse', ]);
Result syntax:
[ 'Bucket' => 'acl1', 'IsTruncated' => 1, 'KeyMarker' => '', 'MaxUploads' => 2, 'NextKeyMarker' => 'someobjectkey', 'NextUploadIdMarker' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', 'UploadIdMarker' => '', 'Uploads' => [ [ 'Initiated' =>, 'Initiator' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'mohanataws', 'ID' => '852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--', ], [ 'Initiated' => , 'Initiator' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', ], ], ]
ListObjectVersions
$result = $client->listObjectVersions
([/* ... */]); $promise = $client->listObjectVersionsAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->listObjectVersions([ 'Bucket' => '<string>', // REQUIRED 'Delimiter' => '<string>', 'EncodingType' => 'url', 'ExpectedBucketOwner' => '<string>', 'KeyMarker' => '<string>', 'MaxKeys' => <integer>, 'OptionalObjectAttributes' => ['<string>', ...], 'Prefix' => '<string>', 'RequestPayer' => 'requester', 'VersionIdMarker' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The bucket name that contains the objects.
- Delimiter
-
- Type: string
A delimiter is a character that you specify to group keys. All keys that contain the same string between the
prefix
and the first occurrence of the delimiter are grouped under a single result element inCommonPrefixes
. These groups are counted as one result against themax-keys
limitation. These keys are not returned elsewhere in the response. - EncodingType
-
- Type: string
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 astest_file%283%29.png
. - ExpectedBucketOwner
-
- Type: string
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). - KeyMarker
-
- Type: string
Specifies the key to start with when listing objects in a bucket.
- MaxKeys
-
- Type: int
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because
max-keys
was exceeded, the response contains<isTruncated>true</isTruncated>
. To return the additional keys, seekey-marker
andversion-id-marker
. - OptionalObjectAttributes
-
- Type: Array of strings
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
- Prefix
-
- Type: string
Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using
prefix
to make groups in the same way that you'd use a folder in a file system.) You can useprefix
withdelimiter
to roll up numerous objects into a single result underCommonPrefixes
. - RequestPayer
-
- Type: string
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination 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.
- VersionIdMarker
-
- Type: string
Specifies the object version you want to start listing from.
Result Syntax
[ 'CommonPrefixes' => [ [ 'Prefix' => '<string>', ], // ... ], 'DeleteMarkers' => [ [ 'IsLatest' => true || false, 'Key' => '<string>', 'LastModified' => <DateTime>, 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'VersionId' => '<string>', ], // ... ], 'Delimiter' => '<string>', 'EncodingType' => 'url', 'IsTruncated' => true || false, 'KeyMarker' => '<string>', 'MaxKeys' => <integer>, 'Name' => '<string>', 'NextKeyMarker' => '<string>', 'NextVersionIdMarker' => '<string>', 'Prefix' => '<string>', 'RequestCharged' => 'requester', 'VersionIdMarker' => '<string>', 'Versions' => [ [ 'ChecksumAlgorithm' => ['<string>', ...], 'ETag' => '<string>', 'IsLatest' => true || false, 'Key' => '<string>', 'LastModified' => <DateTime>, 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'RestoreStatus' => [ 'IsRestoreInProgress' => true || false, 'RestoreExpiryDate' => <DateTime>, ], 'Size' => <integer>, 'StorageClass' => 'STANDARD', 'VersionId' => '<string>', ], // ... ], ]
Result Details
Members
- CommonPrefixes
-
- Type: Array of CommonPrefix structures
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
- DeleteMarkers
-
- Type: Array of DeleteMarkerEntry structures
Container for an object that is a delete marker.
- Delimiter
-
- Type: string
The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in
CommonPrefixes
. These groups are counted as one result against themax-keys
limitation. These keys are not returned elsewhere in the response. - EncodingType
-
- Type: string
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:KeyMarker, NextKeyMarker, Prefix, Key
, andDelimiter
. - IsTruncated
-
- Type: boolean
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request by using the
NextKeyMarker
andNextVersionIdMarker
response parameters as a starting place in another request to return the rest of the results. - KeyMarker
-
- Type: string
Marks the last key returned in a truncated response.
- MaxKeys
-
- Type: int
Specifies the maximum number of objects to return.
- Name
-
- Type: string
The bucket name.
- NextKeyMarker
-
- Type: string
When the number of responses exceeds the value of
MaxKeys
,NextKeyMarker
specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request. - NextVersionIdMarker
-
- Type: string
When the number of responses exceeds the value of
MaxKeys
,NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. Use this value for theversion-id-marker
request parameter in a subsequent request. - Prefix
-
- Type: string
Selects objects that start with the value supplied by this parameter.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- VersionIdMarker
-
- Type: string
Marks the last version of the key returned in a truncated response.
- Versions
-
- Type: Array of ObjectVersion structures
Container for version information.
Errors
There are no errors described for this operation.
Examples
Example 1: To list object versions
The following example 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
([/* ... */]);
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
:
Parameter Syntax
$result = $client->listObjects([ 'Bucket' => '<string>', // REQUIRED 'Delimiter' => '<string>', 'EncodingType' => 'url', 'ExpectedBucketOwner' => '<string>', 'Marker' => '<string>', 'MaxKeys' => <integer>, 'OptionalObjectAttributes' => ['<string>', ...], 'Prefix' => '<string>', 'RequestPayer' => 'requester', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket containing the objects.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - Delimiter
-
- Type: string
A delimiter is a character that you use to group keys.
- EncodingType
-
- Type: string
Encoding type used by Amazon S3 to encode 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 astest_file%283%29.png
. - ExpectedBucketOwner
-
- Type: string
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
-
- Type: string
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.
- MaxKeys
-
- Type: int
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- OptionalObjectAttributes
-
- Type: Array of strings
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
- Prefix
-
- Type: string
Limits the response to keys that begin with the specified prefix.
- RequestPayer
-
- Type: string
Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
Result Syntax
[ 'CommonPrefixes' => [ [ 'Prefix' => '<string>', ], // ... ], 'Contents' => [ [ 'ChecksumAlgorithm' => ['<string>', ...], 'ETag' => '<string>', 'Key' => '<string>', 'LastModified' => <DateTime>, 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'RestoreStatus' => [ 'IsRestoreInProgress' => true || false, 'RestoreExpiryDate' => <DateTime>, ], 'Size' => <integer>, 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', ], // ... ], 'Delimiter' => '<string>', 'EncodingType' => 'url', 'IsTruncated' => true || false, 'Marker' => '<string>', 'MaxKeys' => <integer>, 'Name' => '<string>', 'NextMarker' => '<string>', 'Prefix' => '<string>', 'RequestCharged' => 'requester', ]
Result Details
Members
- CommonPrefixes
-
- Type: Array of CommonPrefix structures
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.
A response can contain
CommonPrefixes
only if you specify a delimiter.CommonPrefixes
contains all (if there are any) keys betweenPrefix
and the next occurrence of the string specified by the delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
), as innotes/summer/july
, the common prefix isnotes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns. - Contents
-
- Type: Array of Object structures
Metadata about each object returned.
- Delimiter
-
- Type: string
Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the
CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value. - EncodingType
-
- Type: string
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 astest_file%283%29.png
. - IsTruncated
-
- Type: boolean
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
- Marker
-
- Type: string
Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
- MaxKeys
-
- Type: int
The maximum number of keys returned in the response body.
- Name
-
- Type: string
The bucket name.
- NextMarker
-
- Type: string
When the response is truncated (the
IsTruncated
element value in the response istrue
), you can use the key name in this field as themarker
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 theNextMarker
element and it is truncated, you can use the value of the lastKey
element in the response as themarker
parameter in the subsequent request to get the next set of object keys. - Prefix
-
- Type: string
Keys that begin with the indicated prefix.
- RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
Errors
- NoSuchBucket:
The specified bucket does not exist.
Examples
Example 1: To list objects in a bucket
The following example list two objects in a bucket.
$result = $client->listObjects([ 'Bucket' => 'examplebucket', 'MaxKeys' => 2, ]);
Result syntax:
[ 'Contents' => [ [ 'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"', 'Key' => 'example1.jpg', 'LastModified' =>, 'Owner' => [ 'DisplayName' => 'myname', 'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 11, 'StorageClass' => 'STANDARD', ], [ 'ETag' => '"9c8af9a76df052144598c115ef33e511"', 'Key' => 'example2.jpg', 'LastModified' => , 'Owner' => [ 'DisplayName' => 'myname', 'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 713193, 'StorageClass' => 'STANDARD', ], ], 'NextMarker' => 'eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==', ]
ListObjectsV2
$result = $client->listObjectsV2
([/* ... */]); $promise = $client->listObjectsV2Async
([/* ... */]);
Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. 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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- Sorting order of returned objects
-
-
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.
-
- HTTP Host header syntax
-
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
:
Parameter Syntax
$result = $client->listObjectsV2([ 'Bucket' => '<string>', // REQUIRED 'ContinuationToken' => '<string>', 'Delimiter' => '<string>', 'EncodingType' => 'url', 'ExpectedBucketOwner' => '<string>', 'FetchOwner' => true || false, 'MaxKeys' => <integer>, 'OptionalObjectAttributes' => ['<string>', ...], 'Prefix' => '<string>', 'RequestPayer' => 'requester', 'StartAfter' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ContinuationToken
-
- Type: string
ContinuationToken
indicates to Amazon S3 that the list is being continued on this bucket with a token.ContinuationToken
is obfuscated and is not a real key. You can use thisContinuationToken
for pagination of the list results. - Delimiter
-
- Type: string
A delimiter is a character that you use to group keys.
-
Directory buckets - For directory buckets,
/
is the only supported delimiter. -
Directory buckets - When you query
ListObjectsV2
with a delimiter during in-progress multipart uploads, theCommonPrefixes
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.
- EncodingType
-
- Type: string
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 astest_file%283%29.png
. - ExpectedBucketOwner
-
- Type: string
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). - FetchOwner
-
- Type: boolean
The owner field is not present in
ListObjectsV2
by default. If you want to return the owner field with each key in the result, then set theFetchOwner
field totrue
.Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
- MaxKeys
-
- Type: int
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- OptionalObjectAttributes
-
- Type: Array of strings
Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.
This functionality is not supported for directory buckets.
- Prefix
-
- Type: string
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. - RequestPayer
-
- Type: string
Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
This functionality is not supported for directory buckets.
- StartAfter
-
- Type: string
StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
This functionality is not supported for directory buckets.
Result Syntax
[ 'CommonPrefixes' => [ [ 'Prefix' => '<string>', ], // ... ], 'Contents' => [ [ 'ChecksumAlgorithm' => ['<string>', ...], 'ETag' => '<string>', 'Key' => '<string>', 'LastModified' => <DateTime>, 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'RestoreStatus' => [ 'IsRestoreInProgress' => true || false, 'RestoreExpiryDate' => <DateTime>, ], 'Size' => <integer>, 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', ], // ... ], 'ContinuationToken' => '<string>', 'Delimiter' => '<string>', 'EncodingType' => 'url', 'IsTruncated' => true || false, 'KeyCount' => <integer>, 'MaxKeys' => <integer>, 'Name' => '<string>', 'NextContinuationToken' => '<string>', 'Prefix' => '<string>', 'RequestCharged' => 'requester', 'StartAfter' => '<string>', ]
Result Details
Members
- CommonPrefixes
-
- Type: Array of CommonPrefix structures
All of the keys (up to 1,000) 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 betweenPrefix
and the next occurrence of the string specified by a delimiter.CommonPrefixes
lists keys that act like subdirectories in the directory specified byPrefix
.For example, if the prefix is
notes/
and the delimiter is a slash (/
) as innotes/summer/july
, the common prefix isnotes/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, theCommonPrefixes
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.
- Contents
-
- Type: Array of Object structures
Metadata about each object returned.
- ContinuationToken
-
- Type: string
If
ContinuationToken
was sent with the request, it is included in the response. You can use the returnedContinuationToken
for pagination of the list response. You can use thisContinuationToken
for pagination of the list results. - Delimiter
-
- Type: string
Causes keys that contain the same string between the
prefix
and the first occurrence of the delimiter to be rolled up into a single result element in theCommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against theMaxKeys
value.Directory buckets - For directory buckets,
/
is the only supported delimiter. - EncodingType
-
- Type: string
Encoding type used by Amazon S3 to encode object key names in the XML response.
If you specify the
encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:Delimiter, Prefix, Key,
andStartAfter
. - IsTruncated
-
- Type: boolean
Set to
false
if all of the results were returned. Set totrue
if more keys are available to return. If the number of results exceeds that specified byMaxKeys
, all of the results might not be returned. - KeyCount
-
- Type: int
KeyCount
is the number of keys returned with this request.KeyCount
will always be less than or equal to theMaxKeys
field. For example, if you ask for 50 keys, your result will include 50 keys or fewer. - MaxKeys
-
- Type: int
Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Name
-
- Type: string
The bucket name.
- NextContinuationToken
-
- Type: string
NextContinuationToken
is sent whenisTruncated
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 thisNextContinuationToken
.NextContinuationToken
is obfuscated and is not a real key - Prefix
-
- Type: string
Keys that begin with the indicated prefix.
Directory buckets - For directory buckets, only prefixes that end in a delimiter (
/
) are supported. - RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- StartAfter
-
- Type: string
If StartAfter was sent with the request, it is included in the response.
This functionality is not supported for directory buckets.
Errors
- NoSuchBucket:
The specified bucket does not exist.
Examples
Example 1: To get object list
The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys.
$result = $client->listObjectsV2([ 'Bucket' => 'DOC-EXAMPLE-BUCKET', 'MaxKeys' => 2, ]);
Result syntax:
[ 'Contents' => [ [ 'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"', 'Key' => 'happyface.jpg', 'LastModified' =>, 'Size' => 11, 'StorageClass' => 'STANDARD', ], [ 'ETag' => '"becf17f89c30367a9a44495d62ed521a-1"', 'Key' => 'test.jpg', 'LastModified' => , 'Size' => 4192256, 'StorageClass' => 'STANDARD', ], ], 'IsTruncated' => 1, 'KeyCount' => 2, 'MaxKeys' => 2, 'Name' => 'DOC-EXAMPLE-BUCKET', 'NextContinuationToken' => '1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==', 'Prefix' => '', ]
ListParts
$result = $client->listParts
([/* ... */]); $promise = $client->listPartsAsync
([/* ... */]);
Lists the parts that have been uploaded for a specific multipart upload.
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://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 Available Local Zone for directory buckets in the Amazon S3 User Guide.
- Permissions
-
-
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 theListParts
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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
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 anotherCreateSession
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, seeCreateSession
.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket-name.s3express-zone-id.region-code.amazonaws.com
.
The following operations are related to ListParts
:
Parameter Syntax
$result = $client->listParts([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Key' => '<string>', // REQUIRED 'MaxParts' => <integer>, 'PartNumberMarker' => <integer>, 'RequestPayer' => 'requester', 'SSECustomerAlgorithm' => '<string>', 'SSECustomerKey' => '<string>', 'SSECustomerKeyMD5' => '<string>', 'UploadId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket to which the parts are being uploaded.
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 formatbucket-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 action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Key
-
- Required: Yes
- Type: string
Object key for which the multipart upload was initiated.
- MaxParts
-
- Type: int
Sets the maximum number of parts to return.
- PartNumberMarker
-
- Type: int
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
- RequestPayer
-
- Type: string
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.
- SSECustomerAlgorithm
-
- Type: string
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- SSECustomerKey
-
- Type: string
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
This value will be base64 encoded on your behalf. - SSECustomerKeyMD5
-
- Type: string
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- UploadId
-
- Required: Yes
- Type: string
Upload ID identifying the multipart upload whose parts are being listed.
Result Syntax
[ 'AbortDate' => <DateTime>, 'AbortRuleId' => '<string>', 'Bucket' => '<string>', 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'Initiator' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'IsTruncated' => true || false, 'Key' => '<string>', 'MaxParts' => <integer>, 'NextPartNumberMarker' => <integer>, 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], 'PartNumberMarker' => <integer>, 'Parts' => [ [ 'ChecksumCRC32' => '<string>', 'ChecksumCRC32C' => '<string>', 'ChecksumSHA1' => '<string>', 'ChecksumSHA256' => '<string>', 'ETag' => '<string>', 'LastModified' => <DateTime>, 'PartNumber' => <integer>, 'Size' => <integer>, ], // ... ], 'RequestCharged' => 'requester', 'StorageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS|GLACIER_IR|SNOW|EXPRESS_ONEZONE', 'UploadId' => '<string>', ]
Result Details
Members
- AbortDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The response will also include the
x-amz-abort-rule-id
header that will provide the ID of the lifecycle configuration rule that defines this action.This functionality is not supported for directory buckets.
- AbortRuleId
-
- Type: string
This header is returned along with the
x-amz-abort-date
header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.This functionality is not supported for directory buckets.
- Bucket
-
- Type: string
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
- ChecksumAlgorithm
-
- Type: string
The algorithm that was used to create a checksum of the object.
- Initiator
-
- Type: Initiator structure
Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services account, this element provides the same information as the
Owner
element. If the initiator is an IAM User, this element provides the user ARN and display name. - IsTruncated
-
- Type: boolean
Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
- Key
-
- Type: string
Object key for which the multipart upload was initiated.
- MaxParts
-
- Type: int
Maximum number of parts that were allowed in the response.
- NextPartNumberMarker
-
- Type: int
When a list is truncated, this element specifies the last part in the list, as well as the value to use for the
part-number-marker
request parameter in a subsequent request. - Owner
-
- Type: Owner structure
Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
Directory buckets - The bucket owner is returned as the object owner for all the parts.
- PartNumberMarker
-
- Type: int
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
- Parts
-
- Type: Array of Part structures
Container for elements related to a particular part. A response can contain zero or more
Part
elements. - RequestCharged
-
- Type: string
If present, indicates that the requester was successfully charged for the request.
This functionality is not supported for directory buckets.
- StorageClass
-
- Type: string
The class of storage used to store the uploaded object.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- UploadId
-
- Type: string
Upload ID identifying the multipart upload whose parts are being listed.
Errors
There are no errors described for this operation.
Examples
Example 1: To list parts of a multipart upload.
The following example lists parts uploaded for a specific multipart upload.
$result = $client->listParts([ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'UploadId' => 'example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ]);
Result syntax:
[ 'Initiator' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Parts' => [ [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'LastModified' =>, 'PartNumber' => 1, 'Size' => 26246026, ], [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'LastModified' => , 'PartNumber' => 2, 'Size' => 26246026, ], ], 'StorageClass' => 'STANDARD', ]
PutBucketAccelerateConfiguration
$result = $client->putBucketAccelerateConfiguration
([/* ... */]); $promise = $client->putBucketAccelerateConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putBucketAccelerateConfiguration([ 'AccelerateConfiguration' => [ // REQUIRED 'Status' => 'Enabled|Suspended', ], 'Bucket' => '<string>', // REQUIRED 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- AccelerateConfiguration
-
- Required: Yes
- Type: AccelerateConfiguration structure
Container for setting the transfer acceleration state.
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which the accelerate configuration is set.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ExpectedBucketOwner
-
- Type: string
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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutBucketAcl
$result = $client->putBucketAcl
([/* ... */]); $promise = $client->putBucketAclAsync
([/* ... */]);
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.
- Permissions
-
You can set access permissions by using one of the following methods:
-
Specify a canned ACL with the
x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value ofx-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
, andx-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 thex-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 accountUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
-
US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (SĂŁo Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
-
For example, the following
x-amz-grant-write
header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two Amazon Web Services accounts identified by their email addresses.x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
-
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
-
- Grantee Values
-
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
-
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
-
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
-
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
-
US East (N. Virginia)
-
US West (N. California)
-
US West (Oregon)
-
Asia Pacific (Singapore)
-
Asia Pacific (Sydney)
-
Asia Pacific (Tokyo)
-
Europe (Ireland)
-
South America (SĂŁo Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
-
-
The following operations are related to PutBucketAcl
:
Parameter Syntax
$result = $client->putBucketAcl([ 'ACL' => 'private|public-read|public-read-write|authenticated-read', 'AccessControlPolicy' => [ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'EmailAddress' => '<string>', 'ID' => '<string>', 'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED 'URI' => '<string>', ], 'Permission' => 'FULL_CONTROL|WRITE|WRITE_ACP|READ|READ_ACP', ], // ... ], 'Owner' => [ 'DisplayName' => '<string>', 'ID' => '<string>', ], ], 'Bucket' => '<string>', // REQUIRED 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', 'GrantFullControl' => '<string>', 'GrantRead' => '<string>', 'GrantReadACP' => '<string>', 'GrantWrite' => '<string>', 'GrantWriteACP' => '<string>', ]);
Parameter Details
Members
- ACL
-
- Type: string
The canned ACL to apply to the bucket.
- AccessControlPolicy
-
- Type: AccessControlPolicy structure
Contains the elements that set the ACL permissions for an object per grantee.
- Bucket
-
- Required: Yes
- Type: string
The bucket to which to apply the ACL.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ContentMD5
-
- Type: string
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
The value will be computed on your behalf. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - GrantFullControl
-
- Type: string
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
- GrantRead
-
- Type: string
Allows grantee to list the objects in the bucket.
- GrantReadACP
-
- Type: string
Allows grantee to read the bucket ACL.
- GrantWrite
-
- Type: string
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
- GrantWriteACP
-
- Type: string
Allows grantee to write the ACL for the applicable bucket.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: Put bucket acl
The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.
$result = $client->putBucketAcl([ 'Bucket' => 'examplebucket', 'GrantFullControl' => 'id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484', 'GrantWrite' => 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery', ]);
PutBucketAnalyticsConfiguration
$result = $client->putBucketAnalyticsConfiguration
([/* ... */]); $promise = $client->putBucketAnalyticsConfigurationAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putBucketAnalyticsConfiguration([ 'AnalyticsConfiguration' => [ // REQUIRED 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], ], 'Id' => '<string>', // REQUIRED 'StorageClassAnalysis' => [ // REQUIRED 'DataExport' => [ 'Destination' => [ // REQUIRED 'S3BucketDestination' => [ // REQUIRED 'Bucket' => '<string>', // REQUIRED 'BucketAccountId' => '<string>', 'Format' => 'CSV', // REQUIRED 'Prefix' => '<string>', ], ], 'OutputSchemaVersion' => 'V_1', // REQUIRED ], ], ], 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED ]);
Parameter Details
Members
- AnalyticsConfiguration
-
- Required: Yes
- Type: AnalyticsConfiguration structure
The configuration and any analyses for the analytics filter.
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket to which an analytics configuration is stored.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID that identifies the analytics configuration.
Result Syntax
[]
Result Details
Errors
There 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 matchAllowedOrigin
elements. -
The request method (for example, GET, PUT, HEAD, and so on) or the
Access-Control-Request-Method
header in case of a pre-flightOPTIONS
request must be one of theAllowedMethod
elements. -
Every header specified in the
Access-Control-Request-Headers
request header of a pre-flight request must match anAllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
The following operations are related to PutBucketCors
:
Parameter Syntax
$result = $client->putBucketCors([ 'Bucket' => '<string>', // REQUIRED 'CORSConfiguration' => [ // REQUIRED 'CORSRules' => [ // REQUIRED [ 'AllowedHeaders' => ['<string>', ...], 'AllowedMethods' => ['<string>', ...], // REQUIRED 'AllowedOrigins' => ['<string>', ...], // REQUIRED 'ExposeHeaders' => ['<string>', ...], 'ID' => '<string>', 'MaxAgeSeconds' => <integer>, ], // ... ], ], 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
Specifies the bucket impacted by the
cors
configuration. - CORSConfiguration
-
- Required: Yes
- Type: CORSConfiguration structure
Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ContentMD5
-
- Type: string
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
The value will be computed on your behalf. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: To set cors configuration on a bucket.
The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.
$result = $client->putBucketCors([ 'Bucket' => '', 'CORSConfiguration' => [ 'CORSRules' => [ [ 'AllowedHeaders' => [ '*', ], 'AllowedMethods' => [ 'PUT', 'POST', 'DELETE', ], 'AllowedOrigins' => [ 'http://www.example.com', ], 'ExposeHeaders' => [ 'x-amz-server-side-encryption', ], 'MaxAgeSeconds' => 3000, ], [ 'AllowedHeaders' => [ 'Authorization', ], 'AllowedMethods' => [ 'GET', ], 'AllowedOrigins' => [ '*', ], 'MaxAgeSeconds' => 3000, ], ], ], 'ContentMD5' => '', ]);
PutBucketEncryption
$result = $client->putBucketEncryption
([/* ... */]); $promise = $client->putBucketEncryptionAsync
([/* ... */]);
This 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 Available Local Zone for directory buckets 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 orPUT
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 for the lifetime of the bucket. The Amazon Web Services managed key (
aws/s3
) isn't supported. -
S3 Bucket Keys are always enabled for
GET
andPUT
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).
- Permissions
-
-
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 thekms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the target KMS key.
-
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region-code.amazonaws.com
.
The following operations are related to PutBucketEncryption
:
Parameter Syntax
$result = $client->putBucketEncryption([ 'Bucket' => '<string>', // REQUIRED 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', 'ServerSideEncryptionConfiguration' => [ // REQUIRED 'Rules' => [ // REQUIRED [ 'ApplyServerSideEncryptionByDefault' => [ 'KMSMasterKeyID' => '<string>', 'SSEAlgorithm' => 'AES256|aws:kms|aws:kms:dsse', // REQUIRED ], 'BucketKeyEnabled' => true || false, ], // ... ], ], ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
Specifies default encryption for a bucket using server-side encryption with different key options.
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 formatbucket-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 - ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ContentMD5
-
- Type: string
The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
This functionality is not supported for directory buckets.
The value will be computed on your behalf. - ExpectedBucketOwner
-
- Type: string
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
-
- Required: Yes
- Type: ServerSideEncryptionConfiguration structure
Specifies the default server-side-encryption configuration.
Result Syntax
[]
Result Details
Errors
There 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:
- HTTP 400 Bad Request Error
-
Code: InvalidArgument
Cause: Invalid Argument
- HTTP 400 Bad Request Error
-
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP 403 Forbidden Error
-
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutIntelligentTieringConfiguration
bucket permission to set the configuration on the bucket.
Parameter Syntax
$result = $client->putBucketIntelligentTieringConfiguration([ 'Bucket' => '<string>', // REQUIRED 'Id' => '<string>', // REQUIRED 'IntelligentTieringConfiguration' => [ // REQUIRED 'Filter' => [ 'And' => [ 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], ], 'Id' => '<string>', // REQUIRED 'Status' => 'Enabled|Disabled', // REQUIRED 'Tierings' => [ // REQUIRED [ 'AccessTier' => 'ARCHIVE_ACCESS|DEEP_ARCHIVE_ACCESS', // REQUIRED 'Days' => <integer>, // REQUIRED ], // ... ], ], ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
- Id
-
- Required: Yes
- Type: string
The ID used to identify the S3 Intelligent-Tiering configuration.
- IntelligentTieringConfiguration
-
- Required: Yes
- Type: IntelligentTieringConfiguration structure
Container for S3 Intelligent-Tiering configuration.
Result Syntax
[]
Result Details
Errors
There 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 inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
- Permissions
-
To use this operation, you must have permission to perform the
s3:PutInventoryConfiguration
action. The bucket owner has this permission by default and can grant this permission to others.The
s3:PutInventoryConfiguration
permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.
PutBucketInventoryConfiguration
has the following special errors:
- HTTP 400 Bad Request Error
-
Code: InvalidArgument
Cause: Invalid Argument
- HTTP 400 Bad Request Error
-
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
- HTTP 403 Forbidden Error
-
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
The following operations are related to PutBucketInventoryConfiguration
:
Parameter Syntax
$result = $client->putBucketInventoryConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED 'InventoryConfiguration' => [ // REQUIRED 'Destination' => [ // REQUIRED 'S3BucketDestination' => [ // REQUIRED 'AccountId' => '<string>', 'Bucket' => '<string>', // REQUIRED 'Encryption' => [ 'SSEKMS' => [ 'KeyId' => '<string>', // REQUIRED ], 'SSES3' => [ ], ], 'Format' => 'CSV|ORC|Parquet', // REQUIRED 'Prefix' => '<string>', ], ], 'Filter' => [ 'Prefix' => '<string>', // REQUIRED ], 'Id' => '<string>', // REQUIRED 'IncludedObjectVersions' => 'All|Current', // REQUIRED 'IsEnabled' => true || false, // REQUIRED 'OptionalFields' => ['<string>', ...], 'Schedule' => [ // REQUIRED 'Frequency' => 'Daily|Weekly', // REQUIRED ], ], ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket where the inventory configuration will be stored.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID used to identify the inventory configuration.
- InventoryConfiguration
-
- Required: Yes
- Type: InventoryConfiguration structure
Specifies the inventory configuration.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutBucketLifecycle
$result = $client->putBucketLifecycle
([/* ... */]); $promise = $client->putBucketLifecycleAsync
([/* ... */]);
For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. 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:
Parameter Syntax
$result = $client->putBucketLifecycle([ 'Bucket' => '<string>', // REQUIRED 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', 'LifecycleConfiguration' => [ 'Rules' => [ // REQUIRED [ 'AbortIncompleteMultipartUpload' => [ 'DaysAfterInitiation' => <integer>, ], 'Expiration' => [ 'Date' => <integer || string || DateTime>, 'Days' => <integer>, 'ExpiredObjectDeleteMarker' => true || false, ], 'ID' => '<string>', 'NoncurrentVersionExpiration' => [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, ], 'NoncurrentVersionTransition' => [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], 'Prefix' => '<string>', // REQUIRED 'Status' => 'Enabled|Disabled', // REQUIRED 'Transition' => [ 'Date' => <integer || string || DateTime>, 'Days' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], ], // ... ], ], ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ContentMD5
-
- Type: string
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
The value will be computed on your behalf. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - LifecycleConfiguration
-
- Type: LifecycleConfiguration structure
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
PutBucketLifecycleConfiguration
$result = $client->putBucketLifecycleConfiguration
([/* ... */]); $promise = $client->putBucketLifecycleConfigurationAsync
([/* ... */]);
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, 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.
- Rules
- Permissions
- HTTP Host header syntax
-
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 Available Local Zone for directory buckets 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
:
Parameter Syntax
$result = $client->putBucketLifecycleConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ExpectedBucketOwner' => '<string>', 'LifecycleConfiguration' => [ 'Rules' => [ // REQUIRED [ 'AbortIncompleteMultipartUpload' => [ 'DaysAfterInitiation' => <integer>, ], 'Expiration' => [ 'Date' => <integer || string || DateTime>, 'Days' => <integer>, 'ExpiredObjectDeleteMarker' => true || false, ], 'Filter' => [ 'And' => [ 'ObjectSizeGreaterThan' => <integer>, 'ObjectSizeLessThan' => <integer>, 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], 'ObjectSizeGreaterThan' => <integer>, 'ObjectSizeLessThan' => <integer>, 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], ], 'ID' => '<string>', 'NoncurrentVersionExpiration' => [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, ], 'NoncurrentVersionTransitions' => [ [ 'NewerNoncurrentVersions' => <integer>, 'NoncurrentDays' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], // ... ], 'Prefix' => '<string>', 'Status' => 'Enabled|Disabled', // REQUIRED 'Transitions' => [ [ 'Date' => <integer || string || DateTime>, 'Days' => <integer>, 'StorageClass' => 'GLACIER|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|GLACIER_IR', ], // ... ], ], // ... ], ], 'TransitionDefaultMinimumObjectSize' => 'varies_by_storage_class|all_storage_classes_128K', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to set the configuration.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ExpectedBucketOwner
-
- Type: string
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.
- LifecycleConfiguration
-
- Type: BucketLifecycleConfiguration structure
Container for lifecycle rules. You can add as many as 1,000 rules.
- TransitionDefaultMinimumObjectSize
-
- Type: string
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
orObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Result Syntax
[ 'TransitionDefaultMinimumObjectSize' => 'varies_by_storage_class|all_storage_classes_128K', ]
Result Details
Members
- TransitionDefaultMinimumObjectSize
-
- Type: string
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
orObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Errors
There are no errors described for this operation.
Examples
Example 1: Put bucket lifecycle
The following example replaces existing lifecycle configuration, if any, on the specified bucket.
$result = $client->putBucketLifecycleConfiguration([ 'Bucket' => 'examplebucket', 'LifecycleConfiguration' => [ 'Rules' => [ [ 'Expiration' => [ 'Days' => 3650, ], 'Filter' => [ 'Prefix' => 'documents/', ], 'ID' => 'TestOnly', 'Status' => 'Enabled', 'Transitions' => [ [ 'Days' => 365, 'StorageClass' => 'GLACIER', ], ], ], ], ], ]);
PutBucketLogging
$result = $client->putBucketLogging
([/* ... */]); $promise = $client->putBucketLoggingAsync
([/* ... */]);
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.
- Grantee Values
-
You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways:
-
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName
is optional and ignored in the request. -
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the
CanonicalUser
and, in a response to aGETObjectAcl
request, appears as the CanonicalUser. -
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
-
To enable logging, you use LoggingEnabled
and its children request elements. To disable logging, you use an empty BucketLoggingStatus
request element:
<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to PutBucketLogging
:
Parameter Syntax
$result = $client->putBucketLogging([ 'Bucket' => '<string>', // REQUIRED 'BucketLoggingStatus' => [ // REQUIRED 'LoggingEnabled' => [ 'TargetBucket' => '<string>', // REQUIRED 'TargetGrants' => [ [ 'Grantee' => [ 'DisplayName' => '<string>', 'EmailAddress' => '<string>', 'ID' => '<string>', 'Type' => 'CanonicalUser|AmazonCustomerByEmail|Group', // REQUIRED 'URI' => '<string>', ], 'Permission' => 'FULL_CONTROL|READ|WRITE', ], // ... ], 'TargetObjectKeyFormat' => [ 'PartitionedPrefix' => [ 'PartitionDateSource' => 'EventTime|DeliveryTime', ], 'SimplePrefix' => [ ], ], 'TargetPrefix' => '<string>', // REQUIRED ], ], 'ChecksumAlgorithm' => 'CRC32|CRC32C|SHA1|SHA256', 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which to set the logging parameters.
- BucketLoggingStatus
-
- Required: Yes
- Type: BucketLoggingStatus structure
Container for logging status information.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ContentMD5
-
- Type: string
The MD5 hash of the
PutBucketLogging
request body.For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
The value will be computed on your behalf. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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 Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: Set logging configuration for a bucket
The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.
$result = $client->putBucketLogging([ 'Bucket' => 'sourcebucket', 'BucketLoggingStatus' => [ 'LoggingEnabled' => [ 'TargetBucket' => 'targetbucket', 'TargetGrants' => [ [ 'Grantee' => [ 'Type' => 'Group', 'URI' => 'http://acs.amazonaws.com/groups/global/AllUsers', ], 'Permission' => 'READ', ], ], 'TargetPrefix' => 'MyBucketLogs/', ], ], ]);
PutBucketMetricsConfiguration
$result = $client->putBucketMetricsConfiguration
([/* ... */]); $promise = $client->putBucketMetricsConfigurationAsync
([/* ... */]);
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
-
Parameter Syntax
$result = $client->putBucketMetricsConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'Id' => '<string>', // REQUIRED 'MetricsConfiguration' => [ // REQUIRED 'Filter' => [ 'AccessPointArn' => '<string>', 'And' => [ 'AccessPointArn' => '<string>', 'Prefix' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], 'Prefix' => '<string>', 'Tag' => [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], ], 'Id' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket for which the metrics configuration is set.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - Id
-
- Required: Yes
- Type: string
The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.
- MetricsConfiguration
-
- Required: Yes
- Type: MetricsConfiguration structure
Specifies the metrics configuration.
Result Syntax
[]
Result Details
Errors
There 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', 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', 'NotificationConfiguration' => [ // REQUIRED 'CloudFunctionConfiguration' => [ 'CloudFunction' => '<string>', 'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete', 'Events' => ['<string>', ...], 'Id' => '<string>', 'InvocationRole' => '<string>', ], 'QueueConfiguration' => [ 'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete', 'Events' => ['<string>', ...], 'Id' => '<string>', 'Queue' => '<string>', ], 'TopicConfiguration' => [ 'Event' => 's3:ReducedRedundancyLostObject|s3:ObjectCreated:*|s3:ObjectCreated:Put|s3:ObjectCreated:Post|s3:ObjectCreated:Copy|s3:ObjectCreated:CompleteMultipartUpload|s3:ObjectRemoved:*|s3:ObjectRemoved:Delete|s3:ObjectRemoved:DeleteMarkerCreated|s3:ObjectRestore:*|s3:ObjectRestore:Post|s3:ObjectRestore:Completed|s3:Replication:*|s3:Replication:OperationFailedReplication|s3:Replication:OperationNotTracked|s3:Replication:OperationMissedThreshold|s3:Replication:OperationReplicatedAfterThreshold|s3:ObjectRestore:Delete|s3:LifecycleTransition|s3:IntelligentTiering|s3:ObjectAcl:Put|s3:LifecycleExpiration:*|s3:LifecycleExpiration:Delete|s3:LifecycleExpiration:DeleteMarkerCreated|s3:ObjectTagging:*|s3:ObjectTagging:Put|s3:ObjectTagging:Delete', 'Events' => ['<string>', ...], 'Id' => '<string>', 'Topic' => '<string>', ], ], ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket.
- ChecksumAlgorithm
-
- Type: string
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
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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. - ContentMD5
-
- Type: string
The MD5 hash of the
PutPublicAccessBlock
request body.For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
The value will be computed on your behalf. - ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - NotificationConfiguration
-
- Required: Yes
- Type: NotificationConfigurationDeprecated structure
The container for the configuration.
Result Syntax
[]
Result Details
Errors
There 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
:
Parameter Syntax
$result = $client->putBucketNotificationConfiguration([ 'Bucket' => '<string>', // REQUIRED 'ExpectedBucketOwner' => '<string>', 'NotificationConfiguration' => [ // REQUIRED 'EventBridgeConfiguration' => [ ], 'LambdaFunctionConfigurations' => [ [ 'Events' => ['<string>', ...], // REQUIRED 'Filter' => [ 'Key' => [ 'FilterRules' => [ [ 'Name' => 'prefix|suffix', 'Value' => '<string>', ], // ... ], ], ], 'Id' => '<string>', 'LambdaFunctionArn' => '<string>', // REQUIRED ], // ... ], 'QueueConfigurations' => [ [ 'Events' => ['<string>', ...], // REQUIRED 'Filter' => [ 'Key' => [ 'FilterRules' => [ [ 'Name' => 'prefix|suffix', 'Value' => '<string>', ], // ... ], ], ], 'Id' => '<string>', 'QueueArn' => '<string>', // REQUIRED ], // ... ], 'TopicConfigurations' => [ [ 'Events' => ['<string>', ...], // REQUIRED 'Filter' => [ 'Key' => [ 'FilterRules' => [ [ 'Name' => 'prefix|suffix', 'Value' => '<string>', ], // ... ], ], ], 'Id' => '<string>', 'TopicArn' => '<string>', // REQUIRED ], // ... ], ], 'SkipDestinationValidation' => true || false, ]);
Parameter Details
Members
- Bucket
-
- Required: Yes
- Type: string
The name of the bucket.
- ExpectedBucketOwner
-
- Type: string
The account ID of the expected bucket owner. If the 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). - NotificationConfiguration
-
- Required: Yes
- Type: NotificationConfiguration structure
A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.
- SkipDestinationValidation
-
- Type: boolean
Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.
Result Syntax
[]
Result Details
Errors
There are no errors described for this operation.
Examples
Example 1: Set notification configuration for a bucket
The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.
$result = $client->putBucketNotificationConfiguration([ 'Bucket' => 'examplebucket', 'NotificationConfiguration' => [ 'TopicConfigurations' => [ [ 'Events' => [ 's3:ObjectCreated:*', ], 'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:s3-notification-topic', ], ], ], ]);
PutBucketOwnershipControls
$result = $client->putBucketOwnershipControls
([/* ... */]); $promise = $client->putBucketOwnershipControlsAsync
([/* ... */]);
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
:
Parameter Syntax
$result = $client->putBucketOwnershipControls([ 'Bucket' => '<string>', // REQUIRED 'ContentMD5' => '<string>', 'ExpectedBucketOwner' => '<string>', 'OwnershipControls' => [ // R