From d5b27f31c7ec4928c89915b1cc97604041a2e658 Mon Sep 17 00:00:00 2001
From: awstools
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.
+ * storage, you should call the ListParts API operation and ensure + * that the parts list is empty. *
- * Directory buckets -
- * If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.
- * To delete these in-progress multipart uploads, use the
- * ListMultipartUploads
operation to list the in-progress multipart
- * uploads in the bucket and use the AbortMultipartUpload
operation to
- * abort all the in-progress multipart uploads.
- *
ListMultipartUploads
operation
+ * to list the in-progress multipart uploads in the bucket and use the
+ * AbortMultipartUpload
operation to abort all the in-progress
+ * multipart uploads.
*
- * Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
- * General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload - * and Permissions in the Amazon S3 - * User Guide.
+ * 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. *@@ -126,6 +128,7 @@ export interface AbortMultipartUploadCommandOutput extends AbortMultipartUploadO * UploadId: "STRING_VALUE", // required * RequestPayer: "requester", * ExpectedBucketOwner: "STRING_VALUE", + * IfMatchInitiatedTime: new Date("TIMESTAMP"), * }; * const command = new AbortMultipartUploadCommand(input); * const response = await client.send(command); diff --git a/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts b/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts index de03417ea05d..abd0fe6b7aa8 100644 --- a/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts +++ b/clients/client-s3/src/commands/CompleteMultipartUploadCommand.ts @@ -37,41 +37,44 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU /** *
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.
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).
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.
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.
+ * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
If you provide an additional checksum
- * value in your MultipartUpload
requests and the
+ * value in your MultipartUpload
requests and the
* object is encrypted with Key Management Service, you must have permission to use the
- * kms:Decrypt
action for the
- * CompleteMultipartUpload
request to succeed.
kms:Decrypt
action for the
+ * CompleteMultipartUpload
request to succeed.
*
@@ -99,9 +102,10 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU
* Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see
* CreateSession
* .
If the object is encrypted with
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
If the object is encrypted with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
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.
+ *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
@@ -126,9 +131,9 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU * *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.
+ *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
@@ -140,8 +145,8 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU * *Description: The list of parts was not in ascending order. The parts list - * must be specified in order by part number.
+ *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
@@ -153,9 +158,9 @@ export interface CompleteMultipartUploadCommandOutput extends CompleteMultipartU * *Description: The specified multipart upload does not exist. The upload ID - * might be invalid, or the multipart upload might have been aborted or - * completed.
+ *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
diff --git a/clients/client-s3/src/commands/CopyObjectCommand.ts b/clients/client-s3/src/commands/CopyObjectCommand.ts index 6bb02ca9bfa2..27e003c99b15 100644 --- a/clients/client-s3/src/commands/CopyObjectCommand.ts +++ b/clients/client-s3/src/commands/CopyObjectCommand.ts @@ -43,55 +43,63 @@ export interface CopyObjectCommandOutput extends CopyObjectOutput, __MetadataBea * (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.
+ *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.
+ *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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints 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.
+ *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.
+ *Both the Region that you want to copy the object from and the Region that you want to + * copy the object to must be enabled for your account. For more information about how to + * enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services + * Account Management Guide.
*Amazon S3 transfer acceleration does not support cross-Region copies. If you request a
* cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad
* Request
error. For more information, see Transfer
- * Acceleration.
All CopyObject
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz-
prefix, including
- * x-amz-copy-source
, must be signed. For more information, see REST Authentication.
All CopyObject
requests must be authenticated and signed by using
+ * IAM credentials (access key ID and secret access key for the IAM identities).
+ * All headers with the x-amz-
prefix, including
+ * x-amz-copy-source
, must be signed. For more information, see
+ * REST Authentication.
- * Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject
API operation, instead of using the
- * temporary security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
+ * Directory buckets - You must use the + * IAM credentials to authenticate and authorize your access to the + *CopyObject
API operation, instead of using the temporary security
+ * credentials through the CreateSession
API operation.
+ * Amazon Web Services CLI or SDKs handles authentication and authorization on your + * behalf.
*You must have - * read access to the source object and write - * access to the destination bucket.
+ *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
+ * General purpose bucket permissions - You
+ * must have permissions in an IAM policy based on the source and destination
* bucket types in a CopyObject
operation.
* 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.
CopyObject
+ * operation.
* If the source object that you want to copy is in a
* directory bucket, you must have the
* s3express:CreateSession
* permission in
- * the Action
element of a policy to read the object. By default, the session is in the ReadWrite
mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode
condition key to ReadOnly
on the copy source bucket.
Action
element of a policy to read the object. By
+ * default, the session is in the ReadWrite
mode. If you
+ * want to restrict the access, you can explicitly set the
+ * s3express:SessionMode
condition key to
+ * ReadOnly
on the copy source bucket.
* If the copy destination is a directory bucket, you must have the + *
If the copy destination is a directory bucket, you must have the
+ *
* s3express:CreateSession
* permission in the
- * Action
element of a policy to write the object
- * to the destination. The s3express:SessionMode
condition
- * key can't be set to ReadOnly
on the copy destination bucket.
Action
element of a policy to write the object to the
+ * destination. The s3express:SessionMode
condition key
+ * can't be set to ReadOnly
on the copy destination bucket.
+ *
* If the object is encrypted with
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the - * Amazon S3 User Guide.
+ *If the object is encrypted with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for + * S3 Express One Zone in the Amazon S3 User Guide.
*If the copy is successful, you receive a response with information about the copied - * object.
+ *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.
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.
+ * standard Amazon S3 error. *If the error occurs during the copy operation, the error response is
- * embedded in the 200 OK
response. For example, in a cross-region copy, you
- * may encounter throttling and receive a 200 OK
response.
- * For more information, see Resolve
- * the Error 200 response when copying objects to Amazon S3.
- * The 200 OK
status code means the copy was accepted, but
- * it doesn't mean the copy is complete. Another example is
- * when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK
response.
- * You must stay connected to Amazon S3 until the entire response is successfully received and processed.
If you call this API operation directly, make - * sure to design your application to parse the content of the response and handle it - * appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the - * embedded error and apply error handling per your configuration settings (including - * automatically retrying the request as appropriate). If the condition persists, the SDKs - * throw an exception (or, for the SDKs that don't use exceptions, they return an + *
If the error occurs during the copy operation, the error response
+ * is embedded in the 200 OK
response. For example, in a
+ * cross-region copy, you may encounter throttling and receive a
+ * 200 OK
response. For more information, see Resolve the Error 200 response when copying objects to
+ * Amazon S3. The 200 OK
status code means the copy
+ * was accepted, but it doesn't mean the copy is complete. Another
+ * example is when you disconnect from Amazon S3 before the copy is complete,
+ * Amazon S3 might cancel the copy and you may receive a 200 OK
+ * response. You must stay connected to Amazon S3 until the entire response is
+ * successfully received and processed.
If you call this API operation directly, make sure to design your + * application to parse the content of the response and handle it + * appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The + * SDKs detect the embedded error and apply error handling per your + * configuration settings (including automatically retrying the request + * as appropriate). If the condition persists, the SDKs throw an + * exception (or, for the SDKs that don't use exceptions, they return an * error).
*The copy request charge is based on the storage class and Region that you specify for - * the destination object. The request can also result in a data retrieval charge for the - * source if the source storage class bills for data retrieval. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see - * Amazon S3 pricing.
+ *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.
*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.
+ *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.
@@ -45,12 +45,14 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat *
- * General purpose buckets - If you send your CreateBucket
request to the s3.amazonaws.com
global endpoint,
- * the request goes to the us-east-1
Region. So the signature
- * calculations in Signature Version 4 must use us-east-1
as the Region, even
- * if the location constraint in the request specifies another Region where the bucket is
- * to be created. If you create a bucket in a Region other than US East (N. Virginia), your
- * application must be able to handle 307 redirect. For more information, see Virtual hosting of
+ * General purpose buckets - If you send your
+ * CreateBucket
request to the s3.amazonaws.com
global
+ * endpoint, the request goes to the us-east-1
Region. So the signature
+ * calculations in Signature Version 4 must use us-east-1
as the Region,
+ * even if the location constraint in the request specifies another Region where the
+ * bucket is to be created. If you create a bucket in a Region other than US East (N.
+ * Virginia), your application must be able to handle 307 redirect. For more
+ * information, see Virtual hosting of
* buckets in the Amazon S3 User Guide.
- * General purpose bucket permissions - In addition to the s3:CreateBucket
permission, the following permissions are
- * required in a policy when your CreateBucket
request includes specific
- * headers:
s3:CreateBucket
permission, the following
+ * permissions are required in a policy when your CreateBucket
+ * request includes specific headers:
*
- * Access control lists (ACLs) - In your CreateBucket
request, if you specify an access control list (ACL)
- * and set it to public-read
, public-read-write
,
- * authenticated-read
, or if you explicitly specify any other custom ACLs, both s3:CreateBucket
and
- * s3:PutBucketAcl
permissions are required. In your CreateBucket
request, if you set the ACL to private
,
- * or if you don't specify any ACLs, only the s3:CreateBucket
permission is required.
- *
CreateBucket
request, if you specify an
+ * access control list (ACL) and set it to public-read
,
+ * public-read-write
, authenticated-read
, or
+ * if you explicitly specify any other custom ACLs, both
+ * s3:CreateBucket
and s3:PutBucketAcl
+ * permissions are required. In your CreateBucket
request,
+ * if you set the ACL to private
, or if you don't specify
+ * any ACLs, only the s3:CreateBucket
permission is
+ * required.
*
* Object Lock - In your
- * CreateBucket
request, if you set
- * x-amz-bucket-object-lock-enabled
to true, the
- * s3:PutBucketObjectLockConfiguration
and
- * s3:PutBucketVersioning
permissions are required.
CreateBucket
request, if you set
+ * x-amz-bucket-object-lock-enabled
to true, the
+ * s3:PutBucketObjectLockConfiguration
and
+ * s3:PutBucketVersioning
permissions are
+ * required.
*
- * S3 Object Ownership - If your
- * CreateBucket
request includes the
- * x-amz-object-ownership
header, then the
- * s3:PutBucketOwnershipControls
permission is required.
CreateBucket
request includes the
+ * x-amz-object-ownership
header, then the
+ * s3:PutBucketOwnershipControls
permission is
+ * required.
* To set an ACL on a bucket as part of a
* CreateBucket
request, you must explicitly set S3
@@ -105,10 +114,10 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat
* Public Access on the bucket before using PutBucketAcl
* to set the ACL. If you try to create a bucket with a public ACL,
* the request will fail.
For the majority of modern use cases in S3, we recommend - * that you keep all Block Public Access settings enabled and keep - * ACLs disabled. If you would like to share data with users outside - * of your account, you can use bucket policies as needed. For more + *
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.
@@ -116,30 +125,36 @@ export interface CreateBucketCommandOutput extends CreateBucketOutput, __Metadat *
- * 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
+ * S3 Block Public Access - If
+ * your specific use case requires granting public access to your S3
+ * resources, you can disable Block Public Access. Specifically, you can
+ * create a new bucket with Block Public Access enabled, then separately
+ * call the
* DeletePublicAccessBlock
* API. To use this operation, you must have the
- * s3:PutBucketPublicAccessBlock
permission. For more information about S3 Block Public
- * Access, see Blocking
- * public access to your Amazon S3 storage in the
- * Amazon S3 User Guide.
s3:PutBucketPublicAccessBlock
permission. For more
+ * information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the
+ * Amazon S3 User Guide.
*
- * Directory bucket permissions - You must have the s3express:CreateBucket
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
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. - *
+ *The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 + * Block Public Access are not supported for directory buckets. For + * directory buckets, all Block Public Access settings are enabled at the + * bucket level and S3 Object Ownership is set to Bucket owner enforced + * (ACLs disabled). These settings can't be modified.
*For more information about permissions for creating and working with - * directory buckets, see Directory buckets in the Amazon S3 User Guide. - * For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
+ * directory buckets, 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. *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.
+ * 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.
+ *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 - + * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
For request signing, multipart upload is just a series of regular requests. You initiate - * a multipart upload, send one or more requests to upload parts, and then complete the - * multipart upload process. You sign each request individually. There is nothing special - * about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 User Guide.
+ *For request signing, multipart upload is just a series of regular requests. You + * initiate a multipart upload, send one or more requests to upload parts, and then + * complete the multipart upload process. You sign each request individually. There + * is nothing special about signing multipart upload requests. For more information + * about signing, see Authenticating + * Requests (Amazon Web Services Signature Version 4) in the + * Amazon S3 User Guide.
*
- * General purpose 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.
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.
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.
*
@@ -152,44 +165,53 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa
* If you specify If you specify
+ * To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester
- * must have permission to the To perform a multipart upload with encryption by using an
+ * Amazon Web Services KMS key, the requester must have permission to the
+ * 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. 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 All
*
* x-amz-server-side-encryption:aws:kms
, but
- * don't provide x-amz-server-side-encryption-aws-kms-key-id
,
- * Amazon S3 uses the Amazon Web Services managed key (aws/s3
key) in KMS to
- * protect the data.x-amz-server-side-encryption:aws:kms
, but
+ * don't provide
+ * x-amz-server-side-encryption-aws-kms-key-id
,
+ * Amazon S3 uses the Amazon Web Services managed key (aws/s3
key) in
+ * KMS to protect the data.kms:Decrypt
and kms:GenerateDataKey*
- * actions on the key. These permissions are required because Amazon S3 must decrypt and read data
- * from the encrypted file parts before it completes the multipart upload. For more
- * information, see Multipart upload API
- * and permissions and Protecting data using
- * server-side encryption with Amazon Web Services KMS in the
- * Amazon S3 User Guide.kms:Decrypt
and
+ * kms:GenerateDataKey*
actions on the key.
+ * These permissions are required because Amazon S3 must decrypt and
+ * read data from the encrypted file parts before it completes
+ * the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services
+ * KMS in the
+ * Amazon S3 User Guide.GET
and PUT
requests for an object
- * protected by KMS fail if you don't make them by using Secure Sockets
- * Layer (SSL), Transport Layer Security (TLS), or Signature Version
- * 4. For information about configuring any of the officially supported Amazon Web Services
- * SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication
- * in the Amazon S3 User Guide.GET
and PUT
requests for an
+ * object protected by KMS fail if you don't make them by
+ * using Secure Sockets Layer (SSL), Transport Layer Security
+ * (TLS), or Signature Version 4. For information about
+ * configuring any of the officially supported Amazon Web Services SDKs and
+ * Amazon Web Services CLI, see Specifying the Signature Version in
+ * Request Authentication in the
+ * Amazon S3 User Guide.
For more information about server-side encryption with KMS keys - * (SSE-KMS), see Protecting Data - * Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.
+ * (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.
+ *Use customer-provided encryption keys (SSE-C) – If you want to + * manage your own encryption keys, provide all the following headers in + * the request.
*@@ -207,16 +229,17 @@ export interface CreateMultipartUploadCommandOutput extends CreateMultipartUploa *
*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.
+ *For more information about server-side encryption with + * customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with + * customer-provided encryption keys (SSE-C) in the + * Amazon S3 User Guide.
*
- * Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
+ * Directory buckets -
+ * For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession
requests or PUT
object requests. Then, new objects
* are automatically encrypted with the desired encryption settings. For more
* information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
For directory buckets, when you perform a CreateMultipartUpload
operation and an UploadPartCopy
operation,
- * the request headers you provide in the CreateMultipartUpload
request must match the default encryption configuration of the destination bucket.
For directory buckets, when you perform a
+ * CreateMultipartUpload
operation and an
+ * UploadPartCopy
operation, the request headers you provide
+ * in the CreateMultipartUpload
request must match the default
+ * encryption configuration of the destination bucket.
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. - *
+ *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
@@ -67,30 +67,44 @@ export interface CreateSessionCommandOutput extends CreateSessionOutput, __Metad
*
*
- * CopyObject
API operation - Unlike other Zonal endpoint API operations, the CopyObject
API operation doesn't use the temporary security credentials returned from the CreateSession
API operation for authentication and authorization. For information about authentication and authorization of the CopyObject
API operation on directory buckets, see CopyObject.
CopyObject
API operation -
+ * Unlike other Zonal endpoint API operations, the CopyObject
API operation doesn't use
+ * the temporary security credentials returned from the CreateSession
+ * API operation for authentication and authorization. For information about
+ * authentication and authorization of the CopyObject
API operation on
+ * directory buckets, see CopyObject.
*
*
- * HeadBucket
API operation - Unlike other Zonal endpoint API operations, the HeadBucket
API operation doesn't use the temporary security credentials returned from the CreateSession
API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket
API operation on directory buckets, see HeadBucket.
HeadBucket
API operation -
+ * Unlike other Zonal endpoint API operations, the HeadBucket
API operation doesn't use
+ * the temporary security credentials returned from the CreateSession
+ * API operation for authentication and authorization. For information about
+ * authentication and authorization of the HeadBucket
API operation on
+ * directory buckets, see HeadBucket.
* To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that
- * grants To obtain temporary security credentials, you must create
+ * a bucket policy or an IAM identity-based policy that grants To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the If you want to encrypt objects with SSE-KMS, you must also have the s3express:CreateSession
permission to the bucket. In a
- * policy, you can have the s3express:SessionMode
condition key to
- * control who can create a ReadWrite
or ReadOnly
session.
- * For more information about ReadWrite
or ReadOnly
- * sessions, see
+ * s3express:CreateSession
+ * permission to the bucket. In a policy, you can have the
+ * s3express:SessionMode
condition key to control who can create a
+ * ReadWrite
or ReadOnly
session. For more information
+ * about ReadWrite
or ReadOnly
sessions, see
* x-amz-create-session-mode
* . For example policies, see
- * Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the
- * Amazon S3 User Guide. s3express:CreateSession
permission.kms:GenerateDataKey
and the kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the target KMS key.
To grant cross-account access to Zonal endpoint API operations, the bucket policy should also
+ * grant both accounts the s3express:CreateSession
permission.
If you want to encrypt objects with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and the kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the target KMS
+ * key.
This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Deletes an analytics configuration for the bucket (specified by the analytics * configuration ID).
diff --git a/clients/client-s3/src/commands/DeleteBucketCommand.ts b/clients/client-s3/src/commands/DeleteBucketCommand.ts index df5bcbbbd495..db7e6e62bba5 100644 --- a/clients/client-s3/src/commands/DeleteBucketCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketCommand.ts @@ -34,7 +34,9 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {} *- * 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 - 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. *@@ -51,11 +53,16 @@ export interface DeleteBucketCommandOutput extends __MetadataBearer {} *
- * General purpose bucket permissions - You must have the s3:DeleteBucket
permission on the specified bucket in a policy.
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.
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.
* This operation is not supported by directory buckets.
+ *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 diff --git a/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts b/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts index e18a4fb3379f..717433843785 100644 --- a/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketEncryptionCommand.ts @@ -34,13 +34,16 @@ export interface DeleteBucketEncryptionCommandOutput extends __MetadataBearer {} *
- * General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket - * Default Encryption in the Amazon S3 User Guide.
+ * 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.
+ * Directory buckets - + * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption + * configuration in directory buckets, see Setting + * default server-side encryption behavior for directory buckets. *
- * General purpose bucket permissions - The s3:PutEncryptionConfiguration
permission is required in a policy.
- * The bucket owner has this permission
- * by default. The bucket owner can grant this permission to others. For more information
- * about permissions, see Permissions Related to Bucket Operations and Managing
- * Access Permissions to Your Amazon S3 Resources.
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.
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.
* This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts b/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts index 7acee47f6f5f..8e42e8263338 100644 --- a/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketInventoryConfigurationCommand.ts @@ -32,7 +32,7 @@ export interface DeleteBucketInventoryConfigurationCommandOutput extends __Metad /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Deletes an inventory configuration (identified by the inventory ID) from the * bucket.
diff --git a/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts b/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts index 4f8fe764b867..7cd655401a3b 100644 --- a/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts +++ b/clients/client-s3/src/commands/DeleteBucketLifecycleCommand.ts @@ -28,18 +28,61 @@ export interface DeleteBucketLifecycleCommandInput extends DeleteBucketLifecycle export interface DeleteBucketLifecycleCommandOutput extends __MetadataBearer {} /** - *This operation is not supported by directory buckets.
- *Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the + *
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the * lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your * objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of * rules contained in the deleted lifecycle configuration.
- *To use this operation, you must have permission to perform the
- * s3:PutLifecycleConfiguration
action. By default, the bucket owner has this
- * permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully - * propagated to all the Amazon S3 systems.
+ *
+ * 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, see Regional and Zonal endpoints in the
+ * Amazon S3 User Guide.
+ * Directory buckets - The HTTP Host
+ * header syntax is
+ * s3express-control.region.amazonaws.com
.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
*Related actions include:
*This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts b/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts
index 172a1876498d..c9ff659610cf 100644
--- a/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts
+++ b/clients/client-s3/src/commands/DeleteBucketOwnershipControlsCommand.ts
@@ -32,7 +32,7 @@ export interface DeleteBucketOwnershipControlsCommandOutput extends __MetadataBe
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts b/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts
index ae2202246b13..9d5b582d37bc 100644
--- a/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts
+++ b/clients/client-s3/src/commands/DeleteBucketPolicyCommand.ts
@@ -28,8 +28,7 @@ export interface DeleteBucketPolicyCommandInput extends DeleteBucketPolicyReques
export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {}
/**
- *
Deletes the - * policy of a specified bucket.
+ *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 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
- * If you don't have 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
+ * If you don't have 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
- * 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
- * General purpose bucket permissions - The https://s3express-control.region_code.amazonaws.com/bucket-name
@@ -40,33 +39,38 @@ export interface DeleteBucketPolicyCommandOutput extends __MetadataBearer {}
*
*
DeleteBucketPolicy
permissions on the specified bucket and belong to the
- * bucket owner's account in order to use this operation.DeleteBucketPolicy
permissions, Amazon S3 returns a 403
- * Access Denied
error. If you have the correct permissions, but you're not using an
- * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not
- * Allowed
error.DeleteBucketPolicy
permissions on the specified bucket and belong
+ * to the bucket owner's account in order to use this operation.DeleteBucketPolicy
permissions, Amazon S3 returns a
+ * 403 Access Denied
error. If you have the correct permissions, but
+ * you're not using an identity that belongs to the bucket owner's account, Amazon S3
+ * returns a 405 Method Not Allowed
error.GetBucketPolicy
, PutBucketPolicy
, and
- * DeleteBucketPolicy
API actions, even if their bucket policy explicitly
- * denies the root principal's access. Bucket owner root principals can only be blocked
- * from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
- * policies.GetBucketPolicy
, PutBucketPolicy
, and
+ * DeleteBucketPolicy
API actions, even if their bucket policy
+ * explicitly denies the root principal's access. Bucket owner root principals can
+ * only be blocked from performing these API actions by VPC endpoint policies and
+ * Amazon Web Services Organizations policies.
*
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.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.
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.
* This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts b/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts
index 6370e78d36ea..fb3d0475232c 100644
--- a/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts
+++ b/clients/client-s3/src/commands/DeleteBucketTaggingCommand.ts
@@ -29,7 +29,7 @@ export interface DeleteBucketTaggingCommandOutput extends __MetadataBearer {}
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts b/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts
index 88df9c8d20b8..2c675338d71a 100644
--- a/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts
+++ b/clients/client-s3/src/commands/DeleteBucketWebsiteCommand.ts
@@ -29,7 +29,7 @@ export interface DeleteBucketWebsiteCommandOutput extends __MetadataBearer {}
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets.
This action removes the website configuration for a bucket. Amazon S3 returns a This operation is not supported by directory buckets. This operation is not supported for directory buckets.200
* OK
response upon successfully deleting a website configuration on the specified
diff --git a/clients/client-s3/src/commands/DeleteObjectCommand.ts b/clients/client-s3/src/commands/DeleteObjectCommand.ts
index 6f938a15d5d5..2e0d30ea5ce4 100644
--- a/clients/client-s3/src/commands/DeleteObjectCommand.ts
+++ b/clients/client-s3/src/commands/DeleteObjectCommand.ts
@@ -133,6 +133,9 @@ export interface DeleteObjectCommandOutput extends DeleteObjectOutput, __Metadat
* RequestPayer: "requester",
* BypassGovernanceRetention: true || false,
* ExpectedBucketOwner: "STRING_VALUE",
+ * IfMatch: "STRING_VALUE",
+ * IfMatchLastModifiedTime: new Date("TIMESTAMP"),
+ * IfMatchSize: Number("long"),
* };
* const command = new DeleteObjectCommand(input);
* const response = await client.send(command);
diff --git a/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts b/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts
index e14facf9d3a9..f1c0711b8df7 100644
--- a/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts
+++ b/clients/client-s3/src/commands/DeleteObjectTaggingCommand.ts
@@ -30,7 +30,7 @@ export interface DeleteObjectTaggingCommandOutput extends DeleteObjectTaggingOut
/**
*
Removes the entire tag set from the specified object. For more information about * managing object tags, see Object Tagging.
diff --git a/clients/client-s3/src/commands/DeleteObjectsCommand.ts b/clients/client-s3/src/commands/DeleteObjectsCommand.ts index 09378b0aaa82..55eaf27d5339 100644 --- a/clients/client-s3/src/commands/DeleteObjectsCommand.ts +++ b/clients/client-s3/src/commands/DeleteObjectsCommand.ts @@ -31,44 +31,46 @@ export interface DeleteObjectsCommandOutput extends DeleteObjectsOutput, __Metad /** *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 + * 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.
+ *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 - + * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints 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.
+ * 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.
+ * Delete in the Amazon S3 User Guide. *- * Directory buckets - MFA delete is not supported by directory buckets.
+ * Directory buckets - + * MFA delete is not supported by directory buckets. *
- * General purpose bucket permissions - The following permissions are required in your policies when your
- * DeleteObjects
request includes specific headers.
DeleteObjects
request includes specific headers.
*
*
* s3:DeleteObject
- * - To delete an object from a bucket, you must always specify the s3:DeleteObject
permission.
s3:DeleteObject
permission.
*
*
* s3:DeleteObjectVersion
- * - To delete a specific version of an object from a versioning-enabled bucket, you must specify the s3:DeleteObjectVersion
permission.
s3:DeleteObjectVersion
permission.
* - * 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.
+ * General purpose bucket - The Content-MD5 + * request header is required for all Multi-Object Delete requests. Amazon S3 uses + * the header value to ensure that your request body has not been altered in + * transit. *
- * Directory bucket - The Content-MD5 request header or a additional checksum request header
- * (including x-amz-checksum-crc32
, x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or
- * x-amz-checksum-sha256
) is required for all Multi-Object Delete requests.
x-amz-checksum-crc32
,
+ * x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or
+ * x-amz-checksum-sha256
) is required for all Multi-Object
+ * Delete requests.
* This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Removes the This operation is not supported by directory buckets. This operation is not supported for directory buckets.PublicAccessBlock
configuration for an Amazon S3 bucket. To use this
* operation, you must have the s3:PutBucketPublicAccessBlock
permission. For
diff --git a/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts
index 0b5cb6061163..6cd0cbf59f8a 100644
--- a/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketAccelerateConfigurationCommand.ts
@@ -35,7 +35,7 @@ export interface GetBucketAccelerateConfigurationCommandOutput
/**
*
This implementation of the GET action uses the This operation is not supported by directory buckets. This operation is not supported for directory buckets.accelerate
subresource to
* return the Transfer Acceleration state of a bucket, which is either Enabled
or
diff --git a/clients/client-s3/src/commands/GetBucketAclCommand.ts b/clients/client-s3/src/commands/GetBucketAclCommand.ts
index 44669d5f3978..bbf9fc234064 100644
--- a/clients/client-s3/src/commands/GetBucketAclCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketAclCommand.ts
@@ -30,7 +30,7 @@ export interface GetBucketAclCommandOutput extends GetBucketAclOutput, __Metadat
/**
*
This implementation of the This operation is not supported by directory buckets. This operation is not supported for directory buckets.GET
action uses the acl
subresource
* to return the access control list (ACL) of a bucket. To use GET
to return the
diff --git a/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts
index 20e3d4c1a0c8..7f9058bd531d 100644
--- a/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketAnalyticsConfigurationCommand.ts
@@ -35,7 +35,7 @@ export interface GetBucketAnalyticsConfigurationCommandOutput
/**
*
This implementation of the GET action returns an analytics configuration (identified by * the analytics configuration ID) from the bucket.
diff --git a/clients/client-s3/src/commands/GetBucketCorsCommand.ts b/clients/client-s3/src/commands/GetBucketCorsCommand.ts index 1b6833dcb836..260230abfba4 100644 --- a/clients/client-s3/src/commands/GetBucketCorsCommand.ts +++ b/clients/client-s3/src/commands/GetBucketCorsCommand.ts @@ -30,7 +30,7 @@ export interface GetBucketCorsCommandOutput extends GetBucketCorsOutput, __Metad /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the * bucket.
diff --git a/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts b/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts index 50390c28f41d..672997f93743 100644 --- a/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts +++ b/clients/client-s3/src/commands/GetBucketEncryptionCommand.ts @@ -40,13 +40,16 @@ export interface GetBucketEncryptionCommandOutput extends GetBucketEncryptionOut *- * General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket - * Default Encryption in the Amazon S3 User Guide.
+ * 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.
+ * Directory buckets - + * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption + * configuration in directory buckets, see Setting + * default server-side encryption behavior for directory buckets. *
- * General purpose bucket permissions - The s3:GetEncryptionConfiguration
permission is required in a policy.
- * The bucket owner has this permission
- * by default. The bucket owner can grant this permission to others. For more information
- * about permissions, see Permissions Related to Bucket Operations and Managing
- * Access Permissions to Your Amazon S3 Resources.
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.
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.
* This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts index c87ed307a9d7..38767f30bc06 100644 --- a/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketInventoryConfigurationCommand.ts @@ -39,7 +39,7 @@ export interface GetBucketInventoryConfigurationCommandOutput /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Returns an inventory configuration (identified by the inventory configuration ID) from * the bucket.
diff --git a/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts index 2c147d18db10..91e6ee87dc48 100644 --- a/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketLifecycleConfigurationCommand.ts @@ -34,25 +34,69 @@ export interface GetBucketLifecycleConfigurationCommandOutput __MetadataBearer {} /** - *This operation is not supported by directory buckets.
- *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 GetBucketLifecycle. Accordingly, - * this section describes the latest API. The response describes the new filter element - * that you can use to specify a filter to select a subset of objects to which the rule - * applies. If you are using a previous version of the lifecycle configuration, it still - * works. For the earlier action,
- *Returns the lifecycle configuration information set on the bucket. For information about + *
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.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object + * key name prefix, one or more object tags, object size, or any combination of these. + * Accordingly, this section describes the latest API, which is compatible with the new + * functionality. The previous version of the API supported filtering based only on an object + * key name prefix, which is supported for general purpose buckets for backward compatibility. + * For the related API description, see GetBucketLifecycle.
+ *Lifecyle configurations for directory buckets only support expiring objects and + * cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters + * are not supported.
+ *
+ * General purpose bucket permissions - By
+ * default, all Amazon S3 resources are private, including buckets, objects, and
+ * related subresources (for example, lifecycle configuration and website
+ * configuration). Only the resource owner (that is, the Amazon Web Services account that
+ * created it) can access the resource. The resource owner can optionally grant
+ * access permissions to others by writing an access policy. For this
+ * operation, a user must have the s3:GetLifecycleConfiguration
+ * permission.
For more information about permissions, see Managing Access + * Permissions to Your Amazon S3 Resources.
+ *
+ * Directory bucket permissions -
+ * You must have the s3express:GetLifecycleConfiguration
+ * permission in an IAM identity-based policy to use this operation.
+ * Cross-account access to this API operation isn't supported. The resource
+ * owner can optionally grant access permissions to others by creating a role
+ * or user for them as long as they are within the same account as the owner
+ * and resource.
For more information about directory bucket policies and permissions, see + * Authorizing Regional endpoint APIs with IAM in the + * Amazon S3 User Guide.
+ *
+ * Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name
+ *
. Virtual-hosted-style requests aren't supported.
+ * For more information, see Regional and Zonal endpoints in the
+ * Amazon S3 User Guide.
+ * Directory buckets - The HTTP Host
+ * header syntax is
+ * s3express-control.region.amazonaws.com
.
* GetBucketLifecycleConfiguration
has the following special error:
This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Returns the Region the bucket resides in. You set the bucket's Region using the
* This operation is not supported by directory buckets. This operation is not supported for directory buckets.LocationConstraint
request parameter in a CreateBucket
diff --git a/clients/client-s3/src/commands/GetBucketLoggingCommand.ts b/clients/client-s3/src/commands/GetBucketLoggingCommand.ts
index 0dabf2894284..960a6ea25914 100644
--- a/clients/client-s3/src/commands/GetBucketLoggingCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketLoggingCommand.ts
@@ -30,7 +30,7 @@ export interface GetBucketLoggingCommandOutput extends GetBucketLoggingOutput, _
/**
*
Returns the logging status of a bucket and the permissions users have to view and modify * that status.
diff --git a/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts index 731571782215..3d2d9b489991 100644 --- a/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketMetricsConfigurationCommand.ts @@ -35,7 +35,7 @@ export interface GetBucketMetricsConfigurationCommandOutput /** *This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts b/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts index 9765d66f3180..d1d43c0c9e99 100644 --- a/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetBucketNotificationConfigurationCommand.ts @@ -33,7 +33,7 @@ export interface GetBucketNotificationConfigurationCommandOutput extends Notific /** *This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts b/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts
index a0a633453cc7..ca31f1880123 100644
--- a/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketOwnershipControlsCommand.ts
@@ -30,7 +30,7 @@ export interface GetBucketOwnershipControlsCommandOutput extends GetBucketOwners
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/GetBucketPolicyCommand.ts b/clients/client-s3/src/commands/GetBucketPolicyCommand.ts
index d473f43f4c3b..692066b7c2c1 100644
--- a/clients/client-s3/src/commands/GetBucketPolicyCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketPolicyCommand.ts
@@ -40,42 +40,51 @@ export interface GetBucketPolicyCommandOutput extends GetBucketPolicyOutput, __M
*
If you are using an identity other than the
- * root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the
- * GetBucketPolicy
permissions on the specified bucket and belong to the
- * bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403
- * Access Denied
error. If you have the correct permissions, but you're not using an
- * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not
- * Allowed
error.
If you are using an identity other than the root user of the Amazon Web Services account that
+ * owns the bucket, the calling identity must both have the
+ * GetBucketPolicy
permissions on the specified bucket and belong to
+ * the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a
+ * 403 Access Denied
error. If you have the correct permissions, but
+ * you're not using an identity that belongs to the bucket owner's account, Amazon S3
+ * returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their own
- * buckets, the root principal in a bucket owner's Amazon Web Services account can perform the
- * GetBucketPolicy
, PutBucketPolicy
, and
- * DeleteBucketPolicy
API actions, even if their bucket policy explicitly
- * denies the root principal's access. Bucket owner root principals can only be blocked
- * from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
- * policies.
To ensure that bucket owners don't inadvertently lock themselves out of
+ * their own buckets, the root principal in a bucket owner's Amazon Web Services account can
+ * perform the GetBucketPolicy
, PutBucketPolicy
, and
+ * DeleteBucketPolicy
API actions, even if their bucket policy
+ * explicitly denies the root principal's access. Bucket owner root principals can
+ * only be blocked from performing these API actions by VPC endpoint policies and
+ * Amazon Web Services Organizations policies.
- * General purpose bucket permissions - The s3:GetBucketPolicy
permission is required in a policy.
- * For more information about general purpose buckets bucket policies, see Using Bucket Policies and User
- * Policies in the Amazon S3 User Guide.
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.
s3express:GetBucketPolicy
permission in
+ * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
+ * For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
* - * General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
+ * General purpose buckets example bucket policies + * - See Bucket policy + * examples in the Amazon S3 User Guide. *- * Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
+ * Directory bucket example bucket policies + * - See Example bucket policies for S3 Express One Zone in the + * Amazon S3 User Guide. *This operation is not supported by directory buckets.
+ *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 This operation is not supported by directory buckets. This operation is not supported for directory buckets.s3:GetBucketPolicyStatus
diff --git a/clients/client-s3/src/commands/GetBucketReplicationCommand.ts b/clients/client-s3/src/commands/GetBucketReplicationCommand.ts
index 6bd7801297e3..2884b3b675a7 100644
--- a/clients/client-s3/src/commands/GetBucketReplicationCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketReplicationCommand.ts
@@ -30,7 +30,7 @@ export interface GetBucketReplicationCommandOutput extends GetBucketReplicationO
/**
*
Returns the replication configuration of a bucket.
*This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/GetBucketTaggingCommand.ts b/clients/client-s3/src/commands/GetBucketTaggingCommand.ts
index 344072a22444..c7591ffbaba7 100644
--- a/clients/client-s3/src/commands/GetBucketTaggingCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketTaggingCommand.ts
@@ -30,7 +30,7 @@ export interface GetBucketTaggingCommandOutput extends GetBucketTaggingOutput, _
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/GetBucketVersioningCommand.ts b/clients/client-s3/src/commands/GetBucketVersioningCommand.ts
index d4e7f1ae7a6c..aa394707a27a 100644
--- a/clients/client-s3/src/commands/GetBucketVersioningCommand.ts
+++ b/clients/client-s3/src/commands/GetBucketVersioningCommand.ts
@@ -30,7 +30,7 @@ export interface GetBucketVersioningCommandOutput extends GetBucketVersioningOut
/**
* This operation is not supported by directory buckets. 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 operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/GetObjectAclCommand.ts b/clients/client-s3/src/commands/GetObjectAclCommand.ts
index 44267b96163a..17289b4b64d6 100644
--- a/clients/client-s3/src/commands/GetObjectAclCommand.ts
+++ b/clients/client-s3/src/commands/GetObjectAclCommand.ts
@@ -30,7 +30,7 @@ export interface GetObjectAclCommandOutput extends GetObjectAclOutput, __Metadat
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets. Returns the access control list (ACL) of an object. To use this operation, you must have
*
- * 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
- * General purpose bucket permissions - To use
- * s3:GetObjectAcl
permissions or READ_ACP
access to the object.
diff --git a/clients/client-s3/src/commands/GetObjectAttributesCommand.ts b/clients/client-s3/src/commands/GetObjectAttributesCommand.ts
index 57c3a89a449f..052ed0223eae 100644
--- a/clients/client-s3/src/commands/GetObjectAttributesCommand.ts
+++ b/clients/client-s3/src/commands/GetObjectAttributesCommand.ts
@@ -42,7 +42,8 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut
* can be returned with a single call to GetObjectAttributes
.https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
*
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 the
- * s3:GetObjectVersion
and s3:GetObjectVersionAttributes
- * permissions for this operation. If the bucket is not versioned, you need the
- * s3:GetObject
and s3:GetObjectAttributes
permissions.
- * For more information, see Specifying Permissions in
- * a Policy in the Amazon S3 User Guide. If the object
- * that you request does not exist, the error Amazon S3 returns depends on whether you
- * also have the s3:ListBucket
permission.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
+ * the s3:GetObjectVersion
and
+ * s3:GetObjectVersionAttributes
permissions for this
+ * operation. If the bucket is not versioned, you need the
+ * s3:GetObject
and s3:GetObjectAttributes
+ * permissions. For more information, see Specifying
+ * Permissions in a Policy in the
+ * Amazon S3 User Guide. If the object that you request does
+ * not exist, the error Amazon S3 returns depends on whether you also have the
+ * s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3
- * returns an HTTP status code 404 Not Found
("no such key")
- * error.
If you have the s3:ListBucket
permission on the
+ * bucket, Amazon S3 returns an HTTP status code 404 Not Found
+ * ("no such key") error.
If you don't have the s3:ListBucket
permission, Amazon S3 returns
- * an HTTP status code 403 Forbidden
("access denied")
- * error.
If you don't have the s3:ListBucket
permission, Amazon S3
+ * returns an HTTP status code 403 Forbidden
("access
+ * denied") error.
CreateSession
* .
- * If the object is encrypted with
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
If
+ * the
+ * object is encrypted with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
Encryption request headers, like x-amz-server-side-encryption
,
- * should not be sent for HEAD
requests if your object uses server-side
- * encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side
- * encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
- * managed encryption keys (SSE-S3). The x-amz-server-side-encryption
header is used when you PUT
an object to S3 and want to specify the encryption method.
- * If you include this header in a GET
request for an object that uses these types of keys,
- * you’ll get an HTTP 400 Bad Request
error. It's because the encryption method can't be changed when you retrieve the object.
HEAD
requests if your object uses
+ * server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
+ * server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
+ * encryption with Amazon S3 managed encryption keys (SSE-S3). The
+ * x-amz-server-side-encryption
header is used when you
+ * PUT
an object to S3 and want to specify the encryption method.
+ * If you include this header in a GET
request for an object that
+ * uses these types of keys, you’ll get an HTTP 400 Bad Request
+ * error. It's because the encryption method can't be changed when you retrieve
+ * the object.
* If you 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:
+ * 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: *@@ -120,12 +133,13 @@ export interface GetObjectAttributesCommandOutput extends GetObjectAttributesOut *
*For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys) in the Amazon S3 - * User Guide.
+ *For more information about SSE-C, see Server-Side + * Encryption (Using Customer-Provided Encryption Keys) in the + * Amazon S3 User Guide.
*
- * Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
+ * Directory bucket permissions -
+ * For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession
requests or PUT
object requests. Then, new objects
* are automatically encrypted with the desired encryption settings. For more
* information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
- * Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
- * to the versionId
query parameter in the request.
null
value of the version ID is supported by directory buckets. You can only specify null
to the
+ * versionId
query parameter in the request.
* Consider the following when using request headers:
*If both of the If-Match
and If-Unmodified-Since
headers
- * are present in the request as follows, then Amazon S3 returns the HTTP status code
- * 200 OK
and the data requested:
If both of the If-Match
and If-Unmodified-Since
+ * headers are present in the request as follows, then Amazon S3 returns the HTTP
+ * status code 200 OK
and the data requested:
- * If-Match
condition evaluates to true
.
If-Match
condition evaluates to
+ * true
.
*
* If-Unmodified-Since
condition evaluates to
- * false
.
false
.
* For more information about conditional requests, see RFC 7232.
*If both of the If-None-Match
and If-Modified-Since
- * headers are present in the request as follows, then Amazon S3 returns the HTTP status code
- * 304 Not Modified
:
If both of the If-None-Match
and
+ * If-Modified-Since
headers are present in the request as
+ * follows, then Amazon S3 returns the HTTP status code 304 Not
+ * Modified
:
- * If-None-Match
condition evaluates to false
.
If-None-Match
condition evaluates to
+ * false
.
*
* If-Modified-Since
condition evaluates to
- * true
.
true
.
* For more information about conditional requests, see RFC 7232.
diff --git a/clients/client-s3/src/commands/GetObjectCommand.ts b/clients/client-s3/src/commands/GetObjectCommand.ts index 154538a85f1a..eb860c7b0965 100644 --- a/clients/client-s3/src/commands/GetObjectCommand.ts +++ b/clients/client-s3/src/commands/GetObjectCommand.ts @@ -41,16 +41,18 @@ export interface GetObjectCommandOutput extends OmitRetrieves 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
+ * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
- * General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject
, you must have the READ
- * access to the object (or version). If you grant READ
access to the anonymous user, the GetObject
operation
- * returns the object without using an authorization header. For more information, see Specifying permissions in
- * a policy in the Amazon S3 User Guide.
If you include a versionId
in your request header, you must have the
- * s3:GetObjectVersion
permission to access a specific
- * version of an object. The s3:GetObject
permission is not required in this scenario.
If you request the
- * current version of an object without a specific versionId
in the request header, only
- * the s3:GetObject
permission is required. The s3:GetObjectVersion
permission is not required in this scenario.
- *
If the object that you request doesn’t exist, the error that
- * Amazon S3 returns depends on whether you also have the s3:ListBucket
+ * General purpose bucket permissions - You
+ * must have the required permissions in a policy. To use
+ * GetObject
, you must have the READ
access to the
+ * object (or version). If you grant READ
access to the anonymous
+ * user, the GetObject
operation returns the object without using
+ * an authorization header. For more information, see Specifying permissions in a policy in the
+ * Amazon S3 User Guide.
If you include a versionId
in your request header, you must
+ * have the s3:GetObjectVersion
permission to access a specific
+ * version of an object. The s3:GetObject
permission is not
+ * required in this scenario.
If you request the current version of an object without a specific
+ * versionId
in the request header, only the
+ * s3:GetObject
permission is required. The
+ * s3:GetObjectVersion
permission is not required in this
+ * scenario.
If the object that you request doesn’t exist, the error that Amazon S3 returns
+ * depends on whether you also have the s3:ListBucket
* permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3
- * returns an HTTP status code 404 Not Found
error.
If you have the s3:ListBucket
permission on the
+ * bucket, Amazon S3 returns an HTTP status code 404 Not Found
+ * error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an
- * HTTP status code 403 Access Denied
error.
If you don’t have the s3:ListBucket
permission, Amazon S3
+ * returns an HTTP status code 403 Access Denied
+ * error.
CreateSession
* .
- * If the object is encrypted using
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
If
+ * the
+ * object is encrypted using SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the
- * S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the
- * S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a
- * copy using RestoreObject. Otherwise, this operation returns an
- * InvalidObjectState
error. For information about restoring archived objects,
- * see Restoring
- * Archived Objects in the Amazon S3 User Guide.
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.
+ * 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 request headers, like x-amz-server-side-encryption
, should not
- * be sent for the GetObject
requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS)
- * keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject
requests for the object that uses
- * these types of keys, you’ll get an HTTP 400 Bad Request
error.
Encryption request headers, like x-amz-server-side-encryption
,
+ * should not be sent for the GetObject
requests, if your object uses
+ * server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side
+ * encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side
+ * encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your
+ * GetObject
requests for the object that uses these types of keys,
+ * you’ll get an HTTP 400 Bad Request
error.
- * Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more + * Directory buckets - + * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more * information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
*There are times when you want to override certain response header values of a
* GetObject
response. For example, you might override the
- * Content-Disposition
response header value through your GetObject
- * request.
You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK
is returned.
- * The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.
- *
The response headers that you can override for the
- * GetObject
response are Cache-Control
, Content-Disposition
,
- * Content-Encoding
, Content-Language
, Content-Type
, and Expires
.
To override values for a set of response headers in the
- * GetObject
response, you can use the following query
- * parameters in the request.
Content-Disposition
response header value through your
+ * GetObject
request.
+ * You can override values for a set of response headers. These modified response
+ * header values are included only in a successful response, that is, when the HTTP
+ * status code 200 OK
is returned. The headers you can override using
+ * the following query parameters in the request are a subset of the headers that
+ * Amazon S3 accepts when you create an object.
The response headers that you can override for the GetObject
+ * response are Cache-Control
, Content-Disposition
,
+ * Content-Encoding
, Content-Language
,
+ * Content-Type
, and Expires
.
To override values for a set of response headers in the GetObject
+ * response, you can use the following query parameters in the request.
@@ -169,9 +188,9 @@ export interface GetObjectCommandOutput extends Omit
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.
+ *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.
*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.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage
+ * class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access
+ * tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you
+ * must first restore a copy using RestoreObject. Otherwise, this
+ * operation returns an InvalidObjectState
error. For information about restoring
+ * archived objects, see Restoring Archived Objects in
+ * the Amazon S3 User Guide.
The specified key does not exist.
diff --git a/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts b/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts index 901d338e310d..42a32695aa06 100644 --- a/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts +++ b/clients/client-s3/src/commands/GetObjectLegalHoldCommand.ts @@ -30,7 +30,7 @@ export interface GetObjectLegalHoldCommandOutput extends GetObjectLegalHoldOutpu /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Gets an object's current legal hold status. For more information, see Locking * Objects.
diff --git a/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts b/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts index c5da4923a86d..0876d0b79f47 100644 --- a/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts +++ b/clients/client-s3/src/commands/GetObjectLockConfigurationCommand.ts @@ -30,7 +30,7 @@ export interface GetObjectLockConfigurationCommandOutput extends GetObjectLockCo /** *This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/GetObjectRetentionCommand.ts b/clients/client-s3/src/commands/GetObjectRetentionCommand.ts
index 2242bcb15990..bb8dae51a5b9 100644
--- a/clients/client-s3/src/commands/GetObjectRetentionCommand.ts
+++ b/clients/client-s3/src/commands/GetObjectRetentionCommand.ts
@@ -30,7 +30,7 @@ export interface GetObjectRetentionCommandOutput extends GetObjectRetentionOutpu
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets.
Retrieves an object's retention settings. For more information, see Locking * Objects.
diff --git a/clients/client-s3/src/commands/GetObjectTaggingCommand.ts b/clients/client-s3/src/commands/GetObjectTaggingCommand.ts index 32326f4bc9dc..fc4903da3e36 100644 --- a/clients/client-s3/src/commands/GetObjectTaggingCommand.ts +++ b/clients/client-s3/src/commands/GetObjectTaggingCommand.ts @@ -30,7 +30,7 @@ export interface GetObjectTaggingCommandOutput extends GetObjectTaggingOutput, _ /** *This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/GetObjectTorrentCommand.ts b/clients/client-s3/src/commands/GetObjectTorrentCommand.ts index 9eefa303a570..a68e90485395 100644 --- a/clients/client-s3/src/commands/GetObjectTorrentCommand.ts +++ b/clients/client-s3/src/commands/GetObjectTorrentCommand.ts @@ -35,7 +35,7 @@ export interface GetObjectTorrentCommandOutput extends OmitThis operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts b/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts index 86f7f8a66338..6686cf535f42 100644 --- a/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts +++ b/clients/client-s3/src/commands/GetPublicAccessBlockCommand.ts @@ -30,7 +30,7 @@ export interface GetPublicAccessBlockCommandOutput extends GetPublicAccessBlockO /** *This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/HeadBucketCommand.ts b/clients/client-s3/src/commands/HeadBucketCommand.ts
index 9ea3c2a1f3a3..3c7d914bfb51 100644
--- a/clients/client-s3/src/commands/HeadBucketCommand.ts
+++ b/clients/client-s3/src/commands/HeadBucketCommand.ts
@@ -29,24 +29,33 @@ export interface HeadBucketCommandInput extends HeadBucketRequest {}
export interface HeadBucketCommandOutput extends HeadBucketOutput, __MetadataBearer {}
/**
- *
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.
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.
HEAD
request returns a generic 400 Bad Request
, 403
+ * Forbidden
or 404 Not Found
code. A message body is not included,
+ * so you cannot determine the exception beyond these HTTP response codes.
*
- * General purpose buckets - Request to public buckets that grant the s3:ListBucket permission publicly do not need to be signed. All other HeadBucket
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz-
prefix, including
- * x-amz-copy-source
, must be signed. For more information, see REST Authentication.
HeadBucket
requests must be authenticated and signed by
+ * using IAM credentials (access key ID and secret access key for the IAM
+ * identities). All headers with the x-amz-
prefix, including
+ * x-amz-copy-source
, must be signed. For more information, see
+ * REST Authentication.
*
- * Directory buckets - You must use IAM credentials to authenticate and authorize your access to the HeadBucket
API operation, instead of using the
- * temporary security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
+ * Directory buckets - You must use IAM + * credentials to authenticate and authorize your access to the + *HeadBucket
API operation, instead of using the temporary security
+ * credentials through the CreateSession
API operation.
+ * Amazon Web Services CLI or SDKs handles authentication and authorization on your + * behalf.
*
- * General purpose bucket permissions - To use this operation, you must have permissions to perform the
- * s3:ListBucket
action. The bucket owner has this permission by default and
- * can grant this permission to others. For more information about permissions, see Managing
- * access permissions to your Amazon S3 resources in the Amazon S3 User Guide.
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.
*
@@ -65,8 +77,12 @@ export interface HeadBucketCommandOutput extends HeadBucketOutput, __MetadataBea
* You must have the
* s3express:CreateSession
* permission in the
- * Action
element of a policy. By default, the session is in the ReadWrite
mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode
condition key to ReadOnly
on the bucket.
For more information about example bucket policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
+ *Action
element of a policy. By default, the session is in
+ * the ReadWrite
mode. If you want to restrict the access, you can
+ * explicitly set the s3express:SessionMode
condition key to
+ * ReadOnly
on the bucket.
+ * For more information about example bucket policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for + * S3 Express One Zone in the Amazon S3 User Guide.
*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.
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.
+ * Request Headers. *
* General purpose bucket permissions - To
- * use HEAD
, you must have the s3:GetObject
permission. You need the relevant read object (or version) permission for this operation.
- * For more information, see Actions, resources, and condition
- * keys for Amazon S3 in the Amazon S3
- * User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.
If the object you request doesn't exist, the error that
- * Amazon S3 returns depends on whether you also have the s3:ListBucket
permission.
HEAD
, you must have the s3:GetObject
+ * permission. You need the relevant read object (or version) permission for
+ * this operation. For more information, see Actions, resources, and
+ * condition keys for Amazon S3 in the Amazon S3 User
+ * Guide. For more information about the permissions to S3 API
+ * operations by S3 resource types, see Required permissions for Amazon S3 API operations in the
+ * Amazon S3 User Guide.
+ * If the object you request doesn't exist, the error that Amazon S3 returns
+ * depends on whether you also have the s3:ListBucket
+ * permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3
- * returns an HTTP status code 404 Not Found
error.
If you have the s3:ListBucket
permission on the
+ * bucket, Amazon S3 returns an HTTP status code 404 Not Found
+ * error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns
- * an HTTP status code 403 Forbidden
error.
If you don’t have the s3:ListBucket
permission, Amazon S3
+ * returns an HTTP status code 403 Forbidden
error.
CreateSession
* .
- * If you enable x-amz-checksum-mode
in the request and the object is encrypted with
- * Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
If you enable x-amz-checksum-mode
in the request and the
+ * object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must
+ * also have the kms:GenerateDataKey
and kms:Decrypt
+ * permissions in IAM identity-based policies and KMS key policies for the
+ * KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption
,
- * should not be sent for HEAD
requests if your object uses server-side
- * encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side
- * encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3
- * managed encryption keys (SSE-S3). The x-amz-server-side-encryption
header is used when you PUT
an object to S3 and want to specify the encryption method.
- * If you include this header in a HEAD
request for an object that uses these types of keys,
- * you’ll get an HTTP 400 Bad Request
error. It's because the encryption method can't be changed when you retrieve the object.
HEAD
requests if your object uses
+ * server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
+ * server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side
+ * encryption with Amazon S3 managed encryption keys (SSE-S3). The
+ * x-amz-server-side-encryption
header is used when you
+ * PUT
an object to S3 and want to specify the encryption method.
+ * If you include this header in a HEAD
request for an object that
+ * uses these types of keys, you’ll get an HTTP 400 Bad Request
+ * error. It's because the encryption method can't be changed when you retrieve
+ * the object.
* If you encrypt an object by using server-side encryption with customer-provided - * encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the - * metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
+ * 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: *@@ -117,12 +132,13 @@ export interface HeadObjectCommandOutput extends HeadObjectOutput, __MetadataBea *
*For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys) in the Amazon S3 - * User Guide.
+ *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 + * Directory bucket - + * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more * information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
*If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
If the current version of the object is a delete marker, Amazon S3 behaves as
+ * if the object was deleted and includes x-amz-delete-marker:
+ * true
in the response.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed
error and the Last-Modified: timestamp
response header.
If the specified version is a delete marker, the response returns a
+ * 405 Method Not Allowed
error and the Last-Modified:
+ * timestamp
response header.
- * Directory buckets - Delete marker is not supported by directory buckets.
+ * Directory buckets - + * Delete marker is not supported for directory buckets. *
- * Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
- * to the versionId
query parameter in the request.
null
value of the version ID is supported by directory buckets. You can only specify null
+ * to the versionId
query parameter in the request.
* This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts index 611057d338c1..7f7183e052f5 100644 --- a/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketIntelligentTieringConfigurationsCommand.ts @@ -39,7 +39,7 @@ export interface ListBucketIntelligentTieringConfigurationsCommandOutput /** *This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts index 2e1f59fc209e..201ca1c96e6c 100644 --- a/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketInventoryConfigurationsCommand.ts @@ -39,7 +39,7 @@ export interface ListBucketInventoryConfigurationsCommandOutput /** *This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts b/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts index 406ac588e6fb..0e40ae3b1a68 100644 --- a/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts +++ b/clients/client-s3/src/commands/ListBucketMetricsConfigurationsCommand.ts @@ -35,7 +35,7 @@ export interface ListBucketMetricsConfigurationsCommandOutput /** *This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/ListBucketsCommand.ts b/clients/client-s3/src/commands/ListBucketsCommand.ts
index 230b28e1120b..77dc71f62345 100644
--- a/clients/client-s3/src/commands/ListBucketsCommand.ts
+++ b/clients/client-s3/src/commands/ListBucketsCommand.ts
@@ -30,17 +30,17 @@ export interface ListBucketsCommandOutput extends ListBucketsOutput, __MetadataB
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets.
Returns a list of all buckets owned by the authenticated sender of the request. To use
- * this operation, you must have the s3:ListAllMyBuckets
permission.
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 requests. Unpaginated requests are only supported for + *
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 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
+ * 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.
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.
+ *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 You must have the You must have the
- * Directory buckets - The HTTP Host header syntax is https://s3express-control.region_code.amazonaws.com/bucket-name
@@ -40,16 +41,21 @@ export interface ListDirectoryBucketsCommandOutput extends ListDirectoryBucketsO
*
*
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.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.s3express-control.region.amazonaws.com
.s3express-control.region.amazonaws.com
.
The BucketRegion
response element is not part of the ListDirectoryBuckets
Response Syntax.
The BucketRegion
response element is not part of the
+ * ListDirectoryBuckets
Response Syntax.
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.
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.
- *
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.
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.
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.
+ * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
- * General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload - * and Permissions in the Amazon S3 - * User Guide.
+ * 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. *@@ -91,22 +100,30 @@ export interface ListMultipartUploadsCommandOutput extends ListMultipartUploadsO *
- * General purpose bucket - In the ListMultipartUploads
response, the multipart uploads are sorted based on two criteria:
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.
+ *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.
+ *Time-based sorting - For uploads that share the same object + * key, they are further sorted in ascending order based on the upload + * initiation time. Among uploads with the same key, the one that was + * initiated first will appear before the ones that were initiated + * later.
*
- * Directory bucket - In the ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
+ * Directory bucket - In the
+ * ListMultipartUploads
response, the multipart uploads aren't
+ * sorted lexicographically based on the object keys.
*
- *
This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/ListObjectsCommand.ts b/clients/client-s3/src/commands/ListObjectsCommand.ts
index d4be20e19f9c..d912a235812d 100644
--- a/clients/client-s3/src/commands/ListObjectsCommand.ts
+++ b/clients/client-s3/src/commands/ListObjectsCommand.ts
@@ -30,7 +30,7 @@ export interface ListObjectsCommandOutput extends ListObjectsOutput, __MetadataB
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/ListObjectsV2Command.ts b/clients/client-s3/src/commands/ListObjectsV2Command.ts
index 0897b22770f2..c8e43b6f81d6 100644
--- a/clients/client-s3/src/commands/ListObjectsV2Command.ts
+++ b/clients/client-s3/src/commands/ListObjectsV2Command.ts
@@ -33,24 +33,27 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad
* 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.
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.
- *
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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
- * General purpose bucket permissions - To use this operation, you must have READ access to the bucket. You must have permission to perform
- * the s3:ListBucket
action. The bucket owner has this permission by default and
- * can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing
- * Access Permissions to Your Amazon S3 Resources in the
- * Amazon S3 User Guide.
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.
* @@ -84,11 +89,15 @@ export interface ListObjectsV2CommandOutput extends ListObjectsV2Output, __Metad *
- * General purpose bucket - For general purpose buckets, ListObjectsV2
returns objects in lexicographical order based on their key names.
ListObjectsV2
returns objects in
+ * lexicographical order based on their key names.
*
- * Directory bucket - For directory buckets, ListObjectsV2
does not return objects in lexicographical order.
ListObjectsV2
does not return objects in
+ * lexicographical order.
* 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.
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.
+ * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
- * General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload - * and Permissions in the Amazon S3 - * User Guide.
- *If the upload was created using server-side encryption with Key Management Service (KMS) keys
- * (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission
- * to the kms:Decrypt
action for the ListParts
request to succeed.
If the upload was created using server-side encryption with Key Management Service
+ * (KMS) keys (SSE-KMS) or dual-layer server-side encryption with
+ * Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the
+ * kms:Decrypt
action for the ListParts
request to
+ * succeed.
diff --git a/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts
index 0a3945af0266..83dcc4dc13a5 100644
--- a/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketAccelerateConfigurationCommand.ts
@@ -33,7 +33,7 @@ export interface PutBucketAccelerateConfigurationCommandOutput extends __Metadat
/**
* This operation is not supported by directory buckets. 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.
diff --git a/clients/client-s3/src/commands/PutBucketAclCommand.ts b/clients/client-s3/src/commands/PutBucketAclCommand.ts index b1963d325ae6..e1d95b2bfaa5 100644 --- a/clients/client-s3/src/commands/PutBucketAclCommand.ts +++ b/clients/client-s3/src/commands/PutBucketAclCommand.ts @@ -30,7 +30,7 @@ export interface PutBucketAclCommandOutput extends __MetadataBearer {} /** *This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts
index e23dd31cc275..6cf32096b131 100644
--- a/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketAnalyticsConfigurationCommand.ts
@@ -32,7 +32,7 @@ export interface PutBucketAnalyticsConfigurationCommandOutput extends __Metadata
/**
* This operation is not supported by directory buckets. 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.
diff --git a/clients/client-s3/src/commands/PutBucketCorsCommand.ts b/clients/client-s3/src/commands/PutBucketCorsCommand.ts index 55c4c5d33fe9..7576aaaa7e33 100644 --- a/clients/client-s3/src/commands/PutBucketCorsCommand.ts +++ b/clients/client-s3/src/commands/PutBucketCorsCommand.ts @@ -30,7 +30,7 @@ export interface PutBucketCorsCommandOutput extends __MetadataBearer {} /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Sets the cors
configuration for your bucket. If the configuration exists,
* Amazon S3 replaces it.
This operation configures default encryption - * and Amazon S3 Bucket Keys for an existing bucket.
+ *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
@@ -48,30 +48,35 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {}
*
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. - *
+ *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.
+ *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).
+ * Directory buckets - You can + * optionally configure default encryption for a bucket by using server-side + * encryption with Key Management Service (KMS) keys (SSE-KMS). *We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
- * CreateSession
requests or PUT
object requests. Then, new objects
- * are automatically encrypted with the desired encryption settings. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
We recommend that the bucket's default encryption uses the desired
+ * encryption configuration and you don't override the bucket default
+ * encryption in your CreateSession
requests or PUT
+ * object requests. Then, new objects are automatically encrypted with the
+ * desired encryption settings.
+ * For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. @@ -87,19 +92,21 @@ export interface PutBucketEncryptionCommandOutput extends __MetadataBearer {} *
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.
+ *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).
+ *If you're specifying a customer managed KMS key, we recommend using a fully + * qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the + * key within the requester’s account. This behavior can result in data that's encrypted + * with a KMS key that belongs to the requester, and not the bucket owner.
+ *Also, this action requires Amazon Web Services Signature Version 4. For more information, see + * Authenticating + * Requests (Amazon Web Services Signature Version 4).
*
- * General purpose bucket permissions - The s3:PutEncryptionConfiguration
permission is required in a policy.
- * The bucket owner has this permission
- * by default. The bucket owner can grant this permission to others. For more information
- * about permissions, see Permissions Related to Bucket Operations and Managing
- * Access Permissions to Your Amazon S3 Resources in the
- * Amazon S3 User Guide.
s3:PutEncryptionConfiguration
permission is required in a
+ * policy. The bucket owner has this permission by default. The bucket owner
+ * can grant this permission to others. For more information about permissions,
+ * see Permissions Related to Bucket Operations and Managing Access
+ * Permissions to Your Amazon S3 Resources in the
+ * Amazon S3 User Guide.
*
- * Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey
and the kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the target KMS key.
s3express:PutEncryptionConfiguration
permission in
+ * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
+ * For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
+ * To set a directory bucket default encryption with SSE-KMS, you must also
+ * have the kms:GenerateDataKey
and the kms:Decrypt
+ * permissions in IAM identity-based policies and KMS key policies for the
+ * target KMS key.
This operation is not supported by directory buckets.
+ *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.
diff --git a/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts index e6c197c0bebe..977786c499a7 100644 --- a/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts +++ b/clients/client-s3/src/commands/PutBucketInventoryConfigurationCommand.ts @@ -35,7 +35,7 @@ export interface PutBucketInventoryConfigurationCommandOutput extends __Metadata /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*This implementation of the This operation is not supported by directory buckets.PUT
action adds an inventory configuration
* (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory
diff --git a/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts
index 9dd8deb0a1dc..7a5d1a98c227 100644
--- a/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketLifecycleConfigurationCommand.ts
@@ -35,26 +35,37 @@ export interface PutBucketLifecycleConfigurationCommandOutput
__MetadataBearer {}
/**
- *
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle + *
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.
*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 the related API description, see PutBucketLifecycle.
+ * 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 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.
@@ -72,59 +83,87 @@ export interface PutBucketLifecycleConfigurationCommandOutput * Management and Lifecycle Configuration * Elements. *By default, all Amazon S3 resources are private, including buckets, objects, and
- * related subresources (for example, lifecycle configuration and website
- * configuration). Only the resource owner (that is, the Amazon Web Services account that created
- * it) can access the resource. The resource owner can optionally grant access
- * permissions to others by writing an access policy. For this operation, a user must
- * get the s3:PutLifecycleConfiguration
permission.
You can also explicitly deny permissions. An explicit deny also supersedes any - * other permissions. If you want to block users or accounts from removing or - * deleting objects from your bucket, you must deny them permissions for the - * following actions:
*
- * s3:DeleteObject
- *
s3: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, see Regional and Zonal endpoints 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
:
- * s3:DeleteObjectVersion
+ * GetBucketLifecycleConfiguration
*
- * s3:PutLifecycleConfiguration
+ * DeleteBucketLifecycle
*
For more information about permissions, see Managing Access - * Permissions to Your Amazon S3 Resources.
*The following operations are related to
- * PutBucketLifecycleConfiguration
:
- * GetBucketLifecycleConfiguration - *
- *- * DeleteBucketLifecycle - *
- *This operation is not supported by directory buckets.
+ *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
diff --git a/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts
index 13264d52868d..95a70d2f579a 100644
--- a/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketMetricsConfigurationCommand.ts
@@ -32,7 +32,7 @@ export interface PutBucketMetricsConfigurationCommandOutput extends __MetadataBe
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts b/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts
index 8331cd01472e..6d8d0c374e02 100644
--- a/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketNotificationConfigurationCommand.ts
@@ -32,7 +32,7 @@ export interface PutBucketNotificationConfigurationCommandOutput extends __Metad
/**
* This operation is not supported by directory buckets. 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
diff --git a/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts b/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts
index 65fec824b489..91e416224f94 100644
--- a/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketOwnershipControlsCommand.ts
@@ -30,7 +30,7 @@ export interface PutBucketOwnershipControlsCommandOutput extends __MetadataBeare
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets. Creates or modifies 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
- * If you don't have 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
+ * If you don't have 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
- * 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
- * General purpose bucket permissions - The OwnershipControls
for an Amazon S3 bucket. To use this
* operation, you must have the s3:PutBucketOwnershipControls
permission. For
diff --git a/clients/client-s3/src/commands/PutBucketPolicyCommand.ts b/clients/client-s3/src/commands/PutBucketPolicyCommand.ts
index ddf473bb2ff0..6c134c1d7d65 100644
--- a/clients/client-s3/src/commands/PutBucketPolicyCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketPolicyCommand.ts
@@ -40,42 +40,51 @@ export interface PutBucketPolicyCommandOutput extends __MetadataBearer {}
*
*
PutBucketPolicy
permissions on the specified bucket and belong to the
- * bucket owner's account in order to use this operation.PutBucketPolicy
permissions, Amazon S3 returns a 403
- * Access Denied
error. If you have the correct permissions, but you're not using an
- * identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not
- * Allowed
error.PutBucketPolicy
permissions on the specified bucket and belong to
+ * the bucket owner's account in order to use this operation.PutBucketPolicy
permissions, Amazon S3 returns a
+ * 403 Access Denied
error. If you have the correct permissions, but
+ * you're not using an identity that belongs to the bucket owner's account, Amazon S3
+ * returns a 405 Method Not Allowed
error.GetBucketPolicy
, PutBucketPolicy
, and
- * DeleteBucketPolicy
API actions, even if their bucket policy explicitly
- * denies the root principal's access. Bucket owner root principals can only be blocked
- * from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations
- * policies.GetBucketPolicy
, PutBucketPolicy
, and
+ * DeleteBucketPolicy
API actions, even if their bucket policy
+ * explicitly denies the root principal's access. Bucket owner root principals can
+ * only be blocked from performing these API actions by VPC endpoint policies and
+ * Amazon Web Services Organizations policies.
*
s3:PutBucketPolicy
permission is required in a policy.
- * For more information about general purpose buckets bucket policies, see Using Bucket Policies and User
- * Policies in the Amazon S3 User Guide.s3:PutBucketPolicy
permission is required in a policy. For
+ * more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the
+ * Amazon S3 User Guide.
- * Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutBucketPolicy
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
s3express:PutBucketPolicy
permission in
+ * an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource.
+ * For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
* - * General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
+ * General purpose buckets example bucket policies + * - See Bucket policy + * examples in the Amazon S3 User Guide. *- * Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
+ * Directory bucket example bucket policies + * - See Example bucket policies for S3 Express One Zone in the + * Amazon S3 User Guide. *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Creates a replication configuration or replaces an existing one. For more information, * see Replication in the Amazon S3 User Guide.
*Specify the replication configuration in the request body. In the replication
* configuration, you provide the name of the destination bucket or buckets where you want
* Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your
- * behalf, and other relevant information. You can invoke this request for a specific
- * Amazon Web Services Region by using the
- *
+ * behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services
+ * Region by using the
* aws:RequestedRegion
* condition key.
A replication configuration must include at least one rule, and can contain a maximum of
diff --git a/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts b/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts
index 40b02d7774fe..58bb078aa5cb 100644
--- a/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketRequestPaymentCommand.ts
@@ -30,7 +30,7 @@ export interface PutBucketRequestPaymentCommandOutput extends __MetadataBearer {
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets.
Sets the request payment configuration for a bucket. By default, the bucket owner pays
* for downloads from the bucket. This configuration parameter enables the bucket owner (only)
diff --git a/clients/client-s3/src/commands/PutBucketTaggingCommand.ts b/clients/client-s3/src/commands/PutBucketTaggingCommand.ts
index 94a3a4d44075..41f1ed96767d 100644
--- a/clients/client-s3/src/commands/PutBucketTaggingCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketTaggingCommand.ts
@@ -30,7 +30,7 @@ export interface PutBucketTaggingCommandOutput extends __MetadataBearer {}
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets.
Sets the tags for a bucket.
*Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,
diff --git a/clients/client-s3/src/commands/PutBucketVersioningCommand.ts b/clients/client-s3/src/commands/PutBucketVersioningCommand.ts
index 34f8d2734a3c..418ed87f9838 100644
--- a/clients/client-s3/src/commands/PutBucketVersioningCommand.ts
+++ b/clients/client-s3/src/commands/PutBucketVersioningCommand.ts
@@ -30,16 +30,13 @@ export interface PutBucketVersioningCommandOutput extends __MetadataBearer {}
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets. When you enable versioning on a bucket for the first time, it might take a short
* amount of time for the change to be fully propagated. We recommend that you wait for 15
- * minutes after enabling versioning before issuing write operations
- * (PUT
- * or
- * DELETE
)
- * on objects in the bucket. PUT
or
+ * DELETE
) on objects in the bucket.
Sets the versioning state of an existing bucket.
*You can set the versioning state with one of the following values:
diff --git a/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts b/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts index 6f2a528dfee8..a211b6becdc1 100644 --- a/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts +++ b/clients/client-s3/src/commands/PutBucketWebsiteCommand.ts @@ -30,7 +30,7 @@ export interface PutBucketWebsiteCommandOutput extends __MetadataBearer {} /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Sets the configuration of the website that is specified in the This operation is not supported by directory buckets. This operation is not supported for directory buckets.website
* subresource. To configure a bucket as a website, you can add this subresource on the bucket
diff --git a/clients/client-s3/src/commands/PutObjectAclCommand.ts b/clients/client-s3/src/commands/PutObjectAclCommand.ts
index 4724ddaa77c3..3af046afa4dc 100644
--- a/clients/client-s3/src/commands/PutObjectAclCommand.ts
+++ b/clients/client-s3/src/commands/PutObjectAclCommand.ts
@@ -31,7 +31,7 @@ export interface PutObjectAclCommandOutput extends PutObjectAclOutput, __Metadat
/**
*
Uses the Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the
- * entire object to the bucket. You cannot use Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added
+ * the entire object to the bucket. You cannot use If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All
- * objects written to the bucket by any account will be owned by the bucket owner. If your bucket uses the bucket owner enforced setting for Object Ownership,
+ * ACLs are disabled and no longer affect permissions. All objects written to the
+ * bucket by any account will be owned by the bucket owner.
- * Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format acl
subresource to set the access control list (ACL) permissions
* for a new or existing object in an S3 bucket. You must have the WRITE_ACP
diff --git a/clients/client-s3/src/commands/PutObjectCommand.ts b/clients/client-s3/src/commands/PutObjectCommand.ts
index a818ed1a0cb3..041a22c6e708 100644
--- a/clients/client-s3/src/commands/PutObjectCommand.ts
+++ b/clients/client-s3/src/commands/PutObjectCommand.ts
@@ -43,46 +43,49 @@ export interface PutObjectCommandOutput extends PutObjectOutput, __MetadataBeare
*
*
* PutObject
to only update a
- * single piece of metadata for an existing object. You must put the entire object with
- * updated metadata if you want to update some values.PutObject
to only
+ * update a single piece of metadata for an existing object. You must put the entire
+ * object with updated metadata if you want to update some values.https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object - * simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
+ * simultaneously, it overwrites all but the last object written. However, Amazon S3 provides + * features that can modify this behavior: ** S3 Object Lock - To prevent objects from - * being deleted or overwritten, you can use Amazon S3 Object - * Lock in the Amazon S3 User Guide.
+ * being deleted or overwritten, you can use Amazon S3 Object + * Lock in the Amazon S3 User Guide. *This functionality is not supported for directory buckets.
*- * S3 Versioning - When you enable - * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object - * simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID - * of that object being stored in Amazon S3. - * You can retrieve, replace, or delete any version of the object. For more information about versioning, see - * Adding Objects to - * Versioning-Enabled Buckets in the Amazon S3 - * User Guide. For information about returning the versioning state - * of a bucket, see GetBucketVersioning.
+ * S3 Versioning - When you enable versioning + * for a bucket, if Amazon S3 receives multiple write requests for the same object + * simultaneously, it stores all versions of the objects. For each write request that is + * made to the same object, Amazon S3 automatically generates a unique version ID of that + * object being stored in Amazon S3. You can retrieve, replace, or delete any version of the + * object. For more information about versioning, see Adding + * Objects to Versioning-Enabled Buckets in the Amazon S3 User + * Guide. For information about returning the versioning state of a + * bucket, see GetBucketVersioning. *This functionality is not supported for directory buckets.
*
- * General purpose bucket permissions - The following permissions are required in your policies when your
- * PutObject
request includes specific headers.
PutObject
request includes specific headers.
*
*
* s3:PutObject
- * - To successfully complete the PutObject
request, you must always have the s3:PutObject
permission on a bucket to add an object
- * to it.
PutObject
request, you must
+ * always have the s3:PutObject
permission on a bucket to
+ * add an object to it.
*
*
* s3:PutObjectAcl
- * - To successfully change the objects ACL of your PutObject
request, you must have the s3:PutObjectAcl
.
PutObject
request, you must have the
+ * s3:PutObjectAcl
.
*
*
* s3:PutObjectTagging
- * - To successfully set the tag-set with your PutObject
request, you
- * must have the s3:PutObjectTagging
.
PutObject
request, you must have the
+ * s3:PutObjectTagging
.
* CreateSession
* .
- * If the object is encrypted with
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
If the object is encrypted with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
- * General purpose bucket - To ensure that data is not corrupted traversing the network, use the
- * Content-MD5
header. When you use this header, Amazon S3 checks the object
- * against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest,
- * you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to
- * the calculated MD5 value.
Content-MD5
header. When you use this header, Amazon S3 checks
+ * the object against the provided MD5 value and, if they do not match, Amazon S3
+ * returns an error. Alternatively, when the object's ETag is its MD5 digest,
+ * you can calculate the MD5 while putting the object to Amazon S3 and compare the
+ * returned ETag to the calculated MD5 value.
* - * Directory bucket - This functionality is not supported for directory buckets.
+ * Directory bucket - + * This functionality is not supported for directory buckets. *+ * The existing object was created with a different encryption type. + * Subsequent write requests must include the appropriate encryption + * parameters in the request or while creating the session. + *
+ * + * @throws {@link InvalidRequest} (client fault) + *You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:
+ *Cannot specify both a write offset value and user-defined object metadata for existing objects.
+ *Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.
+ *Request body cannot be empty when 'write offset' is specified.
+ *+ * The write offset value that you specified does not match the current object size. + *
+ * + * @throws {@link TooManyParts} (client fault) + *+ * You have attempted to add more parts than the maximum of 10000 + * that are allowed for this object. You can use the CopyObject operation + * to copy this object to another and then add more data to the newly copied object. + *
+ * * @throws {@link S3ServiceException} *Base exception class for all service exceptions from S3 service.
* diff --git a/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts b/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts index 278ef5292dc7..2dcebf439f04 100644 --- a/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts +++ b/clients/client-s3/src/commands/PutObjectLegalHoldCommand.ts @@ -31,7 +31,7 @@ export interface PutObjectLegalHoldCommandOutput extends PutObjectLegalHoldOutpu /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Applies a legal hold configuration to the specified object. For more information, see
* Locking
diff --git a/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts b/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts
index 8b99cda53a4c..df5f27ceaeb2 100644
--- a/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts
+++ b/clients/client-s3/src/commands/PutObjectLockConfigurationCommand.ts
@@ -31,7 +31,7 @@ export interface PutObjectLockConfigurationCommandOutput extends PutObjectLockCo
/**
* This operation is not supported by directory buckets. This operation is not supported for directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the
* Object Lock configuration will be applied by default to every new object placed in the
@@ -48,8 +48,8 @@ export interface PutObjectLockConfigurationCommandOutput extends PutObjectLockCo
* You can enable Object Lock for new or existing buckets. For more
- * information, see Configuring Object
+ * You can enable Object Lock for new or existing buckets. For more information,
+ * see Configuring Object
* Lock. This operation is not supported by directory buckets. This operation is not supported for directory buckets. Places an Object Retention configuration on an object. For more information, see Locking Objects.
* Users or accounts require the This operation is not supported by directory buckets. This operation is not supported for directory buckets. Sets the supplied tag-set to an object that already exists in a bucket. A tag is a
* key-value pair. For more information, see Object Tagging. This operation is not supported by directory buckets. This operation is not supported for directory buckets. Creates or modifies the This operation is not supported by directory buckets. This operation is not supported for directory buckets. Restores an archived copy of an object back into Amazon S3 This functionality is not supported for Amazon S3 on Outposts. This operation is not supported by directory buckets. This operation is not supported for directory buckets. This action filters the contents of an Amazon S3 object based on a simple structured query
* language (SQL) statement. In the request, along with the SQL expression, you must also
diff --git a/clients/client-s3/src/commands/UploadPartCommand.ts b/clients/client-s3/src/commands/UploadPartCommand.ts
index a842c4deb449..bdcbde264141 100644
--- a/clients/client-s3/src/commands/UploadPartCommand.ts
+++ b/clients/client-s3/src/commands/UploadPartCommand.ts
@@ -41,10 +41,9 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
/**
* Uploads a part in a multipart upload. In this operation, you provide new data as a part of an object in your request. However, you have an option
- * to specify your existing Amazon S3 object as a data source for the part you are uploading. To
- * upload a part from an existing object, you use the UploadPartCopy operation.
- * In this operation, you provide new data as a part of an object in your request.
+ * However, you have an option to specify your existing Amazon S3 object as a data source for
+ * the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation. You must initiate a multipart upload (see CreateMultipartUpload)
* before you can upload any part. In response to your initiate request, Amazon S3 returns an
@@ -56,17 +55,17 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea
* For information about maximum and minimum part sizes and other multipart upload
* specifications, see Multipart upload limits in the Amazon S3 User Guide. After you initiate multipart upload and upload
- * one or more parts, you must either complete or abort multipart upload in order to stop
- * getting charged for storage of the uploaded parts. Only after you either complete or abort
- * multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts
- * storage. After you initiate multipart upload and upload one or more parts, you must either
+ * complete or abort multipart upload in order to stop getting charged for storage of the
+ * uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up
+ * the parts storage and stops charging you for the parts storage. For more information on multipart uploads, go to Multipart Upload Overview in the
- * Amazon S3 User Guide .Days
and Years
at the same time.s3:PutObjectRetention
permission in order to
diff --git a/clients/client-s3/src/commands/PutObjectTaggingCommand.ts b/clients/client-s3/src/commands/PutObjectTaggingCommand.ts
index f6f48c3d17c8..cbaf8768b2c3 100644
--- a/clients/client-s3/src/commands/PutObjectTaggingCommand.ts
+++ b/clients/client-s3/src/commands/PutObjectTaggingCommand.ts
@@ -31,7 +31,7 @@ export interface PutObjectTaggingCommandOutput extends PutObjectTaggingOutput, _
/**
* PublicAccessBlock
configuration for an Amazon S3 bucket.
* To use this operation, you must have the s3:PutBucketPublicAccessBlock
diff --git a/clients/client-s3/src/commands/RestoreObjectCommand.ts b/clients/client-s3/src/commands/RestoreObjectCommand.ts
index 11eaff639df1..3ee9ffc16793 100644
--- a/clients/client-s3/src/commands/RestoreObjectCommand.ts
+++ b/clients/client-s3/src/commands/RestoreObjectCommand.ts
@@ -31,7 +31,7 @@ export interface RestoreObjectCommandOutput extends RestoreObjectOutput, __Metad
/**
*
- * 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-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
CreateSession
* .
- * If the object is encrypted with
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
If the object is encrypted with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
- * General purpose bucket - To ensure that data is not corrupted traversing the network, specify the
- * Content-MD5
header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the
- * x-amz-content-sha256
header as a checksum instead of
- * Content-MD5
. For more information see Authenticating
- * Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
Content-MD5
+ * header in the upload part request. Amazon S3 checks the part data against the provided
+ * MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is
+ * signed with Signature Version 4, then Amazon Web Services S3 uses the
+ * x-amz-content-sha256
header as a checksum instead of
+ * Content-MD5
. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature
+ * Version 4).
* * Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
@@ -124,23 +127,28 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea *- * General purpose bucket - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it - * writes it to disks in its data centers and decrypts it when you access it. You have - * mutually exclusive options to protect data using server-side encryption in Amazon S3, depending - * on how you choose to manage the encryption keys. Specifically, the encryption key options - * are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys - * (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by - * default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption - * with other key options. The option you use depends on whether you want to use KMS keys - * (SSE-KMS) or provide your own encryption key (SSE-C).
- *Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are - * using a customer-provided encryption key (SSE-C), you don't need to specify the encryption - * parameters in each UploadPart request. Instead, you only need to specify the server-side - * encryption parameters in the initial Initiate Multipart request. For more information, see - * CreateMultipartUpload.
- *If you request server-side encryption using a customer-provided encryption key (SSE-C) - * in your initiate multipart upload request, you must provide identical encryption - * information in each part upload using the following request headers.
+ * General purpose bucket - Server-side + * encryption is for data encryption at rest. Amazon S3 encrypts your data as it + * writes it to disks in its data centers and decrypts it when you access it. + * You have mutually exclusive options to protect data using server-side + * encryption in Amazon S3, depending on how you choose to manage the encryption + * keys. Specifically, the encryption key options are Amazon S3 managed keys + * (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). + * Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys + * (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest + * using server-side encryption with other key options. The option you use + * depends on whether you want to use KMS keys (SSE-KMS) or provide your own + * encryption key (SSE-C). + *Server-side encryption is supported by the S3 Multipart Upload + * operations. Unless you are using a customer-provided encryption key (SSE-C), + * you don't need to specify the encryption parameters in each UploadPart + * request. Instead, you only need to specify the server-side encryption + * parameters in the initial Initiate Multipart request. For more information, + * see CreateMultipartUpload.
+ *If you request server-side encryption using a customer-provided + * encryption key (SSE-C) in your initiate multipart upload request, you must + * provide identical encryption information in each part upload using the + * following request headers.
*x-amz-server-side-encryption-customer-algorithm
@@ -152,13 +160,14 @@ export interface UploadPartCommandOutput extends UploadPartOutput, __MetadataBea *x-amz-server-side-encryption-customer-key-MD5
*- * For more information, see Using Server-Side - * Encryption in the Amazon S3 User Guide.
+ *For more information, see Using + * Server-Side Encryption in the + * Amazon S3 User Guide.
*
- * Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
).
AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
).
* Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
+ *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
diff --git a/clients/client-s3/src/commands/UploadPartCopyCommand.ts b/clients/client-s3/src/commands/UploadPartCopyCommand.ts index a330ba4d28b9..73e8739e5beb 100644 --- a/clients/client-s3/src/commands/UploadPartCopyCommand.ts +++ b/clients/client-s3/src/commands/UploadPartCopyCommand.ts @@ -36,43 +36,50 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met /** *Uploads a part by copying data from an existing object as data source. To specify the
- * data source, you add the request header x-amz-copy-source
in your request. To specify
- * a byte range, you add the request header x-amz-copy-source-range
in your
- * request.
x-amz-copy-source
in your request. To
+ * specify a byte range, you add the request header x-amz-copy-source-range
in
+ * your request.
* For information about maximum and minimum part sizes and other multipart upload * specifications, see Multipart upload limits in the Amazon S3 User Guide.
*Instead of copying data from an existing object as part data, you might use the UploadPart - * action to upload new data as a part of an object in your request.
+ *Instead of copying data from an existing object as part data, you might use the + * UploadPart action to upload new data as a part of an object in your + * request.
*You must initiate a multipart upload before you can upload any part. In response to your * initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in * your upload part request.
- *For conceptual information about multipart uploads, see Uploading - * Objects Using Multipart Upload in the - * Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart - * upload, see Operations on Objects in - * the Amazon S3 User Guide.
+ *For conceptual information about multipart uploads, see Uploading Objects Using Multipart + * Upload in the Amazon S3 User Guide. For information about + * copying objects using a single atomic action vs. a multipart upload, see Operations on + * Objects in the Amazon S3 User Guide.
*
- * Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
+ * 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-az_id.region.amazonaws.com/key-name
*
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the
* Amazon S3 User Guide.
All UploadPartCopy
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz-
prefix, including
- * x-amz-copy-source
, must be signed. For more information, see REST Authentication.
All UploadPartCopy
requests must be authenticated and signed by
+ * using IAM credentials (access key ID and secret access key for the IAM
+ * identities). All headers with the x-amz-
prefix, including
+ * x-amz-copy-source
, must be signed. For more information, see
+ * REST Authentication.
- * Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy
API operation, instead of using the
- * temporary security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
+ * Directory buckets - You must use IAM + * credentials to authenticate and authorize your access to the + *UploadPartCopy
API operation, instead of using the temporary
+ * security credentials through the CreateSession
API operation.
+ * Amazon Web Services CLI or SDKs handles authentication and authorization on your + * behalf.
*You must have READ
access to the source object and WRITE
- * access to the destination bucket.
You must have READ
access to the source object and
+ * WRITE
access to the destination bucket.
@@ -118,8 +125,9 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met *
* Directory bucket permissions -
- * You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination
- * bucket types in an UploadPartCopy
operation.
UploadPartCopy
+ * operation.
* If the source object that you want to copy is in a @@ -134,19 +142,21 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met *
If the copy destination is a directory bucket, you must have the
- *
+ *
* s3express:CreateSession
* permission in the
- * Action
element of a policy to write the object
- * to the destination. The s3express:SessionMode
condition
- * key cannot be set to ReadOnly
on the copy destination.
Action
element of a policy to write the object to the
+ * destination. The s3express:SessionMode
condition key
+ * cannot be set to ReadOnly
on the copy destination.
+ *
* If the object is encrypted with
- * SSE-KMS, you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the - * Amazon S3 User Guide.
+ *If the object is encrypted with SSE-KMS, you must also have the
+ * kms:GenerateDataKey
and kms:Decrypt
permissions
+ * in IAM identity-based policies and KMS key policies for the KMS
+ * key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for + * S3 Express One Zone in the Amazon S3 User Guide.
*
* General purpose buckets -
- *
- * For information about using server-side encryption with customer-provided
- * encryption keys with the UploadPartCopy
operation, see CopyObject and UploadPart.
- *
UploadPartCopy
operation, see CopyObject and
+ * UploadPart.
*
- * Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). For more
+ * Directory buckets -
+ * For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). For more
* information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
For directory buckets, when you perform a CreateMultipartUpload
operation and an UploadPartCopy
operation,
- * the request headers you provide in the CreateMultipartUpload
request must match the default encryption configuration of the destination bucket.
For directory buckets, when you perform a
+ * CreateMultipartUpload
operation and an
+ * UploadPartCopy
operation, the request headers you provide
+ * in the CreateMultipartUpload
request must match the default
+ * encryption configuration of the destination bucket.
S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets * to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
@@ -183,8 +197,8 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met *Description: The specified multipart upload does not exist. The - * upload ID might be invalid, or the multipart upload might have been - * aborted or completed.
+ * upload ID might be invalid, or the multipart upload might have been + * aborted or completed. *HTTP Status Code: 404 Not Found
@@ -197,7 +211,7 @@ export interface UploadPartCopyCommandOutput extends UploadPartCopyOutput, __Met *Description: The specified copy source is not supported as a - * byte-range copy source.
+ * byte-range copy source. *HTTP Status Code: 400 Bad Request
diff --git a/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts b/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts index c6b3f82655c3..6fa861e8ef8b 100644 --- a/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts +++ b/clients/client-s3/src/commands/WriteGetObjectResponseCommand.ts @@ -32,7 +32,7 @@ export interface WriteGetObjectResponseCommandOutput extends __MetadataBearer {} /** *This operation is not supported by directory buckets.
+ *This operation is not supported for directory buckets.
*Passes transformed objects to a 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 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
+ * 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. 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 This functionality is only supported for directory buckets.
- * General purpose buckets - In GetObject
operation when using Object Lambda access points. For
* information about Object Lambda access points, see Transforming objects with
diff --git a/clients/client-s3/src/models/models_0.ts b/clients/client-s3/src/models/models_0.ts
index ca889d5c94b1..034dde19601f 100644
--- a/clients/client-s3/src/models/models_0.ts
+++ b/clients/client-s3/src/models/models_0.ts
@@ -69,7 +69,8 @@ export interface AbortMultipartUploadRequest {
/**
*
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -104,9 +105,9 @@ export interface AbortMultipartUploadRequest {
/**
* 412 Precondition Failed
error.
+ * If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content)
response.
+ *
*
CompleteMultipartUpload
, when a additional checksum (including x-amz-checksum-crc32
, x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or
- * x-amz-checksum-sha256
) is applied to each part, the PartNumber
must start at 1 and
- * the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad Request
status code and an InvalidPartOrder
error code.CompleteMultipartUpload
, when a additional checksum (including
+ * x-amz-checksum-crc32
, x-amz-checksum-crc32c
,
+ * x-amz-checksum-sha1
, or x-amz-checksum-sha256
) is
+ * applied to each part, the PartNumber
must start at 1 and the part
+ * numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad
+ * Request
status code and an InvalidPartOrder
error
+ * code.
- * Directory buckets - In CompleteMultipartUpload
, the PartNumber
must start at 1 and
- * the part numbers must be consecutive.
CompleteMultipartUpload
, the PartNumber
must start at
+ * 1 and the part numbers must be consecutive.
* 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 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
+ * 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. Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a If a conflicting operation occurs during the upload S3 returns a Uploads the object only if the object key name does not already exist in the bucket
+ * specified. Otherwise, Amazon S3 returns a If a conflicting operation occurs during the upload S3 returns a Expects the '*' (asterisk) character. For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide. 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.
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -687,9 +707,9 @@ export interface CompleteMultipartUploadRequest {
/**
* 412 Precondition Failed
error.409 ConditionalRequestConflict
response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload
and re-upload each part.412 Precondition Failed
error.409
+ * ConditionalRequestConflict
response. On a 409 failure you should re-initiate the
+ * multipart upload with CreateMultipartUpload
and re-upload each part.
This functionality is not supported for directory buckets.
*The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
- * AES256
, aws:kms
, aws:kms:dsse
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for
+ * example, AES256
, aws:kms
, aws:kms:dsse
).
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.
+ * 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.
*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.
When you copy an object, the ACL metadata is not preserved and is set to
+ * private
by default. Only the owner has full access control. To override the
+ * default ACL setting, specify a new ACL when you generate a copy request. For more
+ * information, see Using ACLs.
If the destination bucket that you're copying objects to uses the bucket owner enforced
- * setting for S3 Object Ownership, ACLs are disabled and no longer affect
- * permissions. Buckets that use this setting only accept PUT
requests
- * that don't specify an ACL or PUT
requests that specify bucket owner
- * full control ACLs, such as the bucket-owner-full-control
canned ACL
- * or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling
- * ownership of objects and disabling ACLs in the
- * Amazon S3 User Guide.
PUT
requests that don't specify an
+ * ACL or PUT
requests that specify bucket owner full control ACLs, such as the
+ * bucket-owner-full-control
canned ACL or an equivalent form of this ACL
+ * expressed in the XML format. For more information, see Controlling ownership of
+ * objects and disabling ACLs in the Amazon S3 User Guide.
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, - * all objects written to the bucket by any account will be owned by the bucket - * owner.
+ *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.
@@ -1053,7 +1074,8 @@ export interface CopyObjectRequest { /** *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 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 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 For directory buckets, when you use Amazon Web Services SDKs, Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file. Specifies presentational information for the object. Indicates whether an object should
+ * be displayed in a web browser or downloaded as a file. It allows specifying the desired
+ * filename for the downloaded file. Specifies 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: 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
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -1083,10 +1105,13 @@ export interface CopyObjectRequest {
* CopyObject
request does not include this x-amz-checksum-algorithm
header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally
- * specify a different checksum algorithm to use with the
- * x-amz-checksum-algorithm
header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
.CopyObject
request does not
+ * include this x-amz-checksum-algorithm
header, the checksum algorithm will be
+ * copied from the source object to the destination object (if it's present on the source
+ * object). You can optionally specify a different checksum algorithm to use with the
+ * x-amz-checksum-algorithm
header. Unrecognized or unsupported values will
+ * respond with the HTTP status code 400 Bad Request
.CRC32
is the default checksum algorithm that's used for performance.
*
reports/january.pdf
from the general purpose bucket
- * awsexamplebucket
, use awsexamplebucket/reports/january.pdf
.
- * The value must be URL-encoded. To copy the
- * object reports/january.pdf
from the directory bucket
- * awsexamplebucket--use1-az5--x-s3
, use awsexamplebucket--use1-az5--x-s3/reports/january.pdf
.
- * The value must be URL-encoded.awsexamplebucket
, use
+ * awsexamplebucket/reports/january.pdf
. The value must be URL-encoded.
+ * To copy the object reports/january.pdf
from the directory bucket
+ * awsexamplebucket--use1-az5--x-s3
, use
+ * awsexamplebucket--use1-az5--x-s3/reports/january.pdf
. The value must
+ * be URL-encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your source bucket versioning is enabled, the x-amz-copy-source
header by default identifies the current
- * version of an object to copy. If the current version is a delete marker, Amazon S3
- * behaves as if the object was deleted. To copy a different version, use the
- * versionId
query parameter. Specifically, append ?versionId=
- * to the value (for example,
- * awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).
+ *
If your source bucket versioning is enabled, the x-amz-copy-source
header
+ * by default identifies the current version of an object to copy. If the current version is a
+ * delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use
+ * the versionId
query parameter. Specifically, append
+ * ?versionId=
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.
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.
+ * Directory buckets - + * S3 Versioning isn't enabled and supported for directory buckets. *Copies the object if its entity tag (ETag) matches the specified tag.
* If both the x-amz-copy-source-if-match
and
- * x-amz-copy-source-if-unmodified-since
headers are present in the
- * request and evaluate as follows, Amazon S3 returns 200 OK
and copies the
- * data:
x-amz-copy-source-if-unmodified-since
headers are present in the request
+ * and evaluate as follows, Amazon S3 returns 200 OK
and copies the data:
*
- * x-amz-copy-source-if-match
condition evaluates to
- * true
x-amz-copy-source-if-match
condition evaluates to true
* @@ -1202,14 +1231,13 @@ export interface CopyObjectRequest { /** *
Copies the object if it has been modified since the specified time.
*If both the x-amz-copy-source-if-none-match
and
- * x-amz-copy-source-if-modified-since
headers are present in the
- * request and evaluate as follows, Amazon S3 returns the 412 Precondition
- * Failed
response code:
x-amz-copy-source-if-modified-since
headers are present in the request and
+ * evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response
+ * code:
*
- * x-amz-copy-source-if-none-match
condition evaluates to
- * false
x-amz-copy-source-if-none-match
condition evaluates to false
* @@ -1224,14 +1252,13 @@ export interface CopyObjectRequest { /** *
Copies the object if its entity tag (ETag) is different than the specified ETag.
*If both the x-amz-copy-source-if-none-match
and
- * x-amz-copy-source-if-modified-since
headers are present in the
- * request and evaluate as follows, Amazon S3 returns the 412 Precondition
- * Failed
response code:
x-amz-copy-source-if-modified-since
headers are present in the request and
+ * evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response
+ * code:
*
- * x-amz-copy-source-if-none-match
condition evaluates to
- * false
x-amz-copy-source-if-none-match
condition evaluates to false
* @@ -1246,14 +1273,12 @@ export interface CopyObjectRequest { /** *
Copies the object if it hasn't been modified since the specified time.
* If both the x-amz-copy-source-if-match
and
- * x-amz-copy-source-if-unmodified-since
headers are present in the
- * request and evaluate as follows, Amazon S3 returns 200 OK
and copies the
- * data:
x-amz-copy-source-if-unmodified-since
headers are present in the request
+ * and evaluate as follows, Amazon S3 returns 200 OK
and copies the data:
*
- * x-amz-copy-source-if-match
condition evaluates to
- * true
x-amz-copy-source-if-match
condition evaluates to true
* @@ -1349,20 +1374,21 @@ export interface CopyObjectRequest { /** *
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.
- *
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.
s3:x-amz-metadata-directive
condition key
+ * to enforce certain metadata behavior when objects are uploaded. For more information, see
+ * Amazon S3
+ * condition key examples in the Amazon S3 User Guide.
*
- * x-amz-website-redirect-location
is unique to each object and is not copied when using the
- * x-amz-metadata-directive
header. To copy the value, you
- * must specify x-amz-website-redirect-location
in the request header.
x-amz-website-redirect-location
is unique to each object and is not
+ * copied when using the x-amz-metadata-directive
header. To copy the value,
+ * you must specify x-amz-website-redirect-location
in the request
+ * header.
* 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.
+ *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.
+ *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
+ * 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.
To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key).
- * The Amazon Web Services managed key (aws/s3
) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS configuration.
- * Then, when you perform a CopyObject
operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration.
- *
To encrypt new object copies to a directory bucket with SSE-KMS, we recommend you
+ * specify SSE-KMS as the directory bucket's default encryption configuration with
+ * a KMS key (specifically, a customer managed key).
+ * The Amazon Web Services managed key (aws/s3
) isn't supported. Your SSE-KMS
+ * configuration can only support 1 customer managed key per
+ * directory bucket for the lifetime of the bucket. After you specify a customer managed key for
+ * SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS
+ * configuration. Then, when you perform a CopyObject
operation and want to
+ * specify server-side encryption settings for new object copies with SSE-KMS in the
+ * encryption-related request headers, you must ensure the encryption key is the same
+ * customer managed key that you specified for the directory bucket's default encryption
+ * configuration.
+ *
If the x-amz-storage-class
header is not used, the copied object will be stored in the
- * STANDARD
Storage Class by default. The STANDARD
storage class provides high durability and
- * high availability. Depending on performance needs, you can specify a different Storage
- * Class.
- *
If the x-amz-storage-class
header is not used, the copied object will be
+ * stored in the STANDARD
Storage Class by default. The STANDARD
+ * storage class provides high durability and high availability. Depending on performance
+ * needs, you can specify a different Storage Class.
- * Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
+ * 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.
OUTPOSTS
Storage Class.
* You can use the CopyObject
action to change the storage class of
- * an object that is already stored in Amazon S3 by using the x-amz-storage-class
- * header. For more information, see Storage Classes in
- * the Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:
+ *You can use the CopyObject
action to change the storage class of an object
+ * that is already stored in Amazon S3 by using the x-amz-storage-class
header. For
+ * more information, see Storage Classes in the
+ * Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a + * copy of it if it meets any of the following conditions:
*The storage class of the source object is GLACIER
or
- * DEEP_ARCHIVE
.
DEEP_ARCHIVE
.
* The storage class of the source object is
- * INTELLIGENT_TIERING
and it's S3 Intelligent-Tiering access tier is
- * Archive Access
or Deep Archive Access
.
The storage class of the source object is INTELLIGENT_TIERING
and
+ * it's S3 Intelligent-Tiering access tier is Archive Access
or
+ * Deep Archive Access
.
For more - * information, see RestoreObject and Copying - * Objects in - * the Amazon S3 User Guide.
+ *For more information, see RestoreObject and Copying + * Objects in the Amazon S3 User Guide.
* @public */ StorageClass?: StorageClass | undefined; /** - *If the destination bucket is configured as a website, redirects requests for this object copy to another
- * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
- * the object metadata. This value is unique to each object and is not copied when using the
- * x-amz-metadata-directive
header. Instead, you may opt to provide this
- * header in combination with the x-amz-metadata-directive
header.
If the destination bucket is configured as a website, redirects requests for this object
+ * copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of
+ * this header in the object metadata. This value is unique to each object and is not copied
+ * when using the x-amz-metadata-directive
header. Instead, you may opt to
+ * provide this header in combination with the x-amz-metadata-directive
+ * header.
This functionality is not supported for directory buckets.
*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.
AES256
).
+ * When you perform a CopyObject
operation, if you want to use a different
+ * type of encryption setting for the target object, you can specify appropriate
+ * encryption-related headers to encrypt the target object with an Amazon S3 managed key, a
+ * KMS key, or a customer-provided key. If the encryption setting in your request is
+ * different from the default encryption configuration of the destination bucket, the
+ * encryption setting in your request takes precedence.
This functionality is not supported when the destination bucket is a directory bucket.
*Specifies the 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
+ * 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 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. 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
- *
* Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported. Specifies 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
- * x-amz-server-side-encryption
with aws:kms
, the
+ * Directory buckets -
+ * If you specify
x-amz-server-side-encryption
with aws:kms
, the
* x-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 the
@@ -1580,12 +1616,16 @@ export interface CopyObjectRequest {
SSEKMSKeyId?: string | undefined;
/**
- *
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.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.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.
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.
+ * Amazon S3 User Guide. *- * Directory buckets - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets + * Directory buckets - + * S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets * to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
*Specifies the 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.
+ *AES256
).
+ * If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the + * necessary encryption information in your request so that Amazon S3 can decrypt the object for + * copying.
*This functionality is not supported when the source object is in a directory bucket.
*Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source - * object. The encryption key provided in this header must be the same one that was used when the - * source object was created.
- *If - * the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the - * necessary encryption information in your request so that Amazon S3 can decrypt the - * object for copying.
+ * 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.
*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.
+ *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.
*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 + * 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.
@@ -1670,10 +1707,12 @@ export interface CopyObjectRequest { RequestPayer?: RequestPayer | undefined; /** - *The tag-set for the object copy in the destination bucket. This value must be used in conjunction
- * with the x-amz-tagging-directive
if you choose REPLACE
for the x-amz-tagging-directive
. If you choose COPY
for the x-amz-tagging-directive
, you don't need to set
- * the x-amz-tagging
header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query
- * parameters.
The tag-set for the object copy in the destination bucket. This value must be used in
+ * conjunction with the x-amz-tagging-directive
if you choose
+ * REPLACE
for the x-amz-tagging-directive
. If you choose
+ * COPY
for the x-amz-tagging-directive
, you don't need to set
+ * the x-amz-tagging
header, because the tag-set will be copied from the source
+ * object directly. The tag-set must be encoded as URL Query parameters.
The default value is the empty value.
*@@ -1869,8 +1908,8 @@ export const BucketType = { export type BucketType = (typeof BucketType)[keyof typeof BucketType]; /** - *
Specifies the information about the bucket that will be created. For more information about directory buckets, see - * Directory buckets in the Amazon S3 User Guide.
+ *Specifies the information about the bucket that will be created. For more information + * about directory buckets, see Directory buckets in the Amazon S3 User Guide.
*This functionality is only supported by directory buckets.
*Specifies the location where the bucket will be created.
- *For directory buckets, the location type is Availability Zone. For more information about directory buckets, see - * Directory buckets in the Amazon S3 User Guide.
+ *For directory buckets, the location type is Availability Zone. For more information about + * directory buckets, see Directory buckets in the Amazon S3 User Guide.
*This functionality is only supported by directory buckets.
*The name of the location where the bucket will be created.
- *For directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1
.
For directory buckets, the name of the location is the AZ ID of the Availability Zone where the
+ * bucket will be created. An example AZ ID value is usw2-az1
.
If you don't specify a Region, - * the bucket is created in the US East (N. Virginia) Region (us-east-1) by default.
+ *If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region + * (us-east-1) by default.
*This functionality is not supported for directory buckets.
*The container element for object ownership for a bucket's ownership controls.
*
- * BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket
- * owner if the objects are uploaded with the bucket-owner-full-control
canned
- * ACL.
BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to
+ * the bucket owner if the objects are uploaded with the
+ * bucket-owner-full-control
canned ACL.
*
- * ObjectWriter
- The uploading account will own the object if the object is uploaded with
- * the bucket-owner-full-control
canned ACL.
ObjectWriter
- The uploading account will own the object if the object is
+ * uploaded with the bucket-owner-full-control
canned ACL.
*
- * BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no longer affect
- * permissions. The bucket owner automatically owns and has full control over every object in
- * the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner
- * full control ACLs (such as the predefined bucket-owner-full-control
canned ACL or a custom ACL
- * in XML format that grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and ACLs are disabled. We recommend
- * keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see
- * Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
- *
BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no
+ * longer affect permissions. The bucket owner automatically owns and has full control over
+ * every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL
+ * or specify bucket owner full control ACLs (such as the predefined
+ * bucket-owner-full-control
canned ACL or a custom ACL in XML format that
+ * grants the same permissions).
+ * By default, ObjectOwnership
is set to BucketOwnerEnforced
and
+ * ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where
+ * you must control access for each object individually. For more information about S3 Object
+ * Ownership, see Controlling ownership of
+ * objects and disabling ACLs for your bucket in the
+ * Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
*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.
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
- * AES256
, aws:kms
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for
+ * example, AES256
, aws:kms
).
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.
+ * 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.
*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.
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.
The name of the bucket where the multipart upload is initiated and where the object is uploaded.
+ *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 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: 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:
- *
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -2354,30 +2398,29 @@ export interface CreateMultipartUploadRequest {
Expires?: Date | undefined;
/**
- *
*
id
– if the value specified is the canonical user ID
- * of an Amazon Web Services accountid
– 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
uri
– if you are granting permissions to a predefined group
*
- * emailAddress
– if the value specified is the email
- * address of an Amazon Web Services account
emailAddress
– if the value specified is the email address of an
+ * Amazon Web Services account
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*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:
+ *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
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
uri
– if you are granting permissions to a predefined group
*
- * emailAddress
– if the value specified is the email
- * address of an Amazon Web Services account
emailAddress
– if the value specified is the email address of an
+ * Amazon Web Services account
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*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:
+ *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
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
uri
– if you are granting permissions to a predefined group
*
- * emailAddress
– if the value specified is the email
- * address of an Amazon Web Services account
emailAddress
– if the value specified is the email address of an
+ * Amazon Web Services account
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*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:
+ *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
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
uri
– if you are granting permissions to a predefined group
*
- * emailAddress
– if the value specified is the email
- * address of an Amazon Web Services account
emailAddress
– if the value specified is the email address of an
+ * Amazon Web Services account
* Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
*The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
- * AES256
, aws:kms
).
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 your
+ * Directory buckets -
+ * For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession
requests or PUT
object requests. Then, new objects
* are automatically encrypted with the desired encryption settings. For more
- * information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
- *
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession
request.
* You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request.
* You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and
@@ -2698,16 +2737,17 @@ export interface CreateMultipartUploadRequest {
/**
*
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.
+ * 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.
+ *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.
+ *Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*Specifies the algorithm to use when encrypting the object (for example, - * AES256).
+ *Specifies the algorithm to use when encrypting the object (for example, AES256).
*This functionality is not supported for directory buckets.
*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.
+ *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.
*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 + * 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.
@@ -2875,25 +2914,32 @@ export interface CreateMultipartUploadRequest { *The established temporary security credentials of the session.
*- * Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.
+ * Directory buckets - These session + * credentials are only supported for the authentication and authorization of Zonal endpoint API operations + * on directory buckets. *A unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.
+ *A unique identifier that's associated with a secret access key. The access key ID and + * the secret access key are used together to sign programmatic Amazon Web Services requests + * cryptographically.
* @public */ AccessKeyId: string | undefined; /** - *A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.
+ *A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services + * requests. Signing a request identifies the sender and prevents the request from being + * altered.
* @public */ SecretAccessKey: string | undefined; /** - *A part of the temporary security credentials. The session token is used to validate the temporary security credentials. + *
A part of the temporary security credentials. The session token is used to validate the + * temporary security credentials. * *
* @public @@ -2901,8 +2947,10 @@ export interface SessionCredentials { SessionToken: string | undefined; /** - *Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. - * Temporary credentials cannot be extended or refreshed beyond the original specified interval.
+ *Temporary security credentials expire after a specified interval. After temporary + * credentials expire, any calls that you make with those credentials will fail. So you must + * generate a new set of temporary credentials. Temporary credentials cannot be extended or + * refreshed beyond the original specified interval.
* @public */ Expiration: Date | undefined; @@ -3212,6 +3260,10 @@ export interface DeleteBucketLifecycleRequest { /** *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.
+ *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.
+ *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.
*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 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
+ * destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
+ * charges to copy the object. For information about downloading objects from Requester Pays
+ * buckets, see Downloading Objects in
* Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. The For more information about conditional requests, see RFC 7232. This functionality is only supported for directory buckets. If present, the object is deleted only if its modification times matches the provided
+ * This functionality is only supported for directory buckets. If present, the object is deleted only if its size matches the provided size in bytes. If the This functionality is only supported for directory buckets. You can use the 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. 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. An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL.
+ * This header field makes the request method conditional on Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object. If present, the objects are deleted only if its modification times matches the provided This functionality is only supported for directory buckets. If present, the objects are deleted only if its size matches the provided size in bytes. This functionality is only supported for directory buckets. The object to delete.
- * Directory buckets - For directory buckets, an object that's composed entirely of
- * whitespace characters is not supported by the
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -3440,9 +3494,9 @@ export interface DeleteObjectRequest {
/**
* If-Match
header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns
+ * a 412 Precondition Failed
error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No
+ * Content) response
.Timestamp
. If the Timestamp
values do not match, the operation
+ * returns a 412 Precondition Failed
error. If the Timestamp
matches
+ * or if the object doesn’t exist, the operation returns a 204 Success (No
+ * Content)
response.Size
value does not match, the operation returns a 412 Precondition Failed
error. If the Size
matches or if the object doesn’t exist,
+ * the operation returns a 204 Success (No Content)
response.If-Match
, x-amz-if-match-last-modified-time
and x-amz-if-match-size
+ * conditional headers in conjunction with each-other or individually.ETags
. Timestamp
.
+ * DeleteObjects
API operation. The request will receive a 400 Bad Request
error
- * and none of the objects in the request will be deleted.DeleteObjects
API operation. The request will receive a 400 Bad
+ * Request
error and none of the objects in the request will be deleted.
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 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 When performing the This functionality is not supported for directory buckets. Confirms that the requester knows that they will be charged for the request. Bucket
* owners need not specify this parameter in their requests. If either the source or
- * destination S3 bucket has Requester Pays enabled, the requester will pay for
- * corresponding charges to copy the object. For information about downloading objects from
- * Requester Pays buckets, see Downloading Objects in
+ * 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. 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
+ * 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. Describes the default server-side encryption to apply to new objects in the bucket. If a
* PUT Object request doesn't specify any server-side encryption, this default encryption will
- * be applied. For more
- * information, see PutBucketEncryption.
- * General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates
- * an Amazon Web Services KMS key (
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -5529,11 +5654,12 @@ export interface DeleteObjectsRequest {
* 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
+ * 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.
*
aws/s3
) in your Amazon Web Services account the first time that you add an object encrypted
- * with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. aws/s3
) in your Amazon Web Services account the first time that you add an
+ * object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key
+ * for SSE-KMS.
- * Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket.
+ * Directory buckets -
+ * 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.
*
- * Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.
+ * Directory buckets - + * For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. *
- * General purpose buckets - This parameter is allowed if and only if SSEAlgorithm
is set to
- * aws:kms
or aws:kms:dsse
.
SSEAlgorithm
is set to aws:kms
or
+ * aws:kms:dsse
.
*
- * Directory buckets - This parameter is allowed if and only if SSEAlgorithm
is set to
+ * Directory buckets - This parameter is
+ * allowed if and only if SSEAlgorithm
is set to
* aws:kms
.
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
+ *
Key ARN:
+ * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
- * General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified - * KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the - * requester’s account. This behavior can result in data that's encrypted with a KMS key - * that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating - * a VPC flow log. - *
+ * General purpose buckets - If you're specifying + * a customer managed KMS key, we recommend using a fully qualified KMS key ARN. + * If you use a KMS key alias instead, then KMS resolves the key within the + * requester’s account. This behavior can result in data that's encrypted with a + * KMS key that belongs to the requester, and not the bucket owner. Also, if you + * use a key ID, you can run into a LogDestination undeliverable error when creating + * a VPC flow log. *- * Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
+ * Directory buckets - + * When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. *- * General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified - * KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the - * requester’s account. This behavior can result in data that's encrypted with a KMS key - * that belongs to the requester, and not the bucket owner.
+ * General purpose buckets - If you're specifying + * a customer managed KMS key, we recommend using a fully qualified KMS key ARN. + * If you use a KMS key alias instead, then KMS resolves the key within the + * requester’s account. This behavior can result in data that's encrypted with a + * KMS key that belongs to the requester, and not the bucket owner. *- * Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
+ * Directory buckets - + * When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. *- * General purpose buckets - By default, S3 Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the - * Amazon S3 User Guide.
+ * General purpose buckets - By default, S3 + * Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the + * Amazon S3 User Guide. *
- * Directory buckets - S3 Bucket Keys are always enabled for GET
and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
+ * Directory buckets -
+ * S3 Bucket Keys are always enabled for GET
and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
* to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or
* the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
Indicates at what date the object is to be moved or deleted. The date value must conform * to the ISO 8601 format. The time is always midnight UTC.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set * to true, the delete marker will be expired; if set to false the policy takes no action. * This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *The Filter
is used to identify objects that a Lifecycle Rule applies to. A
- * Filter
can have exactly one of Prefix
, Tag
, ObjectSizeGreaterThan
, ObjectSizeLessThan
, or
- * And
specified. If the Filter
element is left empty, the Lifecycle Rule applies to all objects in the bucket.
Filter
can have exactly one of Prefix
, Tag
,
+ * ObjectSizeGreaterThan
, ObjectSizeLessThan
, or And
+ * specified. If the Filter
element is left empty, the Lifecycle Rule applies to
+ * all objects in the bucket.
* @public
*/
export interface LifecycleRuleFilter {
@@ -6894,6 +7042,10 @@ export interface LifecycleRuleFilter {
/**
* This tag must exist in the object's tag set in order for the rule to apply.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *Filter
must have exactly one of Prefix
, Tag
, or
* And
specified. Filter
is required if the
* LifecycleRule
does not contain a Prefix
element.
+ *
+ * Tag
filters are not supported for directory buckets.
Specifies when an Amazon S3 object transitions to a specified storage class.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *Specifies the transition rule for the lifecycle rule that describes when noncurrent + *
Specifies the transition rule for the lifecycle rule that describes when noncurrent * objects transition to a specific storage class. If your bucket is versioning-enabled (or * versioning is suspended), you can set this action to request that Amazon S3 transition * noncurrent object versions to a specific storage class at a set period in the object's - * lifetime.
+ * lifetime. + *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *This parameter applies to general purpose buckets only. It is not supported for + * directory bucket lifecycle configurations.
+ *Indicates which default minimum object size behavior is applied to the lifecycle configuration.
+ *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.
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.
- *
varies_by_storage_class
- Objects smaller than 128 KB will
+ * transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
+ * default, all other storage classes will prevent transitions smaller than 128 KB.
+ *
* To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
To customize the minimum object size for any transition you can add a filter that
+ * specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in
+ * the body of your transition rule. Custom filters always take precedence over the default
+ * transition behavior.
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.
+ *
* [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
*
PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.
+ *PartitionedPrefix defaults to EventTime delivery when server access logs are + * delivered.
* @public */ export interface PartitionedPrefix { /** *Specifies the partition date source for the partitioned prefix.
- * PartitionDateSource
can be EventTime
or
- * DeliveryTime
.
PartitionDateSource
can be EventTime
or
+ * DeliveryTime
.
* For DeliveryTime
, the time in the log file names corresponds to the
* delivery time for the log files.
For EventTime
, The logs delivered are for a specific day only. The year,
@@ -7305,7 +7501,8 @@ export interface PartitionedPrefix {
}
/**
- *
To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
+ *To use simple format for S3 keys for log objects, set SimplePrefix to an empty + * object.
*
* [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
*
Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.
+ *Amazon S3 key format for log objects. Only one format, PartitionedPrefix or + * SimplePrefix, is allowed.
* @public */ export interface TargetObjectKeyFormat { /** - *To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to \{\}.
+ *To use the simple format for S3 keys for log objects. To specify SimplePrefix format, + * set SimplePrefix to \{\}.
* @public */ SimplePrefix?: SimplePrefix | undefined; @@ -7671,7 +7870,14 @@ export const FilterRuleName = { export type FilterRuleName = (typeof FilterRuleName)[keyof typeof FilterRuleName]; /** - *Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023-
or engineering/
. Then, you can use FilterRule
to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.
Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned
+ * to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of
+ * the object key name. A prefix is a specific string of characters at the beginning of an
+ * object key name, which you can use to organize objects. For example, you can start the key
+ * names of related objects with a prefix, such as 2023-
or
+ * engineering/
. Then, you can use FilterRule
to find objects in
+ * a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it
+ * is at the end of the object key name instead of at the beginning.
The container element for object ownership for a bucket's ownership controls.
*
- * BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket
- * owner if the objects are uploaded with the bucket-owner-full-control
canned
- * ACL.
BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to
+ * the bucket owner if the objects are uploaded with the
+ * bucket-owner-full-control
canned ACL.
*
- * ObjectWriter
- The uploading account will own the object if the object is uploaded with
- * the bucket-owner-full-control
canned ACL.
ObjectWriter
- The uploading account will own the object if the object is
+ * uploaded with the bucket-owner-full-control
canned ACL.
*
- * BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no longer affect
- * permissions. The bucket owner automatically owns and has full control over every object in
- * the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner
- * full control ACLs (such as the predefined bucket-owner-full-control
canned ACL or a custom ACL
- * in XML format that grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and ACLs are disabled. We recommend
- * keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see
- * Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.
- *
BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no
+ * longer affect permissions. The bucket owner automatically owns and has full control over
+ * every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL
+ * or specify bucket owner full control ACLs (such as the predefined
+ * bucket-owner-full-control
canned ACL or a custom ACL in XML format that
+ * grants the same permissions).
+ * By default, ObjectOwnership
is set to BucketOwnerEnforced
and
+ * ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where
+ * you must control access for each object individually. For more information about S3 Object
+ * Ownership, see Controlling ownership of
+ * objects and disabling ACLs for your bucket in the
+ * Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
*Specifies encryption-related information for an Amazon S3 bucket that is a destination for * replicated objects.
*If you're specifying a customer managed KMS key, we recommend using a fully qualified - * KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the - * requester’s account. This behavior can result in data that's encrypted with a KMS key - * that belongs to the requester, and not the bucket owner.
+ *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.
*Optional configuration to replicate existing source bucket objects. - *
+ *Optional configuration to replicate existing source bucket objects.
*This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.
+ *This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the + * Amazon S3 User Guide.
*Optional configuration to replicate existing source bucket objects. - *
+ *Optional configuration to replicate existing source bucket objects.
*This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.
+ *This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the + * Amazon S3 User Guide.
*If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
If the current version of the object is a delete marker, Amazon S3 behaves as if the
+ * object was deleted and includes x-amz-delete-marker: true
in the
+ * response.
If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed
error and the Last-Modified: timestamp
response header.
If the specified version in the request is a delete marker, the response
+ * returns a 405 Method Not Allowed
error and the Last-Modified:
+ * timestamp
response header.
If the object expiration is configured (see
* PutBucketLifecycleConfiguration
- * ), the response includes
- * this header. It includes the expiry-date
and rule-id
key-value
- * pairs providing object expiration information. The value of the rule-id
is
+ * ), the response includes this
+ * header. It includes the expiry-date
and rule-id
key-value pairs
+ * providing object expiration information. The value of the rule-id
is
* URL-encoded.
This functionality is not supported for directory buckets.
@@ -9062,7 +9275,8 @@ export interface GetObjectOutput { *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.
+ *This functionality is not supported for directory buckets. + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
*Date and time when the object was last modified.
*
- * General purpose buckets - When you specify a versionId
of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed
error and the Last-Modified: timestamp
response header.
versionId
of the object in your request, if the specified version in the
+ * request is a delete marker, the response returns a 405 Method Not Allowed
+ * error and the Last-Modified: timestamp
response header.
* @public
*/
LastModified?: Date | undefined;
@@ -9122,9 +9339,10 @@ export interface GetObjectOutput {
ChecksumSHA256?: string | undefined;
/**
- * 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 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.
*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.
+ * 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.
*Indicates whether the object uses an S3 Bucket Key for server-side encryption - * with Key Management Service (KMS) keys (SSE-KMS).
+ *Indicates whether the object uses an S3 Bucket Key for server-side encryption with + * Key Management Service (KMS) keys (SSE-KMS).
* @public */ BucketKeyEnabled?: boolean | undefined; @@ -9255,7 +9473,8 @@ export interface GetObjectOutput { * 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.
+ * Directory buckets - + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. *The number of tags, if any, on the object, when you have the relevant permission to read object tags.
+ *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.
*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 Return the object only if its entity tag (ETag) is the same as the one specified in this header;
- * otherwise, return a If both of the Return the object only if its entity tag (ETag) is the same as the one specified in this
+ * header; otherwise, return a If both of the For more information about conditional requests, see RFC 7232. Return the object only if it has been modified since the specified time; otherwise,
* return a If both of the If both of the For more information about conditional requests, see RFC 7232. Return the object only if its entity tag (ETag) is different from the one specified in this header;
- * otherwise, return a If both of the Return the object only if its entity tag (ETag) is different from the one specified in
+ * this header; otherwise, return a If both of the For more information about conditional requests, see RFC 7232. Return the object only if it has not been modified since the specified time; otherwise,
* return a If both of the If both of the For more information about conditional requests, see RFC 7232. Version ID used to reference a specific version of the object. By default, the By default, the If you include a If you include a If you request the current version of an object without a specific If you request the current version of an object without a specific
+ *
- * Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -9372,10 +9593,12 @@ export interface GetObjectRequest {
Bucket: string | undefined;
/**
- * 412 Precondition Failed
error.If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition
- * evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK
and the data requested. 412 Precondition Failed
error.If-Match
and If-Unmodified-Since
headers are
+ * present in the request as follows: If-Match
condition evaluates to
+ * true
, and; If-Unmodified-Since
condition evaluates to
+ * false
; then, S3 returns 200 OK
and the data requested. 304 Not Modified
error.If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
- * condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
- * status code.If-None-Match
and If-Modified-Since
headers are
+ * present in the request as follows: If-None-Match
condition evaluates to
+ * false
, and; If-Modified-Since
condition evaluates to
+ * true
; then, S3 returns 304 Not Modified
status code.304 Not Modified
error.If-None-Match
and If-Modified-Since
- * headers are present in the request as follows: If-None-Match
- * condition evaluates to false
, and; If-Modified-Since
- * condition evaluates to true
; then, S3 returns 304 Not Modified
HTTP status code.304 Not Modified
error.If-None-Match
and If-Modified-Since
headers are
+ * present in the request as follows: If-None-Match
condition evaluates to
+ * false
, and; If-Modified-Since
condition evaluates to
+ * true
; then, S3 returns 304 Not Modified
HTTP status
+ * code.412 Precondition Failed
error.If-Match
and If-Unmodified-Since
- * headers are present in the request as follows: If-Match
condition
- * evaluates to true
, and; If-Unmodified-Since
condition
- * evaluates to false
; then, S3 returns 200 OK
and the data requested. If-Match
and If-Unmodified-Since
headers are
+ * present in the request as follows: If-Match
condition evaluates to
+ * true
, and; If-Unmodified-Since
condition evaluates to
+ * false
; then, S3 returns 200 OK
and the data requested. GetObject
operation returns the current version of an object. To return a different version, use the versionId
subresource.GetObject
operation returns the current version of an
+ * object. To return a different version, use the versionId
subresource.
*
versionId
in your request header, you must have the s3:GetObjectVersion
permission to access a specific version of an object. The s3:GetObject
permission is not required in this scenario.versionId
in your request header, you must have
+ * the s3:GetObjectVersion
permission to access a specific version of an
+ * object. The s3:GetObject
permission is not required in this
+ * scenario.versionId
in the request header, only the s3:GetObject
permission is required. The s3:GetObjectVersion
permission is not required in this scenario.versionId
in the request header, only the
+ * s3:GetObject
permission is required. The
+ * s3:GetObjectVersion
permission is not required in this
+ * scenario.null
value of the version ID is supported by directory buckets. You can only specify null
- * to the versionId
query parameter in the request.null
value of the version ID is supported by directory buckets. You can only specify null
to the
+ * versionId
query parameter in the request.
Specifies the algorithm to use when decrypting the object (for example,
- * AES256
).
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:
@@ -9516,7 +9750,8 @@ export interface GetObjectRequest { *For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
+ * (Using Customer-Provided Encryption Keys) in the + * Amazon S3 User Guide. *This functionality is not supported for directory buckets.
*Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This - * value is used to decrypt the object when recovering it and must match the one used when - * storing the data. The key must be appropriate for use with the algorithm specified in the + *
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, @@ -9550,7 +9786,8 @@ export interface GetObjectRequest { *
For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
+ * (Using Customer-Provided Encryption Keys) in the + * Amazon S3 User Guide. *This functionality is not supported for directory buckets.
*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.
+ *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:
@@ -9583,7 +9820,8 @@ export interface GetObjectRequest { *For more information about SSE-C, see Server-Side Encryption - * (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
+ * (Using Customer-Provided Encryption Keys) in the + * Amazon S3 User Guide. *This functionality is not supported for directory buckets.
*Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. If either the source or - * destination S3 bucket has Requester Pays enabled, the requester will pay for - * corresponding charges to copy the object. For information about downloading objects from - * Requester Pays buckets, see Downloading Objects in + * 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.
@@ -9622,10 +9860,10 @@ export interface GetObjectRequest { /** *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.
kms:Decrypt
action
+ * to retrieve the checksum.
* @public
*/
ChecksumMode?: ChecksumMode | undefined;
@@ -9633,13 +9871,13 @@ export interface GetObjectRequest {
/**
* 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.
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.
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 + * 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.
@@ -9902,13 +10140,19 @@ export interface GetObjectAttributesParts { *
- * General purpose buckets - For GetObjectAttributes
, if a additional checksum (including x-amz-checksum-crc32
,
- * x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or
- * x-amz-checksum-sha256
) isn't applied to the object specified in the request, the response doesn't return Part
.
GetObjectAttributes
, if a additional checksum (including
+ * x-amz-checksum-crc32
, x-amz-checksum-crc32c
,
+ * x-amz-checksum-sha1
, or x-amz-checksum-sha256
) isn't
+ * applied to the object specified in the request, the response doesn't return
+ * Part
.
*
- * Directory buckets - For GetObjectAttributes
, no matter whether a additional checksum is applied to the object specified in the request, the response returns Part
.
GetObjectAttributes
, no matter whether a additional checksum is
+ * applied to the object specified in the request, the response returns
+ * Part
.
* The creation date of the object.
+ *Date and time when the object was last modified.
* @public */ LastModified?: Date | undefined; @@ -9982,7 +10226,8 @@ export interface GetObjectAttributesOutput { *For more information, see Storage Classes.
*- * Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
+ * Directory buckets - + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. *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 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 S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the 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
+ * 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. 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
+ * destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
+ * charges to copy the object. For information about downloading objects from Requester Pays
+ * buckets, see Downloading Objects in
* Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. The container element for optionally specifying the default Object Lock retention settings for new
- * objects placed in the specified bucket. The container element for optionally specifying the default Object Lock retention
+ * settings for new objects placed in the specified bucket. Confirms that the requester knows that they will be charged for the request. Bucket
* owners need not specify this parameter in their requests. If either the source or
- * destination S3 bucket has Requester Pays enabled, the requester will pay for
- * corresponding charges to copy the object. For information about downloading objects from
- * Requester Pays buckets, see Downloading Objects in
+ * 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. 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
+ * 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. 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
+ * destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
+ * charges to copy the object. For information about downloading objects from Requester Pays
+ * buckets, see Downloading Objects in
* Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. The name of the location where the bucket will be created. For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example AZ ID value is For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example
+ * AZ ID value is This functionality is only supported by directory buckets. The bucket name.
- * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format If the object expiration is configured (see
* This functionality is not supported for directory buckets. 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. This functionality is not supported for directory buckets.
+ * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
- * The server-side encryption algorithm used when you store this object in Amazon S3 (for
+ * example, 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.
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -10048,8 +10294,8 @@ export interface GetObjectAttributesRequest {
/**
* null
value of the version ID is supported by directory buckets. You can only specify null
- * to the versionId
query parameter in the request.null
value of the version ID is supported by directory buckets. You can only specify null
to the
+ * versionId
query parameter in the request.
*
usw2-az1
.usw2-az1
.
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -10766,9 +11014,9 @@ export interface HeadObjectOutput {
/**
* PutBucketLifecycleConfiguration
- * ), the response includes
- * this header. It includes the expiry-date
and rule-id
key-value
- * pairs providing object expiration information. The value of the rule-id
is
+ * ), the response includes this
+ * header. It includes the expiry-date
and rule-id
key-value pairs
+ * providing object expiration information. The value of the rule-id
is
* URL-encoded.ongoing-request="true"
.AES256
, aws:kms
, aws:kms:dsse
).AES256
, aws:kms
, aws:kms:dsse
).
This functionality is not supported for directory buckets.
*Indicates whether the object uses an S3 Bucket Key for server-side encryption - * with Key Management Service (KMS) keys (SSE-KMS).
+ *Indicates whether the object uses an S3 Bucket Key for server-side encryption with + * Key Management Service (KMS) keys (SSE-KMS).
* @public */ BucketKeyEnabled?: boolean | undefined; @@ -10991,7 +11240,8 @@ export interface HeadObjectOutput { *For more information, see Storage Classes.
*- * Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
+ * Directory buckets - + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. *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 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 both of the
@@ -11136,8 +11386,7 @@ export interface HeadObjectRequest {
*
- *
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -11126,9 +11377,8 @@ export interface HeadObjectRequest {
/**
* If-Match
and
- * If-Unmodified-Since
headers are present in the request as
- * follows:If-Match
and If-Unmodified-Since
headers are
+ * present in the request as follows:
*
If-Unmodified-Since
condition evaluates to
- * false
;If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
Return the object only if it has been modified since the specified time; otherwise, * return a 304 (not modified) error.
- *If both of the If-None-Match
and
- * If-Modified-Since
headers are present in the request as
- * follows:
If both of the If-None-Match
and If-Modified-Since
headers are
+ * present in the request as follows:
- * If-None-Match
condition evaluates to false
,
- * and;
If-None-Match
condition evaluates to false
, and;
*
- * If-Modified-Since
condition evaluates to
- * true
;
If-Modified-Since
condition evaluates to true
;
* Then Amazon S3 returns the 304 Not Modified
response code.
Return the object only if its entity tag (ETag) is different from the one specified; * otherwise, return a 304 (not modified) error.
- *If both of the If-None-Match
and
- * If-Modified-Since
headers are present in the request as
- * follows:
If both of the If-None-Match
and If-Modified-Since
headers are
+ * present in the request as follows:
- * If-None-Match
condition evaluates to false
,
- * and;
If-None-Match
condition evaluates to false
, and;
*
- * If-Modified-Since
condition evaluates to
- * true
;
If-Modified-Since
condition evaluates to true
;
* Then Amazon S3 returns the 304 Not Modified
response code.
Return the object only if it has not been modified since the specified time; otherwise, * return a 412 (precondition failed) error.
- *If both of the If-Match
and
- * If-Unmodified-Since
headers are present in the request as
- * follows:
If both of the If-Match
and If-Unmodified-Since
headers are
+ * present in the request as follows:
@@ -11207,8 +11449,7 @@ export interface HeadObjectRequest { *
- * If-Unmodified-Since
condition evaluates to
- * false
;
If-Unmodified-Since
condition evaluates to false
;
* Then Amazon S3 returns 200 OK
and the data requested.
Specifies the algorithm to use when encrypting the object (for example, - * AES256).
+ *Specifies the algorithm to use when encrypting the object (for example, AES256).
*This functionality is not supported for directory buckets.
*Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. If either the source or - * destination S3 bucket has Requester Pays enabled, the requester will pay for - * corresponding charges to copy the object. For information about downloading objects from - * Requester Pays buckets, see Downloading Objects in + * 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.
@@ -11340,14 +11580,17 @@ export interface HeadObjectRequest { /** *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
+ * 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.
kms:Decrypt
action to retrieve the checksum.
*
- * Directory buckets - If you enable ChecksumMode
and the object is encrypted with
- * Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the
- * kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
ChecksumMode
and the object is encrypted with Amazon Web Services Key Management Service
+ * (Amazon Web Services KMS), you must also have the kms:GenerateDataKey
and
+ * kms:Decrypt
permissions in IAM identity-based policies and KMS key
+ * policies for the KMS key to retrieve the checksum of the object.
* @public
*/
ChecksumMode?: ChecksumMode | undefined;
@@ -11595,7 +11838,7 @@ export interface ListBucketMetricsConfigurationsRequest {
}
/**
- * In terms of implementation, a Bucket is a resource.
+ *In terms of implementation, a Bucket is a resource.
* @public */ export interface Bucket { @@ -11614,7 +11857,8 @@ export interface Bucket { /** *
- * BucketRegion
indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.
BucketRegion
indicates the Amazon Web Services region where the bucket is located. If the
+ * request contains at least one valid parameter, it is included in the response.
* @public
*/
BucketRegion?: string | undefined;
@@ -11638,8 +11882,10 @@ export interface ListBucketsOutput {
/**
*
- * ContinuationToken
is included in the
- * response when there are more buckets that can be listed with pagination. The next ListBuckets
request to Amazon S3 can be continued with this ContinuationToken
. ContinuationToken
is obfuscated and is not a real bucket.
ContinuationToken
is included in the response when there are more buckets
+ * that can be listed with pagination. The next ListBuckets
request to Amazon S3 can
+ * be continued with this ContinuationToken
. ContinuationToken
is
+ * obfuscated and is not a real bucket.
* @public
*/
ContinuationToken?: string | undefined;
@@ -11657,7 +11903,9 @@ export interface ListBucketsOutput {
*/
export interface ListBucketsRequest {
/**
- * 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.
+ *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.
* @public */ MaxBuckets?: number | undefined; @@ -11666,7 +11914,7 @@ export interface ListBucketsRequest { *
* ContinuationToken
indicates to Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken
is obfuscated and is not a real
- * key. You can use this ContinuationToken
for pagination of the list results.
ContinuationToken
for pagination of the list results.
* Length Constraints: Minimum length of 0. Maximum length of 1024.
*Required: No.
*Limits the response to bucket names that begin with the specified bucket name prefix.
+ *Limits the response to bucket names that begin with the specified bucket name + * prefix.
* @public */ Prefix?: string | undefined; /** - *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.
Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services
+ * Region must be expressed according to the Amazon Web Services Region code, such as us-west-2
+ * for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services
+ * Regions, see Regions and Endpoints.
Requests made to a Regional endpoint that is different from the bucket-region
parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2
, the request must be made to an endpoint in Region us-west-2
.
Requests made to a Regional endpoint that is different from the
+ * bucket-region
parameter are not supported. For example, if you want to
+ * limit the response to your buckets in Region us-west-2
, the request must be
+ * made to an endpoint in Region us-west-2
.
If ContinuationToken
was sent with the request, it is included in the
- * response. You can use the returned ContinuationToken
for pagination of the list response.
ContinuationToken
for pagination of the
+ * list response.
* @public
*/
ContinuationToken?: string | undefined;
@@ -11718,14 +11974,18 @@ export interface ListDirectoryBucketsOutput {
export interface ListDirectoryBucketsRequest {
/**
*
- * ContinuationToken
indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken
is obfuscated and is not a real
- * bucket name. You can use this ContinuationToken
for the pagination of the list results.
ContinuationToken
indicates to Amazon S3 that the list is being continued on
+ * buckets in this account with a token. ContinuationToken
is obfuscated and is
+ * not a real bucket name. You can use this ContinuationToken
for the pagination
+ * of the list results.
* @public
*/
ContinuationToken?: string | undefined;
/**
- * 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.
+ *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.
* @public */ MaxDirectoryBuckets?: number | undefined; @@ -11769,8 +12029,9 @@ export interface Initiator { * principal is an IAM User, it provides a user ARN value. *- * Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the - * principal is an IAM User, it provides a user ARN value.
+ * Directory buckets - If the principal is an + * Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it + * provides a user ARN value. *The class of storage used to store the object.
*- * Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
+ * Directory buckets - + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. *Specifies the owner of the object that is part of the multipart upload.
*- * Directory buckets - The bucket owner is returned as the object owner for all the objects.
+ * Directory buckets - The bucket owner is + * returned as the object owner for all the objects. *upload-id-marker
.
+ * upload-id-marker
.
* This functionality is not supported for directory buckets.
*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 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
- *
- * General purpose buckets - For general purpose buckets, If If
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -12022,7 +12286,7 @@ export interface ListMultipartUploadsRequest {
* test_file(3).png
will appear as
+ * test_file(3).png
will appear as
* test_file%283%29.png
.
*
key-marker
- * is an object key. Together with upload-id-marker
, this parameter specifies the multipart
- * upload after which listing should begin.upload-id-marker
is not specified, only the keys lexicographically
- * greater than the specified key-marker
will be included in the list.upload-id-marker
is specified, any multipart uploads for a key equal to
- * the key-marker
might also be included, provided those multipart uploads have
- * upload IDs lexicographically greater than the specified
- * upload-id-marker
.key-marker
is an object key. Together with
+ * upload-id-marker
, this parameter specifies the multipart upload
+ * after which listing should begin.
If upload-id-marker
is not specified, only the keys
+ * lexicographically greater than the specified key-marker
will be
+ * included in the list.
If upload-id-marker
is specified, any multipart uploads for a key
+ * equal to the key-marker
might also be included, provided those
+ * multipart uploads have upload IDs lexicographically greater than the specified
+ * upload-id-marker
.
- * Directory buckets - For directory buckets, key-marker
- * is obfuscated and isn't a real object key.
- * The upload-id-marker
parameter isn't supported by directory buckets.
- * To list the additional multipart uploads, you only need to set the value of key-marker
to the NextKeyMarker
value from the previous response.
- *
In the ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys.
+ * Directory buckets - For
+ * directory buckets, key-marker
is obfuscated and isn't a real object
+ * key. The upload-id-marker
parameter isn't supported by
+ * directory buckets. To list the additional multipart uploads, you only need to set
+ * the value of key-marker
to the NextKeyMarker
value from
+ * the previous response.
In the ListMultipartUploads
response, the multipart uploads aren't
+ * sorted lexicographically based on the object keys.
*
- *
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 + * 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.
@@ -12122,7 +12390,8 @@ export interface ListMultipartUploadsRequest { * and how to work with archived objects, see Working with archived * objects in the Amazon S3 User Guide. *This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
+ *This functionality is not supported for directory buckets. + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
*The class of storage used to store the object.
*- * Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
+ * Directory buckets - + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. *The owner of the object
*- * Directory buckets - The bucket owner is returned as the object owner.
+ * Directory buckets - The bucket owner is + * returned as the object owner. *This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
+ *This functionality is not supported for directory buckets. + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
*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 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
- * 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. 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
@@ -12576,9 +12850,12 @@ export interface ListObjectsV2Output {
*
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -12447,7 +12720,7 @@ export interface ListObjectsRequest {
* test_file(3).png
will appear as
+ * test_file(3).png
will appear as
* test_file%283%29.png
.CommonPrefixes
only if you specify a
* delimiter.
- * Directory buckets - When you query ListObjectsV2
with a delimiter during in-progress multipart uploads, the
- * CommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads.
- * For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
ListObjectsV2
with a delimiter during in-progress multipart
+ * uploads, the CommonPrefixes
response parameter contains the prefixes
+ * that are associated with the in-progress multipart uploads. For more information
+ * about multipart uploads, see Multipart Upload Overview in
+ * the Amazon S3 User Guide.
* If ContinuationToken
was sent with the request, it is included in the
- * response. You can use the returned ContinuationToken
for pagination of the list response. You can use this ContinuationToken
for pagination of the list results.
ContinuationToken
for pagination of the
+ * list response. You can use this ContinuationToken
for pagination of the list
+ * results.
* @public
*/
ContinuationToken?: string | undefined;
@@ -12650,7 +12929,8 @@ export interface ListObjectsV2Output {
export interface ListObjectsV2Request {
/**
*
- * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
- * Directory buckets - When you query
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -12680,9 +12960,12 @@ export interface ListObjectsV2Request {
*
* ListObjectsV2
with a delimiter during in-progress multipart uploads, the
- * CommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads.
- * For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.ListObjectsV2
with a delimiter during in-progress multipart
+ * uploads, the CommonPrefixes
response parameter contains the prefixes
+ * that are associated with the in-progress multipart uploads. For more information
+ * about multipart uploads, see Multipart Upload Overview in
+ * the Amazon S3 User Guide.
When using the URL encoding type, non-ASCII characters that are used in an object's
* key name will be percent-encoded according to UTF-8 code values. For example, the object
- * test_file(3).png
will appear as
+ * test_file(3).png
will appear as
* test_file%283%29.png
.
* ContinuationToken
indicates to Amazon S3 that the list is being continued on
* this bucket with a token. ContinuationToken
is obfuscated and is not a real
- * key. You can use this ContinuationToken
for pagination of the list results.
ContinuationToken
for pagination of the list results.
+ *
* @public
*/
ContinuationToken?: string | undefined;
@@ -12741,7 +13025,8 @@ export interface ListObjectsV2Request {
* field to true
.
* - * Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
+ * Directory buckets - For directory buckets, + * the bucket owner is returned as the object owner for all objects. *When using the URL encoding type, non-ASCII characters that are used in an object's
* key name will be percent-encoded according to UTF-8 code values. For example, the object
- * test_file(3).png
will appear as
+ * test_file(3).png
will appear as
* test_file%283%29.png
.
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 + * 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.
@@ -13265,8 +13550,8 @@ export interface ListPartsOutput { IsTruncated?: boolean | undefined; /** - *Container for elements related to a particular part. A response can contain zero or
- * more Part
elements.
Container for elements related to a particular part. A response can contain zero or more
+ * Part
elements.
- * Directory buckets - The bucket owner is returned as the object owner for all the parts.
+ * Directory buckets - The bucket owner is + * returned as the object owner for all the parts. *The class of storage used to store the uploaded - * object.
+ *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.
+ * Directory buckets - + * Only the S3 Express One Zone storage class is supported by directory buckets to store objects. *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 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
+ * 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. Indicates which default minimum object size behavior is applied to the lifecycle configuration. 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.
- *
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -13375,9 +13662,9 @@ export interface ListPartsRequest {
/**
*
*
all_storage_classes_128K
- Objects smaller than 128 KB will not transition to any storage class by default. 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.
- *
varies_by_storage_class
- Objects smaller than 128 KB will
+ * transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
+ * default, all other storage classes will prevent transitions smaller than 128 KB.
+ *
* To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
To customize the minimum object size for any transition you can add a filter that
+ * specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in
+ * the body of your transition rule. Custom filters always take precedence over the default
+ * transition behavior.
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.
+ *Indicates which default minimum object size behavior is applied to the lifecycle configuration.
+ *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.
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.
- *
varies_by_storage_class
- Objects smaller than 128 KB will
+ * transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By
+ * default, all other storage classes will prevent transitions smaller than 128 KB.
+ *
* To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
To customize the minimum object size for any transition you can add a filter that
+ * specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in
+ * the body of your transition rule. Custom filters always take precedence over the default
+ * transition behavior.
The bucket policy as a JSON document.
- *For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession
.
For directory buckets, the only IAM action supported in the bucket policy is
+ * s3express:CreateSession
.
+ * The existing object was created with a different encryption type. + * Subsequent write requests must include the appropriate encryption + * parameters in the request or while creating the session. + *
+ * @public + */ +export class EncryptionTypeMismatch extends __BaseException { + readonly name: "EncryptionTypeMismatch" = "EncryptionTypeMismatch"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeYou may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:
+ *Cannot specify both a write offset value and user-defined object metadata for existing objects.
+ *Checksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.
+ *Request body cannot be empty when 'write offset' is specified.
+ *+ * The write offset value that you specified does not match the current object size. + *
+ * @public + */ +export class InvalidWriteOffset extends __BaseException { + readonly name: "InvalidWriteOffset" = "InvalidWriteOffset"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeIf the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It
- * includes the expiry-date
and rule-id
key-value pairs that provide
- * information about object expiration. The value of the rule-id
is
- * URL-encoded.
If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide,
+ * the response includes this header. It includes the expiry-date
and
+ * rule-id
key-value pairs that provide information about object expiration.
+ * The value of the rule-id
is URL-encoded.
This functionality is not supported for directory buckets.
*Entity tag for the uploaded object.
*- * General purpose buckets - To ensure that data is not corrupted traversing the network, - * for objects where the - * ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to - * the calculated MD5 value.
+ * General purpose buckets - To ensure that data is not + * corrupted traversing the network, for objects where the ETag is the MD5 digest of the + * object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned + * ETag to the calculated MD5 value. *- * Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
+ * Directory buckets - The ETag for the object in + * a directory bucket isn't the MD5 digest of the object. * @public */ ETag?: string | undefined; @@ -614,10 +693,9 @@ export interface PutObjectOutput { * for the object being stored. Amazon S3 returns this ID in the response. When you enable * versioning for a bucket, if Amazon S3 receives multiple write requests for the same object * simultaneously, it stores all of the objects. For more information about versioning, see - * Adding Objects to - * Versioning-Enabled Buckets in the Amazon S3 - * User Guide. For information about returning the versioning state - * of a bucket, see GetBucketVersioning. + * Adding Objects to + * Versioning-Enabled Buckets in the Amazon S3 User Guide. For + * information about returning the versioning state of a bucket, see GetBucketVersioning. *This functionality is not supported for directory buckets.
*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.
+ * 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.
*+ * The size of the object in bytes. This will only be present if you append to an object. + *
+ *This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
+ *If present, indicates that the requester was successfully charged for the * request.
@@ -686,7 +775,7 @@ export interface PutObjectOutput { export interface PutObjectRequest { /** *The canned ACL to apply to the object. For more information, see Canned - * ACL in the Amazon S3 User Guide.
+ * ACL in the Amazon S3 User Guide. *When adding a new object, you can use headers to grant ACL-based permissions to
* individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are
* then added to the ACL on the object. By default, all objects are private. Only the owner
@@ -699,7 +788,7 @@ export interface PutObjectRequest {
* specify bucket owner full control ACLs, such as the bucket-owner-full-control
* canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that
* contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a
- * 400
error with the error code AccessControlListNotSupported
.
+ * 400
error with the error code AccessControlListNotSupported
.
* For more information, see Controlling ownership of
* objects and disabling ACLs in the Amazon S3 User Guide.
The bucket name to which the PUT action was initiated.
*
- * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -786,10 +876,10 @@ export interface PutObjectRequest {
* Content-MD5 mechanism as an end-to-end integrity check. For more information about REST
* request authentication, see REST Authentication.
The Content-MD5
or x-amz-sdk-checksum-algorithm
header is required for any request to upload an
- * object with a retention period configured using Amazon S3 Object Lock. For more
- * information, see Uploading objects to an Object Lock enabled bucket
- * in the Amazon S3 User Guide.
The Content-MD5
or x-amz-sdk-checksum-algorithm
header is
+ * required for any request to upload an object with a retention period configured using
+ * Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the
+ * Amazon S3 User Guide.
This functionality is not supported for directory buckets.
@@ -844,10 +934,10 @@ export interface PutObjectRequest { *ChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm
*
.
* The Content-MD5
or x-amz-sdk-checksum-algorithm
header is required for any request to upload an
- * object with a retention period configured using Amazon S3 Object Lock. For more
- * information, see Uploading objects to an Object Lock enabled bucket
- * in the Amazon S3 User Guide.
The Content-MD5
or x-amz-sdk-checksum-algorithm
header is
+ * required for any request to upload an object with a retention period configured using
+ * Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the
+ * Amazon S3 User Guide.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed
error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
response. On a 409 failure you should retry the upload.
Uploads the object only if the object key name does not already exist in the bucket
+ * specified. Otherwise, Amazon S3 returns a 412 Precondition Failed
error.
If a conflicting operation occurs during the upload S3 returns a 409
+ * ConditionalRequestConflict
response. On a 409 failure you should retry the
+ * upload.
Expects the '*' (asterisk) character.
*For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
* @public @@ -976,6 +1069,19 @@ export interface PutObjectRequest { */ Key: string | undefined; + /** + *+ * Specifies the offset for appending data to existing objects in bytes. + * The offset must be equal to the size of the existing object being appended to. + * If no object exists, setting this header to 0 will create a new object. + *
+ *This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
+ *A map of metadata to store with the object in S3.
* @public @@ -983,27 +1089,28 @@ export interface PutObjectRequest { Metadata?: RecordThe server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
- * AES256
, aws:kms
, aws:kms:dsse
).
The server-side encryption algorithm that was used when you store this object in Amazon S3
+ * (for example, AES256
, aws:kms
, aws:kms:dsse
).
- * General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in - * Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the - * encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or - * DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side - * encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to - * encrypt data at rest by using server-side encryption with other key options. For more - * information, see Using Server-Side - * Encryption in the Amazon S3 User Guide.
+ * General purpose buckets - You have four mutually + * exclusive options to protect data using server-side encryption in Amazon S3, depending on + * how you choose to manage the encryption keys. Specifically, the encryption key + * options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and + * customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by + * using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt + * data at rest by using server-side encryption with other key options. For more + * information, see Using Server-Side + * Encryption in the Amazon S3 User Guide. *
- * Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
+ * Directory buckets -
+ * For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession
requests or PUT
object requests. Then, new objects
* are automatically encrypted with the desired encryption settings. For more
- * information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
- *
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession
request.
* You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request.
* You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and
@@ -1026,16 +1133,17 @@ export interface PutObjectRequest {
/**
*
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.
+ * 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.
+ *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.
+ *Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*If the bucket is configured as a website, redirects requests for this object to another * object in the same bucket or to an external URL. Amazon S3 stores the value of this header in - * the object metadata. For information about object metadata, see Object Key and Metadata in the Amazon S3 - * User Guide.
+ * the object metadata. For information about object metadata, see Object Key and Metadata in the + * Amazon S3 User Guide. *In the following example, the request header sets the redirect to an object * (anotherPage.html) in the same bucket:
*@@ -1060,8 +1168,7 @@ export interface PutObjectRequest { *
*For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and * How to - * Configure Website Page Redirects in the Amazon S3 - * User Guide.
+ * Configure Website Page Redirects in the Amazon S3 User Guide. *This functionality is not supported for directory buckets.
*Specifies the algorithm to use when encrypting the object (for example,
- * AES256
).
AES256
).
* This functionality is not supported for directory buckets.
*Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. If either the source or - * destination S3 bucket has Requester Pays enabled, the requester will pay for - * corresponding charges to copy the object. For information about downloading objects from - * Requester Pays buckets, see Downloading Objects in + * 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.
@@ -1199,7 +1306,8 @@ export interface PutObjectRequest { /** *Specifies whether a legal hold will be applied to this object. For more information - * about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
+ * about S3 Object Lock, see Object Lock in the + * Amazon S3 User Guide. *This functionality is not supported for directory buckets.
*+ * You have attempted to add more parts than the maximum of 10000 + * that are allowed for this object. You can use the CopyObject operation + * to copy this object to another and then add more data to the newly copied object. + *
+ * @public + */ +export class TooManyParts extends __BaseException { + readonly name: "TooManyParts" = "TooManyParts"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeConfirms 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 + * 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.
@@ -1400,9 +1532,9 @@ export interface PutObjectLegalHoldRequest { /** *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 + * 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.
@@ -1479,9 +1611,9 @@ export interface PutObjectLockConfigurationRequest { /** *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 + * 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.
@@ -1568,9 +1700,9 @@ export interface PutObjectRetentionRequest { /** *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 + * 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.
@@ -1692,9 +1824,9 @@ export interface PutObjectTaggingRequest { /** *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 + * 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.
@@ -2352,9 +2484,9 @@ export interface RestoreObjectRequest { /** *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 + * 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.
@@ -2774,8 +2906,8 @@ export interface SelectObjectContentRequest { */ export interface UploadPartOutput { /** - *The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
- * AES256
, aws:kms
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for
+ * example, AES256
, aws:kms
).
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.
+ * 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.
*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 Specifies the algorithm to use when encrypting the object (for example,
- * AES256). Specifies the algorithm to use when encrypting the object (for example, AES256). This functionality is not supported for directory buckets. Confirms that the requester knows that they will be charged for the request. Bucket
* owners need not specify this parameter in their requests. If either the source or
- * destination S3 bucket has Requester Pays enabled, the requester will pay for
- * corresponding charges to copy the object. For information about downloading objects from
- * Requester Pays buckets, see Downloading Objects in
+ * destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding
+ * charges to copy the object. For information about downloading objects from Requester Pays
+ * buckets, see Downloading Objects in
* Requester Pays Buckets in the Amazon S3 User Guide. This functionality is not supported for directory buckets. The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
- * The server-side encryption algorithm used when you store this object in Amazon S3 (for
+ * example, 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.
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -2988,8 +3121,7 @@ export interface UploadPartRequest {
UploadId: string | undefined;
/**
- * AES256
, aws:kms
).AES256
, aws:kms
).
This functionality is not supported for directory buckets.
*The bucket name.
*
- * Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
+ * Directory buckets -
+ * When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format
* bucket_base_name--az-id--x-s3
(for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming
@@ -3221,22 +3354,22 @@ export interface UploadPartCopyRequest {
* arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your bucket has versioning enabled, you could have multiple versions of the
- * same object. By default, x-amz-copy-source
identifies the current
- * version of the source object to copy.
- * To copy a specific version of the source object to copy, append ?versionId=
- * to the x-amz-copy-source
request header (for example,
- * x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).
- *
If the current version is a delete marker and you
- * don't specify a versionId in the x-amz-copy-source
request header, Amazon S3 returns a
- * 404 Not Found
error, because the object does not exist. If you specify versionId in the
- * x-amz-copy-source
and the versionId is a delete marker, Amazon S3
- * returns an HTTP 400 Bad Request
error, because you are not allowed to specify a delete marker
- * as a version for the x-amz-copy-source
.
If your bucket has versioning enabled, you could have multiple versions of the same
+ * object. By default, x-amz-copy-source
identifies the current version of the
+ * source object to copy. To copy a specific version of the source object to copy, append
+ * ?versionId=
to the x-amz-copy-source
request
+ * header (for example, x-amz-copy-source:
+ * /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).
If the current version is a delete marker and you don't specify a versionId in the
+ * x-amz-copy-source
request header, Amazon S3 returns a 404 Not Found
+ * error, because the object does not exist. If you specify versionId in the
+ * x-amz-copy-source
and the versionId is a delete marker, Amazon S3 returns an
+ * HTTP 400 Bad Request
error, because you are not allowed to specify a delete
+ * marker as a version for the x-amz-copy-source
.
- * Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
+ * Directory buckets - + * S3 Versioning isn't enabled and supported for directory buckets. *Copies the object if its entity tag (ETag) matches the specified tag.
- *If both of the
- * x-amz-copy-source-if-match
and
- * x-amz-copy-source-if-unmodified-since
headers are present in the
- * request as follows:
If both of the x-amz-copy-source-if-match
and
+ * x-amz-copy-source-if-unmodified-since
headers are present in the request as
+ * follows:
* x-amz-copy-source-if-match
condition evaluates to true
,
* and;
* x-amz-copy-source-if-unmodified-since
condition evaluates to
- * false
;
false
;
* Amazon S3 returns 200 OK
and copies the data.
*
Copies the object if it has been modified since the specified time.
- *If both of the
- * x-amz-copy-source-if-none-match
and
- * x-amz-copy-source-if-modified-since
headers are present in the
- * request as follows:
If both of the x-amz-copy-source-if-none-match
and
+ * x-amz-copy-source-if-modified-since
headers are present in the request as
+ * follows:
- * x-amz-copy-source-if-none-match
condition evaluates to
- * false
, and;
x-amz-copy-source-if-none-match
condition evaluates to false
,
+ * and;
*
* x-amz-copy-source-if-modified-since
condition evaluates to
- * true
;
true
;
* Amazon S3 returns 412 Precondition Failed
response code.
*
Copies the object if its entity tag (ETag) is different than the specified ETag.
- *If both of the
- * x-amz-copy-source-if-none-match
and
- * x-amz-copy-source-if-modified-since
headers are present in the
- * request as follows:
If both of the x-amz-copy-source-if-none-match
and
+ * x-amz-copy-source-if-modified-since
headers are present in the request as
+ * follows:
- * x-amz-copy-source-if-none-match
condition evaluates to
- * false
, and;
x-amz-copy-source-if-none-match
condition evaluates to false
,
+ * and;
*
* x-amz-copy-source-if-modified-since
condition evaluates to
- * true
;
true
;
* Amazon S3 returns 412 Precondition Failed
response code.
*
Copies the object if it hasn't been modified since the specified time.
- *If both of the
- * x-amz-copy-source-if-match
and
- * x-amz-copy-source-if-unmodified-since
headers are present in the
- * request as follows:
If both of the x-amz-copy-source-if-match
and
+ * x-amz-copy-source-if-unmodified-since
headers are present in the request as
+ * follows:
* x-amz-copy-source-if-match
condition evaluates to true
,
* and;
* x-amz-copy-source-if-unmodified-since
condition evaluates to
- * false
;
false
;
* Amazon S3 returns 200 OK
and copies the data.
*
Specifies the algorithm to use when encrypting the object (for example, - * AES256).
+ *Specifies the algorithm to use when encrypting the object (for example, AES256).
*This functionality is not supported when the destination bucket is a directory bucket.
*Specifies the algorithm to use when decrypting the source object (for example,
- * AES256
).
AES256
).
* This functionality is not supported when the source object is in a directory bucket.
*Confirms that the requester knows that they will be charged for the request. Bucket * owners need not specify this parameter in their requests. If either the source or - * destination S3 bucket has Requester Pays enabled, the requester will pay for - * corresponding charges to copy the object. For information about downloading objects from - * Requester Pays buckets, see Downloading Objects in + * 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.
@@ -3777,8 +3905,9 @@ export interface WriteGetObjectResponseRequest { SSECustomerAlgorithm?: string | undefined; /** - *If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric - * encryption customer managed key that was used for stored in Amazon S3 object.
+ *If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key + * Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in + * Amazon S3 object.
* @public */ SSEKMSKeyId?: string | undefined; diff --git a/clients/client-s3/src/protocols/Aws_restXml.ts b/clients/client-s3/src/protocols/Aws_restXml.ts index a0e2a0bd1736..c4973d6e6f81 100644 --- a/clients/client-s3/src/protocols/Aws_restXml.ts +++ b/clients/client-s3/src/protocols/Aws_restXml.ts @@ -419,9 +419,12 @@ import { CSVInput, CSVOutput, Encryption, + EncryptionTypeMismatch, EndEvent, GlacierJobParameters, InputSerialization, + InvalidRequest, + InvalidWriteOffset, JSONInput, JSONOutput, MetadataEntry, @@ -442,6 +445,7 @@ import { Stats, StatsEvent, Tagging, + TooManyParts, VersioningConfiguration, WebsiteConfiguration, } from "../models/models_1"; @@ -458,6 +462,7 @@ export const se_AbortMultipartUploadCommand = async ( const headers: any = map({}, isSerializableHeaderValue, { [_xarp]: input[_RP]!, [_xaebo]: input[_EBO]!, + [_xaimit]: [() => isSerializableHeaderValue(input[_IMIT]), () => __dateToUtcString(input[_IMIT]!).toString()], }); b.bp("/{Key+}"); b.p("Bucket", () => input.Bucket!, "{Bucket}", false); @@ -971,6 +976,9 @@ export const se_DeleteObjectCommand = async ( [_xarp]: input[_RP]!, [_xabgr]: [() => isSerializableHeaderValue(input[_BGR]), () => input[_BGR]!.toString()], [_xaebo]: input[_EBO]!, + [_im]: input[_IM]!, + [_xaimlmt]: [() => isSerializableHeaderValue(input[_IMLMT]), () => __dateToUtcString(input[_IMLMT]!).toString()], + [_xaims]: [() => isSerializableHeaderValue(input[_IMS]), () => input[_IMS]!.toString()], }); b.bp("/{Key+}"); b.p("Bucket", () => input.Bucket!, "{Bucket}", false); @@ -1498,7 +1506,7 @@ export const se_GetObjectCommand = async ( const b = rb(input, context); const headers: any = map({}, isSerializableHeaderValue, { [_im]: input[_IM]!, - [_ims]: [() => isSerializableHeaderValue(input[_IMS]), () => __dateToUtcString(input[_IMS]!).toString()], + [_ims]: [() => isSerializableHeaderValue(input[_IMSf]), () => __dateToUtcString(input[_IMSf]!).toString()], [_inm]: input[_INM]!, [_ius]: [() => isSerializableHeaderValue(input[_IUS]), () => __dateToUtcString(input[_IUS]!).toString()], [_ra]: input[_R]!, @@ -1747,7 +1755,7 @@ export const se_HeadObjectCommand = async ( const b = rb(input, context); const headers: any = map({}, isSerializableHeaderValue, { [_im]: input[_IM]!, - [_ims]: [() => isSerializableHeaderValue(input[_IMS]), () => __dateToUtcString(input[_IMS]!).toString()], + [_ims]: [() => isSerializableHeaderValue(input[_IMSf]), () => __dateToUtcString(input[_IMSf]!).toString()], [_inm]: input[_INM]!, [_ius]: [() => isSerializableHeaderValue(input[_IUS]), () => __dateToUtcString(input[_IUS]!).toString()], [_ra]: input[_R]!, @@ -2637,6 +2645,7 @@ export const se_PutObjectCommand = async ( [_xagr]: input[_GR]!, [_xagra]: input[_GRACP]!, [_xagwa]: input[_GWACP]!, + [_xawob]: [() => isSerializableHeaderValue(input[_WOB]), () => input[_WOB]!.toString()], [_xasse]: input[_SSE]!, [_xasc]: input[_SC]!, [_xawrl]: input[_WRL]!, @@ -5154,6 +5163,7 @@ export const de_PutObjectCommand = async ( [_SSEKMSKI]: [, output.headers[_xasseakki]], [_SSEKMSEC]: [, output.headers[_xassec]], [_BKE]: [() => void 0 !== output.headers[_xassebke], () => __parseBoolean(output.headers[_xassebke])], + [_Si]: [() => void 0 !== output.headers[_xaos], () => __strictParseLong(output.headers[_xaos])], [_RC]: [, output.headers[_xarc]], }); await collectBody(output.body, context); @@ -5408,6 +5418,18 @@ const de_CommandError = async (output: __HttpResponse, context: __SerdeContext): case "NotFound": case "com.amazonaws.s3#NotFound": throw await de_NotFoundRes(parsedOutput, context); + case "EncryptionTypeMismatch": + case "com.amazonaws.s3#EncryptionTypeMismatch": + throw await de_EncryptionTypeMismatchRes(parsedOutput, context); + case "InvalidRequest": + case "com.amazonaws.s3#InvalidRequest": + throw await de_InvalidRequestRes(parsedOutput, context); + case "InvalidWriteOffset": + case "com.amazonaws.s3#InvalidWriteOffset": + throw await de_InvalidWriteOffsetRes(parsedOutput, context); + case "TooManyParts": + case "com.amazonaws.s3#TooManyParts": + throw await de_TooManyPartsRes(parsedOutput, context); case "ObjectAlreadyInActiveTierError": case "com.amazonaws.s3#ObjectAlreadyInActiveTierError": throw await de_ObjectAlreadyInActiveTierErrorRes(parsedOutput, context); @@ -5451,6 +5473,22 @@ const de_BucketAlreadyOwnedByYouRes = async ( return __decorateServiceException(exception, parsedOutput.body); }; +/** + * deserializeAws_restXmlEncryptionTypeMismatchRes + */ +const de_EncryptionTypeMismatchRes = async ( + parsedOutput: any, + context: __SerdeContext +): PromiseThis operation aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.
\nTo verify that all parts have been removed and prevent getting charged for the part\n storage, you should call the ListParts API operation and ensure that\n the parts list is empty.
\n\n Directory buckets - \n 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. \n To delete these in-progress multipart uploads, use the\n ListMultipartUploads
operation to list the in-progress multipart\n uploads in the bucket and use the AbortMultipartUpload
operation to\n abort all the in-progress multipart uploads.\n
\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload\n and Permissions in the Amazon S3\n User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to AbortMultipartUpload
:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThis operation aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.
\nTo verify that all parts have been removed and prevent getting charged for the part\n storage, you should call the ListParts API operation and ensure\n that the parts list is empty.
\n\n Directory buckets - If multipart\n uploads in a directory bucket are in progress, you can't delete the bucket until\n all the in-progress multipart uploads are aborted or completed. To delete these\n in-progress multipart uploads, use the ListMultipartUploads
operation\n to list the in-progress multipart uploads in the bucket and use the\n AbortMultipartUpload
operation to abort all the in-progress\n multipart uploads.
\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For\n information about permissions required to use the multipart upload, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to AbortMultipartUpload
:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe bucket name to which the upload was taking place.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name to which the upload was taking place.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp.\n If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed
error. \n If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content)
response. \n
This functionality is only supported for directory buckets.
\n\n BucketRegion
indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.
\n BucketRegion
indicates the Amazon Web Services region where the bucket is located. If the\n request contains at least one valid parameter, it is included in the response.
In terms of implementation, a Bucket is a resource.
" + "smithy.api#documentation": "In terms of implementation, a Bucket is a resource.
" } }, "com.amazonaws.s3#BucketAccelerateStatus": { @@ -17712,7 +17719,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the information about the bucket that will be created. For more information about directory buckets, see \n Directory buckets in the Amazon S3 User Guide.
\nThis functionality is only supported by directory buckets.
\nSpecifies the information about the bucket that will be created. For more information\n about directory buckets, see Directory buckets in the Amazon S3 User Guide.
\nThis functionality is only supported by directory buckets.
\nCompletes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation or the UploadPartCopy\n operation. After successfully uploading all relevant parts of an upload, you call this\n CompleteMultipartUpload
operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts\n in ascending order by part number to create a new object. In the CompleteMultipartUpload \n request, you must provide the parts list and ensure that the parts list is complete.\n The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list,\n you must provide the PartNumber
value and the ETag
value that are returned after that part\n was uploaded.
The processing of a CompleteMultipartUpload request could take several minutes to\n finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK
response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. A request could fail after the\n initial 200 OK
response has been sent. This means that a 200 OK
response can\n contain either a success or an error. The error response might be embedded in the 200 OK
response. \n If you call this API operation directly, make sure to design\n your application to parse the contents of the response and handle it appropriately. If you\n use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply\n error handling per your configuration settings (including automatically retrying the\n request as appropriate). If the condition persists, the SDKs throw an exception (or, for\n the SDKs that don't use exceptions, they return an error).
Note that if CompleteMultipartUpload
fails, applications should be prepared\n to retry any failed requests (including 500 error responses). For more information, see Amazon S3 Error Best\n Practices.
You can't use Content-Type: application/x-www-form-urlencoded
for the \n CompleteMultipartUpload requests. Also, if you don't provide a\n Content-Type
header, CompleteMultipartUpload
can still return a 200\n OK
response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3\n User Guide.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\nIf you provide an additional checksum\n value in your MultipartUpload
requests and the\n object is encrypted with Key Management Service, you must have permission to use the\n kms:Decrypt
action for the\n CompleteMultipartUpload
request to succeed.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with\n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
Error Code: EntityTooSmall
\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\nHTTP Status Code: 400 Bad Request
\nError Code: InvalidPart
\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified ETag might not have\n matched the uploaded part's ETag.
\nHTTP Status Code: 400 Bad Request
\nError Code: InvalidPartOrder
\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\nHTTP Status Code: 400 Bad Request
\nError Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\nHTTP Status Code: 404 Not Found
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CompleteMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nCompletes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation or the UploadPartCopy operation.\n After successfully uploading all relevant parts of an upload, you call this\n CompleteMultipartUpload
operation to complete the upload. Upon receiving\n this request, Amazon S3 concatenates all the parts in ascending order by part number to create a\n new object. In the CompleteMultipartUpload request, you must provide the parts list and\n ensure that the parts list is complete. The CompleteMultipartUpload API operation\n concatenates the parts that you provide in the list. For each part in the list, you must\n provide the PartNumber
value and the ETag
value that are returned\n after that part was uploaded.
The processing of a CompleteMultipartUpload request could take several minutes to\n finalize. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK
response. While processing is in progress, Amazon S3\n periodically sends white space characters to keep the connection from timing out. A request\n could fail after the initial 200 OK
response has been sent. This means that a\n 200 OK
response can contain either a success or an error. The error\n response might be embedded in the 200 OK
response. If you call this API\n operation directly, make sure to design your application to parse the contents of the\n response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition.\n The SDKs detect the embedded error and apply error handling per your configuration settings\n (including automatically retrying the request as appropriate). If the condition persists,\n the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an\n error).
Note that if CompleteMultipartUpload
fails, applications should be prepared\n to retry any failed requests (including 500 error responses). For more information, see\n Amazon S3 Error\n Best Practices.
You can't use Content-Type: application/x-www-form-urlencoded
for the\n CompleteMultipartUpload requests. Also, if you don't provide a Content-Type
\n header, CompleteMultipartUpload
can still return a 200 OK
\n response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\nIf you provide an additional checksum\n value in your MultipartUpload
requests and the\n object is encrypted with Key Management Service, you must have permission to use the\n kms:Decrypt
action for the\n CompleteMultipartUpload
request to succeed.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.
Error Code: EntityTooSmall
\n
Description: Your proposed upload is smaller than the minimum\n allowed object size. Each part must be at least 5 MB in size, except\n the last part.
\nHTTP Status Code: 400 Bad Request
\nError Code: InvalidPart
\n
Description: One or more of the specified parts could not be found.\n The part might not have been uploaded, or the specified ETag might not\n have matched the uploaded part's ETag.
\nHTTP Status Code: 400 Bad Request
\nError Code: InvalidPartOrder
\n
Description: The list of parts was not in ascending order. The\n parts list must be specified in order by part number.
\nHTTP Status Code: 400 Bad Request
\nError Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\nHTTP Status Code: 404 Not Found
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CompleteMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nName of the bucket to which the multipart upload was initiated.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Name of the bucket to which the multipart upload was initiated.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed
error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload
and re-upload each part.
Expects the '*' (asterisk) character.
\nFor more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Uploads the object only if the object key name does not already exist in the bucket\n specified. Otherwise, Amazon S3 returns a 412 Precondition Failed
error.
If a conflicting operation occurs during the upload S3 returns a 409\n ConditionalRequestConflict
response. On a 409 failure you should re-initiate the\n multipart upload with CreateMultipartUpload
and re-upload each part.
Expects the '*' (asterisk) character.
\nFor more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
", "smithy.api#httpHeader": "If-None-Match" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is\n required only when the object was created using a checksum algorithm or if\n your bucket policy requires the use of SSE-C. For more information, see Protecting data\n using SSE-C keys in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nThe server-side encryption (SSE) algorithm used to encrypt the object. This parameter is\n required only when the object was created using a checksum algorithm or if your bucket\n policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User\n Guide.
\nThis functionality is not supported for directory buckets.
\nPart number that identifies the part. This is a positive integer between 1 and\n 10,000.
\n\n General purpose buckets - In CompleteMultipartUpload
, when a additional checksum (including x-amz-checksum-crc32
, x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or \n x-amz-checksum-sha256
) is applied to each part, the PartNumber
must start at 1 and \n the part numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad Request
status code and an InvalidPartOrder
error code.
\n Directory buckets - In CompleteMultipartUpload
, the PartNumber
must start at 1 and \n the part numbers must be consecutive.
Part number that identifies the part. This is a positive integer between 1 and\n 10,000.
\n\n General purpose buckets - In\n CompleteMultipartUpload
, when a additional checksum (including\n x-amz-checksum-crc32
, x-amz-checksum-crc32c
,\n x-amz-checksum-sha1
, or x-amz-checksum-sha256
) is\n applied to each part, the PartNumber
must start at 1 and the part\n numbers must be consecutive. Otherwise, Amazon S3 generates an HTTP 400 Bad\n Request
status code and an InvalidPartOrder
error\n code.
\n Directory buckets - In\n CompleteMultipartUpload
, the PartNumber
must start at\n 1 and the part numbers must be consecutive.
Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.
\nYou can copy individual objects between general purpose buckets, between directory buckets, and \n between general purpose buckets and directory buckets.
\nAmazon S3 supports copy operations using Multi-Region Access Points only as a destination when using the Multi-Region Access Point ARN.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n 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.
\nBoth the\n Region that you want to copy the object from and the Region that you want to copy the\n object to must be enabled for your account. For more information about how to enable a Region for your account, see Enable \n or disable a Region for standalone accounts in the\n Amazon Web Services Account Management Guide.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request
error. For more information, see Transfer\n Acceleration.
All CopyObject
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed. For more information, see REST Authentication.
\n Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject
API operation, instead of using the \n temporary security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
\nYou must have\n read access to the source object and write\n access to the destination bucket.
\n\n General purpose bucket permissions -\n You must have permissions in an IAM policy based on the source and destination\n bucket types in a CopyObject
operation.
If the source object is in a general purpose bucket, you must have\n \n s3:GetObject
\n \n permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have\n \n s3:PutObject
\n \n permission to write the object copy to the destination bucket.
\n Directory bucket permissions -\n You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination\n bucket types in a CopyObject
operation.
If the source object that you want to copy is in a\n directory bucket, you must have the \n s3express:CreateSession
\n permission in\n the Action
element of a policy to read the object. By default, the session is in the ReadWrite
mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode
condition key to ReadOnly
on the copy source bucket.
If the copy destination is a directory bucket, you must have the \n s3express:CreateSession
\n permission in the\n Action
element of a policy to write the object\n to the destination. The s3express:SessionMode
condition\n key can't be set to ReadOnly
on the copy destination bucket.
If the object is encrypted with\n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the\n Amazon S3 User Guide.
\nWhen the request is an HTTP 1.1 request, the response is chunk encoded. When\n the request is not an HTTP 1.1 request, the response would not contain the\n Content-Length
. You always need to read the entire response body\n to check if the copy succeeds.
If the copy is successful, you receive a response with information about the copied\n object.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n 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\n standard Amazon S3 error.
\nIf the error occurs during the copy operation, the error response is\n embedded in the 200 OK
response. For example, in a cross-region copy, you \n may encounter throttling and receive a 200 OK
response. \n For more information, see Resolve \n the Error 200 response when copying objects to Amazon S3. \n The 200 OK
status code means the copy was accepted, but \n it doesn't mean the copy is complete. Another example is \n when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK
response. \n You must stay connected to Amazon S3 until the entire response is successfully received and processed.
If you call this API operation directly, make\n sure to design your application to parse the content of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the\n embedded error and apply error handling per your configuration settings (including\n automatically retrying the request as appropriate). If the condition persists, the SDKs\n throw an exception (or, for the SDKs that don't use exceptions, they return an \n error).
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. The request can also result in a data retrieval charge for the\n 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\n Amazon S3 pricing.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CopyObject
:
Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.
\nYou can copy individual objects between general purpose buckets, between directory buckets,\n and between general purpose buckets and directory buckets.
\nAmazon S3 supports copy operations using Multi-Region Access Points only as a\n destination when using the Multi-Region Access Point ARN.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
VPC endpoints don't support cross-Region requests (including copies). If you're\n using VPC endpoints, your source and destination buckets should be in the same\n Amazon Web Services Region as your VPC endpoint.
\nBoth the Region that you want to copy the object from and the Region that you want to\n copy the object to must be enabled for your account. For more information about how to\n enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services\n Account Management Guide.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request
error. For more information, see Transfer\n Acceleration.
All CopyObject
requests must be authenticated and signed by using\n IAM credentials (access key ID and secret access key for the IAM identities).\n All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed. For more information, see\n REST Authentication.
\n Directory buckets - You must use the\n IAM credentials to authenticate and authorize your access to the\n CopyObject
API operation, instead of using the temporary security\n credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your\n behalf.
\nYou must have read access to the source object and\n write access to the destination bucket.
\n\n General purpose bucket permissions - You\n must have permissions in an IAM policy based on the source and destination\n bucket types in a CopyObject
operation.
If the source object is in a general purpose bucket, you must have\n \n s3:GetObject
\n \n permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have\n \n s3:PutObject
\n \n permission to write the object copy to the destination bucket.
\n Directory bucket permissions -\n You must have permissions in a bucket policy or an IAM identity-based policy based on the\n source and destination bucket types in a CopyObject
\n operation.
If the source object that you want to copy is in a\n directory bucket, you must have the \n s3express:CreateSession
\n permission in\n the Action
element of a policy to read the object. By\n default, the session is in the ReadWrite
mode. If you\n want to restrict the access, you can explicitly set the\n s3express:SessionMode
condition key to\n ReadOnly
on the copy source bucket.
If the copy destination is a directory bucket, you must have the\n \n s3express:CreateSession
\n permission in the\n Action
element of a policy to write the object to the\n destination. The s3express:SessionMode
condition key\n can't be set to ReadOnly
on the copy destination bucket.\n
If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n 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\n S3 Express One Zone in the Amazon S3 User Guide.
\nWhen the request is an HTTP 1.1 request, the response is chunk encoded. When\n the request is not an HTTP 1.1 request, the response would not contain the\n Content-Length
. You always need to read the entire response body\n to check if the copy succeeds.
If the copy is successful, you receive a response with information about\n the copied object.
\nA copy request might return an error when Amazon S3 receives the copy request\n or while Amazon S3 is copying the files. A 200 OK
response can\n contain either a success or an error.
If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error.
\nIf the error occurs during the copy operation, the error response\n is embedded in the 200 OK
response. For example, in a\n cross-region copy, you may encounter throttling and receive a\n 200 OK
response. For more information, see Resolve the Error 200 response when copying objects to\n Amazon S3. The 200 OK
status code means the copy\n was accepted, but it doesn't mean the copy is complete. Another\n example is when you disconnect from Amazon S3 before the copy is complete,\n Amazon S3 might cancel the copy and you may receive a 200 OK
\n response. You must stay connected to Amazon S3 until the entire response is\n successfully received and processed.
If you call this API operation directly, make sure to design your\n application to parse the content of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The\n SDKs detect the embedded error and apply error handling per your\n configuration settings (including automatically retrying the request\n as appropriate). If the condition persists, the SDKs throw an\n exception (or, for the SDKs that don't use exceptions, they return an\n error).
\nThe copy request charge is based on the storage class and Region that you\n specify for the destination object. The request can also result in a data\n retrieval charge for the source if the source storage class bills for data\n retrieval. If the copy source is in a different region, the data transfer is\n billed to the copy source account. For pricing information, see Amazon S3 pricing.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CopyObject
:
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
, aws:kms:dsse
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256
, aws:kms
, aws:kms:dsse
).
If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nThe canned access control list (ACL) to apply to the object.
\nWhen you copy an object, the ACL metadata is not preserved and is set\n to private
by default. Only the owner has full access\n control. To override the default ACL setting,\n specify a new ACL when you generate a copy request. For more information, see Using\n ACLs.
If the destination bucket that you're copying objects to uses the bucket owner enforced\n setting for S3 Object Ownership, ACLs are disabled and no longer affect\n permissions. Buckets that use this setting only accept PUT
requests\n that don't specify an ACL or PUT
requests that specify bucket owner\n full control ACLs, such as the bucket-owner-full-control
canned ACL\n or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling\n ownership of objects and disabling ACLs in the\n Amazon S3 User Guide.
If your destination bucket uses the bucket owner enforced setting for Object Ownership,\n all objects written to the bucket by any account will be owned by the bucket\n owner.
\nThis functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe canned access control list (ACL) to apply to the object.
\nWhen you copy an object, the ACL metadata is not preserved and is set to\n private
by default. Only the owner has full access control. To override the\n default ACL setting, specify a new ACL when you generate a copy request. For more\n information, see Using ACLs.
If the destination bucket that you're copying objects to uses the bucket owner enforced\n setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions.\n Buckets that use this setting only accept PUT
requests that don't specify an\n ACL or PUT
requests that specify bucket owner full control ACLs, such as the\n bucket-owner-full-control
canned ACL or an equivalent form of this ACL\n expressed in the XML format. For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
If your destination bucket uses the bucket owner enforced setting for Object\n Ownership, all objects written to the bucket by any account will be owned by the\n bucket owner.
\nThis functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe name of the destination bucket.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the destination bucket.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see\n Checking object integrity in\n the Amazon S3 User Guide.
\nWhen you copy an object, if the source object has a checksum, that checksum value will be copied to\n the new object by default. If the CopyObject
request does not include this x-amz-checksum-algorithm
header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally\n specify a different checksum algorithm to use with the\n x-amz-checksum-algorithm
header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see\n Checking object integrity in\n the Amazon S3 User Guide.
\nWhen you copy an object, if the source object has a checksum, that checksum value will\n be copied to the new object by default. If the CopyObject
request does not\n include this x-amz-checksum-algorithm
header, the checksum algorithm will be\n copied from the source object to the destination object (if it's present on the source\n object). You can optionally specify a different checksum algorithm to use with the\n x-amz-checksum-algorithm
header. Unrecognized or unsupported values will\n respond with the HTTP status code 400 Bad Request
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
", + "smithy.api#documentation": "Specifies presentational information for the object. Indicates whether an object should\n be displayed in a web browser or downloaded as a file. It allows specifying the desired\n filename for the downloaded file.
", "smithy.api#httpHeader": "Content-Disposition" } }, @@ -18877,7 +18884,7 @@ "CopySource": { "target": "com.amazonaws.s3#CopySource", "traits": { - "smithy.api#documentation": "Specifies the source object for the copy operation. The source object \n 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.
\nYou specify the value of the copy source in one of two\n formats, depending on whether you want to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket\n and the key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf
from the general purpose bucket \n awsexamplebucket
, use awsexamplebucket/reports/january.pdf
.\n The value must be URL-encoded. To copy the\n object reports/january.pdf
from the directory bucket \n awsexamplebucket--use1-az5--x-s3
, use awsexamplebucket--use1-az5--x-s3/reports/january.pdf
.\n 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:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
\nAccess points are not supported by directory buckets.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your source bucket versioning is enabled, the x-amz-copy-source
header by default identifies the current\n version of an object to copy. If the current version is a delete marker, Amazon S3\n behaves as if the object was deleted. To copy a different version, use the\n versionId
query parameter. Specifically, append ?versionId=
\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version\n ID for the copied object. This version ID is different from the version ID\n of the source object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the destination bucket, the version\n ID that Amazon S3 generates in the\n x-amz-version-id
response header is always null.
\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
\nSpecifies the source object for the copy operation. The source object can be up to 5 GB.\n If the source object is an object that was uploaded by using a multipart upload, the object\n copy will be a single part object after the source object is copied to the destination\n bucket.
\nYou specify the value of the copy source in one of two formats, depending on whether you\n want to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket\n and the key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf
from the general purpose bucket\n awsexamplebucket
, use\n awsexamplebucket/reports/january.pdf
. The value must be URL-encoded.\n To copy the object reports/january.pdf
from the directory bucket\n awsexamplebucket--use1-az5--x-s3
, use\n awsexamplebucket--use1-az5--x-s3/reports/january.pdf
. The value must\n 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:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
\nAccess points are not supported by directory buckets.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your source bucket versioning is enabled, the x-amz-copy-source
header\n by default identifies the current version of an object to copy. If the current version is a\n delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use\n the versionId
query parameter. Specifically, append\n ?versionId=
to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID\n for the copied object. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n 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\n that Amazon S3 generates in the x-amz-version-id
response header is always\n null.
\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets.
\nCopies the object if its entity tag (ETag) matches the specified tag.
\n If both the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n request and evaluate as follows, Amazon S3 returns 200 OK
and copies the\n data:
\n x-amz-copy-source-if-match
condition evaluates to\n true
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
Copies the object if its entity tag (ETag) matches the specified tag.
\n If both the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK
and copies the data:
\n x-amz-copy-source-if-match
condition evaluates to true
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
Copies the object if it has been modified since the specified time.
\nIf both the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the\n request and evaluate as follows, Amazon S3 returns the 412 Precondition\n Failed
response code:
\n x-amz-copy-source-if-none-match
condition evaluates to\n false
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
Copies the object if it has been modified since the specified time.
\nIf both the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response\n code:
\n x-amz-copy-source-if-none-match
condition evaluates to false
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
Copies the object if its entity tag (ETag) is different than the specified ETag.
\nIf both the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the\n request and evaluate as follows, Amazon S3 returns the 412 Precondition\n Failed
response code:
\n x-amz-copy-source-if-none-match
condition evaluates to\n false
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
Copies the object if its entity tag (ETag) is different than the specified ETag.
\nIf both the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response\n code:
\n x-amz-copy-source-if-none-match
condition evaluates to false
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
Copies the object if it hasn't been modified since the specified time.
\n If both the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n request and evaluate as follows, Amazon S3 returns 200 OK
and copies the\n data:
\n x-amz-copy-source-if-match
condition evaluates to\n true
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
Copies the object if it hasn't been modified since the specified time.
\n If both the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK
and copies the data:
\n x-amz-copy-source-if-match
condition evaluates to true
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
Specifies whether the metadata is copied from the source object or replaced with\n metadata that's provided in the request. \n When copying an object, you can preserve all metadata (the default) or specify\n new metadata. If this header isn’t specified, COPY
is the default behavior. \n
\n General purpose bucket - For general purpose buckets, when you grant permissions, you\n can use the s3:x-amz-metadata-directive
condition key to enforce\n certain metadata behavior when objects are uploaded. For more information, see\n Amazon S3 condition key examples in the Amazon S3 User Guide.
\n x-amz-website-redirect-location
is unique to each object and is not copied when using the\n x-amz-metadata-directive
header. To copy the value, you \n must specify x-amz-website-redirect-location
in the request header.
Specifies whether the metadata is copied from the source object or replaced with\n metadata that's provided in the request. When copying an object, you can preserve all\n metadata (the default) or specify new metadata. If this header isn’t specified,\n COPY
is the default behavior.
\n General purpose bucket - For general purpose buckets, when you\n grant permissions, you can use the s3:x-amz-metadata-directive
condition key\n to enforce certain metadata behavior when objects are uploaded. For more information, see\n Amazon S3\n condition key examples in the Amazon S3 User Guide.
\n x-amz-website-redirect-location
is unique to each object and is not\n copied when using the x-amz-metadata-directive
header. To copy the value,\n you must specify x-amz-website-redirect-location
in the request\n header.
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.\n When copying an object, if you don't specify encryption information in your copy\n request, the encryption setting of the target object is set to the default\n encryption configuration of the destination bucket. By default, all buckets have a\n base level of encryption configuration that uses server-side encryption with Amazon S3\n managed keys (SSE-S3). If the destination bucket has a different default encryption\n configuration, Amazon S3 uses\n the corresponding encryption key to encrypt the target\n object copy.
\nWith server-side\n encryption, Amazon S3 encrypts your data as it writes your data to disks in its data\n centers and decrypts the data when you access it. For more information about server-side encryption, see Using\n Server-Side Encryption in the\n Amazon S3 User Guide.
\n\n General purpose buckets \n
\nFor general purpose buckets, there are the following supported options for server-side encryption: server-side encryption with Key Management Service (KMS) keys\n (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and \n server-side encryption with customer-provided encryption keys (SSE-C). Amazon S3 uses\n the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.
\nWhen you perform a CopyObject
operation, if you want to use a\n different type of encryption setting for the target object, you can specify \n appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a\n KMS key, or a customer-provided key. If the encryption setting in\n your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence.
\n Directory buckets \n
\nFor directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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). \n 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. \n Then, when you perform a CopyObject
operation and want to specify server-side encryption settings for new object copies with SSE-KMS in the encryption-related request headers, you must ensure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration. \n
The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized\n or unsupported values won’t write a destination object and will receive a 400 Bad\n Request
response.
Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When\n copying an object, if you don't specify encryption information in your copy request, the\n encryption setting of the target object is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a different default encryption configuration, Amazon S3 uses the\n corresponding encryption key to encrypt the target object copy.
\nWith server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in\n its data centers and decrypts the data when you access it. For more information about\n server-side encryption, see Using Server-Side Encryption\n in the Amazon S3 User Guide.
\n\n General purpose buckets \n
\nFor general purpose buckets, there are the following supported options for server-side\n encryption: server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), and server-side encryption\n with customer-provided encryption keys (SSE-C). Amazon S3 uses the corresponding\n KMS key, or a customer-provided key to encrypt the target object copy.
\nWhen you perform a CopyObject
operation, if you want to use a\n different type of encryption setting for the target object, you can specify\n appropriate encryption-related headers to encrypt the target object with an Amazon S3\n managed key, a KMS key, or a customer-provided key. If the encryption setting in\n your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence.
\n Directory buckets \n
\nFor directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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\n specify SSE-KMS as the directory bucket's default encryption configuration with\n a KMS key (specifically, a customer managed key).\n The Amazon Web Services managed key (aws/s3
) isn't supported. Your SSE-KMS\n configuration can only support 1 customer managed key per\n directory bucket for the lifetime of the bucket. After you specify a customer managed key for\n SSE-KMS, you can't override the customer managed key for the bucket's SSE-KMS\n configuration. Then, when you perform a CopyObject
operation and want to\n specify server-side encryption settings for new object copies with SSE-KMS in the\n encryption-related request headers, you must ensure the encryption key is the same\n customer managed key that you specified for the directory bucket's default encryption\n configuration.\n
If the x-amz-storage-class
header is not used, the copied object will be stored in the\n STANDARD
Storage Class by default. The STANDARD
storage class provides high durability and\n high availability. Depending on performance needs, you can specify a different Storage\n Class.\n
\n Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request
.
\n 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\n an object that is already stored in Amazon S3 by using the x-amz-storage-class
\n header. For more information, see Storage Classes in\n 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:
\nThe storage class of the source object is GLACIER
or\n DEEP_ARCHIVE
.
The storage class of the source object is\n INTELLIGENT_TIERING
and it's S3 Intelligent-Tiering access tier is\n Archive Access
or Deep Archive Access
.
For more\n information, see RestoreObject and Copying\n Objects in\n the Amazon S3 User Guide.
", + "smithy.api#documentation": "If the x-amz-storage-class
header is not used, the copied object will be\n stored in the STANDARD
Storage Class by default. The STANDARD
\n storage class provides high durability and high availability. Depending on performance\n needs, you can specify a different Storage Class.
\n Directory buckets -\n For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request
.
\n Amazon S3 on Outposts - S3 on Outposts only\n uses the OUTPOSTS
Storage Class.
You can use the CopyObject
action to change the storage class of an object\n that is already stored in Amazon S3 by using the x-amz-storage-class
header. For\n more information, see Storage Classes in the\n Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a\n copy of it if it meets any of the following conditions:
\nThe storage class of the source object is GLACIER
or\n DEEP_ARCHIVE
.
The storage class of the source object is INTELLIGENT_TIERING
and\n it's S3 Intelligent-Tiering access tier is Archive Access
or\n Deep Archive Access
.
For more information, see RestoreObject and Copying\n Objects in the Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-storage-class" } }, "WebsiteRedirectLocation": { "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "If the destination bucket is configured as a website, redirects requests for this object copy to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. This value is unique to each object and is not copied when using the\n x-amz-metadata-directive
header. Instead, you may opt to provide this\n header in combination with the x-amz-metadata-directive
header.
This functionality is not supported for directory buckets.
\nIf the destination bucket is configured as a website, redirects requests for this object\n copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of\n this header in the object metadata. This value is unique to each object and is not copied\n when using the x-amz-metadata-directive
header. Instead, you may opt to\n provide this header in combination with the x-amz-metadata-directive
\n header.
This functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when encrypting the object (for example,\n AES256
).
When you perform a CopyObject
operation, if you want to use a\n different type of encryption setting for the target object, you can specify \n appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a\n KMS key, or a customer-provided key. If the encryption setting in\n your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence.
This functionality is not supported when the destination bucket is a directory bucket.
\nSpecifies the algorithm to use when encrypting the object (for example,\n AES256
).
When you perform a CopyObject
operation, if you want to use a different\n type of encryption setting for the target object, you can specify appropriate\n encryption-related headers to encrypt the target object with an Amazon S3 managed key, a\n KMS key, or a customer-provided key. If the encryption setting in your request is\n different from the default encryption configuration of the destination bucket, the\n encryption setting in your request takes precedence.
This functionality is not supported when the destination bucket is a directory bucket.
\nSpecifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an\n object protected by KMS will fail if they're not made via SSL or using SigV4. For\n information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see\n Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.
\n\n Directory buckets - If you specify x-amz-server-side-encryption
with aws:kms
, the \n x-amz-server-side-encryption-aws-kms-key-id
header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-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 \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request
error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3
) isn't supported. \n
Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.\n All GET and PUT requests for an object protected by KMS will fail if they're not made via\n SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services\n SDKs and Amazon Web Services CLI, see Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.
\n\n Directory buckets -\n If you specify x-amz-server-side-encryption
with aws:kms
, the \n x-amz-server-side-encryption-aws-kms-key-id
header is implicitly assigned the ID of the KMS \n symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. \n If you want to specify the \n x-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 \n customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request
error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3
) isn't supported. \n
Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of\n this header is a base64-encoded UTF-8 string holding JSON with the encryption context\n key-value pairs.
\n\n General purpose buckets - This value must be explicitly added to specify encryption context for \n 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.
\n 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.
", + "smithy.api#documentation": "Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use\n for the destination object encryption. The value of this header is a base64-encoded UTF-8\n string holding JSON with the encryption context key-value pairs.
\n\n General purpose buckets - This value must be explicitly\n added to specify encryption context for CopyObject
requests if you want an\n additional encryption context for your destination object. The additional encryption\n context of the source object won't be copied to the destination object. For more\n information, see Encryption\n context in the Amazon S3 User Guide.
\n 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.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, "BucketKeyEnabled": { "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n 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\n object.
\nSetting this header to\n true
causes Amazon S3 to use an S3 Bucket Key for object encryption with\n SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3\n Bucket Key.
For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\n\n Directory buckets - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto 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.
\nSpecifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses\n SSE-KMS, you can enable an S3 Bucket Key for the object.
\nSetting this header to true
causes Amazon S3 to use an S3 Bucket Key for object\n encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect\n bucket-level settings for S3 Bucket Key.
For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\n\n Directory buckets -\n S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto 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.
\nSpecifies the algorithm to use when decrypting the source object (for example,\n AES256
).
If\n the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the\n object for copying.
\nThis functionality is not supported when the source object is in a directory bucket.
\nSpecifies the algorithm to use when decrypting the source object (for example,\n AES256
).
If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the object for\n copying.
\nThis functionality is not supported when the source object is in a directory bucket.
\nSpecifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be the same one that was used when the\n source object was created.
\nIf\n the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the\n object for copying.
\nThis functionality is not supported when the source object is in a directory bucket.
\nSpecifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be the same one that was used when\n the source object was created.
\nIf the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the object for\n copying.
\nThis functionality is not supported when the source object is in a directory bucket.
\nSpecifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
\nIf\n the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the\n object for copying.
\nThis functionality is not supported when the source object is in a directory bucket.
\nSpecifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
\nIf the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the\n necessary encryption information in your request so that Amazon S3 can decrypt the object for\n copying.
\nThis functionality is not supported when the source object is in a directory bucket.
\nThe tag-set for the object copy in the destination bucket. This value must be used in conjunction\n with the x-amz-tagging-directive
if you choose REPLACE
for the x-amz-tagging-directive
. If you choose COPY
for the x-amz-tagging-directive
, you don't need to set \n the x-amz-tagging
header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query\n parameters.
The default value is the empty value.
\n\n Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. \nWhen the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
When you attempt to COPY
the tag-set from an S3 source object that has non-empty tags.
When you attempt to REPLACE
the tag-set of a source object and set a non-empty value to x-amz-tagging
.
When you don't set the x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive
is COPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
When you attempt to COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.
When you attempt to REPLACE
the tag-set of a directory bucket source object and set the x-amz-tagging
value of the directory bucket destination object to empty.
When you attempt to REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging
value of the directory bucket destination object to empty.
When you attempt to REPLACE
the tag-set of a directory bucket source object and don't set the x-amz-tagging
value of the directory bucket destination object. This is because the default value of x-amz-tagging
is the empty value.
The tag-set for the object copy in the destination bucket. This value must be used in\n conjunction with the x-amz-tagging-directive
if you choose\n REPLACE
for the x-amz-tagging-directive
. If you choose\n COPY
for the x-amz-tagging-directive
, you don't need to set\n the x-amz-tagging
header, because the tag-set will be copied from the source\n object directly. The tag-set must be encoded as URL Query parameters.
The default value is the empty value.
\n\n Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. \nWhen the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
When you attempt to COPY
the tag-set from an S3 source object that has non-empty tags.
When you attempt to REPLACE
the tag-set of a source object and set a non-empty value to x-amz-tagging
.
When you don't set the x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value of x-amz-tagging-directive
is COPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
When you attempt to COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object.
When you attempt to REPLACE
the tag-set of a directory bucket source object and set the x-amz-tagging
value of the directory bucket destination object to empty.
When you attempt to REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set the x-amz-tagging
value of the directory bucket destination object to empty.
When you attempt to REPLACE
the tag-set of a directory bucket source object and don't set the x-amz-tagging
value of the directory bucket destination object. This is because the default value of x-amz-tagging
is the empty value.
This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see \n CreateBucket
\n .
Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nThere are two types of buckets: general purpose buckets and directory buckets. For more\n information about these bucket types, see Creating, configuring, and\n working with Amazon S3 buckets in the Amazon S3 User Guide.
\n\n General purpose buckets - If you send your CreateBucket
request to the s3.amazonaws.com
global endpoint,\n the request goes to the us-east-1
Region. So the signature\n calculations in Signature Version 4 must use us-east-1
as the Region, even\n if the location constraint in the request specifies another Region where the bucket is\n to be created. If you create a bucket in a Region other than US East (N. Virginia), your\n application must be able to handle 307 redirect. For more information, see Virtual hosting of\n buckets in the Amazon S3 User Guide.
\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - In addition to the s3:CreateBucket
permission, the following permissions are\n required in a policy when your CreateBucket
request includes specific\n headers:
\n Access control lists (ACLs) - In your CreateBucket
request, if you specify an access control list (ACL) \n and set it to public-read
, public-read-write
,\n authenticated-read
, or if you explicitly specify any other custom ACLs, both s3:CreateBucket
and\n s3:PutBucketAcl
permissions are required. In your CreateBucket
request, if you set the ACL to private
, \n or if you don't specify any ACLs, only the s3:CreateBucket
permission is required.\n
\n Object Lock - In your\n CreateBucket
request, if you set \n x-amz-bucket-object-lock-enabled
to true, the \n s3:PutBucketObjectLockConfiguration
and\n s3:PutBucketVersioning
permissions are required.
\n S3 Object Ownership - If your\n CreateBucket
request includes the\n x-amz-object-ownership
header, then the\n s3:PutBucketOwnershipControls
permission is required.
To set an ACL on a bucket as part of a\n CreateBucket
request, you must explicitly set S3\n Object Ownership for the bucket to a different value than the\n default, BucketOwnerEnforced
. Additionally, if your\n desired bucket ACL grants public access, you must first create the\n bucket (without the bucket ACL) and then explicitly disable Block\n Public Access on the bucket before using PutBucketAcl
\n to set the ACL. If you try to create a bucket with a public ACL,\n the request will fail.
For the majority of modern use cases in S3, we recommend\n that you keep all Block Public Access settings enabled and keep\n ACLs disabled. If you would like to share data with users outside\n of your account, you can use bucket policies as needed. For more\n information, see Controlling ownership of objects and disabling ACLs for your\n bucket and Blocking public access to your Amazon S3 storage in\n the Amazon S3 User Guide.
\n\n S3 Block Public Access - If your\n specific use case requires granting public access to your S3 resources, you\n can disable Block Public Access. Specifically, you can create a new bucket with Block\n Public Access enabled, then separately call the \n DeletePublicAccessBlock
\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock
permission. For more information about S3 Block Public\n Access, see Blocking\n public access to your Amazon S3 storage in the\n Amazon S3 User Guide.
\n 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. \n For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 \n Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.\n
\nFor more information about permissions for creating and working with \n directory buckets, see Directory buckets in the Amazon S3 User Guide. \n For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to CreateBucket
:
\n PutObject\n
\n\n DeleteBucket\n
\nThis action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see \n CreateBucket
\n .
Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services\n Access Key ID to authenticate requests. Anonymous requests are never allowed to create\n buckets. By creating the bucket, you become the bucket owner.
\nThere are two types of buckets: general purpose buckets and directory buckets. For more\n information about these bucket types, see Creating, configuring, and\n working with Amazon S3 buckets in the Amazon S3 User Guide.
\n\n General purpose buckets - If you send your\n CreateBucket
request to the s3.amazonaws.com
global\n endpoint, the request goes to the us-east-1
Region. So the signature\n calculations in Signature Version 4 must use us-east-1
as the Region,\n even if the location constraint in the request specifies another Region where the\n bucket is to be created. If you create a bucket in a Region other than US East (N.\n Virginia), your application must be able to handle 307 redirect. For more\n information, see Virtual hosting of\n buckets in the Amazon S3 User Guide.
\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - In\n addition to the s3:CreateBucket
permission, the following\n permissions are required in a policy when your CreateBucket
\n request includes specific headers:
\n Access control lists (ACLs)\n - In your CreateBucket
request, if you specify an\n access control list (ACL) and set it to public-read
,\n public-read-write
, authenticated-read
, or\n if you explicitly specify any other custom ACLs, both\n s3:CreateBucket
and s3:PutBucketAcl
\n permissions are required. In your CreateBucket
request,\n if you set the ACL to private
, or if you don't specify\n any ACLs, only the s3:CreateBucket
permission is\n required.
\n Object Lock - In your\n CreateBucket
request, if you set\n x-amz-bucket-object-lock-enabled
to true, the\n s3:PutBucketObjectLockConfiguration
and\n s3:PutBucketVersioning
permissions are\n required.
\n S3 Object Ownership - If\n your CreateBucket
request includes the\n x-amz-object-ownership
header, then the\n s3:PutBucketOwnershipControls
permission is\n required.
To set an ACL on a bucket as part of a\n CreateBucket
request, you must explicitly set S3\n Object Ownership for the bucket to a different value than the\n default, BucketOwnerEnforced
. Additionally, if your\n desired bucket ACL grants public access, you must first create the\n bucket (without the bucket ACL) and then explicitly disable Block\n Public Access on the bucket before using PutBucketAcl
\n to set the ACL. If you try to create a bucket with a public ACL,\n the request will fail.
For the majority of modern use cases in S3, we recommend that\n you keep all Block Public Access settings enabled and keep ACLs\n disabled. If you would like to share data with users outside of\n your account, you can use bucket policies as needed. For more\n information, see Controlling ownership of objects and disabling ACLs for your\n bucket and Blocking public access to your Amazon S3 storage in\n the Amazon S3 User Guide.
\n\n S3 Block Public Access - If\n your specific use case requires granting public access to your S3\n resources, you can disable Block Public Access. Specifically, you can\n create a new bucket with Block Public Access enabled, then separately\n call the \n DeletePublicAccessBlock
\n API. To use this operation, you must have the\n s3:PutBucketPublicAccessBlock
permission. For more\n information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n You must have the s3express:CreateBucket
permission in\n 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.\n 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\n Block Public Access are not supported for directory buckets. For\n directory buckets, all Block Public Access settings are enabled at the\n bucket level and S3 Object Ownership is set to Bucket owner enforced\n (ACLs disabled). These settings can't be modified.
\nFor more information about permissions for creating and working with\n directory buckets, see Directory buckets in the\n Amazon S3 User Guide. For more information about\n supported S3 features for directory buckets, see Features of S3 Express One Zone in the\n Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to CreateBucket
:
\n PutObject\n
\n\n DeleteBucket\n
\nSpecifies the Region where the bucket will be created. You might choose a Region to\n optimize latency, minimize costs, or address regulatory requirements. For example, if you\n reside in Europe, you will probably find it advantageous to create buckets in the Europe\n (Ireland) Region. For more information, see Accessing a\n bucket in the Amazon S3 User Guide.
\nIf you don't specify a Region,\n the bucket is created in the US East (N. Virginia) Region (us-east-1) by default.
\nThis functionality is not supported for directory buckets.
\nSpecifies the Region where the bucket will be created. You might choose a Region to\n optimize latency, minimize costs, or address regulatory requirements. For example, if you\n reside in Europe, you will probably find it advantageous to create buckets in the Europe\n (Ireland) Region. For more information, see Accessing a\n bucket in the Amazon S3 User Guide.
\nIf you don't specify a Region, the bucket is created in the US East (N. Virginia) Region\n (us-east-1) by default.
\nThis functionality is not supported for directory buckets.
\nThis action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
\nAfter you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stops charging you for\n storing them only after you either complete or abort a multipart upload.
\nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart \n upload must be completed within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle\n Configuration.
\n\n Directory buckets - S3 Lifecycle is not supported by directory buckets.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
For request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n 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.
\n\n General purpose bucket permissions - To\n perform a multipart upload with encryption using an Key Management Service (KMS)\n KMS key, the requester must have permission to the\n kms:Decrypt
and kms:GenerateDataKey
actions on\n the key. The requester must also have permissions for the\n kms:GenerateDataKey
action for the\n CreateMultipartUpload
API. Then, the requester needs\n permissions for the kms:Decrypt
action on the\n UploadPart
and UploadPartCopy
APIs. These\n permissions are required because Amazon S3 must decrypt and read data from the\n encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API and permissions and Protecting data\n using server-side encryption with Amazon Web Services KMS in the\n Amazon S3 User Guide.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose buckets - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it. Amazon S3\n automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a\n multipart upload, if you don't specify encryption information in your request, the\n encryption setting of the uploaded parts is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a default encryption configuration that uses server-side encryption\n with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),\n Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded\n parts. When you perform a CreateMultipartUpload operation, if you want to use a different\n type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the\n object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption\n setting in your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence. If you choose\n to provide your own encryption key, the request headers you provide in UploadPart\n 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\n (aws/s3
) and KMS customer managed keys stored in Key Management Service (KMS) –\n If you want Amazon Web Services to manage the keys used to encrypt data, specify the\n following headers in the request.
\n x-amz-server-side-encryption
\n
\n x-amz-server-side-encryption-aws-kms-key-id
\n
\n x-amz-server-side-encryption-context
\n
If you specify x-amz-server-side-encryption:aws:kms
, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id
,\n Amazon S3 uses the Amazon Web Services managed key (aws/s3
key) in KMS to\n protect the data.
To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester\n must have permission to the kms:Decrypt
and kms:GenerateDataKey*
\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n and permissions and Protecting data using\n server-side encryption with Amazon Web Services KMS in the\n 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,\n 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\n policy and your IAM user or role.
\nAll GET
and PUT
requests for an object\n protected by KMS fail if you don't make them by using Secure Sockets\n Layer (SSL), Transport Layer Security (TLS), or Signature Version\n 4. For information about configuring any of the officially supported Amazon Web Services\n SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.
For more information about server-side encryption with KMS keys\n (SSE-KMS), see Protecting Data\n Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.
\nUse customer-provided encryption keys (SSE-C) – If you want to manage\n your own encryption keys, provide all the following headers in the\n request.
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about server-side encryption with customer-provided\n encryption keys (SSE-C), see \n Protecting data using server-side encryption with customer-provided\n encryption keys (SSE-C) in the Amazon S3 User Guide.
\n\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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. \n You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n
For directory buckets, when you perform a CreateMultipartUpload
operation and an UploadPartCopy
operation, \n the request headers you provide in the CreateMultipartUpload
request must match the default encryption configuration of the destination bucket.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CreateMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThis action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload request.\n For more information about multipart uploads, see Multipart Upload Overview in the\n Amazon S3 User Guide.
\nAfter you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stops charging you for\n storing them only after you either complete or abort a multipart upload.
\nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the\n created multipart upload must be completed within the number of days specified in the\n bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible\n for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle\n Configuration.
\n\n Directory buckets -\n S3 Lifecycle is not supported by directory buckets.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
For request signing, multipart upload is just a series of regular requests. You\n initiate a multipart upload, send one or more requests to upload parts, and then\n complete the multipart upload process. You sign each request individually. There\n is nothing special about signing multipart upload requests. For more information\n about signing, see Authenticating\n Requests (Amazon Web Services Signature Version 4) in the\n Amazon S3 User Guide.
\n\n General purpose bucket permissions - To\n perform a multipart upload with encryption using an Key Management Service (KMS)\n KMS key, the requester must have permission to the\n kms:Decrypt
and kms:GenerateDataKey
actions on\n the key. The requester must also have permissions for the\n kms:GenerateDataKey
action for the\n CreateMultipartUpload
API. Then, the requester needs\n permissions for the kms:Decrypt
action on the\n UploadPart
and UploadPartCopy
APIs. These\n permissions are required because Amazon S3 must decrypt and read data from the\n encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API and permissions and Protecting data\n using server-side encryption with Amazon Web Services KMS in the\n Amazon S3 User Guide.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose buckets - Server-side\n encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it.\n Amazon S3 automatically encrypts all new objects that are uploaded to an S3\n bucket. When doing a multipart upload, if you don't specify encryption\n information in your request, the encryption setting of the uploaded parts is\n set to the default encryption configuration of the destination bucket. By\n default, all buckets have a base level of encryption configuration that uses\n server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination\n bucket has a default encryption configuration that uses server-side\n encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided\n encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a\n customer-provided key to encrypt the uploaded parts. When you perform a\n CreateMultipartUpload operation, if you want to use a different type of\n encryption setting for the uploaded parts, you can request that Amazon S3\n encrypts the object with a different encryption key (such as an Amazon S3 managed\n key, a KMS key, or a customer-provided key). When the encryption setting\n in your request is different from the default encryption configuration of\n the destination bucket, the encryption setting in your request takes\n precedence. If you choose to provide your own encryption key, the request\n headers you provide in UploadPart and\n UploadPartCopy\n requests must match the headers you used in the\n CreateMultipartUpload
request.
Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key\n (aws/s3
) and KMS customer managed keys stored in Key Management Service\n (KMS) – If you want Amazon Web Services to manage the keys used to encrypt data,\n specify the following headers in the request.
\n x-amz-server-side-encryption
\n
\n x-amz-server-side-encryption-aws-kms-key-id
\n
\n x-amz-server-side-encryption-context
\n
If you specify\n x-amz-server-side-encryption:aws:kms
, but\n don't provide\n x-amz-server-side-encryption-aws-kms-key-id
,\n Amazon S3 uses the Amazon Web Services managed key (aws/s3
key) in\n KMS to protect the data.
To perform a multipart upload with encryption by using an\n Amazon Web Services KMS key, the requester must have permission to the\n kms:Decrypt
and\n kms:GenerateDataKey*
actions on the key.\n These permissions are required because Amazon S3 must decrypt and\n read data from the encrypted file parts before it completes\n the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services\n KMS in the\n Amazon S3 User Guide.
If your Identity and Access Management (IAM) user or role is in the same\n Amazon Web Services account as the KMS key, then you must have these\n permissions on the key policy. If your IAM user or role is\n in a different account from the key, then you must have the\n permissions on both the key policy and your IAM user or\n role.
\nAll GET
and PUT
requests for an\n object protected by KMS fail if you don't make them by\n using Secure Sockets Layer (SSL), Transport Layer Security\n (TLS), or Signature Version 4. For information about\n configuring any of the officially supported Amazon Web Services SDKs and\n Amazon Web Services CLI, see Specifying the Signature Version in\n Request Authentication in the\n Amazon S3 User Guide.
For more information about server-side encryption with KMS keys\n (SSE-KMS), see Protecting\n Data Using Server-Side Encryption with KMS keys in the\n Amazon S3 User Guide.
\nUse customer-provided encryption keys (SSE-C) – If you want to\n manage your own encryption keys, provide all the following headers in\n the request.
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about server-side encryption with\n customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with\n customer-provided encryption keys (SSE-C) in the\n Amazon S3 User Guide.
\n\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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. \n You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n
For directory buckets, when you perform a\n CreateMultipartUpload
operation and an\n UploadPartCopy
operation, the request headers you provide\n in the CreateMultipartUpload
request must match the default\n encryption configuration of the destination bucket.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CreateMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nIf the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle\n Configuration in the Amazon S3 User Guide.
\nThe response also includes the x-amz-abort-rule-id
header that provides the\n ID of the lifecycle configuration rule that defines the abort action.
This functionality is not supported for directory buckets.
\nIf the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in\n the Amazon S3 User Guide.
\nThe response also includes the x-amz-abort-rule-id
header that provides the\n ID of the lifecycle configuration rule that defines the abort action.
This functionality is not supported for directory buckets.
\nThe server-side encryption algorithm used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256
, aws:kms
).
If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nThe canned ACL to apply to the object. Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL in the Amazon S3 User Guide.
\nBy default, all objects are private. Only the owner has full access\n control. When uploading an object, you can grant access permissions to individual\n Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then\n added to the access control list (ACL) on the new object. For more information, see\n Using ACLs. One way to\n 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.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as\n canned ACLs. Each canned ACL has a predefined set of grantees and\n permissions. For more information, see Canned ACL in the\n Amazon S3 User Guide.
\nBy default, all objects are private. Only the owner has full access control. When\n uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to\n predefined groups defined by Amazon S3. These permissions are then added to the access control\n list (ACL) on the new object. For more information, see Using ACLs. One way to grant\n the permissions using the request headers is to specify a canned ACL with the\n x-amz-acl
request header.
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe name of the bucket where the multipart upload is initiated and where the object is uploaded.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket where the multipart upload is initiated and where the object is\n uploaded.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nBy default, all objects are private. Only the owner has full access\n control. When uploading an object, you can use this header to explicitly grant access\n permissions to specific Amazon Web Services accounts or groups.\n This header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP\n permissions on the object.
\nBy default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an\n Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to allow grantee to read the object data and its metadata.
\nBy default, all objects are private. Only the owner has full access\n control. When uploading an object, you can use this header to explicitly grant access\n permissions to specific Amazon Web Services accounts or groups.\n This header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to allow grantee to read the object data and its\n metadata.
\nBy default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an\n Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to allows grantee to read the object ACL.
\nBy default, all objects are private. Only the owner has full access\n control. When uploading an object, you can use this header to explicitly grant access\n permissions to specific Amazon Web Services accounts or groups.\n This header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to allows grantee to read the object ACL.
\nBy default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an\n Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
\nBy default, all objects are private. Only the owner has full access\n control. When uploading an object, you can use this header to explicitly grant access\n permissions to specific Amazon Web Services accounts or groups.\n This header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nSpecify access permissions explicitly to allows grantee to allow grantee to write the\n ACL for the applicable object.
\nBy default, all objects are private. Only the owner has full access control. When\n uploading an object, you can use this header to explicitly grant access permissions to\n specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3\n supports in an ACL. For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nYou specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an\n Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe server-side encryption algorithm used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
).
\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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. \n
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. \n You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n
The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256
, aws:kms
).
\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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. \n You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\nFor directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
\nAmazon S3 on Outposts only uses\n the OUTPOSTS Storage Class.
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.
\nFor directory buckets, only the S3 Express One Zone storage class is supported to store\n newly created objects.
\nAmazon S3 on Outposts only uses the OUTPOSTS Storage Class.
\nSpecifies the algorithm to use when encrypting the object (for example,\n AES256).
\nThis functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when encrypting the object (for example, AES256).
\nThis functionality is not supported for directory buckets.
\nSpecifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
\nThis functionality is not supported for directory buckets.
\nSpecifies the 128-bit MD5 digest of the customer-provided encryption key according to\n RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption\n key was transmitted without error.
\nThis functionality is not supported for directory buckets.
\nCreates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. \n For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see \n S3 Express One Zone APIs in the Amazon S3 User Guide. \n
\nTo make Zonal endpoint API requests on a directory bucket, use the CreateSession
\n API operation. Specifically, you grant s3express:CreateSession
permission to a\n bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the\n CreateSession
API request on the bucket, which returns temporary security\n credentials that include the access key ID, secret access key, session token, and\n expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After\n the session is created, you don’t need to use other policies to grant permissions to each\n Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by\n applying the temporary security credentials of the session to the request headers and\n following the SigV4 protocol for authentication. You also apply the session token to the\n x-amz-s3session-token
request header for authorization. Temporary security\n credentials are scoped to the bucket and expire after 5 minutes. After the expiration time,\n any calls that you make with those credentials will fail. You must use IAM credentials\n again to make a CreateSession
API request that generates a new set of\n temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond\n the original specified interval.
If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid\n service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to\n initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the\n Amazon S3 User Guide.
\nYou 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-az_id.region.amazonaws.com
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n \n CopyObject
API operation - Unlike other Zonal endpoint API operations, the CopyObject
API operation doesn't use the temporary security credentials returned from the CreateSession
API operation for authentication and authorization. For information about authentication and authorization of the CopyObject
API operation on directory buckets, see CopyObject.
\n \n HeadBucket
API operation - Unlike other Zonal endpoint API operations, the HeadBucket
API operation doesn't use the temporary security credentials returned from the CreateSession
API operation for authentication and authorization. For information about authentication and authorization of the HeadBucket
API operation on directory buckets, see HeadBucket.
To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that\n grants s3express:CreateSession
permission to the bucket. In a\n policy, you can have the s3express:SessionMode
condition key to\n control who can create a ReadWrite
or ReadOnly
session.\n For more information about ReadWrite
or ReadOnly
\n sessions, see \n x-amz-create-session-mode
\n . For example policies, see\n 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\n Amazon S3 User Guide.
To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the s3express:CreateSession
permission.
If you want to encrypt objects with SSE-KMS, you must also have the kms:GenerateDataKey
and the kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the target KMS key.
For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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, \nyou authenticate and authorize requests through CreateSession for low latency. \n 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.
\n\n 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. \n 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.\n
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, \n you can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) from the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n it's not supported to override the values of the encryption settings from the CreateSession
request. \n\n
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
Creates a session that establishes temporary security credentials to support fast\n authentication and authorization for the Zonal endpoint API operations on directory buckets. For more\n information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see S3 Express One Zone\n APIs in the Amazon S3 User Guide.
\nTo make Zonal endpoint API requests on a directory bucket, use the CreateSession
\n API operation. Specifically, you grant s3express:CreateSession
permission to a\n bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the\n CreateSession
API request on the bucket, which returns temporary security\n credentials that include the access key ID, secret access key, session token, and\n expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After\n the session is created, you don’t need to use other policies to grant permissions to each\n Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by\n applying the temporary security credentials of the session to the request headers and\n following the SigV4 protocol for authentication. You also apply the session token to the\n x-amz-s3session-token
request header for authorization. Temporary security\n credentials are scoped to the bucket and expire after 5 minutes. After the expiration time,\n any calls that you make with those credentials will fail. You must use IAM credentials\n again to make a CreateSession
API request that generates a new set of\n temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond\n the original specified interval.
If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid\n service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to\n initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the\n Amazon S3 User Guide.
\nYou 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-az_id.region.amazonaws.com
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n \n CopyObject
API operation -\n Unlike other Zonal endpoint API operations, the CopyObject
API operation doesn't use\n the temporary security credentials returned from the CreateSession
\n API operation for authentication and authorization. For information about\n authentication and authorization of the CopyObject
API operation on\n directory buckets, see CopyObject.
\n \n HeadBucket
API operation -\n Unlike other Zonal endpoint API operations, the HeadBucket
API operation doesn't use\n the temporary security credentials returned from the CreateSession
\n API operation for authentication and authorization. For information about\n authentication and authorization of the HeadBucket
API operation on\n directory buckets, see HeadBucket.
To obtain temporary security credentials, you must create\n a bucket policy or an IAM identity-based policy that grants s3express:CreateSession
\n permission to the bucket. In a policy, you can have the\n s3express:SessionMode
condition key to control who can create a\n ReadWrite
or ReadOnly
session. For more information\n about ReadWrite
or ReadOnly
sessions, see \n x-amz-create-session-mode
\n . For example policies, see\n Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for\n 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\n grant both accounts the s3express:CreateSession
permission.
If you want to encrypt objects with SSE-KMS, you must also have the\n kms:GenerateDataKey
and the kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the target KMS\n key.
For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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, \nyou authenticate and authorize requests through CreateSession for low latency. \n 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.
\n\n 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. \n 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.\n
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, \n you can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) from the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n it's not supported to override the values of the encryption settings from the CreateSession
request. \n\n
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The container element for optionally specifying the default Object Lock retention settings for new\n objects placed in the specified bucket.
\nThe DefaultRetention
settings require both a mode and a\n period.
The DefaultRetention
period can be either Days
or\n Years
but you must select one. You cannot specify\n Days
and Years
at the same time.
The container element for optionally specifying the default Object Lock retention\n settings for new objects placed in the specified bucket.
\nThe DefaultRetention
settings require both a mode and a\n period.
The DefaultRetention
period can be either Days
or\n Years
but you must select one. You cannot specify\n Days
and Years
at the same time.
The object to delete.
\n\n Directory buckets - For directory buckets, an object that's composed entirely of \n whitespace characters is not supported by the DeleteObjects
API operation. The request will receive a 400 Bad Request
error \n and none of the objects in the request will be deleted.
The object to delete.
\n\n Directory buckets - For directory buckets,\n an object that's composed entirely of whitespace characters is not supported by the\n DeleteObjects
API operation. The request will receive a 400 Bad\n Request
error and none of the objects in the request will be deleted.
Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.
\n\n 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.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - You must have the s3:DeleteBucket
permission on the specified bucket in a policy.
\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to DeleteBucket
:
\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.
\n\n Directory buckets - If multipart\n uploads in a directory bucket are in progress, you can't delete the bucket until\n all the in-progress multipart uploads are aborted or completed.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - You\n must have the s3:DeleteBucket
permission on the specified\n bucket in a policy.
\n Directory bucket permissions -\n You must have the s3express:DeleteBucket
permission in\n 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.\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to DeleteBucket
:
\n CreateBucket\n
\n\n DeleteObject\n
\nThis operation is not supported by directory buckets.
\nDeletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n DeleteBucketAnalyticsConfiguration
:
This operation is not supported for directory buckets.
\nDeletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n DeleteBucketAnalyticsConfiguration
:
This operation is not supported by directory buckets.
\nDeletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS
action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors
, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\n Related Resources\n
\n\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nThis operation is not supported for directory buckets.
\nDeletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS
action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors
, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\n Related Resources\n
\n\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nThis implementation of the DELETE action resets the default encryption for the bucket as\n server-side encryption with Amazon S3 managed keys (SSE-S3).
\n\n General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket\n Default Encryption in the Amazon S3 User Guide.
\n\n 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 \n for directory buckets.
\n\n General purpose bucket permissions - The s3:PutEncryptionConfiguration
permission is required in a policy. \n The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to DeleteBucketEncryption
:
\n PutBucketEncryption\n
\n\n GetBucketEncryption\n
\nThis implementation of the DELETE action resets the default encryption for the bucket as\n server-side encryption with Amazon S3 managed keys (SSE-S3).
\n\n General purpose buckets - For information\n about the bucket default encryption feature, see Amazon S3 Bucket Default\n Encryption in the Amazon S3 User Guide.
\n\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption\n configuration in directory buckets, see Setting\n default server-side encryption behavior for directory buckets.
\n\n General purpose bucket permissions - The\n s3:PutEncryptionConfiguration
permission is required in a\n policy. The bucket owner has this permission by default. The bucket owner\n can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Operations and Managing Access\n Permissions to Your Amazon S3 Resources.
\n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:PutEncryptionConfiguration
permission in\n 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.\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to DeleteBucketEncryption
:
\n PutBucketEncryption\n
\n\n GetBucketEncryption\n
\nThis operation is not supported by directory buckets.
\nDeletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to DeleteBucketIntelligentTieringConfiguration
include:
This operation is not supported for directory buckets.
\nDeletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to DeleteBucketIntelligentTieringConfiguration
include:
This operation is not supported by directory buckets.
\nDeletes an inventory configuration (identified by the inventory ID) from the\n bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nOperations related to DeleteBucketInventoryConfiguration
include:
This operation is not supported for directory buckets.
\nDeletes an inventory configuration (identified by the inventory ID) from the\n bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nOperations related to DeleteBucketInventoryConfiguration
include:
This operation is not supported by directory buckets.
\nDeletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.
\nTo use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration
action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.
\nFor more information about the object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nDeletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.
\n\n General purpose bucket permissions - By\n default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that\n created it) can access the resource. The resource owner can optionally grant\n access permissions to others by writing an access policy. For this\n operation, a user must have the s3:PutLifecycleConfiguration
\n permission.
For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.
\n\n Directory bucket permissions -\n You must have the s3express:PutLifecycleConfiguration
\n permission in an IAM identity-based policy to use this operation.\n Cross-account access to this API operation isn't supported. The resource\n owner can optionally grant access permissions to others by creating a role\n or user for them as long as they are within the same account as the owner\n and resource.
For more information about directory bucket policies and permissions, see\n Authorizing Regional endpoint APIs with IAM in the\n Amazon S3 User Guide.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com
.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nThe account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
The 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\n directory bucket lifecycle configurations.
\nThis operation is not supported by directory buckets.
\nDeletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.
\n To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with\n Amazon CloudWatch.
\nThe following operations are related to\n DeleteBucketMetricsConfiguration
:
This operation is not supported for directory buckets.
\nDeletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.
\n To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with\n Amazon CloudWatch.
\nThe following operations are related to\n DeleteBucketMetricsConfiguration
:
This operation is not supported by directory buckets.
\nRemoves OwnershipControls
for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls
permission. For more information\n about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to\n DeleteBucketOwnershipControls
:
This operation is not supported for directory buckets.
\nRemoves OwnershipControls
for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls
permission. For more information\n about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to\n DeleteBucketOwnershipControls
:
Deletes the\n policy of a specified bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the\n DeleteBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403\n Access Denied
error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy
, PutBucketPolicy
, and\n DeleteBucketPolicy
API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked\n from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations\n policies.
\n General purpose bucket permissions - The s3:DeleteBucketPolicy
permission is required in a policy. \n For more information about general purpose buckets bucket policies, see Using Bucket Policies and User\n Policies in the Amazon S3 User Guide.
\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to DeleteBucketPolicy
\n
\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the policy of a specified bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that\n owns the bucket, the calling identity must both have the\n DeleteBucketPolicy
permissions on the specified bucket and belong\n to the bucket owner's account in order to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a\n 403 Access Denied
error. If you have the correct permissions, but\n you're not using an identity that belongs to the bucket owner's account, Amazon S3\n returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of\n their own buckets, the root principal in a bucket owner's Amazon Web Services account can\n perform the GetBucketPolicy
, PutBucketPolicy
, and\n DeleteBucketPolicy
API actions, even if their bucket policy\n explicitly denies the root principal's access. Bucket owner root principals can\n only be blocked from performing these API actions by VPC endpoint policies and\n Amazon Web Services Organizations policies.
\n General purpose bucket permissions - The\n s3:DeleteBucketPolicy
permission is required in a policy.\n For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:DeleteBucketPolicy
permission in\n 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.\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to DeleteBucketPolicy
\n
\n CreateBucket\n
\n\n DeleteObject\n
\nThis operation is not supported by directory buckets.
\nDeletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration
action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully\n propagate.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThe following operations are related to DeleteBucketReplication
:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nThis operation is not supported for directory buckets.
\nDeletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration
action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully\n propagate.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThe following operations are related to DeleteBucketReplication
:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nThis operation is not supported by directory buckets.
\nDeletes the tags from the bucket.
\nTo use this operation, you must have permission to perform the\n s3:PutBucketTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nThis operation is not supported for directory buckets.
\nDeletes the tags from the bucket.
\nTo use this operation, you must have permission to perform the\n s3:PutBucketTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nThis operation is not supported by directory buckets.
\nThis action removes the website configuration for a bucket. Amazon S3 returns a 200\n OK
response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK
response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if\n the bucket specified in the request does not exist.
This DELETE action requires the S3:DeleteBucketWebsite
permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite
\n permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
\nThe following operations are related to DeleteBucketWebsite
:
\n GetBucketWebsite\n
\n\n PutBucketWebsite\n
\nThis operation is not supported for directory buckets.
\nThis action removes the website configuration for a bucket. Amazon S3 returns a 200\n OK
response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK
response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if\n the bucket specified in the request does not exist.
This DELETE action requires the S3:DeleteBucketWebsite
permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite
\n permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
\nThe following operations are related to DeleteBucketWebsite
:
\n GetBucketWebsite\n
\n\n PutBucketWebsite\n
\nIndicates whether the specified object version that was permanently deleted was (true) or was\n not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or\n not (false) the current version of the object is a delete marker.
\nThis functionality is not supported for directory buckets.
\nIndicates whether the specified object version that was permanently deleted was (true)\n or was not (false) a delete marker before deletion. In a simple DELETE, this header\n indicates whether (true) or not (false) the current version of the object is a delete\n marker.
\nThis functionality is not supported for directory buckets.
\nThe bucket name of the bucket containing the object.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name of the bucket containing the object.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
The If-Match
header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns\n a 412 Precondition Failed
error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No \n Content) response
.
For more information about conditional requests, see RFC 7232.
\nThis functionality is only supported for directory buckets.
\nIf present, the object is deleted only if its modification times matches the provided\n Timestamp
. If the Timestamp
values do not match, the operation\n returns a 412 Precondition Failed
error. If the Timestamp
matches\n or if the object doesn’t exist, the operation returns a 204 Success (No\n Content)
response.
This functionality is only supported for directory buckets.
\nIf present, the object is deleted only if its size matches the provided size in bytes. If the Size
value does not match, the operation returns a 412 Precondition Failed
error. If the Size
matches or if the object doesn’t exist, \n the operation returns a 204 Success (No Content)
response.
This functionality is only supported for directory buckets.
\nYou can use the If-Match
, x-amz-if-match-last-modified-time
and x-amz-if-match-size
\n conditional headers in conjunction with each-other or individually.
This operation is not supported by directory buckets.
\nRemoves the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.
\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteObjectTagging
:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nThis operation is not supported for directory buckets.
\nRemoves the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.
\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteObjectTagging
:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nThis operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides a\n suitable alternative to sending individual delete requests, reducing per-request\n overhead.
\nThe request can contain a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete operation and returns the result of that delete, success or failure, in the response.\n Note that if the object specified in the request is not found, Amazon S3 returns the result as\n deleted.
\n\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each key\n in your request. In quiet mode the response includes only keys where the delete operation \n encountered an error. For a successful deletion in a quiet mode, the operation does not return any information\n about the delete in the response body.
\nWhen performing this action on an MFA Delete enabled bucket, that attempts to delete any\n versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3\n User Guide.
\n\n Directory buckets - MFA delete is not supported by directory buckets.
\n\n General purpose bucket permissions - The following permissions are required in your policies when your \n DeleteObjects
request includes specific headers.
\n \n s3:DeleteObject
\n - To delete an object from a bucket, you must always specify the s3:DeleteObject
permission.
\n \n s3:DeleteObjectVersion
\n - To delete a specific version of an object from a versioning-enabled bucket, you must specify the s3:DeleteObjectVersion
permission.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - The Content-MD5 request header is required for all Multi-Object Delete requests. Amazon S3\n uses the header value to ensure that your request body has not been altered in\n transit.
\n\n Directory bucket - The Content-MD5 request header or a additional checksum request header \n (including x-amz-checksum-crc32
, x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or \n x-amz-checksum-sha256
) is required for all Multi-Object Delete requests.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to DeleteObjects
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThis operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides\n a suitable alternative to sending individual delete requests, reducing per-request\n overhead.
\nThe request can contain a list of up to 1000 keys that you want to delete. In the XML,\n you provide the object key names, and optionally, version IDs if you want to delete a\n specific version of the object from a versioning-enabled bucket. For each key, Amazon S3\n performs a delete operation and returns the result of that delete, success or failure, in\n the response. Note that if the object specified in the request is not found, Amazon S3 returns\n the result as deleted.
\n\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n operation encountered an error. For a successful deletion in a quiet mode, the operation\n does not return any information about the delete in the response body.
\nWhen performing this action on an MFA Delete enabled bucket, that attempts to delete any\n versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3 User Guide.
\n\n Directory buckets -\n MFA delete is not supported by directory buckets.
\n\n General purpose bucket permissions - The\n following permissions are required in your policies when your\n DeleteObjects
request includes specific headers.
\n \n s3:DeleteObject
\n \n - To delete an object from a bucket, you must always specify\n the s3:DeleteObject
permission.
\n \n s3:DeleteObjectVersion
\n - To delete a specific version of an object from a\n versioning-enabled bucket, you must specify the\n s3:DeleteObjectVersion
permission.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - The Content-MD5\n request header is required for all Multi-Object Delete requests. Amazon S3 uses\n the header value to ensure that your request body has not been altered in\n transit.
\n\n Directory bucket - The\n Content-MD5 request header or a additional checksum request header\n (including x-amz-checksum-crc32
,\n x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or\n x-amz-checksum-sha256
) is required for all Multi-Object\n Delete requests.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to DeleteObjects
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThe bucket name containing the objects to delete.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name containing the objects to delete.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.
\nWhen performing the DeleteObjects
operation on an MFA delete enabled bucket, which attempts to delete the specified \n versioned objects, you must include an MFA token. If you don't provide an MFA token, the entire\n request will fail, even if there are non-versioned objects that you are trying to delete. If you\n provide an invalid token, whether there are versioned object keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
\nThe concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.
\nWhen performing the DeleteObjects
operation on an MFA delete enabled\n bucket, which attempts to delete the specified versioned objects, you must include an MFA\n token. If you don't provide an MFA token, the entire request will fail, even if there are\n non-versioned objects that you are trying to delete. If you provide an invalid token,\n whether there are versioned object keys in the request or not, the entire Multi-Object\n Delete request will fail. For information about MFA Delete, see MFA\n Delete in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
\nThis operation is not supported by directory buckets.
\nRemoves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock
permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeletePublicAccessBlock
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThis operation is not supported for directory buckets.
\nRemoves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock
permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeletePublicAccessBlock
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nIndicates whether the specified object version that was permanently deleted was (true) or was\n not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or\n not (false) the current version of the object is a delete marker.
\nThis functionality is not supported for directory buckets.
\nIndicates whether the specified object version that was permanently deleted was (true)\n or was not (false) a delete marker before deletion. In a simple DELETE, this header\n indicates whether (true) or not (false) the current version of the object is a delete\n marker.
\nThis functionality is not supported for directory buckets.
\nEncoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.
\nWhen using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png
will appear as\n test_file%283%29.png
.
Encoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.
\nWhen using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png
will appear as\n test_file%283%29.png
.
Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects.
\nIf you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.
\nSpecifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects.
\nIf you're specifying a customer managed KMS key, we recommend using a fully\n qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the\n key within the requester’s account. This behavior can result in data that's encrypted\n with a KMS key that belongs to the requester, and not the bucket owner.
\n\n The existing object was created with a different encryption type. \n Subsequent write requests must include the appropriate encryption \n parameters in the request or while creating the session.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 } }, "com.amazonaws.s3#End": { @@ -21658,7 +21695,7 @@ } }, "traits": { - "smithy.api#documentation": "Optional configuration to replicate existing source bucket objects. \n
\nThis parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.
\nOptional configuration to replicate existing source bucket objects.
\nThis parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the\n Amazon S3 User Guide.
\nSpecifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023-
or engineering/
. Then, you can use FilterRule
to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.
Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned\n to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of\n the object key name. A prefix is a specific string of characters at the beginning of an\n object key name, which you can use to organize objects. For example, you can start the key\n names of related objects with a prefix, such as 2023-
or\n engineering/
. Then, you can use FilterRule
to find objects in\n a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it\n is at the end of the object key name instead of at the beginning.
This operation is not supported by directory buckets.
\nThis implementation of the GET action uses the accelerate
subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled
or\n Suspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to your Amazon S3 Resources in the\n Amazon S3 User Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or\n Suspended
by using the PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in\n the Amazon S3 User Guide.
\nThe following operations are related to\n GetBucketAccelerateConfiguration
:
This operation is not supported for directory buckets.
\nThis implementation of the GET action uses the accelerate
subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled
or\n Suspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to your Amazon S3 Resources in the\n Amazon S3 User Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or\n Suspended
by using the PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in\n the Amazon S3 User Guide.
\nThe following operations are related to\n GetBucketAccelerateConfiguration
:
This operation is not supported by directory buckets.
\nThis implementation of the GET
action uses the acl
subresource\n to return the access control list (ACL) of a bucket. To use GET
to return the\n ACL of the bucket, you must have the READ_ACP
access to the bucket. If\n READ_ACP
permission is granted to the anonymous user, you can return the\n 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.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control
ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetBucketAcl
:
\n ListObjects\n
\nThis operation is not supported for directory buckets.
\nThis implementation of the GET
action uses the acl
subresource\n to return the access control list (ACL) of a bucket. To use GET
to return the\n ACL of the bucket, you must have the READ_ACP
access to the bucket. If\n READ_ACP
permission is granted to the anonymous user, you can return the\n 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.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control
ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetBucketAcl
:
\n ListObjects\n
\nThis operation is not supported by directory buckets.
\nThis implementation of the GET action returns an analytics configuration (identified by\n the analytics configuration ID) from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon S3 User Guide.
\nThe following operations are related to\n GetBucketAnalyticsConfiguration
:
This operation is not supported for directory buckets.
\nThis implementation of the GET action returns an analytics configuration (identified by\n the analytics configuration ID) from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon S3 User Guide.
\nThe following operations are related to\n GetBucketAnalyticsConfiguration
:
This operation is not supported by directory buckets.
\nReturns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.
\n To use this operation, you must have permission to perform the\n s3:GetBucketCORS
action. By default, the bucket owner has this permission\n 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.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.
\nThe following operations are related to GetBucketCors
:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nThis operation is not supported for directory buckets.
\nReturns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.
\n To use this operation, you must have permission to perform the\n s3:GetBucketCORS
action. By default, the bucket owner has this permission\n 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.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.
\nThe following operations are related to GetBucketCors
:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nReturns the default encryption configuration for an Amazon S3 bucket. By default, all buckets\n have a default encryption configuration that uses server-side encryption with Amazon S3 managed\n keys (SSE-S3).
\n\n General purpose buckets - For information about the bucket default encryption feature, see Amazon S3 Bucket\n Default Encryption in the Amazon S3 User Guide.
\n\n 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 \n for directory buckets.
\n\n General purpose bucket permissions - The s3:GetEncryptionConfiguration
permission is required in a policy. \n The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to GetBucketEncryption
:
\n PutBucketEncryption\n
\nReturns the default encryption configuration for an Amazon S3 bucket. By default, all buckets\n have a default encryption configuration that uses server-side encryption with Amazon S3 managed\n keys (SSE-S3).
\n\n General purpose buckets - For information\n about the bucket default encryption feature, see Amazon S3 Bucket Default\n Encryption in the Amazon S3 User Guide.
\n\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. For information about the default encryption\n configuration in directory buckets, see Setting\n default server-side encryption behavior for directory buckets.
\n\n General purpose bucket permissions - The\n s3:GetEncryptionConfiguration
permission is required in a\n policy. The bucket owner has this permission by default. The bucket owner\n can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Operations and Managing Access\n Permissions to Your Amazon S3 Resources.
\n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:GetEncryptionConfiguration
permission in\n 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.\n 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.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to GetBucketEncryption
:
\n PutBucketEncryption\n
\nThis operation is not supported by directory buckets.
\nGets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to GetBucketIntelligentTieringConfiguration
include:
This operation is not supported for directory buckets.
\nGets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to GetBucketIntelligentTieringConfiguration
include:
This operation is not supported by directory buckets.
\nReturns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration
action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nThe following operations are related to\n GetBucketInventoryConfiguration
:
This operation is not supported for directory buckets.
\nReturns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration
action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nThe following operations are related to\n GetBucketInventoryConfiguration
:
This operation is not supported by directory buckets.
\nBucket 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.\n For the related API description, see GetBucketLifecycle. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier action,
\nReturns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object Lifecycle\n Management.
\nTo use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration
action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n GetBucketLifecycleConfiguration
has the following special error:
Error code: NoSuchLifecycleConfiguration
\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following operations are related to\n GetBucketLifecycleConfiguration
:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nReturns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object Lifecycle\n Management.
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an object\n key name prefix, one or more object tags, object size, or any combination of these.\n Accordingly, this section describes the latest API, which is compatible with the new\n functionality. The previous version of the API supported filtering based only on an object\n key name prefix, which is supported for general purpose buckets for backward compatibility.\n For the related API description, see GetBucketLifecycle.
\nLifecyle configurations for directory buckets only support expiring objects and\n cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters\n are not supported.
\n\n General purpose bucket permissions - By\n default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that\n created it) can access the resource. The resource owner can optionally grant\n access permissions to others by writing an access policy. For this\n operation, a user must have the s3:GetLifecycleConfiguration
\n permission.
For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.
\n\n Directory bucket permissions -\n You must have the s3express:GetLifecycleConfiguration
\n permission in an IAM identity-based policy to use this operation.\n Cross-account access to this API operation isn't supported. The resource\n owner can optionally grant access permissions to others by creating a role\n or user for them as long as they are within the same account as the owner\n and resource.
For more information about directory bucket policies and permissions, see\n Authorizing Regional endpoint APIs with IAM in the\n Amazon S3 User Guide.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com
.
\n GetBucketLifecycleConfiguration
has the following special error:
Error code: NoSuchLifecycleConfiguration
\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following operations are related to\n GetBucketLifecycleConfiguration
:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nIndicates which default minimum object size behavior is applied to the lifecycle configuration.
\n\n all_storage_classes_128K
- Objects smaller than 128 KB will not transition to any storage class by default.
\n 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.\n
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Indicates which default minimum object size behavior is applied to the lifecycle\n configuration.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\n\n all_storage_classes_128K
- Objects smaller than 128 KB will not\n transition to any storage class by default.
\n varies_by_storage_class
- Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\n
To customize the minimum object size for any transition you can add a filter that\n specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in\n the body of your transition rule. Custom filters always take precedence over the default\n transition behavior.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
The 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\n directory bucket lifecycle configurations.
\nThis operation is not supported by directory buckets.
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint
request parameter in a CreateBucket
\n 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.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
We recommend that you use HeadBucket to return the Region\n that a bucket resides in. For backward compatibility, Amazon S3 continues to support\n GetBucketLocation.
\nThe following operations are related to GetBucketLocation
:
\n GetObject\n
\n\n CreateBucket\n
\nThis operation is not supported for directory buckets.
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint
request parameter in a CreateBucket
\n 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.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
We recommend that you use HeadBucket to return the Region\n that a bucket resides in. For backward compatibility, Amazon S3 continues to support\n GetBucketLocation.
\nThe following operations are related to GetBucketLocation
:
\n GetObject\n
\n\n CreateBucket\n
\nThis operation is not supported by directory buckets.
\nReturns the logging status of a bucket and the permissions users have to view and modify\n that status.
\nThe following operations are related to GetBucketLogging
:
\n CreateBucket\n
\n\n PutBucketLogging\n
\nThis operation is not supported for directory buckets.
\nReturns the logging status of a bucket and the permissions users have to view and modify\n that status.
\nThe following operations are related to GetBucketLogging
:
\n CreateBucket\n
\n\n PutBucketLogging\n
\nThis operation is not supported by directory buckets.
\nGets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.
\n To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n GetBucketMetricsConfiguration
:
This operation is not supported for directory buckets.
\nGets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.
\n To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n GetBucketMetricsConfiguration
:
This operation is not supported by directory buckets.
\nReturns the notification configuration of a bucket.
\nIf notifications are not enabled on the bucket, the action returns an empty\n NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification
\n permission.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of Bucket Events. For more information about bucket\n policies, see Using Bucket Policies.
\nThe following action is related to GetBucketNotification
:
This operation is not supported for directory buckets.
\nReturns the notification configuration of a bucket.
\nIf notifications are not enabled on the bucket, the action returns an empty\n NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification
\n permission.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
\nWhen 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of Bucket Events. For more information about bucket\n policies, see Using Bucket Policies.
\nThe following action is related to GetBucketNotification
:
This operation is not supported by directory buckets.
\nRetrieves OwnershipControls
for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls
permission. For more information\n about Amazon S3 permissions, see Specifying permissions in a\n policy.
For information about Amazon S3 Object Ownership, see Using Object\n Ownership.
\nThe following operations are related to GetBucketOwnershipControls
:
This operation is not supported for directory buckets.
\nRetrieves OwnershipControls
for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls
permission. For more information\n about Amazon S3 permissions, see Specifying permissions in a\n policy.
For information about Amazon S3 Object Ownership, see Using Object\n Ownership.
\nThe following operations are related to GetBucketOwnershipControls
:
Returns the policy of a specified bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the\n GetBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403\n Access Denied
error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy
, PutBucketPolicy
, and\n DeleteBucketPolicy
API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked\n from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations\n policies.
\n General purpose bucket permissions - The s3:GetBucketPolicy
permission is required in a policy. \n For more information about general purpose buckets bucket policies, see Using Bucket Policies and User\n Policies in the Amazon S3 User Guide.
\n 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.
\n General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
\n\n Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following action is related to GetBucketPolicy
:
\n GetObject\n
\nReturns the policy of a specified bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that\n owns the bucket, the calling identity must both have the\n GetBucketPolicy
permissions on the specified bucket and belong to\n the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a\n 403 Access Denied
error. If you have the correct permissions, but\n you're not using an identity that belongs to the bucket owner's account, Amazon S3\n returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of\n their own buckets, the root principal in a bucket owner's Amazon Web Services account can\n perform the GetBucketPolicy
, PutBucketPolicy
, and\n DeleteBucketPolicy
API actions, even if their bucket policy\n explicitly denies the root principal's access. Bucket owner root principals can\n only be blocked from performing these API actions by VPC endpoint policies and\n Amazon Web Services Organizations policies.
\n General purpose bucket permissions - The\n s3:GetBucketPolicy
permission is required in a policy. For\n more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:GetBucketPolicy
permission in\n 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.\n 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.
\n General purpose buckets example bucket policies\n - See Bucket policy\n examples in the Amazon S3 User Guide.
\n\n Directory bucket example bucket policies\n - See Example bucket policies for S3 Express One Zone in the\n Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following action is related to GetBucketPolicy
:
\n GetObject\n
\nThis operation is not supported by directory buckets.
\nRetrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".
\nThe following operations are related to GetBucketPolicyStatus
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThis operation is not supported for directory buckets.
\nRetrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".
\nThe following operations are related to GetBucketPolicyStatus
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThis operation is not supported by directory buckets.
\nReturns the replication configuration of a bucket.
\nIt can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThis action requires permissions for the s3:GetReplicationConfiguration
\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.
If you include the Filter
element in a replication configuration, you must\n also include the DeleteMarkerReplication
and Priority
elements.\n The response also returns those elements.
For information about GetBucketReplication
errors, see List of\n replication-related error codes\n
The following operations are related to GetBucketReplication
:
\n PutBucketReplication\n
\nThis operation is not supported for directory buckets.
\nReturns the replication configuration of a bucket.
\nIt can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThis action requires permissions for the s3:GetReplicationConfiguration
\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.
If you include the Filter
element in a replication configuration, you must\n also include the DeleteMarkerReplication
and Priority
elements.\n The response also returns those elements.
For information about GetBucketReplication
errors, see List of\n replication-related error codes\n
The following operations are related to GetBucketReplication
:
\n PutBucketReplication\n
\nThis operation is not supported by directory buckets.
\nReturns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays\n Buckets.
\nThe following operations are related to GetBucketRequestPayment
:
\n ListObjects\n
\nThis operation is not supported for directory buckets.
\nReturns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays\n Buckets.
\nThe following operations are related to GetBucketRequestPayment
:
\n ListObjects\n
\nThis operation is not supported by directory buckets.
\nReturns the tag set associated with the bucket.
\nTo use this operation, you must have permission to perform the\n s3:GetBucketTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
\n GetBucketTagging
has the following special error:
Error code: NoSuchTagSet
\n
Description: There is no tag set associated with the bucket.
\nThe following operations are related to GetBucketTagging
:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis operation is not supported for directory buckets.
\nReturns the tag set associated with the bucket.
\nTo use this operation, you must have permission to perform the\n s3:GetBucketTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
\n GetBucketTagging
has the following special error:
Error code: NoSuchTagSet
\n
Description: There is no tag set associated with the bucket.
\nThe following operations are related to GetBucketTagging
:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis operation is not supported by directory buckets.
\nReturns the versioning state of a bucket.
\nTo retrieve the versioning state of a bucket, you must be the bucket owner.
\nThis implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled
, the bucket owner must use an authentication\n device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nThis operation is not supported for directory buckets.
\nReturns the versioning state of a bucket.
\nTo retrieve the versioning state of a bucket, you must be the bucket owner.
\nThis implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled
, the bucket owner must use an authentication\n device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nThis operation is not supported by directory buckets.
\nReturns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on Amazon S3.
\nThis GET action requires the S3:GetBucketWebsite
permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite
permission.
The following operations are related to GetBucketWebsite
:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nThis operation is not supported for directory buckets.
\nReturns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on Amazon S3.
\nThis GET action requires the S3:GetBucketWebsite
permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite
permission.
The following operations are related to GetBucketWebsite
:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nRetrieves an object from Amazon S3.
\nIn the GetObject
request, specify the full key name for the object.
\n 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\n the object photos/2006/February/sample.jpg
, specify the object key name as\n /photos/2006/February/sample.jpg
. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg
in the bucket named\n examplebucket
, specify the object key name as\n /examplebucket/photos/2006/February/sample.jpg
. For more information about\n request types, see HTTP Host\n Header Bucket Specification in the Amazon S3 User Guide.
\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject
, you must have the READ
\n access to the object (or version). If you grant READ
access to the anonymous user, the GetObject
operation \n returns the object without using an authorization header. For more information, see Specifying permissions in\n a policy in the Amazon S3 User Guide.
If you include a versionId
in your request header, you must have the\n s3:GetObjectVersion
permission to access a specific\n version of an object. The s3:GetObject
permission is not required in this scenario.
If you request the\n current version of an object without a specific versionId
in the request header, only\n the s3:GetObject
permission is required. The s3:GetObjectVersion
permission is not required in this scenario.\n
If the object that you request doesn’t exist, the error that\n Amazon S3 returns depends on whether you also have the s3:ListBucket
\n permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found
error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an\n HTTP status code 403 Access Denied
error.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted using \n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the \n S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the \n S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectState
error. For information about restoring archived objects,\n see Restoring\n Archived Objects in the Amazon S3 User Guide.
\n Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request
.
Encryption request headers, like x-amz-server-side-encryption
, should not\n be sent for the GetObject
requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS)\n keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject
requests for the object that uses \n these types of keys, you’ll get an HTTP 400 Bad Request
error.
\n 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\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
\nThere are times when you want to override certain response header values of a\n GetObject
response. For example, you might override the\n Content-Disposition
response header value through your GetObject
\n 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. \n 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. \n
The response headers that you can override for the\n GetObject
response are Cache-Control
, Content-Disposition
, \n Content-Encoding
, Content-Language
, Content-Type
, and Expires
.
To override values for a set of response headers in the\n GetObject
response, you can use the following query\n parameters in the request.
\n response-cache-control
\n
\n response-content-disposition
\n
\n response-content-encoding
\n
\n response-content-language
\n
\n response-content-type
\n
\n response-expires
\n
When you use these parameters, you must sign the request by using either an Authorization header or a\n presigned URL. These parameters cannot be used with an\n unsigned (anonymous) request.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to GetObject
:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nRetrieves an object from Amazon S3.
\nIn the GetObject
request, specify the full key name for the object.
\n General purpose buckets - Both the virtual-hosted-style\n requests and the path-style requests are supported. For a virtual hosted-style request\n example, if you have the object photos/2006/February/sample.jpg
, specify the\n object key name as /photos/2006/February/sample.jpg
. For a path-style request\n example, if you have the object photos/2006/February/sample.jpg
in the bucket\n named examplebucket
, specify the object key name as\n /examplebucket/photos/2006/February/sample.jpg
. For more information about\n request types, see HTTP Host\n Header Bucket Specification in the Amazon S3 User Guide.
\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - You\n must have the required permissions in a policy. To use\n GetObject
, you must have the READ
access to the\n object (or version). If you grant READ
access to the anonymous\n user, the GetObject
operation returns the object without using\n an authorization header. For more information, see Specifying permissions in a policy in the\n Amazon S3 User Guide.
If you include a versionId
in your request header, you must\n have the s3:GetObjectVersion
permission to access a specific\n version of an object. The s3:GetObject
permission is not\n required in this scenario.
If you request the current version of an object without a specific\n versionId
in the request header, only the\n s3:GetObject
permission is required. The\n s3:GetObjectVersion
permission is not required in this\n scenario.
If the object that you request doesn’t exist, the error that Amazon S3 returns\n depends on whether you also have the s3:ListBucket
\n permission.
If you have the s3:ListBucket
permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found
\n error.
If you don’t have the s3:ListBucket
permission, Amazon S3\n returns an HTTP status code 403 Access Denied
\n error.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If\n the\n object is encrypted using SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval\n storage class, the S3 Glacier Deep Archive storage class, the\n S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier,\n before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectState
error. For information about restoring archived\n objects, see Restoring Archived\n Objects in the Amazon S3 User Guide.
\n Directory buckets -\n For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. \nUnsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request
.
Encryption request headers, like x-amz-server-side-encryption
,\n should not be sent for the GetObject
requests, if your object uses\n server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your\n GetObject
requests for the object that uses these types of keys,\n you’ll get an HTTP 400 Bad Request
error.
\n Directory buckets -\n 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\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
\nThere are times when you want to override certain response header values of a\n GetObject
response. For example, you might override the\n Content-Disposition
response header value through your\n GetObject
request.
You can override values for a set of response headers. These modified response\n header values are included only in a successful response, that is, when the HTTP\n status code 200 OK
is returned. The headers you can override using\n the following query parameters in the request are a subset of the headers that\n Amazon S3 accepts when you create an object.
The response headers that you can override for the GetObject
\n response are Cache-Control
, Content-Disposition
,\n Content-Encoding
, Content-Language
,\n Content-Type
, and Expires
.
To override values for a set of response headers in the GetObject
\n response, you can use the following query parameters in the request.
\n response-cache-control
\n
\n response-content-disposition
\n
\n response-content-encoding
\n
\n response-content-language
\n
\n response-content-type
\n
\n response-expires
\n
When you use these parameters, you must sign the request by using either an\n Authorization header or a presigned URL. These parameters cannot be used with\n an unsigned (anonymous) request.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to GetObject
:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nThis operation is not supported by directory buckets.
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl
permissions or READ_ACP
access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n
This functionality is not supported for Amazon S3 on Outposts.
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control
ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetObjectAcl
:
\n GetObject\n
\n\n GetObjectAttributes\n
\n\n DeleteObject\n
\n\n PutObject\n
\nThis operation is not supported for directory buckets.
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl
permissions or READ_ACP
access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n
This functionality is not supported for Amazon S3 on Outposts.
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control
ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetObjectAcl
:
\n GetObject\n
\n\n GetObjectAttributes\n
\n\n DeleteObject\n
\n\n PutObject\n
\nRetrieves all the metadata from an object without returning the object itself. This\n operation is useful if you're interested only in an object's metadata.
\n\n GetObjectAttributes
combines the functionality of HeadObject
\n and ListParts
. All of the data returned with each of those individual calls\n can be returned with a single call to GetObjectAttributes
.
\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - To use\n GetObjectAttributes
, you must have READ access to the object. The permissions that you need to use this operation depend on whether the\n bucket is versioned. If the bucket is versioned, you need both the\n s3:GetObjectVersion
and s3:GetObjectVersionAttributes
\n permissions for this operation. If the bucket is not versioned, you need the\n s3:GetObject
and s3:GetObjectAttributes
permissions.\n For more information, see Specifying Permissions in\n a Policy in the Amazon S3 User Guide. If the object\n that you request does not exist, the error Amazon S3 returns depends on whether you\n also have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found
(\"no such key\")\n error.
If you don't have the s3:ListBucket
permission, Amazon S3 returns\n an HTTP status code 403 Forbidden
(\"access denied\")\n error.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with\n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
Encryption request headers, like x-amz-server-side-encryption
,\n should not be sent for HEAD
requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). The x-amz-server-side-encryption
header is used when you PUT
an object to S3 and want to specify the encryption method. \n If you include this header in a GET
request for an object that uses these types of keys, \n you’ll get an HTTP 400 Bad Request
error. It's because the encryption method can't be changed when you retrieve the object.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n 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:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3\n User Guide.
\n\n Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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.
\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
\n to the versionId
query parameter in the request.
Consider the following when using request headers:
\nIf both of the If-Match
and If-Unmodified-Since
headers\n are present in the request as follows, then Amazon S3 returns the HTTP status code\n 200 OK
and the data requested:
\n If-Match
condition evaluates to true
.
\n If-Unmodified-Since
condition evaluates to\n false
.
For more information about conditional requests, see RFC 7232.
\nIf both of the If-None-Match
and If-Modified-Since
\n headers are present in the request as follows, then Amazon S3 returns the HTTP status code\n 304 Not Modified
:
\n If-None-Match
condition evaluates to false
.
\n If-Modified-Since
condition evaluates to\n true
.
For more information about conditional requests, see RFC 7232.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following actions are related to GetObjectAttributes
:
\n GetObject\n
\n\n GetObjectAcl\n
\n\n GetObjectLegalHold\n
\n\n GetObjectRetention\n
\n\n GetObjectTagging\n
\n\n HeadObject\n
\n\n ListParts\n
\nRetrieves all the metadata from an object without returning the object itself. This\n operation is useful if you're interested only in an object's metadata.
\n\n GetObjectAttributes
combines the functionality of HeadObject
\n and ListParts
. All of the data returned with each of those individual calls\n can be returned with a single call to GetObjectAttributes
.
\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - To\n use GetObjectAttributes
, you must have READ access to the\n object. The permissions that you need to use this operation depend on\n whether the bucket is versioned. If the bucket is versioned, you need both\n the s3:GetObjectVersion
and\n s3:GetObjectVersionAttributes
permissions for this\n operation. If the bucket is not versioned, you need the\n s3:GetObject
and s3:GetObjectAttributes
\n permissions. For more information, see Specifying\n Permissions in a Policy in the\n Amazon S3 User Guide. If the object that you request does\n not exist, the error Amazon S3 returns depends on whether you also have the\n s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found
\n (\"no such key\") error.
If you don't have the s3:ListBucket
permission, Amazon S3\n returns an HTTP status code 403 Forbidden
(\"access\n denied\") error.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If\n the\n object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.
Encryption request headers, like x-amz-server-side-encryption
,\n should not be sent for HEAD
requests if your object uses\n server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side\n encryption with Amazon S3 managed encryption keys (SSE-S3). The\n x-amz-server-side-encryption
header is used when you\n PUT
an object to S3 and want to specify the encryption method.\n If you include this header in a GET
request for an object that\n uses these types of keys, you’ll get an HTTP 400 Bad Request
\n error. It's because the encryption method can't be changed when you retrieve\n the object.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve\n the metadata from the object, you must use the following headers to provide the\n encryption key for the server to be able to retrieve the object's metadata. The\n headers are:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\n\n Directory bucket permissions -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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.
\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
to the\n versionId
query parameter in the request.
Consider the following when using request headers:
\nIf both of the If-Match
and If-Unmodified-Since
\n headers are present in the request as follows, then Amazon S3 returns the HTTP\n status code 200 OK
and the data requested:
\n If-Match
condition evaluates to\n true
.
\n If-Unmodified-Since
condition evaluates to\n false
.
For more information about conditional requests, see RFC 7232.
\nIf both of the If-None-Match
and\n If-Modified-Since
headers are present in the request as\n follows, then Amazon S3 returns the HTTP status code 304 Not\n Modified
:
\n If-None-Match
condition evaluates to\n false
.
\n If-Modified-Since
condition evaluates to\n true
.
For more information about conditional requests, see RFC 7232.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following actions are related to GetObjectAttributes
:
\n GetObject\n
\n\n GetObjectAcl\n
\n\n GetObjectLegalHold\n
\n\n GetObjectRetention\n
\n\n GetObjectTagging\n
\n\n HeadObject\n
\n\n ListParts\n
\nThe creation date of the object.
", + "smithy.api#documentation": "Date and time when the object was last modified.
", "smithy.api#httpHeader": "Last-Modified" } }, @@ -23572,7 +23609,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Provides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
\n\n Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nProvides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
\n\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nA container for elements related to a particular part. A response can contain zero or\n more Parts
elements.
\n General purpose buckets - For GetObjectAttributes
, if a additional checksum (including x-amz-checksum-crc32
, \n x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or \n x-amz-checksum-sha256
) isn't applied to the object specified in the request, the response doesn't return Part
.
\n Directory buckets - For GetObjectAttributes
, no matter whether a additional checksum is applied to the object specified in the request, the response returns Part
.
A container for elements related to a particular part. A response can contain zero or\n more Parts
elements.
\n General purpose buckets - For\n GetObjectAttributes
, if a additional checksum (including\n x-amz-checksum-crc32
, x-amz-checksum-crc32c
,\n x-amz-checksum-sha1
, or x-amz-checksum-sha256
) isn't\n applied to the object specified in the request, the response doesn't return\n Part
.
\n Directory buckets - For\n GetObjectAttributes
, no matter whether a additional checksum is\n applied to the object specified in the request, the response returns\n Part
.
The name of the bucket that contains the object.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket that contains the object.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The version ID used to reference a specific version of the object.
\nS3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
\n to the versionId
query parameter in the request.
The version ID used to reference a specific version of the object.
\nS3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
to the\n versionId
query parameter in the request.
This operation is not supported by directory buckets.
\nGets an object's current legal hold status. For more information, see Locking\n Objects.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe following action is related to GetObjectLegalHold
:
\n GetObjectAttributes\n
\nThis operation is not supported for directory buckets.
\nGets an object's current legal hold status. For more information, see Locking\n Objects.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe following action is related to GetObjectLegalHold
:
\n GetObjectAttributes\n
\nThis operation is not supported by directory buckets.
\nGets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking Objects.
\nThe following action is related to GetObjectLockConfiguration
:
\n GetObjectAttributes\n
\nThis operation is not supported for directory buckets.
\nGets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking Objects.
\nThe following action is related to GetObjectLockConfiguration
:
\n GetObjectAttributes\n
\nIndicates whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.
\nIf the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed
error and the Last-Modified: timestamp
response header.
Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.
\nIf the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true
in the\n response.
If the specified version in the request is a delete marker, the response\n returns a 405 Method Not Allowed
error and the Last-Modified:\n timestamp
response header.
If the object expiration is configured (see \n PutBucketLifecycleConfiguration
\n ), the response includes\n this header. It includes the expiry-date
and rule-id
key-value\n pairs providing object expiration information. The value of the rule-id
is\n URL-encoded.
This functionality is not supported for directory buckets.
\nIf the object expiration is configured (see \n PutBucketLifecycleConfiguration
\n ), the response includes this\n header. It includes the expiry-date
and rule-id
key-value pairs\n providing object expiration information. The value of the rule-id
is\n URL-encoded.
This functionality is not supported for directory buckets.
\nProvides information about object restoration action and expiration time of the restored\n object copy.
\nThis functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nProvides information about object restoration action and expiration time of the restored\n object copy.
\nThis functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nDate and time when the object was last modified.
\n\n General purpose buckets - When you specify a versionId
of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed
error and the Last-Modified: timestamp
response header.
Date and time when the object was last modified.
\n\n General purpose buckets - When you specify a\n versionId
of the object in your request, if the specified version in the\n request is a delete marker, the response returns a 405 Method Not Allowed
\n error and the Last-Modified: timestamp
response header.
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\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.
This functionality is not supported for directory buckets.
\nThis is set to the number of metadata entries not returned in the headers that are\n prefixed with x-amz-meta-
. This can happen if you create metadata using an API\n like SOAP that supports more flexible metadata than the REST API. For example, using SOAP,\n you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIndicates whether the object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\n\n Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nProvides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\n\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe number of tags, if any, on the object, when you have the relevant permission to read object tags.
\nYou can use GetObjectTagging to retrieve\n the tag set associated with an object.
\nThis functionality is not supported for directory buckets.
\nThe number of tags, if any, on the object, when you have the relevant permission to read\n object tags.
\nYou can use GetObjectTagging to retrieve\n the tag set associated with an object.
\nThis functionality is not supported for directory buckets.
\nThe bucket name containing the object.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\n\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name containing the object.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\n\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Return the object only if its entity tag (ETag) is the same as the one specified in this header;\n otherwise, return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition \n evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is the same as the one specified in this\n header; otherwise, return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are\n present in the request as follows: If-Match
condition evaluates to\n true
, and; If-Unmodified-Since
condition evaluates to\n false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-Match" } }, "IfModifiedSince": { "target": "com.amazonaws.s3#IfModifiedSince", "traits": { - "smithy.api#documentation": "Return the object only if it has been modified since the specified time; otherwise,\n return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
\n condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
\n status code.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if it has been modified since the specified time; otherwise,\n return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are\n present in the request as follows: If-None-Match
condition evaluates to\n false
, and; If-Modified-Since
condition evaluates to\n true
; then, S3 returns 304 Not Modified
status code.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-Modified-Since" } }, "IfNoneMatch": { "target": "com.amazonaws.s3#IfNoneMatch", "traits": { - "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified in this header;\n otherwise, return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
\n headers are present in the request as follows: If-None-Match
\n condition evaluates to false
, and; If-Modified-Since
\n condition evaluates to true
; then, S3 returns 304 Not Modified
HTTP status code.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified in\n this header; otherwise, return a 304 Not Modified
error.
If both of the If-None-Match
and If-Modified-Since
headers are\n present in the request as follows: If-None-Match
condition evaluates to\n false
, and; If-Modified-Since
condition evaluates to\n true
; then, S3 returns 304 Not Modified
HTTP status\n code.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-None-Match" } }, "IfUnmodifiedSince": { "target": "com.amazonaws.s3#IfUnmodifiedSince", "traits": { - "smithy.api#documentation": "Return the object only if it has not been modified since the specified time; otherwise,\n return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
\n headers are present in the request as follows: If-Match
condition\n evaluates to true
, and; If-Unmodified-Since
condition\n evaluates to false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if it has not been modified since the specified time; otherwise,\n return a 412 Precondition Failed
error.
If both of the If-Match
and If-Unmodified-Since
headers are\n present in the request as follows: If-Match
condition evaluates to\n true
, and; If-Unmodified-Since
condition evaluates to\n false
; then, S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-Unmodified-Since" } }, @@ -24227,28 +24264,28 @@ "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "Version ID used to reference a specific version of the object.
\nBy default, the GetObject
operation returns the current version of an object. To return a different version, use the versionId
subresource.
If you include a versionId
in your request header, you must have the s3:GetObjectVersion
permission to access a specific version of an object. The s3:GetObject
permission is not required in this scenario.
If you request the current version of an object without a specific versionId
in the request header, only the s3:GetObject
permission is required. The s3:GetObjectVersion
permission is not required in this scenario.
\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
\n to the versionId
query parameter in the request.
For more information about versioning, see PutBucketVersioning.
", + "smithy.api#documentation": "Version ID used to reference a specific version of the object.
\nBy default, the GetObject
operation returns the current version of an\n object. To return a different version, use the versionId
subresource.
If you include a versionId
in your request header, you must have\n the s3:GetObjectVersion
permission to access a specific version of an\n object. The s3:GetObject
permission is not required in this\n scenario.
If you request the current version of an object without a specific\n versionId
in the request header, only the\n s3:GetObject
permission is required. The\n s3:GetObjectVersion
permission is not required in this\n scenario.
\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
to the\n versionId
query parameter in the request.
For more information about versioning, see PutBucketVersioning.
", "smithy.api#httpQuery": "versionId" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use when decrypting the object (for example,\n AES256
).
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when decrypting the object (for example,\n AES256
).
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This\n value is used to decrypt the object when recovering it and must match the one used when\n storing the data. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies the customer-provided encryption key that you originally provided for Amazon S3 to\n encrypt the data before storing it. This value is used to decrypt the object when\n recovering it and must match the one used when storing the data. The key must be\n appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
\nIf you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies the 128-bit MD5 digest of the customer-provided encryption key according to\n RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption\n key was transmitted without error.
\nIf you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nTo retrieve the checksum, this mode must be enabled.
\n\n General purpose buckets - In addition, if you enable checksum mode and the object is uploaded with a \n checksum \n and encrypted with an Key Management Service (KMS) key, you must have permission to use the \n kms:Decrypt
action to retrieve the checksum.
To retrieve the checksum, this mode must be enabled.
\n\n General purpose buckets - In addition, if you enable\n checksum mode and the object is uploaded with a checksum and encrypted with an\n Key Management Service (KMS) key, you must have permission to use the kms:Decrypt
action\n to retrieve the checksum.
This operation is not supported by directory buckets.
\nRetrieves an object's retention settings. For more information, see Locking\n Objects.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe following action is related to GetObjectRetention
:
\n GetObjectAttributes\n
\nThis operation is not supported for directory buckets.
\nRetrieves an object's retention settings. For more information, see Locking\n Objects.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe following action is related to GetObjectRetention
:
\n GetObjectAttributes\n
\nThis operation is not supported by directory buckets.
\nReturns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging
action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging
\n action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\nThe following actions are related to GetObjectTagging
:
\n DeleteObjectTagging\n
\n\n GetObjectAttributes\n
\n\n PutObjectTagging\n
\nThis operation is not supported for directory buckets.
\nReturns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging
action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging
\n action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\nThe following actions are related to GetObjectTagging
:
\n DeleteObjectTagging\n
\n\n GetObjectAttributes\n
\n\n PutObjectTagging\n
\nThis operation is not supported by directory buckets.
\nReturns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.
\nTo use GET, you must have READ access to the object.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe following action is related to GetObjectTorrent
:
\n GetObject\n
\nThis operation is not supported for directory buckets.
\nReturns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.
\nTo use GET, you must have READ access to the object.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe following action is related to GetObjectTorrent
:
\n GetObject\n
\nThis operation is not supported by directory buckets.
\nRetrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock
permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or\n an object, it checks the PublicAccessBlock
configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to GetPublicAccessBlock
:
\n PutPublicAccessBlock\n
\n\n GetPublicAccessBlock\n
\nThis operation is not supported for directory buckets.
\nRetrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock
permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or\n an object, it checks the PublicAccessBlock
configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to GetPublicAccessBlock
:
\n PutPublicAccessBlock\n
\n\n GetPublicAccessBlock\n
\nYou 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\n to access it.
If the bucket does not exist or you do not have permission to access it, the\n HEAD
request returns a generic 400 Bad Request
, 403\n Forbidden
or 404 Not Found
code. A message body is not included, so\n you cannot determine the exception beyond these HTTP response codes.
\n General purpose buckets - Request to public buckets that grant the s3:ListBucket permission publicly do not need to be signed. All other HeadBucket
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed. For more information, see REST Authentication.
\n Directory buckets - You must use IAM credentials to authenticate and authorize your access to the HeadBucket
API operation, instead of using the \n temporary security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
\n\n General purpose bucket permissions - To use this operation, you must have permissions to perform the\n s3:ListBucket
action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Managing\n access permissions to your Amazon S3 resources in the Amazon S3 User Guide.
\n Directory bucket permissions -\n You must have the \n s3express:CreateSession
\n permission in the\n Action
element of a policy. By default, the session is in the ReadWrite
mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode
condition key to ReadOnly
on the bucket.
For more information about example bucket policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.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-az_id.region.amazonaws.com
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
You can use this operation to determine if a bucket exists and if you have permission to\n access it. The action returns a 200 OK
if the bucket exists and you have\n permission to access it.
If the bucket does not exist or you do not have permission to access it, the\n HEAD
request returns a generic 400 Bad Request
, 403\n Forbidden
or 404 Not Found
code. A message body is not included,\n so you cannot determine the exception beyond these HTTP response codes.
\n General purpose buckets - Request to public\n buckets that grant the s3:ListBucket permission publicly do not need to be signed.\n All other HeadBucket
requests must be authenticated and signed by\n using IAM credentials (access key ID and secret access key for the IAM\n identities). All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed. For more information, see\n REST Authentication.
\n Directory buckets - You must use IAM\n credentials to authenticate and authorize your access to the\n HeadBucket
API operation, instead of using the temporary security\n credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your\n behalf.
\n\n General purpose bucket permissions - To\n use this operation, you must have permissions to perform the\n s3:ListBucket
action. The bucket owner has this permission\n by default and can grant this permission to others. For more information\n about permissions, see Managing access\n permissions to your Amazon S3 resources in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n You must have the \n s3express:CreateSession
\n permission in the\n Action
element of a policy. By default, the session is in\n the ReadWrite
mode. If you want to restrict the access, you can\n explicitly set the s3express:SessionMode
condition key to\n ReadOnly
on the bucket.
For more information about example bucket policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for\n S3 Express One Zone in the Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.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-az_id.region.amazonaws.com
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The name of the location where the bucket will be created.
\nFor directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example AZ ID value is usw2-az1
.
This functionality is only supported by directory buckets.
\nThe name of the location where the bucket will be created.
\nFor directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example\n AZ ID value is usw2-az1
.
This functionality is only supported by directory buckets.
\nThe bucket name.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\n\n 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
Access points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\n\n 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. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError
is returned. \nFor more information about InvalidAccessPointAliasError
, see List of\n Error Codes.
Access points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The HEAD
operation retrieves metadata from an object without returning the\n 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\n object. The response is identical to the GET
response except that there is no\n response body. Because of this, if the HEAD
request generates an error, it\n returns a generic code, such as 400 Bad Request
, 403 Forbidden
, 404 Not\n Found
, 405 Method Not Allowed
, 412 Precondition Failed
, or 304 Not Modified
. \n 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\n Request Headers.
\n\n General purpose bucket permissions - To\n use HEAD
, you must have the s3:GetObject
permission. You need the relevant read object (or version) permission for this operation.\n For more information, see Actions, resources, and condition\n keys for Amazon S3 in the Amazon S3\n 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\n 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\n returns an HTTP status code 404 Not Found
error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns\n an HTTP status code 403 Forbidden
error.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If you enable x-amz-checksum-mode
in the request and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption
,\n should not be sent for HEAD
requests if your object uses server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side\n encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3\n managed encryption keys (SSE-S3). The x-amz-server-side-encryption
header is used when you PUT
an object to S3 and want to specify the encryption method. \n If you include this header in a HEAD
request for an object that uses these types of keys, \n you’ll get an HTTP 400 Bad Request
error. It's because the encryption method can't be changed when you retrieve the object.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n 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:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the Amazon S3\n User Guide.
\n\n 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\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
\nIf the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
If the specified version is a delete marker, the response returns a 405 Method Not Allowed
error and the Last-Modified: timestamp
response header.
\n Directory buckets - Delete marker is not supported by directory buckets.
\n\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
\n to the versionId
query parameter in the request.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The following actions are related to HeadObject
:
\n GetObject\n
\n\n GetObjectAttributes\n
\nThe HEAD
operation retrieves metadata from an object without returning the\n object itself. This operation is useful if you're interested only in an object's\n metadata.
A HEAD
request has the same options as a GET
operation on\n an object. The response is identical to the GET
response except that there\n is no response body. Because of this, if the HEAD
request generates an\n error, it returns a generic code, such as 400 Bad Request
, 403\n Forbidden
, 404 Not Found
, 405 Method Not Allowed
,\n 412 Precondition Failed
, or 304 Not Modified
. It's not\n possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common\n Request Headers.
\n\n General purpose bucket permissions - To\n use HEAD
, you must have the s3:GetObject
\n permission. You need the relevant read object (or version) permission for\n this operation. For more information, see Actions, resources, and\n condition keys for Amazon S3 in the Amazon S3 User\n Guide. For more information about the permissions to S3 API\n operations by S3 resource types, see Required permissions for Amazon S3 API operations in the\n Amazon S3 User Guide.
If the object you request doesn't exist, the error that Amazon S3 returns\n depends on whether you also have the s3:ListBucket
\n permission.
If you have the s3:ListBucket
permission on the\n bucket, Amazon S3 returns an HTTP status code 404 Not Found
\n error.
If you don’t have the s3:ListBucket
permission, Amazon S3\n returns an HTTP status code 403 Forbidden
error.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If you enable x-amz-checksum-mode
in the request and the\n object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must\n also have the kms:GenerateDataKey
and kms:Decrypt
\n permissions in IAM identity-based policies and KMS key policies for the\n KMS key to retrieve the checksum of the object.
Encryption request headers, like x-amz-server-side-encryption
,\n should not be sent for HEAD
requests if your object uses\n server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side\n encryption with Amazon S3 managed encryption keys (SSE-S3). The\n x-amz-server-side-encryption
header is used when you\n PUT
an object to S3 and want to specify the encryption method.\n If you include this header in a HEAD
request for an object that\n uses these types of keys, you’ll get an HTTP 400 Bad Request
\n error. It's because the encryption method can't be changed when you retrieve\n the object.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve\n the metadata from the object, you must use the following headers to provide the\n encryption key for the server to be able to retrieve the object's metadata. The\n headers are:
\n\n x-amz-server-side-encryption-customer-algorithm
\n
\n x-amz-server-side-encryption-customer-key
\n
\n x-amz-server-side-encryption-customer-key-MD5
\n
For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\n\n Directory bucket -\n 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\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
\nIf the current version of the object is a delete marker, Amazon S3 behaves as\n if the object was deleted and includes x-amz-delete-marker:\n true
in the response.
If the specified version is a delete marker, the response returns a\n 405 Method Not Allowed
error and the Last-Modified:\n timestamp
response header.
\n Directory buckets -\n Delete marker is not supported for directory buckets.
\n\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null
value of the version ID is supported by directory buckets. You can only specify null
\n to the versionId
query parameter in the request.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
The following actions are related to HeadObject
:
\n GetObject\n
\n\n GetObjectAttributes\n
\nIf the object expiration is configured (see \n PutBucketLifecycleConfiguration
\n ), the response includes\n this header. It includes the expiry-date
and rule-id
key-value\n pairs providing object expiration information. The value of the rule-id
is\n URL-encoded.
This functionality is not supported for directory buckets.
\nIf the object expiration is configured (see \n PutBucketLifecycleConfiguration
\n ), the response includes this\n header. It includes the expiry-date
and rule-id
key-value pairs\n providing object expiration information. The value of the rule-id
is\n URL-encoded.
This functionality is not supported for directory buckets.
\nIf the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
\nIf an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:
\n\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00\n GMT\"
\n
If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
\nThis functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nIf the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
\nIf an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:
\n\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 21 Dec 2012 00:00:00\n GMT\"
\n
If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
\nThis functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe server-side encryption algorithm used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
, aws:kms:dsse
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256
, aws:kms
, aws:kms:dsse
).
If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIndicates whether the object uses an S3 Bucket Key for server-side encryption\n with Key Management Service (KMS) keys (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with\n Key Management Service (KMS) keys (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
\n\n Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nProvides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
\n\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe name of the bucket that contains the object.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket that contains the object.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Return the object only if its entity tag (ETag) is the same as the one specified;\n otherwise, return a 412 (precondition failed) error.
\nIf both of the If-Match
and\n If-Unmodified-Since
headers are present in the request as\n follows:
\n If-Match
condition evaluates to true
, and;
\n If-Unmodified-Since
condition evaluates to\n false
;
Then Amazon S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is the same as the one specified;\n otherwise, return a 412 (precondition failed) error.
\nIf both of the If-Match
and If-Unmodified-Since
headers are\n present in the request as follows:
\n If-Match
condition evaluates to true
, and;
\n If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-Match" } }, "IfModifiedSince": { "target": "com.amazonaws.s3#IfModifiedSince", "traits": { - "smithy.api#documentation": "Return the object only if it has been modified since the specified time; otherwise,\n return a 304 (not modified) error.
\nIf both of the If-None-Match
and\n If-Modified-Since
headers are present in the request as\n follows:
\n If-None-Match
condition evaluates to false
,\n and;
\n If-Modified-Since
condition evaluates to\n true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if it has been modified since the specified time; otherwise,\n return a 304 (not modified) error.
\nIf both of the If-None-Match
and If-Modified-Since
headers are\n present in the request as follows:
\n If-None-Match
condition evaluates to false
, and;
\n If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-Modified-Since" } }, "IfNoneMatch": { "target": "com.amazonaws.s3#IfNoneMatch", "traits": { - "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified;\n otherwise, return a 304 (not modified) error.
\nIf both of the If-None-Match
and\n If-Modified-Since
headers are present in the request as\n follows:
\n If-None-Match
condition evaluates to false
,\n and;
\n If-Modified-Since
condition evaluates to\n true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified;\n otherwise, return a 304 (not modified) error.
\nIf both of the If-None-Match
and If-Modified-Since
headers are\n present in the request as follows:
\n If-None-Match
condition evaluates to false
, and;
\n If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-None-Match" } }, "IfUnmodifiedSince": { "target": "com.amazonaws.s3#IfUnmodifiedSince", "traits": { - "smithy.api#documentation": "Return the object only if it has not been modified since the specified time; otherwise,\n return a 412 (precondition failed) error.
\nIf both of the If-Match
and\n If-Unmodified-Since
headers are present in the request as\n follows:
\n If-Match
condition evaluates to true
, and;
\n If-Unmodified-Since
condition evaluates to\n false
;
Then Amazon S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", + "smithy.api#documentation": "Return the object only if it has not been modified since the specified time; otherwise,\n return a 412 (precondition failed) error.
\nIf both of the If-Match
and If-Unmodified-Since
headers are\n present in the request as follows:
\n If-Match
condition evaluates to true
, and;
\n If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
", "smithy.api#httpHeader": "If-Unmodified-Since" } }, @@ -25303,7 +25340,7 @@ "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use when encrypting the object (for example,\n AES256).
\nThis functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when encrypting the object (for example, AES256).
\nThis functionality is not supported for directory buckets.
\nTo retrieve the checksum, this parameter must be enabled.
\n\n General purpose buckets - If you enable checksum mode and the object is uploaded with a \n checksum \n and encrypted with an Key Management Service (KMS) key, you must have permission to use the \n kms:Decrypt
action to retrieve the checksum.
\n Directory buckets - If you enable ChecksumMode
and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.
To retrieve the checksum, this parameter must be enabled.
\n\n General purpose buckets -\n If you enable checksum mode and the object is uploaded with a\n checksum\n and encrypted with an Key Management Service (KMS) key, you must have permission to use the\n kms:Decrypt
action to retrieve the checksum.
\n Directory buckets - If you enable\n ChecksumMode
and the object is encrypted with Amazon Web Services Key Management Service\n (Amazon Web Services KMS), you must also have the kms:GenerateDataKey
and\n kms:Decrypt
permissions in IAM identity-based policies and KMS key\n policies for the KMS key to retrieve the checksum of the object.
If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the\n principal is an IAM User, it provides a user ARN value.
\n\n Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the\n principal is an IAM User, it provides a user ARN value.
\nIf the principal is an Amazon Web Services account, it provides the Canonical User ID. If the\n principal is an IAM User, it provides a user ARN value.
\n\n Directory buckets - If the principal is an\n Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it\n provides a user ARN value.
\nObject is archived and inaccessible until restored.
\nIf the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the \n S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the \n S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this operation returns an\n InvalidObjectState
error. For information about restoring archived objects,\n see Restoring\n Archived Objects in the Amazon S3 User Guide.
Object is archived and inaccessible until restored.
\nIf the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage\n class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access\n tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you\n must first restore a copy using RestoreObject. Otherwise, this\n operation returns an InvalidObjectState
error. For information about restoring\n archived objects, see Restoring Archived Objects in\n the Amazon S3 User Guide.
You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:
\nCannot specify both a write offset value and user-defined object metadata for existing objects.
\nChecksum Type mismatch occurred, expected checksum Type: sha1, actual checksum Type: crc32c.
\nRequest body cannot be empty when 'write offset' is specified.
\n\n The write offset value that you specified does not match the current object size.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.s3#InventoryConfiguration": { "type": "structure", "members": { @@ -26038,13 +26108,19 @@ "com.amazonaws.s3#LastModified": { "type": "timestamp" }, + "com.amazonaws.s3#LastModifiedTime": { + "type": "timestamp", + "traits": { + "smithy.api#timestampFormat": "http-date" + } + }, "com.amazonaws.s3#LifecycleExpiration": { "type": "structure", "members": { "Date": { "target": "com.amazonaws.s3#Date", "traits": { - "smithy.api#documentation": "Indicates at what date the object is to be moved or deleted. The date value must conform\n to the ISO 8601 format. The time is always midnight UTC.
" + "smithy.api#documentation": "Indicates at what date the object is to be moved or deleted. The date value must conform\n to the ISO 8601 format. The time is always midnight UTC.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nIndicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
" + "smithy.api#documentation": "Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nThe Filter
is used to identify objects that a Lifecycle Rule applies to. A\n Filter
must have exactly one of Prefix
, Tag
, or\n And
specified. Filter
is required if the\n LifecycleRule
does not contain a Prefix
element.
The Filter
is used to identify objects that a Lifecycle Rule applies to. A\n Filter
must have exactly one of Prefix
, Tag
, or\n And
specified. Filter
is required if the\n LifecycleRule
does not contain a Prefix
element.
\n Tag
filters are not supported for directory buckets.
Specifies when an Amazon S3 object transitions to a specified storage class.
", + "smithy.api#documentation": "Specifies when an Amazon S3 object transitions to a specified storage class.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nSpecifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.
", + "smithy.api#documentation": "Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nThis tag must exist in the object's tag set in order for the rule to apply.
" + "smithy.api#documentation": "This tag must exist in the object's tag set in order for the rule to apply.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nThe Filter
is used to identify objects that a Lifecycle Rule applies to. A\n Filter
can have exactly one of Prefix
, Tag
, ObjectSizeGreaterThan
, ObjectSizeLessThan
, or\n And
specified. If the Filter
element is left empty, the Lifecycle Rule applies to all objects in the bucket.
The Filter
is used to identify objects that a Lifecycle Rule applies to. A\n Filter
can have exactly one of Prefix
, Tag
,\n ObjectSizeGreaterThan
, ObjectSizeLessThan
, or And
\n specified. If the Filter
element is left empty, the Lifecycle Rule applies to\n all objects in the bucket.
This operation is not supported by directory buckets.
\nLists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. You should always check the IsTruncated
element in the response. If\n there are no more configurations to list, IsTruncated
is set to false. If\n there are more configurations to list, IsTruncated
is set to true, and there\n will be a value in NextContinuationToken
. You use the\n NextContinuationToken
value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET
the next\n page.
To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n ListBucketAnalyticsConfigurations
:
This operation is not supported for directory buckets.
\nLists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. You should always check the IsTruncated
element in the response. If\n there are no more configurations to list, IsTruncated
is set to false. If\n there are more configurations to list, IsTruncated
is set to true, and there\n will be a value in NextContinuationToken
. You use the\n NextContinuationToken
value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET
the next\n page.
To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n ListBucketAnalyticsConfigurations
:
This operation is not supported by directory buckets.
\nLists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to ListBucketIntelligentTieringConfigurations
include:
This operation is not supported for directory buckets.
\nLists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to ListBucketIntelligentTieringConfigurations
include:
This operation is not supported by directory buckets.
\nReturns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated
element in the response. If there are no\n more configurations to list, IsTruncated
is set to false. If there are more\n configurations to list, IsTruncated
is set to true, and there is a value in\n NextContinuationToken
. You use the NextContinuationToken
value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET
the next page.
To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n
\nThe following operations are related to\n ListBucketInventoryConfigurations
:
This operation is not supported for directory buckets.
\nReturns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated
element in the response. If there are no\n more configurations to list, IsTruncated
is set to false. If there are more\n configurations to list, IsTruncated
is set to true, and there is a value in\n NextContinuationToken
. You use the NextContinuationToken
value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET
the next page.
To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n
\nThe following operations are related to\n ListBucketInventoryConfigurations
:
This operation is not supported by directory buckets.
\nLists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated
element in the response. If there are no\n more configurations to list, IsTruncated
is set to false. If there are more\n configurations to list, IsTruncated
is set to true, and there is a value in\n NextContinuationToken
. You use the NextContinuationToken
value\n to continue the pagination of the list by passing the value in\n continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon CloudWatch.
\nThe following operations are related to\n ListBucketMetricsConfigurations
:
This operation is not supported for directory buckets.
\nLists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated
element in the response. If there are no\n more configurations to list, IsTruncated
is set to false. If there are more\n configurations to list, IsTruncated
is set to true, and there is a value in\n NextContinuationToken
. You use the NextContinuationToken
value\n to continue the pagination of the list by passing the value in\n continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon CloudWatch.
\nThe following operations are related to\n ListBucketMetricsConfigurations
:
This operation is not supported by directory buckets.
\nReturns a list of all buckets owned by the authenticated sender of the request. To use\n this operation, you must have the s3:ListAllMyBuckets
permission.
For information about Amazon S3 buckets, see Creating, configuring, and\n working with Amazon S3 buckets.
\nWe strongly recommend using only paginated requests. Unpaginated requests are only supported for \n Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved \n general purpose bucket quota above 10,000, you must send paginated requests to list your account’s buckets. \n All unpaginated ListBuckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota \n greater than 10,000.
\nThis operation is not supported for directory buckets.
\nReturns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use\n this operation, you must add the s3:ListAllMyBuckets
policy action.
For information about Amazon S3 buckets, see Creating, configuring, and\n working with Amazon S3 buckets.
\nWe strongly recommend using only paginated ListBuckets
requests. Unpaginated ListBuckets
requests are only supported for \n Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved \n general purpose bucket quota above 10,000, you must send paginated ListBuckets
requests to list your account’s buckets. \n All unpaginated ListBuckets
requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota \n greater than 10,000.
\n ContinuationToken
is included in the\n response when there are more buckets that can be listed with pagination. The next ListBuckets
request to Amazon S3 can be continued with this ContinuationToken
. ContinuationToken
is obfuscated and is not a real bucket.
\n ContinuationToken
is included in the response when there are more buckets\n that can be listed with pagination. The next ListBuckets
request to Amazon S3 can\n be continued with this ContinuationToken
. ContinuationToken
is\n obfuscated and is not a real bucket.
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.
", + "smithy.api#documentation": "Maximum number of buckets to be returned in response. When the number is more than the\n count of buckets that are owned by an Amazon Web Services account, return all the buckets in\n response.
", "smithy.api#httpQuery": "max-buckets" } }, "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "\n ContinuationToken
indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken
is obfuscated and is not a real\n key. You can use this ContinuationToken
for pagination of the list results.
Length Constraints: Minimum length of 0. Maximum length of 1024.
\nRequired: No.
\nIf you specify the bucket-region
, prefix
, or continuation-token
\n query parameters without using max-buckets
to set the maximum number of buckets returned in the response, \n Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.
\n ContinuationToken
indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken
is obfuscated and is not a real\n key. You can use this ContinuationToken
for pagination of the list results.
Length Constraints: Minimum length of 0. Maximum length of 1024.
\nRequired: No.
\nIf you specify the bucket-region
, prefix
, or continuation-token
\n query parameters without using max-buckets
to set the maximum number of buckets returned in the response, \n Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.
Limits the response to bucket names that begin with the specified bucket name prefix.
", + "smithy.api#documentation": "Limits the response to bucket names that begin with the specified bucket name\n prefix.
", "smithy.api#httpQuery": "prefix" } }, "BucketRegion": { "target": "com.amazonaws.s3#BucketRegion", "traits": { - "smithy.api#documentation": "Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2
for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.
Requests made to a Regional endpoint that is different from the bucket-region
parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2
, the request must be made to an endpoint in Region us-west-2
.
Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services\n Region must be expressed according to the Amazon Web Services Region code, such as us-west-2
\n for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services\n Regions, see Regions and Endpoints.
Requests made to a Regional endpoint that is different from the\n bucket-region
parameter are not supported. For example, if you want to\n limit the response to your buckets in Region us-west-2
, the request must be\n made to an endpoint in Region us-west-2
.
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.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
You must have the s3express:ListAllMyDirectoryBuckets
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
\n 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.
Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the\n request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
You must have the s3express:ListAllMyDirectoryBuckets
permission\n 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.\n 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.
\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com
.
The BucketRegion
response element is not part of the\n ListDirectoryBuckets
Response Syntax.
If ContinuationToken
was sent with the request, it is included in the\n response. You can use the returned ContinuationToken
for pagination of the list response.
If ContinuationToken
was sent with the request, it is included in the\n response. You can use the returned ContinuationToken
for pagination of the\n list response.
\n 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\n bucket name. You can use this ContinuationToken
for the pagination of the list results.
\n ContinuationToken
indicates to Amazon S3 that the list is being continued on\n buckets in this account with a token. ContinuationToken
is obfuscated and is\n not a real bucket name. You can use this ContinuationToken
for the pagination\n of the list results.
Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.
", + "smithy.api#documentation": "Maximum number of buckets to be returned in response. When the number is more than the\n count of buckets that are owned by an Amazon Web Services account, return all the buckets in\n response.
", "smithy.api#httpQuery": "max-directory-buckets" } } @@ -26746,7 +26822,7 @@ "target": "com.amazonaws.s3#ListMultipartUploadsOutput" }, "traits": { - "smithy.api#documentation": "This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a\n multipart upload that has been initiated by the CreateMultipartUpload
request, but\n has not yet been completed or aborted.
\n Directory buckets - \n 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. \n To delete these in-progress multipart uploads, use the ListMultipartUploads
operation to list the in-progress multipart\n uploads in the bucket and use the AbortMultipartUpload
operation to abort all the in-progress multipart uploads.\n
The ListMultipartUploads
operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart\n uploads is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads
request parameter. If there are more than 1,000 multipart uploads that \n satisfy your ListMultipartUploads
request, the response returns an IsTruncated
element\n with the value of true
, a NextKeyMarker
element, and a NextUploadIdMarker
element. \n To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads
requests. \n In these requests, include two query parameters: key-marker
and upload-id-marker
. \n Set the value of key-marker
to the NextKeyMarker
value from the previous response. \n Similarly, set the value of upload-id-marker
to the NextUploadIdMarker
value from the previous response.
\n Directory buckets - The upload-id-marker
element and \n the NextUploadIdMarker
element aren't supported by directory buckets. \n 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\n Upload in the Amazon S3\n User Guide.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload\n and Permissions in the Amazon S3\n User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n 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.
\nTime-based sorting - For uploads that share the same object key, \n 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.
\n\n Directory bucket - In the ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys. \n \n
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to ListMultipartUploads
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThis operation lists in-progress multipart uploads in a bucket. An in-progress multipart\n upload is a multipart upload that has been initiated by the\n CreateMultipartUpload
request, but has not yet been completed or\n aborted.
\n Directory buckets - If multipart uploads in\n a directory bucket are in progress, you can't delete the bucket until all the\n in-progress multipart uploads are aborted or completed. To delete these in-progress\n multipart uploads, use the ListMultipartUploads
operation to list the\n in-progress multipart uploads in the bucket and use the\n AbortMultipartUpload
operation to abort all the in-progress multipart\n uploads.
The ListMultipartUploads
operation returns a maximum of 1,000 multipart\n uploads in the response. The limit of 1,000 multipart uploads is also the default value.\n You can further limit the number of uploads in a response by specifying the\n max-uploads
request parameter. If there are more than 1,000 multipart\n uploads that satisfy your ListMultipartUploads
request, the response returns\n an IsTruncated
element with the value of true
, a\n NextKeyMarker
element, and a NextUploadIdMarker
element. To\n list the remaining multipart uploads, you need to make subsequent\n ListMultipartUploads
requests. In these requests, include two query\n parameters: key-marker
and upload-id-marker
. Set the value of\n key-marker
to the NextKeyMarker
value from the previous\n response. Similarly, set the value of upload-id-marker
to the\n NextUploadIdMarker
value from the previous response.
\n Directory buckets - The\n upload-id-marker
element and the NextUploadIdMarker
element\n aren't supported by directory buckets. To list the additional multipart uploads, you\n only need to set the value of key-marker
to the NextKeyMarker
\n value from the previous response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - In the\n ListMultipartUploads
response, the multipart uploads are\n sorted based on two criteria:
Key-based sorting - Multipart uploads are initially sorted\n in ascending order based on their object keys.
\nTime-based sorting - For uploads that share the same object\n key, they are further sorted in ascending order based on the upload\n initiation time. Among uploads with the same key, the one that was\n initiated first will appear before the ones that were initiated\n later.
\n\n Directory bucket - In the\n ListMultipartUploads
response, the multipart uploads aren't\n sorted lexicographically based on the object keys.\n \n
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to ListMultipartUploads
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nTogether with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker
.
This functionality is not supported for directory buckets.
\nTogether with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker
.
This functionality is not supported for directory buckets.
\nThe name of the bucket to which the multipart upload was initiated.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket to which the multipart upload was initiated.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Specifies the multipart upload after which listing should begin.
\n\n General purpose buckets - For general purpose buckets, key-marker
\n is an object key. Together with upload-id-marker
, this parameter specifies the multipart\n upload after which listing should begin.
If upload-id-marker
is not specified, only the keys lexicographically\n greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to\n the key-marker
might also be included, provided those multipart uploads have\n upload IDs lexicographically greater than the specified\n upload-id-marker
.
\n Directory buckets - For directory buckets, key-marker
\n is obfuscated and isn't a real object key. \n The upload-id-marker
parameter isn't supported by directory buckets. \n To list the additional multipart uploads, you only need to set the value of key-marker
to the NextKeyMarker
value from the previous response. \n
In the ListMultipartUploads
response, the multipart uploads aren't sorted lexicographically based on the object keys. \n \n
Specifies the multipart upload after which listing should begin.
\n\n General purpose buckets - For\n general purpose buckets, key-marker
is an object key. Together with\n upload-id-marker
, this parameter specifies the multipart upload\n after which listing should begin.
If upload-id-marker
is not specified, only the keys\n lexicographically greater than the specified key-marker
will be\n included in the list.
If upload-id-marker
is specified, any multipart uploads for a key\n equal to the key-marker
might also be included, provided those\n multipart uploads have upload IDs lexicographically greater than the specified\n upload-id-marker
.
\n Directory buckets - For\n directory buckets, key-marker
is obfuscated and isn't a real object\n key. The upload-id-marker
parameter isn't supported by\n directory buckets. To list the additional multipart uploads, you only need to set\n the value of key-marker
to the NextKeyMarker
value from\n the previous response.
In the ListMultipartUploads
response, the multipart uploads aren't\n sorted lexicographically based on the object keys.\n \n
This operation is not supported by directory buckets.
\nReturns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\n To use this operation, you must have permission to perform the\n s3:ListBucketVersions
action. Be aware of the name difference.
A 200 OK
response can contain valid or invalid XML. Make sure to design\n your application to parse the contents of the response and handle it\n appropriately.
To use this operation, you must have READ access to the bucket.
\nThe following operations are related to ListObjectVersions
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nThis operation is not supported for directory buckets.
\nReturns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\n To use this operation, you must have permission to perform the\n s3:ListBucketVersions
action. Be aware of the name difference.
A 200 OK
response can contain valid or invalid XML. Make sure to design\n your application to parse the contents of the response and handle it\n appropriately.
To use this operation, you must have READ access to the bucket.
\nThe following operations are related to ListObjectVersions
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nThis operation is not supported by directory buckets.
\nReturns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.
\nThis action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility,\n Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\n\n ListBuckets\n
\nThis operation is not supported for directory buckets.
\nReturns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.
\nThis action has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility,\n Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\n\n ListBuckets\n
\nThe name of the bucket containing the objects.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket containing the objects.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Returns some or all (up to 1,000) of the objects in a bucket with each request. You can\n use the request parameters as selection criteria to return a subset of the objects in a\n bucket. A 200 OK
response can contain valid or invalid XML. Make sure to\n design your application to parse the contents of the response and handle it appropriately.\n \n For more information about listing objects, see Listing object keys\n programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.
\n General purpose bucket - For general purpose buckets, ListObjectsV2
doesn't return prefixes that are related only to in-progress multipart uploads.
\n Directory buckets - \n For directory buckets, ListObjectsV2
response includes the prefixes that are related only to in-progress multipart uploads.\n
\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - To use this operation, you must have READ access to the bucket. You must have permission to perform\n the s3:ListBucket
action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - For general purpose buckets, ListObjectsV2
returns objects in lexicographical order based on their key names.
\n Directory bucket - For directory buckets, ListObjectsV2
does not return objects in lexicographical order.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
This section describes the latest revision of this action. We recommend that you use\n this revised API operation for application development. For backward compatibility, Amazon S3\n continues to support the prior version of this API operation, ListObjects.
\nThe following operations are related to ListObjectsV2
:
\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\nReturns some or all (up to 1,000) of the objects in a bucket with each request. You can\n use the request parameters as selection criteria to return a subset of the objects in a\n bucket. A 200 OK
response can contain valid or invalid XML. Make sure to\n design your application to parse the contents of the response and handle it appropriately.\n For more information about listing objects, see Listing object keys\n programmatically in the Amazon S3 User Guide. To get a list of\n your buckets, see ListBuckets.
\n General purpose bucket - For general purpose buckets,\n ListObjectsV2
doesn't return prefixes that are related only to\n in-progress multipart uploads.
\n Directory buckets - For\n directory buckets, ListObjectsV2
response includes the prefixes that\n are related only to in-progress multipart uploads.
\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - To\n use this operation, you must have READ access to the bucket. You must have\n permission to perform the s3:ListBucket
action. The bucket\n owner has this permission by default and can grant this permission to\n others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access\n Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n General purpose bucket - For\n general purpose buckets, ListObjectsV2
returns objects in\n lexicographical order based on their key names.
\n Directory bucket - For\n directory buckets, ListObjectsV2
does not return objects in\n lexicographical order.
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
This section describes the latest revision of this action. We recommend that you use\n this revised API operation for application development. For backward compatibility, Amazon S3\n continues to support the prior version of this API operation, ListObjects.
\nThe following operations are related to ListObjectsV2
:
\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\nAll 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, \n this group of keys is considered as one item.
\nA response can contain CommonPrefixes
only if you specify a\n delimiter.
\n CommonPrefixes
contains all (if there are any) keys between\n Prefix
and the next occurrence of the string specified by a\n delimiter.
\n CommonPrefixes
lists keys that act like subdirectories in the directory\n specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash\n (/
) as in notes/summer/july
, the common prefix is\n notes/summer/
. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.
\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/
) are supported.
\n Directory buckets - When you query ListObjectsV2
with a delimiter during in-progress multipart uploads, the \n CommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. \n For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
All of the keys (up to 1,000) that share the same prefix are grouped together. When\n counting the total numbers of returns by this API operation, this group of keys is\n considered as one item.
\nA response can contain CommonPrefixes
only if you specify a\n delimiter.
\n CommonPrefixes
contains all (if there are any) keys between\n Prefix
and the next occurrence of the string specified by a\n delimiter.
\n CommonPrefixes
lists keys that act like subdirectories in the directory\n specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash\n (/
) as in notes/summer/july
, the common prefix is\n notes/summer/
. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.
\n Directory buckets - For directory buckets, only prefixes that end in a delimiter (/
) are supported.
\n Directory buckets - When you query\n ListObjectsV2
with a delimiter during in-progress multipart\n uploads, the CommonPrefixes
response parameter contains the prefixes\n that are associated with the in-progress multipart uploads. For more information\n about multipart uploads, see Multipart Upload Overview in\n the Amazon S3 User Guide.
If ContinuationToken
was sent with the request, it is included in the\n response. You can use the returned ContinuationToken
for pagination of the list response. You can use this ContinuationToken
for pagination of the list results.
If ContinuationToken
was sent with the request, it is included in the\n response. You can use the returned ContinuationToken
for pagination of the\n list response. You can use this ContinuationToken
for pagination of the list\n results.
\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
A delimiter is a character that you use to group keys.
\n\n Directory buckets - For directory buckets, /
is the only supported delimiter.
\n Directory buckets - When you query ListObjectsV2
with a delimiter during in-progress multipart uploads, the \n CommonPrefixes
response parameter contains the prefixes that are associated with the in-progress multipart uploads. \n For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
A delimiter is a character that you use to group keys.
\n\n Directory buckets - For directory buckets, /
is the only supported delimiter.
\n Directory buckets - When you query\n ListObjectsV2
with a delimiter during in-progress multipart\n uploads, the CommonPrefixes
response parameter contains the prefixes\n that are associated with the in-progress multipart uploads. For more information\n about multipart uploads, see Multipart Upload Overview in\n the Amazon S3 User Guide.
Encoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.
\nWhen using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png
will appear as\n test_file%283%29.png
.
Encoding type used by Amazon S3 to encode the object keys in the response.\n Responses are encoded only in UTF-8. An object key can contain any Unicode character.\n However, the XML 1.0 parser can't parse certain characters, such as characters with an\n ASCII value from 0 to 10. For characters that aren't supported in XML 1.0, you can add this\n parameter to request that Amazon S3 encode the keys in the response. For more information about\n characters to avoid in object key names, see Object key naming\n guidelines.
\nWhen using the URL encoding type, non-ASCII characters that are used in an object's\n key name will be percent-encoded according to UTF-8 code values. For example, the object\n test_file(3).png
will appear as\n test_file%283%29.png
.
\n ContinuationToken
indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken
is obfuscated and is not a real\n key. You can use this ContinuationToken
for pagination of the list results.
\n ContinuationToken
indicates to Amazon S3 that the list is being continued on\n this bucket with a token. ContinuationToken
is obfuscated and is not a real\n key. You can use this ContinuationToken
for pagination of the list results.\n
The owner field is not present in ListObjectsV2
by default. If you want to\n return the owner field with each key in the result, then set the FetchOwner
\n field to true
.
\n Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.
\nThe owner field is not present in ListObjectsV2
by default. If you want to\n return the owner field with each key in the result, then set the FetchOwner
\n field to true
.
\n Directory buckets - For directory buckets,\n the bucket owner is returned as the object owner for all objects.
\nLists the parts that have been uploaded for a specific multipart upload.
\nTo use this operation, you must provide the upload ID
in the request. You obtain this uploadID by sending the initiate multipart upload\n 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\n max-parts
request parameter. If your multipart upload consists of more than\n 1,000 parts, the response returns an IsTruncated
field with the value of true
,\n and a NextPartNumberMarker
element. To list remaining uploaded parts, in subsequent ListParts
\n requests, include the part-number-marker
query string parameter and set its value to\n the NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3\n User Guide.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload\n and Permissions in the Amazon S3\n User Guide.
\nIf the upload was created using server-side encryption with Key Management Service (KMS) keys\n (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission\n to the kms:Decrypt
action for the ListParts
request to succeed.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to ListParts
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n GetObjectAttributes\n
\n\n ListMultipartUploads\n
\nLists the parts that have been uploaded for a specific multipart upload.
\nTo use this operation, you must provide the upload ID
in the request. You\n 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\n of 1,000 parts is also the default value. You can restrict the number of parts in a\n response by specifying the max-parts
request parameter. If your multipart\n upload consists of more than 1,000 parts, the response returns an IsTruncated
\n field with the value of true
, and a NextPartNumberMarker
element.\n To list remaining uploaded parts, in subsequent ListParts
requests, include\n the part-number-marker
query string parameter and set its value to the\n NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - For\n information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\nIf the upload was created using server-side encryption with Key Management Service\n (KMS) keys (SSE-KMS) or dual-layer server-side encryption with\n Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the\n kms:Decrypt
action for the ListParts
request to\n succeed.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to ListParts
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n GetObjectAttributes\n
\n\n ListMultipartUploads\n
\nContainer for elements related to a particular part. A response can contain zero or\n more Part
elements.
Container for elements related to a particular part. A response can contain zero or more\n Part
elements.
Container element that identifies the object owner, after the object is created. If\n multipart upload is initiated by an IAM user, this element provides the parent account ID\n and display name.
\n\n Directory buckets - The bucket owner is returned as the object owner for all the parts.
\nContainer element that identifies the object owner, after the object is created. If\n multipart upload is initiated by an IAM user, this element provides the parent account ID\n and display name.
\n\n Directory buckets - The bucket owner is\n returned as the object owner for all the parts.
\nThe class of storage used to store the uploaded\n object.
\n\n Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe class of storage used to store the uploaded object.
\n\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe name of the bucket to which the parts are being uploaded.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket to which the parts are being uploaded.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the location where the bucket will be created.
\nFor directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1
.
The name of the location where the bucket will be created.
\nFor directory buckets, the name of the location is the AZ ID of the Availability Zone where the\n bucket will be created. An example AZ ID value is usw2-az1
.
Specifies the location where the bucket will be created.
\nFor directory buckets, the location type is Availability Zone. For more information about directory buckets, see \n Directory buckets in the Amazon S3 User Guide.
\nThis functionality is only supported by directory buckets.
\nSpecifies the location where the bucket will be created.
\nFor directory buckets, the location type is Availability Zone. For more information about\n directory buckets, see Directory buckets in the Amazon S3 User Guide.
\nThis functionality is only supported by directory buckets.
\nThe class of storage used to store the object.
\n\n Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe class of storage used to store the object.
\n\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nSpecifies the owner of the object that is part of the multipart upload.
\n\n Directory buckets - The bucket owner is returned as the object owner for all the objects.
\nSpecifies the owner of the object that is part of the multipart upload.
\n\n Directory buckets - The bucket owner is\n returned as the object owner for all the objects.
\nSpecifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. The value must be a non-zero positive integer. For information about the\n noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. The value must be a non-zero positive integer. For information about the\n noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nSpecifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100\n noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent\n versions beyond the specified number to retain. For more information about noncurrent\n versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100\n noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent\n versions beyond the specified number to retain. For more information about noncurrent\n versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nSpecifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n deletes the noncurrent object versions. You set this lifecycle configuration action on a\n bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n object versions at a specific period in the object's lifetime.
" + "smithy.api#documentation": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n deletes the noncurrent object versions. You set this lifecycle configuration action on a\n bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n object versions at a specific period in the object's lifetime.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\nThe class of storage used to store the object.
\n\n Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe class of storage used to store the object.
\n\n Directory buckets -\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThe owner of the object
\n\n Directory buckets - The bucket owner is returned as the object owner.
\nThe owner of the object
\n\n Directory buckets - The bucket owner is\n returned as the object owner.
\nSpecifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nSpecifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nVersion ID for the specific version of the object to delete.
\nThis functionality is not supported for directory buckets.
\nAn entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL.\n This header field makes the request method conditional on ETags
.
Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.
\nIf present, the objects are deleted only if its modification times matches the provided Timestamp
. \n
This functionality is only supported for directory buckets.
\nIf present, the objects are deleted only if its size matches the provided size in bytes.
\nThis functionality is only supported for directory buckets.
\nThe container element for object ownership for a bucket's ownership controls.
\n\n BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control
canned\n ACL.
\n ObjectWriter
- The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control
canned ACL.
\n BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no longer affect\n permissions. The bucket owner automatically owns and has full control over every object in\n the bucket. The bucket only accepts PUT requests that don't specify an ACL or specify bucket owner\n full control ACLs (such as the predefined bucket-owner-full-control
canned ACL or a custom ACL \n in XML format that grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and ACLs are disabled. We recommend\n 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\n Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.\n
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
\nThe container element for object ownership for a bucket's ownership controls.
\n\n BucketOwnerPreferred
- Objects uploaded to the bucket change ownership to\n the bucket owner if the objects are uploaded with the\n bucket-owner-full-control
canned ACL.
\n ObjectWriter
- The uploading account will own the object if the object is\n uploaded with the bucket-owner-full-control
canned ACL.
\n BucketOwnerEnforced
- Access control lists (ACLs) are disabled and no\n longer affect permissions. The bucket owner automatically owns and has full control over\n every object in the bucket. The bucket only accepts PUT requests that don't specify an ACL\n or specify bucket owner full control ACLs (such as the predefined\n bucket-owner-full-control
canned ACL or a custom ACL in XML format that\n grants the same permissions).
By default, ObjectOwnership
is set to BucketOwnerEnforced
and\n ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where\n you must control access for each object individually. For more information about S3 Object\n Ownership, see Controlling ownership of\n objects and disabling ACLs for your bucket in the\n Amazon S3 User Guide.
This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.
\nSpecifies the partition date source for the partitioned prefix.\n PartitionDateSource
can be EventTime
or\n DeliveryTime
.
For DeliveryTime
, the time in the log file names corresponds to the\n delivery time for the log files.
For EventTime
, The logs delivered are for a specific day only. The year,\n month, and day correspond to the day on which the event occurred, and the hour, minutes and\n seconds are set to 00 in the key.
Specifies the partition date source for the partitioned prefix.\n PartitionDateSource
can be EventTime
or\n DeliveryTime
.
For DeliveryTime
, the time in the log file names corresponds to the\n delivery time for the log files.
For EventTime
, The logs delivered are for a specific day only. The year,\n month, and day correspond to the day on which the event occurred, and the hour, minutes and\n seconds are set to 00 in the key.
Amazon S3 keys for log objects are partitioned in the following format:
\n\n [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
\n
PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.
", + "smithy.api#documentation": "Amazon S3 keys for log objects are partitioned in the following format:
\n\n [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
\n
PartitionedPrefix defaults to EventTime delivery when server access logs are\n delivered.
", "smithy.api#xmlName": "PartitionedPrefix" } }, @@ -29508,7 +29602,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nSets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.
\n To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The Transfer Acceleration state of a bucket can be set to one of the following two\n values:
\nEnabled – Enables accelerated data transfers to the bucket.
\nSuspended – Disables accelerated data transfers to the bucket.
\nThe GetBucketAccelerateConfiguration action returns the transfer acceleration state\n of a bucket.
\nAfter setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.
\nThe name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").
\nFor more information about transfer acceleration, see Transfer\n Acceleration.
\nThe following operations are related to\n PutBucketAccelerateConfiguration
:
\n CreateBucket\n
\nThis operation is not supported for directory buckets.
\nSets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.
\n To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The Transfer Acceleration state of a bucket can be set to one of the following two\n values:
\nEnabled – Enables accelerated data transfers to the bucket.
\nSuspended – Disables accelerated data transfers to the bucket.
\nThe GetBucketAccelerateConfiguration action returns the transfer acceleration state\n of a bucket.
\nAfter setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.
\nThe name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").
\nFor more information about transfer acceleration, see Transfer\n Acceleration.
\nThe following operations are related to\n PutBucketAccelerateConfiguration
:
\n CreateBucket\n
\nThis operation is not supported by directory buckets.
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have the WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported
error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions by using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3\n supports a set of predefined ACLs, known as canned\n ACLs. Each canned ACL has a predefined set of grantees and\n permissions. Specify the canned ACL name as the value of\n x-amz-acl
. If you use this header, you cannot use other\n access control-specific headers in your request. For more information, see\n Canned\n ACL.
Specify access permissions explicitly with the\n x-amz-grant-read
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers,\n you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3\n groups) who will receive the permission. If you use these ACL-specific\n headers, you cannot use the x-amz-acl
header to set a canned\n ACL. These parameters map to the set of permissions that Amazon S3 supports in an\n ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write
header grants\n create, overwrite, and delete objects permission to LogDelivery group\n predefined by Amazon S3 and two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-write:\n uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\",\n id=\"555566667777\"
\n
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nYou can specify the person (grantee) to whom you're assigning access rights\n (using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET\n Object acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe following operations are related to PutBucketAcl
:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nThis operation is not supported for directory buckets.
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have the WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported
error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions by using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3\n supports a set of predefined ACLs, known as canned\n ACLs. Each canned ACL has a predefined set of grantees and\n permissions. Specify the canned ACL name as the value of\n x-amz-acl
. If you use this header, you cannot use other\n access control-specific headers in your request. For more information, see\n Canned\n ACL.
Specify access permissions explicitly with the\n x-amz-grant-read
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers,\n you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3\n groups) who will receive the permission. If you use these ACL-specific\n headers, you cannot use the x-amz-acl
header to set a canned\n ACL. These parameters map to the set of permissions that Amazon S3 supports in an\n ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write
header grants\n create, overwrite, and delete objects permission to LogDelivery group\n predefined by Amazon S3 and two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-write:\n uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\",\n id=\"555566667777\"
\n
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nYou can specify the person (grantee) to whom you're assigning access rights\n (using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET\n Object acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe following operations are related to PutBucketAcl
:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nThis operation is not supported by directory buckets.
\nSets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.
\nYou can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport
request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3\n Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n PutBucketAnalyticsConfiguration
has the following special errors:
\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: InvalidArgument\n
\n\n Cause: Invalid argument.\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: TooManyConfigurations\n
\n\n Cause: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.\n
\n\n HTTP Error: HTTP 403 Forbidden\n
\n\n Code: AccessDenied\n
\n\n Cause: You are not the owner of the specified bucket, or you do\n not have the s3:PutAnalyticsConfiguration bucket permission to set the\n configuration on the bucket.\n
\nThe following operations are related to\n PutBucketAnalyticsConfiguration
:
This operation is not supported for directory buckets.
\nSets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.
\nYou can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport
request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3\n Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n PutBucketAnalyticsConfiguration
has the following special errors:
\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: InvalidArgument\n
\n\n Cause: Invalid argument.\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: TooManyConfigurations\n
\n\n Cause: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.\n
\n\n HTTP Error: HTTP 403 Forbidden\n
\n\n Code: AccessDenied\n
\n\n Cause: You are not the owner of the specified bucket, or you do\n not have the s3:PutAnalyticsConfiguration bucket permission to set the\n configuration on the bucket.\n
\nThe following operations are related to\n PutBucketAnalyticsConfiguration
:
This operation is not supported by directory buckets.
\nSets the cors
configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
\n 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\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com
to access your Amazon S3 bucket at\n my.example.bucket.com
by using the browser's XMLHttpRequest
\n capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors
subresource to the bucket. The cors
subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n 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\n bucket, it evaluates the cors
configuration on the bucket and uses the first\n CORSRule
rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin
header must match AllowedOrigin
\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method
header in case of a pre-flight\n OPTIONS
request must be one of the AllowedMethod
\n elements.
Every header specified in the Access-Control-Request-Headers
request\n header of a pre-flight request must match an AllowedHeader
element.\n
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\nThe following operations are related to PutBucketCors
:
\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nThis operation is not supported for directory buckets.
\nSets the cors
configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
\n 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\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com
to access your Amazon S3 bucket at\n my.example.bucket.com
by using the browser's XMLHttpRequest
\n capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors
subresource to the bucket. The cors
subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n 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\n bucket, it evaluates the cors
configuration on the bucket and uses the first\n CORSRule
rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin
header must match AllowedOrigin
\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method
header in case of a pre-flight\n OPTIONS
request must be one of the AllowedMethod
\n elements.
Every header specified in the Access-Control-Request-Headers
request\n header of a pre-flight request must match an AllowedHeader
element.\n
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\nThe following operations are related to PutBucketCors
:
\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nThis operation configures default encryption \n and Amazon S3 Bucket Keys for an existing bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
By default, all buckets have a default encryption configuration that uses server-side\n encryption with Amazon S3 managed keys (SSE-S3).
\n\n General purpose buckets\n
\nYou can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or\n dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). \n If you specify default encryption by using\n SSE-KMS, you can also configure Amazon S3 Bucket\n Keys. For information about the bucket default\n encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.\n
\nIf 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.
\n\n Directory buckets - You can optionally configure default encryption\n for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
\nWe recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n 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. \nThe Amazon Web Services managed key (aws/s3
) isn't supported. \n
S3 Bucket Keys are always enabled for GET
and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n 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.
\nFor 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.
\nIf you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.
\nAlso, this action requires Amazon Web Services Signature Version 4. For more information, see \n Authenticating Requests (Amazon Web Services Signature Version 4).
\n\n General purpose bucket permissions - The s3:PutEncryptionConfiguration
permission is required in a policy. \n The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
\n Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey
and the kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the target KMS key.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to PutBucketEncryption
:
\n GetBucketEncryption\n
\nThis operation configures default encryption and Amazon S3 Bucket Keys for an existing\n bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
By default, all buckets have a default encryption configuration that uses server-side\n encryption with Amazon S3 managed keys (SSE-S3).
\n\n General purpose buckets\n
\nYou can optionally configure default encryption for a bucket by using\n server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer\n server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify\n default encryption by using SSE-KMS, you can also configure Amazon S3\n Bucket Keys. For information about the bucket default encryption\n feature, see Amazon S3 Bucket Default\n Encryption in the Amazon S3 User Guide.
\nIf you use PutBucketEncryption to set your default bucket\n encryption to SSE-KMS, you should verify that your KMS key ID\n is correct. Amazon S3 doesn't validate the KMS key ID provided in\n PutBucketEncryption requests.
\n\n Directory buckets - You can\n optionally configure default encryption for a bucket by using server-side\n encryption with Key Management Service (KMS) keys (SSE-KMS).
\nWe recommend that the bucket's default encryption uses the desired\n encryption configuration and you don't override the bucket default\n encryption in your CreateSession
requests or PUT
\n object requests. Then, new objects are automatically encrypted with the\n desired encryption settings.\n 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. \nThe Amazon Web Services managed key (aws/s3
) isn't supported. \n
S3 Bucket Keys are always enabled for GET
and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n 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.
\nFor directory buckets, if you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, Amazon S3 validates the\n KMS key ID provided in PutBucketEncryption requests.
\nIf you're specifying a customer managed KMS key, we recommend using a fully\n qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the\n key within the requester’s account. This behavior can result in data that's encrypted\n with a KMS key that belongs to the requester, and not the bucket owner.
\nAlso, this action requires Amazon Web Services Signature Version 4. For more information, see\n Authenticating\n Requests (Amazon Web Services Signature Version 4).
\n\n General purpose bucket permissions - The\n s3:PutEncryptionConfiguration
permission is required in a\n policy. The bucket owner has this permission by default. The bucket owner\n can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Operations and Managing Access\n Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:PutEncryptionConfiguration
permission in\n 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.\n 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\n have the kms:GenerateDataKey
and the kms:Decrypt
\n permissions in IAM identity-based policies and KMS key policies for the\n target KMS key.
\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to PutBucketEncryption
:
\n GetBucketEncryption\n
\nThis operation is not supported by directory buckets.
\nPuts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to\n 1,000 S3 Intelligent-Tiering configurations per bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to PutBucketIntelligentTieringConfiguration
include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access\n or Deep Archive Access tier.
\n\n PutBucketIntelligentTieringConfiguration
has the following special\n errors:
\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n Cause: You are not the owner of the specified bucket, or\n you do not have the s3:PutIntelligentTieringConfiguration
bucket\n permission to set the configuration on the bucket.
This operation is not supported for directory buckets.
\nPuts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to\n 1,000 S3 Intelligent-Tiering configurations per bucket.
\nThe 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.
\nThe 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to PutBucketIntelligentTieringConfiguration
include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access\n or Deep Archive Access tier.
\n\n PutBucketIntelligentTieringConfiguration
has the following special\n errors:
\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n Cause: You are not the owner of the specified bucket, or\n you do not have the s3:PutIntelligentTieringConfiguration
bucket\n permission to set the configuration on the bucket.
This operation is not supported by directory buckets.
\nThis implementation of the PUT
action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same Amazon Web Services Region as the\n source bucket.
\nWhen you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3 Inventory in the\n Amazon S3 User Guide.
\nYou must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permission to perform the\n s3:PutInventoryConfiguration
action. The bucket owner has this\n permission by default and can grant this permission to others.
The s3:PutInventoryConfiguration
permission allows a user to\n create an S3 Inventory\n report that includes all object metadata fields available and to specify the\n destination bucket to store the inventory. A user with read access to objects in\n the destination bucket can also access all object metadata fields that are\n available in the inventory report.
To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the\n Amazon S3 User Guide. For more information about the metadata\n fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For\n more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the\n Amazon S3 User Guide.
\n\n PutBucketInventoryConfiguration
has the following special errors:
\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n Cause: You are not the owner of the specified bucket, or\n you do not have the s3:PutInventoryConfiguration
bucket permission to\n set the configuration on the bucket.
The following operations are related to\n PutBucketInventoryConfiguration
:
This operation is not supported for directory buckets.
\nThis implementation of the PUT
action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same Amazon Web Services Region as the\n source bucket.
\nWhen you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3 Inventory in the\n Amazon S3 User Guide.
\nYou must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permission to perform the\n s3:PutInventoryConfiguration
action. The bucket owner has this\n permission by default and can grant this permission to others.
The s3:PutInventoryConfiguration
permission allows a user to\n create an S3 Inventory\n report that includes all object metadata fields available and to specify the\n destination bucket to store the inventory. A user with read access to objects in\n the destination bucket can also access all object metadata fields that are\n available in the inventory report.
To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the\n Amazon S3 User Guide. For more information about the metadata\n fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For\n more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the\n Amazon S3 User Guide.
\n\n PutBucketInventoryConfiguration
has the following special errors:
\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n Cause: You are not the owner of the specified bucket, or\n you do not have the s3:PutInventoryConfiguration
bucket permission to\n set the configuration on the bucket.
The following operations are related to\n PutBucketInventoryConfiguration
:
This operation is not supported by directory buckets.
\nCreates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3\n Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.
\nBucket 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.\n For the related API description, see PutBucketLifecycle.
\nA lifecycle rule consists of the following:
\nA 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.
\nA status indicating whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want\n Amazon S3 to perform on the objects identified by the filter. If the state of\n your bucket is versioning-enabled or versioning-suspended, you can have many\n versions of the same object (one current version and zero or more noncurrent\n versions). Amazon S3 provides predefined actions that you can specify for current\n and noncurrent object versions.
\nFor more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.
\nBy default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that created\n it) can access the resource. The resource owner can optionally grant access\n permissions to others by writing an access policy. For this operation, a user must\n get the s3:PutLifecycleConfiguration
permission.
You can also explicitly deny permissions. An explicit deny also supersedes any\n other permissions. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them permissions for the\n following actions:
\n\n s3:DeleteObject
\n
\n s3:DeleteObjectVersion
\n
\n s3:PutLifecycleConfiguration
\n
For more information about permissions, see Managing Access\n Permissions to Your Amazon S3 Resources.
\nThe following operations are related to\n PutBucketLifecycleConfiguration
:
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3\n Lifecycle configuration can have up to 1,000 rules. This limit is not\n adjustable.
\nBucket lifecycle configuration supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, object size, or any combination\n of these. Accordingly, this section describes the latest API. The previous version\n of the API supported filtering based only on an object key name prefix, which is\n supported for backward compatibility for general purpose buckets. For the related\n API description, see PutBucketLifecycle.
\nLifecyle configurations for directory buckets only support expiring objects and\n cancelling multipart uploads. Expiring of versioned objects,transitions and tag\n filters are not supported.
\nA lifecycle rule consists of the following:
\nA filter identifying a subset of objects to which the rule applies. The\n filter can be based on a key name prefix, object tags, object size, or any\n combination of these.
\nA status indicating whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want\n Amazon S3 to perform on the objects identified by the filter. If the state of\n your bucket is versioning-enabled or versioning-suspended, you can have many\n versions of the same object (one current version and zero or more noncurrent\n versions). Amazon S3 provides predefined actions that you can specify for current\n and noncurrent object versions.
\nFor more information, see Object Lifecycle\n Management and Lifecycle Configuration\n Elements.
\n\n General purpose bucket permissions - By\n default, all Amazon S3 resources are private, including buckets, objects, and\n related subresources (for example, lifecycle configuration and website\n configuration). Only the resource owner (that is, the Amazon Web Services account that\n created it) can access the resource. The resource owner can optionally grant\n access permissions to others by writing an access policy. For this\n operation, a user must have the s3:PutLifecycleConfiguration
\n permission.
You can also explicitly deny permissions. An explicit deny also\n supersedes any other permissions. If you want to block users or accounts\n from removing or deleting objects from your bucket, you must deny them\n permissions for the following actions:
\n\n s3:DeleteObject
\n
\n s3:DeleteObjectVersion
\n
\n s3:PutLifecycleConfiguration
\n
For more information about permissions, see Managing\n Access Permissions to Your Amazon S3 Resources.
\n\n Directory bucket permissions -\n You must have the s3express:PutLifecycleConfiguration
\n permission in an IAM identity-based policy to use this operation.\n Cross-account access to this API operation isn't supported. The resource\n owner can optionally grant access permissions to others by creating a role\n or user for them as long as they are within the same account as the owner\n and resource.
For more information about directory bucket policies and permissions, see\n Authorizing Regional endpoint APIs with IAM in the\n Amazon S3 User Guide.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n Directory buckets - The HTTP Host\n header syntax is\n s3express-control.region.amazonaws.com
.
The following operations are related to\n PutBucketLifecycleConfiguration
:
Indicates which default minimum object size behavior is applied to the lifecycle configuration.
\n\n all_storage_classes_128K
- Objects smaller than 128 KB will not transition to any storage class by default.
\n 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.\n
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Indicates which default minimum object size behavior is applied to the lifecycle\n configuration.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\n\n all_storage_classes_128K
- Objects smaller than 128 KB will not\n transition to any storage class by default.
\n varies_by_storage_class
- Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\n
To customize the minimum object size for any transition you can add a filter that\n specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in\n the body of your transition rule. Custom filters always take precedence over the default\n transition behavior.
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
The 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\n directory bucket lifecycle configurations.
\nIndicates which default minimum object size behavior is applied to the lifecycle configuration.
\n\n all_storage_classes_128K
- Objects smaller than 128 KB will not transition to any storage class by default.
\n 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.\n
To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in the body of your transition rule. Custom filters always take precedence over the default transition behavior.
Indicates which default minimum object size behavior is applied to the lifecycle\n configuration.
\nThis parameter applies to general purpose buckets only. It is not supported for\n directory bucket lifecycle configurations.
\n\n all_storage_classes_128K
- Objects smaller than 128 KB will not\n transition to any storage class by default.
\n varies_by_storage_class
- Objects smaller than 128 KB will\n transition to Glacier Flexible Retrieval or Glacier Deep Archive storage classes. By\n default, all other storage classes will prevent transitions smaller than 128 KB.\n
To customize the minimum object size for any transition you can add a filter that\n specifies a custom ObjectSizeGreaterThan
or ObjectSizeLessThan
in\n the body of your transition rule. Custom filters always take precedence over the default\n transition behavior.
This operation is not supported by directory buckets.
\nSet the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.
\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee
request element to grant access to other people. The\n Permissions
request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee
request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.
You can specify the person (grantee) to whom you're assigning access rights (by\n using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
\n DisplayName
is optional and ignored in the request.
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser
and, in a\n response to a GETObjectAcl
request, appears as the\n CanonicalUser.
By URI:
\n\n
\n
To enable logging, you use LoggingEnabled
and its children request\n elements. To disable logging, you use an empty BucketLoggingStatus
request\n element:
\n
\n
For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.
\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\nThe following operations are related to PutBucketLogging
:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nThis operation is not supported for directory buckets.
\nSet the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.
\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee
request element to grant access to other people. The\n Permissions
request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee
request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.
You can specify the person (grantee) to whom you're assigning access rights (by\n using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
\n DisplayName
is optional and ignored in the request.
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser
and, in a\n response to a GETObjectAcl
request, appears as the\n CanonicalUser.
By URI:
\n\n
\n
To enable logging, you use LoggingEnabled
and its children request\n elements. To disable logging, you use an empty BucketLoggingStatus
request\n element:
\n
\n
For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.
\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\nThe following operations are related to PutBucketLogging
:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nThis operation is not supported by directory buckets.
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n PutBucketMetricsConfiguration
:
\n PutBucketMetricsConfiguration
has the following special error:
Error code: TooManyConfigurations
\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nThis operation is not supported for directory buckets.
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n PutBucketMetricsConfiguration
:
\n PutBucketMetricsConfiguration
has the following special error:
Error code: TooManyConfigurations
\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nThis operation is not supported by directory buckets.
\nEnables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration
.
\n
\n
\n \n
This action replaces the existing notification configuration with the configuration you\n include in the request body.
\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.
\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\nFor more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.
\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with the required s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.
\nIf the configuration in the request body includes only one\n TopicConfiguration
specifying only the\n s3:ReducedRedundancyLostObject
event type, the response will also include\n the x-amz-sns-test-message-id
header containing the message ID of the test\n notification sent to the topic.
The following action is related to\n PutBucketNotificationConfiguration
:
This operation is not supported for directory buckets.
\nEnables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration
.
\n
\n
\n \n
This action replaces the existing notification configuration with the configuration you\n include in the request body.
\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.
\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\nFor more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.
\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with the required s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.
\nIf the configuration in the request body includes only one\n TopicConfiguration
specifying only the\n s3:ReducedRedundancyLostObject
event type, the response will also include\n the x-amz-sns-test-message-id
header containing the message ID of the test\n notification sent to the topic.
The following action is related to\n PutBucketNotificationConfiguration
:
This operation is not supported by directory buckets.
\nCreates or modifies OwnershipControls
for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls
permission. For\n more information about Amazon S3 permissions, see Specifying permissions in a\n policy.
For information about Amazon S3 Object Ownership, see Using object\n ownership.
\nThe following operations are related to PutBucketOwnershipControls
:
This operation is not supported for directory buckets.
\nCreates or modifies OwnershipControls
for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls
permission. For\n more information about Amazon S3 permissions, see Specifying permissions in a\n policy.
For information about Amazon S3 Object Ownership, see Using object\n ownership.
\nThe following operations are related to PutBucketOwnershipControls
:
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the\n PutBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403\n Access Denied
error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy
, PutBucketPolicy
, and\n DeleteBucketPolicy
API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked\n from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations\n policies.
\n General purpose bucket permissions - The s3:PutBucketPolicy
permission is required in a policy. \n For more information about general purpose buckets bucket policies, see Using Bucket Policies and User\n Policies in the Amazon S3 User Guide.
\n Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutBucketPolicy
permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.
\n General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
\n\n Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to PutBucketPolicy
:
\n CreateBucket\n
\n\n DeleteBucket\n
\nApplies an Amazon S3 bucket policy to an Amazon S3 bucket.
\n\n 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\n
. Virtual-hosted-style requests aren't supported. \nFor more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
If you are using an identity other than the root user of the Amazon Web Services account that\n owns the bucket, the calling identity must both have the\n PutBucketPolicy
permissions on the specified bucket and belong to\n the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a\n 403 Access Denied
error. If you have the correct permissions, but\n you're not using an identity that belongs to the bucket owner's account, Amazon S3\n returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of\n their own buckets, the root principal in a bucket owner's Amazon Web Services account can\n perform the GetBucketPolicy
, PutBucketPolicy
, and\n DeleteBucketPolicy
API actions, even if their bucket policy\n explicitly denies the root principal's access. Bucket owner root principals can\n only be blocked from performing these API actions by VPC endpoint policies and\n Amazon Web Services Organizations policies.
\n General purpose bucket permissions - The\n s3:PutBucketPolicy
permission is required in a policy. For\n more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n To grant access to this API operation, you must have the\n s3express:PutBucketPolicy
permission in\n 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.\n 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.
\n General purpose buckets example bucket policies\n - See Bucket policy\n examples in the Amazon S3 User Guide.
\n\n Directory bucket example bucket policies\n - See Example bucket policies for S3 Express One Zone in the\n Amazon S3 User Guide.
\n\n Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com
.
The following operations are related to PutBucketPolicy
:
\n CreateBucket\n
\n\n DeleteBucket\n
\nThe bucket policy as a JSON document.
\nFor directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession
.
The bucket policy as a JSON document.
\nFor directory buckets, the only IAM action supported in the bucket policy is\n s3express:CreateSession
.
This operation is not supported by directory buckets.
\nCreates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.
\nSpecify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information. You can invoke this request for a specific\n Amazon Web Services Region by using the \n \n aws:RequestedRegion
\n condition key.
A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.
\nTo specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication
, Status
, and\n Priority
.
If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.
\nFor information about enabling versioning on a bucket, see Using Versioning.
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using\n server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects,\n add the following: SourceSelectionCriteria
,\n SseKmsEncryptedObjects
, Status
,\n EncryptionConfiguration
, and ReplicaKmsKeyID
. For\n information about replication configuration, see Replicating\n Objects Created with SSE Using KMS keys.
For information on PutBucketReplication
errors, see List of\n replication-related error codes\n
To create a PutBucketReplication
request, you must have\n s3:PutReplicationConfiguration
permissions for the bucket.\n \n
By default, a resource owner, in this case the Amazon Web Services account that created the\n bucket, can perform this operation. The resource owner can also grant others\n permissions to perform the operation. For more information about permissions, see\n Specifying Permissions in\n a Policy and Managing Access\n Permissions to Your Amazon S3 Resources.
\nTo perform this operation, the user or role performing the action must have\n the iam:PassRole\n permission.
\nThe following operations are related to PutBucketReplication
:
\n GetBucketReplication\n
\nThis operation is not supported for directory buckets.
\nCreates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.
\nSpecify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information. You can invoke this request for a specific Amazon Web Services\n Region by using the \n aws:RequestedRegion
\n condition key.
A replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.
\nTo specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication
, Status
, and\n Priority
.
If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.
\nFor information about enabling versioning on a bucket, see Using Versioning.
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using\n server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects,\n add the following: SourceSelectionCriteria
,\n SseKmsEncryptedObjects
, Status
,\n EncryptionConfiguration
, and ReplicaKmsKeyID
. For\n information about replication configuration, see Replicating\n Objects Created with SSE Using KMS keys.
For information on PutBucketReplication
errors, see List of\n replication-related error codes\n
To create a PutBucketReplication
request, you must have\n s3:PutReplicationConfiguration
permissions for the bucket.\n \n
By default, a resource owner, in this case the Amazon Web Services account that created the\n bucket, can perform this operation. The resource owner can also grant others\n permissions to perform the operation. For more information about permissions, see\n Specifying Permissions in\n a Policy and Managing Access\n Permissions to Your Amazon S3 Resources.
\nTo perform this operation, the user or role performing the action must have\n the iam:PassRole\n permission.
\nThe following operations are related to PutBucketReplication
:
\n GetBucketReplication\n
\nThis operation is not supported by directory buckets.
\nSets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.
\nThe following operations are related to PutBucketRequestPayment
:
\n CreateBucket\n
\nThis operation is not supported for directory buckets.
\nSets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.
\nThe following operations are related to PutBucketRequestPayment
:
\n CreateBucket\n
\nThis operation is not supported by directory buckets.
\nSets the tags for a bucket.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation and\n Tagging and Using Cost Allocation in Amazon S3\n Bucket Tags.
\nWhen this operation sets the tags for a bucket, it will overwrite any current tags\n the bucket already has. You cannot use this operation to add tags to an existing list of\n tags.
\nTo use this operation, you must have permissions to perform the\n s3:PutBucketTagging
action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n PutBucketTagging
has the following special errors. For more Amazon S3 errors\n see, Error\n Responses.
\n InvalidTag
- The tag provided was not a valid tag. This error\n can occur if the tag did not pass input validation. For more information, see Using\n Cost Allocation in Amazon S3 Bucket Tags.
\n MalformedXML
- The XML provided does not match the\n schema.
\n OperationAborted
- A conflicting conditional action is\n currently in progress against this resource. Please try again.
\n InternalError
- The service was unable to apply the provided\n tag to the bucket.
The following operations are related to PutBucketTagging
:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis operation is not supported for directory buckets.
\nSets the tags for a bucket.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation and\n Tagging and Using Cost Allocation in Amazon S3\n Bucket Tags.
\nWhen this operation sets the tags for a bucket, it will overwrite any current tags\n the bucket already has. You cannot use this operation to add tags to an existing list of\n tags.
\nTo use this operation, you must have permissions to perform the\n s3:PutBucketTagging
action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n PutBucketTagging
has the following special errors. For more Amazon S3 errors\n see, Error\n Responses.
\n InvalidTag
- The tag provided was not a valid tag. This error\n can occur if the tag did not pass input validation. For more information, see Using\n Cost Allocation in Amazon S3 Bucket Tags.
\n MalformedXML
- The XML provided does not match the\n schema.
\n OperationAborted
- A conflicting conditional action is\n currently in progress against this resource. Please try again.
\n InternalError
- The service was unable to apply the provided\n tag to the bucket.
The following operations are related to PutBucketTagging
:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nThis operation is not supported by directory buckets.
\nWhen you enable versioning on a bucket for the first time, it might take a short\n amount of time for the change to be fully propagated. We recommend that you wait for 15\n minutes after enabling versioning before issuing write operations\n (PUT
\n or\n DELETE
)\n on objects in the bucket.
Sets the versioning state of an existing bucket.
\nYou can set the versioning state with one of the following values:
\n\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.
\n\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.
\nIf the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.
\nIn order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must include the\n x-amz-mfa request
header and the Status
and the\n MfaDelete
request elements in a request to set the versioning state of the\n bucket.
If you have an object expiration lifecycle configuration in your non-versioned bucket\n and you want to maintain the same permanent delete behavior when you enable versioning,\n you must add a noncurrent expiration policy. The noncurrent expiration lifecycle\n configuration will manage the deletes of the noncurrent object versions in the\n version-enabled bucket. (A version-enabled bucket maintains one current and zero or more\n noncurrent object versions.) For more information, see Lifecycle and Versioning.
\nThe following operations are related to PutBucketVersioning
:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nThis operation is not supported for directory buckets.
\nWhen you enable versioning on a bucket for the first time, it might take a short\n amount of time for the change to be fully propagated. We recommend that you wait for 15\n minutes after enabling versioning before issuing write operations (PUT
or\n DELETE
) on objects in the bucket.
Sets the versioning state of an existing bucket.
\nYou can set the versioning state with one of the following values:
\n\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.
\n\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.
\nIf the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.
\nIn order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must include the\n x-amz-mfa request
header and the Status
and the\n MfaDelete
request elements in a request to set the versioning state of the\n bucket.
If you have an object expiration lifecycle configuration in your non-versioned bucket\n and you want to maintain the same permanent delete behavior when you enable versioning,\n you must add a noncurrent expiration policy. The noncurrent expiration lifecycle\n configuration will manage the deletes of the noncurrent object versions in the\n version-enabled bucket. (A version-enabled bucket maintains one current and zero or more\n noncurrent object versions.) For more information, see Lifecycle and Versioning.
\nThe following operations are related to PutBucketVersioning
:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nThis operation is not supported by directory buckets.
\nSets the configuration of the website that is specified in the website
\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT action requires the S3:PutBucketWebsite
permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.
\n\n WebsiteConfiguration
\n
\n RedirectAllRequestsTo
\n
\n HostName
\n
\n Protocol
\n
If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.
\n\n WebsiteConfiguration
\n
\n IndexDocument
\n
\n Suffix
\n
\n ErrorDocument
\n
\n Key
\n
\n RoutingRules
\n
\n RoutingRule
\n
\n Condition
\n
\n HttpErrorCodeReturnedEquals
\n
\n KeyPrefixEquals
\n
\n Redirect
\n
\n Protocol
\n
\n HostName
\n
\n ReplaceKeyPrefixWith
\n
\n ReplaceKeyWith
\n
\n HttpRedirectCode
\n
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon S3 User Guide.
\nThe maximum request length is limited to 128 KB.
", + "smithy.api#documentation": "This operation is not supported for directory buckets.
\nSets the configuration of the website that is specified in the website
\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT action requires the S3:PutBucketWebsite
permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.
\n\n WebsiteConfiguration
\n
\n RedirectAllRequestsTo
\n
\n HostName
\n
\n Protocol
\n
If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.
\n\n WebsiteConfiguration
\n
\n IndexDocument
\n
\n Suffix
\n
\n ErrorDocument
\n
\n Key
\n
\n RoutingRules
\n
\n RoutingRule
\n
\n Condition
\n
\n HttpErrorCodeReturnedEquals
\n
\n KeyPrefixEquals
\n
\n Redirect
\n
\n Protocol
\n
\n HostName
\n
\n ReplaceKeyPrefixWith
\n
\n ReplaceKeyWith
\n
\n HttpRedirectCode
\n
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon S3 User Guide.
\nThe maximum request length is limited to 128 KB.
", "smithy.api#examples": [ { "title": "Set website configuration on a bucket", @@ -31056,11 +31150,25 @@ "output": { "target": "com.amazonaws.s3#PutObjectOutput" }, + "errors": [ + { + "target": "com.amazonaws.s3#EncryptionTypeMismatch" + }, + { + "target": "com.amazonaws.s3#InvalidRequest" + }, + { + "target": "com.amazonaws.s3#InvalidWriteOffset" + }, + { + "target": "com.amazonaws.s3#TooManyParts" + } + ], "traits": { "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "Adds an object to a bucket.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject
to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All\n objects written to the bucket by any account will be owned by the bucket owner.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides features that can modify this behavior:
\n\n S3 Object Lock - To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\n\n S3 Versioning - When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all versions of the objects. For each write request that is made to the same object, Amazon S3 automatically generates a unique version ID\n of that object being stored in Amazon S3. \n You can retrieve, replace, or delete any version of the object. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3\n User Guide. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nThis functionality is not supported for directory buckets.
\n\n General purpose bucket permissions - The following permissions are required in your policies when your \n PutObject
request includes specific headers.
\n \n s3:PutObject
\n - To successfully complete the PutObject
request, you must always have the s3:PutObject
permission on a bucket to add an object\n to it.
\n \n s3:PutObjectAcl
\n - To successfully change the objects ACL of your PutObject
request, you must have the s3:PutObjectAcl
.
\n \n s3:PutObjectTagging
\n - To successfully set the tag-set with your PutObject
request, you\n must have the s3:PutObjectTagging
.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with\n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
\n General purpose bucket - To ensure that data is not corrupted traversing the network, use the\n Content-MD5
header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, \n you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
\n Directory bucket - This functionality is not supported for directory buckets.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
For more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nAdds an object to a bucket.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added\n the entire object to the bucket. You cannot use PutObject
to only\n update a single piece of metadata for an existing object. You must put the entire\n object with updated metadata if you want to update some values.
If your bucket uses the bucket owner enforced setting for Object Ownership,\n ACLs are disabled and no longer affect permissions. All objects written to the\n bucket by any account will be owned by the bucket owner.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. However, Amazon S3 provides\n features that can modify this behavior:
\n\n S3 Object Lock - To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\n\n S3 Versioning - When you enable versioning\n for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all versions of the objects. For each write request that is\n made to the same object, Amazon S3 automatically generates a unique version ID of that\n object being stored in Amazon S3. You can retrieve, replace, or delete any version of the\n object. For more information about versioning, see Adding\n Objects to Versioning-Enabled Buckets in the Amazon S3 User\n Guide. For information about returning the versioning state of a\n bucket, see GetBucketVersioning.
\nThis functionality is not supported for directory buckets.
\n\n General purpose bucket permissions - The\n following permissions are required in your policies when your\n PutObject
request includes specific headers.
\n \n s3:PutObject
\n -\n To successfully complete the PutObject
request, you must\n always have the s3:PutObject
permission on a bucket to\n add an object to it.
\n \n s3:PutObjectAcl
\n - To successfully change the objects ACL of your\n PutObject
request, you must have the\n s3:PutObjectAcl
.
\n \n s3:PutObjectTagging
\n - To successfully set the tag-set with your\n PutObject
request, you must have the\n s3:PutObjectTagging
.
\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.
\n General purpose bucket - To ensure that\n data is not corrupted traversing the network, use the\n Content-MD5
header. When you use this header, Amazon S3 checks\n the object against the provided MD5 value and, if they do not match, Amazon S3\n returns an error. Alternatively, when the object's ETag is its MD5 digest,\n you can calculate the MD5 while putting the object to Amazon S3 and compare the\n returned ETag to the calculated MD5 value.
\n Directory bucket -\n This functionality is not supported for directory buckets.
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
For more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nThis operation is not supported by directory buckets.
\nUses the acl
subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have the WRITE_ACP
\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This functionality is not supported for Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that approach.\n For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported
error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has\n a predefined set of grantees and permissions. Specify the canned ACL name as\n the value of x-amz-ac
l. If you use this header, you cannot use\n other access control-specific headers in your request. For more information,\n see Canned\n ACL.
Specify access permissions explicitly with the\n x-amz-grant-read
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers,\n you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3\n groups) who will receive the permission. If you use these ACL-specific\n headers, you cannot use x-amz-acl
header to set a canned ACL.\n These parameters map to the set of permissions that Amazon S3 supports in an ACL.\n For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read
header grants\n list objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\"
\n
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nYou can specify the person (grantee) to whom you're assigning access rights\n (using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET\n Object acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe ACL of an object is set at the object version level. By default, PUT sets\n the ACL of the current version of an object. To set the ACL of a different\n version, use the versionId
subresource.
The following operations are related to PutObjectAcl
:
\n CopyObject\n
\n\n GetObject\n
\nThis operation is not supported for directory buckets.
\nUses the acl
subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have the WRITE_ACP
\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This functionality is not supported for Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that approach.\n For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported
error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has\n a predefined set of grantees and permissions. Specify the canned ACL name as\n the value of x-amz-ac
l. If you use this header, you cannot use\n other access control-specific headers in your request. For more information,\n see Canned\n ACL.
Specify access permissions explicitly with the\n x-amz-grant-read
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers,\n you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3\n groups) who will receive the permission. If you use these ACL-specific\n headers, you cannot use x-amz-acl
header to set a canned ACL.\n These parameters map to the set of permissions that Amazon S3 supports in an ACL.\n For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read
header grants\n list objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\"
\n
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nYou can specify the person (grantee) to whom you're assigning access rights\n (using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET\n Object acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe ACL of an object is set at the object version level. By default, PUT sets\n the ACL of the current version of an object. To set the ACL of a different\n version, use the versionId
subresource.
The following operations are related to PutObjectAcl
:
\n CopyObject\n
\n\n GetObject\n
\nThis operation is not supported by directory buckets.
\nApplies a legal hold configuration to the specified object. For more information, see\n Locking\n Objects.
\nThis functionality is not supported for Amazon S3 on Outposts.
", + "smithy.api#documentation": "This operation is not supported for directory buckets.
\nApplies a legal hold configuration to the specified object. For more information, see\n Locking\n Objects.
\nThis functionality is not supported for Amazon S3 on Outposts.
", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?legal-hold", @@ -31458,7 +31566,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nPlaces an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.
\nThe DefaultRetention
settings require both a mode and a\n period.
The DefaultRetention
period can be either Days
or\n Years
but you must select one. You cannot specify\n Days
and Years
at the same time.
You can enable Object Lock for new or existing buckets. For more\n information, see Configuring Object\n Lock.
\nThis operation is not supported for directory buckets.
\nPlaces an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.
\nThe DefaultRetention
settings require both a mode and a\n period.
The DefaultRetention
period can be either Days
or\n Years
but you must select one. You cannot specify\n Days
and Years
at the same time.
You can enable Object Lock for new or existing buckets. For more information,\n see Configuring Object\n Lock.
\nIf the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It\n includes the expiry-date
and rule-id
key-value pairs that provide\n information about object expiration. The value of the rule-id
is\n URL-encoded.
This functionality is not supported for directory buckets.
\nIf the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide,\n the response includes this header. It includes the expiry-date
and\n rule-id
key-value pairs that provide information about object expiration.\n The value of the rule-id
is URL-encoded.
This functionality is not supported for directory buckets.
\nEntity tag for the uploaded object.
\n\n General purpose buckets - To ensure that data is not corrupted traversing the network, \n for objects where the \n ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
\n\n Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
", + "smithy.api#documentation": "Entity tag for the uploaded object.
\n\n General purpose buckets - To ensure that data is not\n corrupted traversing the network, for objects where the ETag is the MD5 digest of the\n object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned\n ETag to the calculated MD5 value.
\n\n Directory buckets - The ETag for the object in\n a directory bucket isn't the MD5 digest of the object.
", "smithy.api#httpHeader": "ETag" } }, @@ -31596,7 +31704,7 @@ "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "Version ID of the object.
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3\n User Guide. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nThis functionality is not supported for directory buckets.
\nVersion ID of the object.
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets in the Amazon S3 User Guide. For\n information about returning the versioning state of a bucket, see GetBucketVersioning.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\n\n The size of the object in bytes. This will only be present if you append to an object.\n
\nThis functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
\nThe canned ACL to apply to the object. For more information, see Canned\n ACL in the Amazon S3 User Guide.
\nWhen adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API in the Amazon S3 User Guide.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control
\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400
error with the error code AccessControlListNotSupported
.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe canned ACL to apply to the object. For more information, see Canned\n ACL in the Amazon S3 User Guide.
\nWhen adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API in the Amazon S3 User Guide.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control
\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400
error with the error code AccessControlListNotSupported
.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThe bucket name to which the PUT action was initiated.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name to which the PUT action was initiated.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST Authentication.
\nThe Content-MD5
or x-amz-sdk-checksum-algorithm
header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information, see Uploading objects to an Object Lock enabled bucket\n in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
\nThe base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST Authentication.
\nThe Content-MD5
or x-amz-sdk-checksum-algorithm
header is\n required for any request to upload an object with a retention period configured using\n Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the\n Amazon S3 User Guide.
This functionality is not supported for directory buckets.
\nIndicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n
or\n x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
.
For the x-amz-checksum-algorithm\n
header, replace \n algorithm\n
with the supported algorithm from the following list:
\n CRC32
\n
\n CRC32C
\n
\n SHA1
\n
\n SHA256
\n
For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf the individual checksum value you provide through x-amz-checksum-algorithm\n
doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm
, Amazon S3 ignores any provided\n ChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n
.
The Content-MD5
or x-amz-sdk-checksum-algorithm
header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information, see Uploading objects to an Object Lock enabled bucket\n in the Amazon S3 User Guide.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any\n additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm\n
or\n x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
.
For the x-amz-checksum-algorithm\n
header, replace \n algorithm\n
with the supported algorithm from the following list:
\n CRC32
\n
\n CRC32C
\n
\n SHA1
\n
\n SHA256
\n
For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
\nIf the individual checksum value you provide through x-amz-checksum-algorithm\n
doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm
, Amazon S3 ignores any provided\n ChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm\n
.
The Content-MD5
or x-amz-sdk-checksum-algorithm
header is\n required for any request to upload an object with a retention period configured using\n Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the\n Amazon S3 User Guide.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed
error.
If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
response. On a 409 failure you should retry the upload.
Expects the '*' (asterisk) character.
\nFor more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Uploads the object only if the object key name does not already exist in the bucket\n specified. Otherwise, Amazon S3 returns a 412 Precondition Failed
error.
If a conflicting operation occurs during the upload S3 returns a 409\n ConditionalRequestConflict
response. On a 409 failure you should retry the\n upload.
Expects the '*' (asterisk) character.
\nFor more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.
", "smithy.api#httpHeader": "If-None-Match" } }, @@ -31812,6 +31927,13 @@ } } }, + "WriteOffsetBytes": { + "target": "com.amazonaws.s3#WriteOffsetBytes", + "traits": { + "smithy.api#documentation": "\n Specifies the offset for appending data to existing objects in bytes. \n The offset must be equal to the size of the existing object being appended to. \n If no object exists, setting this header to 0 will create a new object.\n
\nThis functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.
\nThe server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
, aws:kms:dsse
).
\n General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in\n Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or\n DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side\n encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to\n encrypt data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption in the Amazon S3 User Guide.
\n\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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. \n
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. \n You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n
The server-side encryption algorithm that was used when you store this object in Amazon S3\n (for example, AES256
, aws:kms
, aws:kms:dsse
).
\n General purpose buckets - You have four mutually\n exclusive options to protect data using server-side encryption in Amazon S3, depending on\n how you choose to manage the encryption keys. Specifically, the encryption key\n options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and\n customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by\n using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt\n data at rest by using server-side encryption with other key options. For more\n information, see Using Server-Side\n Encryption in the Amazon S3 User Guide.
\n\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your \n CreateSession
requests or PUT
object requests. Then, new objects \n are automatically encrypted with the desired encryption settings. For more\n 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. \n You can't override the values of the encryption settings (x-amz-server-side-encryption
, x-amz-server-side-encryption-aws-kms-key-id
, x-amz-server-side-encryption-context
, and x-amz-server-side-encryption-bucket-key-enabled
) that are specified in the CreateSession
request. \n You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and \n Amazon S3 will use the encryption settings values from the CreateSession
request to protect new objects in the directory bucket. \n
When you use the CLI or the Amazon Web Services SDKs, for CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket's default encryption configuration for the \n CreateSession
request. It's not supported to override the encryption settings values in the CreateSession
request. \n So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), \n the encryption request headers must match the default encryption configuration of the directory bucket.\n\n
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\nFor directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
\nAmazon S3 on Outposts only uses\n the OUTPOSTS Storage Class.
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. For more information, see\n Storage\n Classes in the Amazon S3 User Guide.
\nFor directory buckets, only the S3 Express One Zone storage class is supported to store\n newly created objects.
\nAmazon S3 on Outposts only uses the OUTPOSTS Storage Class.
\nIf the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata in the Amazon S3\n User Guide.
\nIn the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:
\n\n x-amz-website-redirect-location: /anotherPage.html
\n
In the following example, the request header sets the object redirect to another\n website:
\n\n x-amz-website-redirect-location: http://www.example.com/
\n
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and\n How to\n Configure Website Page Redirects in the Amazon S3\n User Guide.
\nThis functionality is not supported for directory buckets.
\nIf the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata in the\n Amazon S3 User Guide.
\nIn the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:
\n\n x-amz-website-redirect-location: /anotherPage.html
\n
In the following example, the request header sets the object redirect to another\n website:
\n\n x-amz-website-redirect-location: http://www.example.com/
\n
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and\n How to\n Configure Website Page Redirects in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when encrypting the object (for example,\n AES256
).
This functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when encrypting the object (for example,\n AES256
).
This functionality is not supported for directory buckets.
\nSpecifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nSpecifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object Lock in the\n Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nThis operation is not supported by directory buckets.
\nPlaces an Object Retention configuration on an object. For more information, see Locking Objects.\n Users or accounts require the s3:PutObjectRetention
permission in order to\n place an Object Retention configuration on objects. Bypassing a Governance Retention\n configuration requires the s3:BypassGovernanceRetention
permission.
This functionality is not supported for Amazon S3 on Outposts.
", + "smithy.api#documentation": "This operation is not supported for directory buckets.
\nPlaces an Object Retention configuration on an object. For more information, see Locking Objects.\n Users or accounts require the s3:PutObjectRetention
permission in order to\n place an Object Retention configuration on objects. Bypassing a Governance Retention\n configuration requires the s3:BypassGovernanceRetention
permission.
This functionality is not supported for Amazon S3 on Outposts.
", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?retention", @@ -32052,7 +32174,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "This operation is not supported by directory buckets.
\nSets the supplied tag-set to an object that already exists in a bucket. A tag is a\n key-value pair. For more information, see Object Tagging.
\nYou can associate tags with an object by sending a PUT request against the tagging\n subresource that is associated with the object. You can retrieve tags by sending a GET\n request. For more information, see GetObjectTagging.
\nFor tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.
\nTo use this operation, you must have permission to perform the\n s3:PutObjectTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
To put tags of any other version, use the versionId
query parameter. You\n also need permission for the s3:PutObjectVersionTagging
action.
\n PutObjectTagging
has the following special errors. For more Amazon S3 errors\n see, Error\n Responses.
\n InvalidTag
- The tag provided was not a valid tag. This error\n can occur if the tag did not pass input validation. For more information, see Object\n Tagging.
\n MalformedXML
- The XML provided does not match the\n schema.
\n OperationAborted
- A conflicting conditional action is\n currently in progress against this resource. Please try again.
\n InternalError
- The service was unable to apply the provided\n tag to the object.
The following operations are related to PutObjectTagging
:
\n GetObjectTagging\n
\n\n DeleteObjectTagging\n
\nThis operation is not supported for directory buckets.
\nSets the supplied tag-set to an object that already exists in a bucket. A tag is a\n key-value pair. For more information, see Object Tagging.
\nYou can associate tags with an object by sending a PUT request against the tagging\n subresource that is associated with the object. You can retrieve tags by sending a GET\n request. For more information, see GetObjectTagging.
\nFor tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.
\nTo use this operation, you must have permission to perform the\n s3:PutObjectTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
To put tags of any other version, use the versionId
query parameter. You\n also need permission for the s3:PutObjectVersionTagging
action.
\n PutObjectTagging
has the following special errors. For more Amazon S3 errors\n see, Error\n Responses.
\n InvalidTag
- The tag provided was not a valid tag. This error\n can occur if the tag did not pass input validation. For more information, see Object\n Tagging.
\n MalformedXML
- The XML provided does not match the\n schema.
\n OperationAborted
- A conflicting conditional action is\n currently in progress against this resource. Please try again.
\n InternalError
- The service was unable to apply the provided\n tag to the object.
The following operations are related to PutObjectTagging
:
\n GetObjectTagging\n
\n\n DeleteObjectTagging\n
\nThis operation is not supported by directory buckets.
\nCreates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or\n an object, it checks the PublicAccessBlock
configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to PutPublicAccessBlock
:
\n GetPublicAccessBlock\n
\nThis operation is not supported for directory buckets.
\nCreates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or\n an object, it checks the PublicAccessBlock
configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to PutPublicAccessBlock
:
\n GetPublicAccessBlock\n
\nOptional configuration to replicate existing source bucket objects.\n
\nThis parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.
\nOptional configuration to replicate existing source bucket objects.
\nThis parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the\n Amazon S3 User Guide.
\nConfirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. If either the source or\n destination S3 bucket has Requester Pays enabled, the requester will pay for\n corresponding charges to copy the object. For information about downloading objects from\n Requester Pays buckets, see Downloading Objects in\n Requester Pays Buckets in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nConfirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. If either the source or\n destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding\n charges to copy the object. For information about downloading objects from Requester Pays\n buckets, see Downloading Objects in\n Requester Pays Buckets in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.
\nThis operation is not supported by directory buckets.
\nRestores an archived copy of an object back into Amazon S3
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n restore an archive
- Restore an archived object
For more information about the S3
structure in the request body, see the\n following:
\n PutObject\n
\n\n Managing Access with ACLs in the\n Amazon S3 User Guide\n
\n\n Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide\n
\nTo use this operation, you must have permissions to perform the\n s3:RestoreObject
action. The bucket owner has this permission by\n default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval\n or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.
\nTo restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object, you can specify one of the following data\n access tier options in the Tier
element of the request body:
\n Expedited
- Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
\n Standard
- Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.
\n Bulk
- Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5–12 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
For more information about archive retrieval options and provisioned capacity\n for Expedited
data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.
\nTo get the status of object restoration, you can send a HEAD
\n request. Operations return the x-amz-restore
header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.
\nA successful action returns either the 200 OK
or 202\n Accepted
status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted
in the response.
If the object is previously restored, Amazon S3 returns 200 OK
in\n the response.
Special errors:
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress.\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not to S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\nThe following operations are related to RestoreObject
:
This operation is not supported for directory buckets.
\nRestores an archived copy of an object back into Amazon S3
\nThis functionality is not supported for Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n restore an archive
- Restore an archived object
For more information about the S3
structure in the request body, see the\n following:
\n PutObject\n
\n\n Managing Access with ACLs in the\n Amazon S3 User Guide\n
\n\n Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide\n
\nTo use this operation, you must have permissions to perform the\n s3:RestoreObject
action. The bucket owner has this permission by\n default and can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval\n or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive\n storage classes, you must first initiate a restore request, and then wait until a\n temporary copy of the object is available. If you want a permanent copy of the\n object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket.\n To access an archived object, you must restore the object for the duration (number\n of days) that you specify. For objects in the Archive Access or Deep Archive\n Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request,\n and then wait until the object is moved into the Frequent Access tier.
\nTo restore a specific object version, you can provide a version ID. If you\n don't provide a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object, you can specify one of the following data\n access tier options in the Tier
element of the request body:
\n Expedited
- Expedited retrievals allow you to quickly access\n your data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval\n storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests\n for restoring archives are required. For all but the largest archived\n objects (250 MB+), data accessed using Expedited retrievals is typically\n made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it.\n Expedited retrievals and provisioned capacity are not available for objects\n stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
\n Standard
- Standard retrievals allow you to access any of\n your archived objects within several hours. This is the default option for\n retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.
\n Bulk
- Bulk retrievals free for objects stored in the\n S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes,\n enabling you to retrieve large amounts, even petabytes, of data at no cost.\n Bulk retrievals typically finish within 5–12 hours for objects stored in the\n S3 Glacier Flexible Retrieval Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost\n retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
For more information about archive retrieval options and provisioned capacity\n for Expedited
data access, see Restoring Archived\n Objects in the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster\n speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.
\nTo get the status of object restoration, you can send a HEAD
\n request. Operations return the x-amz-restore
header, which provides\n information about the restoration status, in the response. You can use Amazon S3 event\n notifications to notify you when a restore is initiated or completed. For more\n information, see Configuring Amazon S3 Event\n Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by\n reissuing the request with a new period. Amazon S3 updates the restoration period\n relative to the current time and charges only for the request-there are no\n data transfer charges. You cannot update the restoration period when Amazon S3 is\n actively processing your current restore request for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an\n expiration action, the object expiration overrides the life span that you specify\n in a restore request. For example, if you restore an object copy for 10 days, but\n the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days.\n For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle\n Management in Amazon S3 User Guide.
\nA successful action returns either the 200 OK
or 202\n Accepted
status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted
in the response.
If the object is previously restored, Amazon S3 returns 200 OK
in\n the response.
Special errors:
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress.\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to\n process the Expedited request. This error applies only to Expedited\n retrievals and not to S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\nThe following operations are related to RestoreObject
:
Specifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nSpecifies the restoration status of an object. Objects in certain storage classes must\n be restored before they can be retrieved. For more information about these storage classes\n and how to work with archived objects, see Working with archived\n objects in the Amazon S3 User Guide.
\nThis functionality is not supported for directory buckets.\n Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
\nThis operation is not supported by directory buckets.
\nThis action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\n \nYou must have the s3:GetObject
permission for this operation. Amazon S3\n Select does not support anonymous access. For more information about permissions,\n see Specifying Permissions in\n a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports\n querying objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more\n information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys)\n in the Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,\n so you don't need to specify anything. For more information about\n server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide.
\nGiven the response size is unknown, Amazon S3 Select streams the response as a\n series of messages and includes a Transfer-Encoding
header with\n chunked
as its value in the response. For more information, see\n Appendix:\n SelectObjectContent\n Response.
The SelectObjectContent
action does not support the following\n GetObject
functionality. For more information, see GetObject.
\n Range
: Although you can specify a scan range for an Amazon S3 Select\n request (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.\n
The GLACIER
, DEEP_ARCHIVE
, and\n REDUCED_REDUNDANCY
storage classes, or the\n ARCHIVE_ACCESS
and DEEP_ARCHIVE_ACCESS
access\n tiers of the INTELLIGENT_TIERING
storage class: You cannot\n query objects in the GLACIER
, DEEP_ARCHIVE
, or\n REDUCED_REDUNDANCY
storage classes, nor objects in the\n ARCHIVE_ACCESS
or DEEP_ARCHIVE_ACCESS
access\n tiers of the INTELLIGENT_TIERING
storage class. For more\n information about storage classes, see Using Amazon S3\n storage classes in the\n Amazon S3 User Guide.
For a list of special errors for this operation, see List of SELECT Object Content Error Codes\n
\nThe following operations are related to SelectObjectContent
:
\n GetObject\n
\nThis operation is not supported for directory buckets.
\nThis action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis functionality is not supported for Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\n \nYou must have the s3:GetObject
permission for this operation. Amazon S3\n Select does not support anonymous access. For more information about permissions,\n see Specifying Permissions in\n a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports\n querying objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more\n information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys)\n in the Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently,\n so you don't need to specify anything. For more information about\n server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the\n Amazon S3 User Guide.
\nGiven the response size is unknown, Amazon S3 Select streams the response as a\n series of messages and includes a Transfer-Encoding
header with\n chunked
as its value in the response. For more information, see\n Appendix:\n SelectObjectContent\n Response.
The SelectObjectContent
action does not support the following\n GetObject
functionality. For more information, see GetObject.
\n Range
: Although you can specify a scan range for an Amazon S3 Select\n request (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.\n
The GLACIER
, DEEP_ARCHIVE
, and\n REDUCED_REDUNDANCY
storage classes, or the\n ARCHIVE_ACCESS
and DEEP_ARCHIVE_ACCESS
access\n tiers of the INTELLIGENT_TIERING
storage class: You cannot\n query objects in the GLACIER
, DEEP_ARCHIVE
, or\n REDUCED_REDUNDANCY
storage classes, nor objects in the\n ARCHIVE_ACCESS
or DEEP_ARCHIVE_ACCESS
access\n tiers of the INTELLIGENT_TIERING
storage class. For more\n information about storage classes, see Using Amazon S3\n storage classes in the\n Amazon S3 User Guide.
For a list of special errors for this operation, see List of SELECT Object Content Error Codes\n
\nThe following operations are related to SelectObjectContent
:
\n GetObject\n
\nAmazon Web Services Key Management Service (KMS) customer managed key ID to use for the default\n encryption.
\n\n General purpose buckets - This parameter is allowed if and only if SSEAlgorithm
is set to\n aws:kms
or aws:kms:dsse
.
\n Directory buckets - This parameter is allowed if and only if SSEAlgorithm
is set to\n aws:kms
.
You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS\n key.
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key Alias: alias/alias-name
\n
If you are using encryption with cross-account or Amazon Web Services service operations, you must use\n a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
\n\n General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating\n a VPC flow log. \n
\n\n Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
\nAmazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service\n Developer Guide.
\nAmazon Web Services Key Management Service (KMS) customer managed key ID to use for the default\n encryption.
\n\n General purpose buckets - This parameter is\n allowed if and only if SSEAlgorithm
is set to aws:kms
or\n aws:kms:dsse
.
\n Directory buckets - This parameter is\n allowed if and only if SSEAlgorithm
is set to\n aws:kms
.
You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS\n key.
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key Alias: alias/alias-name
\n
If you are using encryption with cross-account or Amazon Web Services service operations, you must use\n a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
\n\n General purpose buckets - If you're specifying\n a customer managed KMS key, we recommend using a fully qualified KMS key ARN.\n If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a\n KMS key that belongs to the requester, and not the bucket owner. Also, if you\n use a key ID, you can run into a LogDestination undeliverable error when creating\n a VPC flow log.
\n\n Directory buckets -\n 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.
\nAmazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service\n Developer Guide.
\nDescribes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more\n information, see PutBucketEncryption.
\n\n General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates\n an Amazon Web Services KMS key (aws/s3
) in your Amazon Web Services account the first time that you add an object encrypted\n with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS.
\n Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3
) isn't supported. \n
\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.
\nDescribes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PutBucketEncryption.
\n\n General purpose buckets - If you don't specify\n a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key\n (aws/s3
) in your Amazon Web Services account the first time that you add an\n object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key\n for SSE-KMS.
\n Directory buckets -\n Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. \nThe Amazon Web Services managed key (aws/s3
) isn't supported. \n
\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.
\nSpecifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS\n (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the\n BucketKeyEnabled
element to true
causes Amazon S3 to use an S3\n Bucket Key.
\n General purpose buckets - By default, S3 Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\n\n Directory buckets - S3 Bucket Keys are always enabled for GET
and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS\n (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the\n BucketKeyEnabled
element to true
causes Amazon S3 to use an S3\n Bucket Key.
\n General purpose buckets - By default, S3\n Bucket Key is not enabled. For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\n\n Directory buckets -\n S3 Bucket Keys are always enabled for GET
and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or \n the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
Specifies the default server-side encryption configuration.
\n\n General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified\n KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a KMS key\n that belongs to the requester, and not the bucket owner.
\n\n Directory buckets - When you specify an KMS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported.
\nSpecifies the default server-side encryption configuration.
\n\n General purpose buckets - If you're specifying\n a customer managed KMS key, we recommend using a fully qualified KMS key ARN.\n If you use a KMS key alias instead, then KMS resolves the key within the\n requester’s account. This behavior can result in data that's encrypted with a\n KMS key that belongs to the requester, and not the bucket owner.
\n\n Directory buckets -\n 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.
\nA unique identifier that's associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.
", + "smithy.api#documentation": "A unique identifier that's associated with a secret access key. The access key ID and\n the secret access key are used together to sign programmatic Amazon Web Services requests\n cryptographically.
", "smithy.api#required": {}, "smithy.api#xmlName": "AccessKeyId" } @@ -33462,7 +33584,7 @@ "SecretAccessKey": { "target": "com.amazonaws.s3#SessionCredentialValue", "traits": { - "smithy.api#documentation": "A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.
", + "smithy.api#documentation": "A key that's used with the access key ID to cryptographically sign programmatic Amazon Web Services\n requests. Signing a request identifies the sender and prevents the request from being\n altered.
", "smithy.api#required": {}, "smithy.api#xmlName": "SecretAccessKey" } @@ -33470,7 +33592,7 @@ "SessionToken": { "target": "com.amazonaws.s3#SessionCredentialValue", "traits": { - "smithy.api#documentation": "A part of the temporary security credentials. The session token is used to validate the temporary security credentials. \n \n
", + "smithy.api#documentation": "A part of the temporary security credentials. The session token is used to validate the\n temporary security credentials.\n \n
", "smithy.api#required": {}, "smithy.api#xmlName": "SessionToken" } @@ -33478,14 +33600,14 @@ "Expiration": { "target": "com.amazonaws.s3#SessionExpiration", "traits": { - "smithy.api#documentation": "Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. \n Temporary credentials cannot be extended or refreshed beyond the original specified interval.
", + "smithy.api#documentation": "Temporary security credentials expire after a specified interval. After temporary\n credentials expire, any calls that you make with those credentials will fail. So you must\n generate a new set of temporary credentials. Temporary credentials cannot be extended or\n refreshed beyond the original specified interval.
", "smithy.api#required": {}, "smithy.api#xmlName": "Expiration" } } }, "traits": { - "smithy.api#documentation": "The established temporary security credentials of the session.
\n\n Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.
\nThe established temporary security credentials of the session.
\n\n Directory buckets - These session\n credentials are only supported for the authentication and authorization of Zonal endpoint API operations\n on directory buckets.
\nTo use simple format for S3 keys for log objects, set SimplePrefix to an empty object.
\n\n [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
\n
To use simple format for S3 keys for log objects, set SimplePrefix to an empty\n object.
\n\n [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]
\n
To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.
", + "smithy.api#documentation": "To use the simple format for S3 keys for log objects. To specify SimplePrefix format,\n set SimplePrefix to {}.
", "smithy.api#xmlName": "SimplePrefix" } }, @@ -33875,7 +33997,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.
" + "smithy.api#documentation": "Amazon S3 key format for log objects. Only one format, PartitionedPrefix or\n SimplePrefix, is allowed.
" } }, "com.amazonaws.s3#TargetPrefix": { @@ -33935,6 +34057,15 @@ "com.amazonaws.s3#Token": { "type": "string" }, + "com.amazonaws.s3#TooManyParts": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "\n You have attempted to add more parts than the maximum of 10000 \n that are allowed for this object. You can use the CopyObject operation \n to copy this object to another and then add more data to the newly copied object.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.s3#TopicArn": { "type": "string" }, @@ -34106,7 +34237,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "Uploads a part in a multipart upload.
\nIn this operation, you provide new data as a part of an object in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n
\nYou must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier that you must include in your upload part request.
\nPart numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten.
\nFor information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nAfter you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.
\nFor more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - To\n perform a multipart upload with encryption using an Key Management Service key, the\n requester must have permission to the kms:Decrypt
and\n kms:GenerateDataKey
actions on the key. The requester must\n also have permissions for the kms:GenerateDataKey
action for\n the CreateMultipartUpload
API. Then, the requester needs\n permissions for the kms:Decrypt
action on the\n UploadPart
and UploadPartCopy
APIs.
These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For\n more information about KMS permissions, see Protecting data\n using server-side encryption with KMS in the\n Amazon S3 User Guide. For information about the\n permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the\n Amazon S3 User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with\n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
\n General purpose bucket - To ensure that data is not corrupted traversing the network, specify the\n Content-MD5
header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the\n x-amz-content-sha256
header as a checksum instead of\n Content-MD5
. For more information see Authenticating\n Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
\n Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
\n\n General purpose bucket - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it. You have \n mutually exclusive options to protect data using server-side encryption in Amazon S3, depending\n on how you choose to manage the encryption keys. Specifically, the encryption key options\n are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys\n (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by\n default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption\n with other key options. The option you use depends on whether you want to use KMS keys\n (SSE-KMS) or provide your own encryption key (SSE-C).
\nServer-side encryption is supported by the S3 Multipart Upload operations. Unless you are\n using a customer-provided encryption key (SSE-C), you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.
\nIf you request server-side encryption using a customer-provided encryption key (SSE-C)\n in your initiate multipart upload request, you must provide identical encryption\n information in each part upload using the following request headers.
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\n\n For more information, see Using Server-Side\n Encryption in the Amazon S3 User Guide.
\n\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
).
Error Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to UploadPart
:
\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part in a multipart upload.
\nIn this operation, you provide new data as a part of an object in your request.\n However, you have an option to specify your existing Amazon S3 object as a data source for\n the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
\nYou must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier that you must include in your upload part request.
\nPart numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten.
\nFor information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nAfter you initiate multipart upload and upload one or more parts, you must either\n complete or abort multipart upload in order to stop getting charged for storage of the\n uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up\n the parts storage and stops charging you for the parts storage.
\nFor more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
\n General purpose bucket permissions - To\n perform a multipart upload with encryption using an Key Management Service key, the\n requester must have permission to the kms:Decrypt
and\n kms:GenerateDataKey
actions on the key. The requester must\n also have permissions for the kms:GenerateDataKey
action for\n the CreateMultipartUpload
API. Then, the requester needs\n permissions for the kms:Decrypt
action on the\n UploadPart
and UploadPartCopy
APIs.
These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For\n more information about KMS permissions, see Protecting data\n using server-side encryption with KMS in the\n Amazon S3 User Guide. For information about the\n permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the\n Amazon S3 User Guide.
\n\n Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the \n CreateSession
\n API operation for session-based authorization. Specifically, you grant the s3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession
API call to generate a new session token for use. \nAmazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see \n CreateSession
\n .
If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n key.
\n General purpose bucket - To ensure that data\n is not corrupted traversing the network, specify the Content-MD5
\n header in the upload part request. Amazon S3 checks the part data against the provided\n MD5 value. If they do not match, Amazon S3 returns an error. If the upload request is\n signed with Signature Version 4, then Amazon Web Services S3 uses the\n x-amz-content-sha256
header as a checksum instead of\n Content-MD5
. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature\n Version 4).
\n Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
\n\n General purpose bucket - Server-side\n encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it.\n You have mutually exclusive options to protect data using server-side\n encryption in Amazon S3, depending on how you choose to manage the encryption\n keys. Specifically, the encryption key options are Amazon S3 managed keys\n (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C).\n Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys\n (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest\n using server-side encryption with other key options. The option you use\n depends on whether you want to use KMS keys (SSE-KMS) or provide your own\n encryption key (SSE-C).
\nServer-side encryption is supported by the S3 Multipart Upload\n operations. Unless you are using a customer-provided encryption key (SSE-C),\n you don't need to specify the encryption parameters in each UploadPart\n request. Instead, you only need to specify the server-side encryption\n parameters in the initial Initiate Multipart request. For more information,\n see CreateMultipartUpload.
\nIf you request server-side encryption using a customer-provided\n encryption key (SSE-C) in your initiate multipart upload request, you must\n provide identical encryption information in each part upload using the\n following request headers.
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information, see Using\n Server-Side Encryption in the\n Amazon S3 User Guide.
\n\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
).
Error Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to UploadPart
:
\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part by copying data from an existing object as data source. To specify the\n data source, you add the request header x-amz-copy-source
in your request. To specify \n a byte range, you add the request header x-amz-copy-source-range
in your\n request.
For information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nInstead of copying data from an existing object as part data, you might use the UploadPart\n action to upload new data as a part of an object in your request.
\nYou must initiate a multipart upload before you can upload any part. In response to your\n initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in\n your upload part request.
\nFor conceptual information about multipart uploads, see Uploading\n Objects Using Multipart Upload in the\n Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart\n upload, see Operations on Objects in\n the Amazon S3 User Guide.
\n\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
All UploadPartCopy
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed. For more information, see REST Authentication.
\n Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy
API operation, instead of using the \n temporary security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
\nYou must have READ
access to the source object and WRITE
\n access to the destination bucket.
\n General purpose bucket permissions - You\n must have the permissions in a policy based on the bucket types of your\n source bucket and destination bucket in an UploadPartCopy
\n operation.
If the source object is in a general purpose bucket, you must have the\n \n s3:GetObject
\n \n permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have the\n \n s3:PutObject
\n \n permission to write the object copy to the destination bucket.
To perform a multipart upload with encryption using an Key Management Service\n key, the requester must have permission to the\n kms:Decrypt
and kms:GenerateDataKey
\n actions on the key. The requester must also have permissions for the\n kms:GenerateDataKey
action for the\n CreateMultipartUpload
API. Then, the requester needs\n permissions for the kms:Decrypt
action on the\n UploadPart
and UploadPartCopy
APIs. These\n permissions are required because Amazon S3 must decrypt and read data from\n the encrypted file parts before it completes the multipart upload. For\n more information about KMS permissions, see Protecting\n data using server-side encryption with KMS in the\n Amazon S3 User Guide. For information about the\n permissions required to use the multipart upload API, see Multipart upload\n and permissions and Multipart upload API and permissions in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination\n bucket types in an UploadPartCopy
operation.
If the source object that you want to copy is in a\n directory bucket, you must have the \n s3express:CreateSession
\n permission in\n the Action
element of a policy to read the object. By\n default, the session is in the ReadWrite
mode. If you\n want to restrict the access, you can explicitly set the\n s3express:SessionMode
condition key to\n ReadOnly
on the copy source bucket.
If the copy destination is a directory bucket, you must have the \n \n s3express:CreateSession
\n permission in the\n Action
element of a policy to write the object\n to the destination. The s3express:SessionMode
condition\n key cannot be set to ReadOnly
on the copy destination.
If the object is encrypted with\n SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions in IAM identity-based policies and KMS key policies for the KMS key.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the\n Amazon S3 User Guide.
\n\n General purpose buckets - \n \n For information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy
operation, see CopyObject and UploadPart.\n
\n Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
For directory buckets, when you perform a CreateMultipartUpload
operation and an UploadPartCopy
operation, \n the request headers you provide in the CreateMultipartUpload
request must match the default encryption configuration of the destination bucket.
S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
\nError Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\nHTTP Status Code: 404 Not Found
\nError Code: InvalidRequest
\n
Description: The specified copy source is not supported as a\n byte-range copy source.
\nHTTP Status Code: 400 Bad Request
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to UploadPartCopy
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part by copying data from an existing object as data source. To specify the\n data source, you add the request header x-amz-copy-source
in your request. To\n specify a byte range, you add the request header x-amz-copy-source-range
in\n your request.
For information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nInstead of copying data from an existing object as part data, you might use the\n UploadPart action to upload new data as a part of an object in your\n request.
\nYou must initiate a multipart upload before you can upload any part. In response to your\n initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in\n your upload part request.
\nFor conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide. For information about\n copying objects using a single atomic action vs. a multipart upload, see Operations on\n Objects in the Amazon S3 User Guide.
\n\n Directory buckets -\n 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-az_id.region.amazonaws.com/key-name\n
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the\n Amazon S3 User Guide.
All UploadPartCopy
requests must be authenticated and signed by\n using IAM credentials (access key ID and secret access key for the IAM\n identities). All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed. For more information, see\n REST Authentication.
\n Directory buckets - You must use IAM\n credentials to authenticate and authorize your access to the\n UploadPartCopy
API operation, instead of using the temporary\n security credentials through the CreateSession
API operation.
Amazon Web Services CLI or SDKs handles authentication and authorization on your\n behalf.
\nYou must have READ
access to the source object and\n WRITE
access to the destination bucket.
\n General purpose bucket permissions - You\n must have the permissions in a policy based on the bucket types of your\n source bucket and destination bucket in an UploadPartCopy
\n operation.
If the source object is in a general purpose bucket, you must have the\n \n s3:GetObject
\n \n permission to read the source object that is being copied.
If the destination bucket is a general purpose bucket, you must have the\n \n s3:PutObject
\n \n permission to write the object copy to the destination bucket.
To perform a multipart upload with encryption using an Key Management Service\n key, the requester must have permission to the\n kms:Decrypt
and kms:GenerateDataKey
\n actions on the key. The requester must also have permissions for the\n kms:GenerateDataKey
action for the\n CreateMultipartUpload
API. Then, the requester needs\n permissions for the kms:Decrypt
action on the\n UploadPart
and UploadPartCopy
APIs. These\n permissions are required because Amazon S3 must decrypt and read data from\n the encrypted file parts before it completes the multipart upload. For\n more information about KMS permissions, see Protecting\n data using server-side encryption with KMS in the\n Amazon S3 User Guide. For information about the\n permissions required to use the multipart upload API, see Multipart upload\n and permissions and Multipart upload API and permissions in the\n Amazon S3 User Guide.
\n Directory bucket permissions -\n You must have permissions in a bucket policy or an IAM identity-based policy based on the\n source and destination bucket types in an UploadPartCopy
\n operation.
If the source object that you want to copy is in a\n directory bucket, you must have the \n s3express:CreateSession
\n permission in\n the Action
element of a policy to read the object. By\n default, the session is in the ReadWrite
mode. If you\n want to restrict the access, you can explicitly set the\n s3express:SessionMode
condition key to\n ReadOnly
on the copy source bucket.
If the copy destination is a directory bucket, you must have the\n \n s3express:CreateSession
\n permission in the\n Action
element of a policy to write the object to the\n destination. The s3express:SessionMode
condition key\n cannot be set to ReadOnly
on the copy destination.\n
If the object is encrypted with SSE-KMS, you must also have the\n kms:GenerateDataKey
and kms:Decrypt
permissions\n in IAM identity-based policies and KMS key policies for the KMS\n 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\n S3 Express One Zone in the Amazon S3 User Guide.
\n\n General purpose buckets -\n For information about using\n server-side encryption with customer-provided encryption keys with the\n UploadPartCopy
operation, see CopyObject and\n UploadPart.
\n Directory buckets -\n For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) and server-side encryption with KMS keys (SSE-KMS) (aws:kms
). For more\n information, see Protecting data with server-side encryption in the Amazon S3 User Guide.
For directory buckets, when you perform a\n CreateMultipartUpload
operation and an\n UploadPartCopy
operation, the request headers you provide\n in the CreateMultipartUpload
request must match the default\n encryption configuration of the destination bucket.
S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets \nto directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
\nError Code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The\n upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\nHTTP Status Code: 404 Not Found
\nError Code: InvalidRequest
\n
Description: The specified copy source is not supported as a\n byte-range copy source.
\nHTTP Status Code: 400 Bad Request
\n\n Directory buckets - The HTTP Host header syntax is \n Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to UploadPartCopy
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe server-side encryption algorithm used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256
, aws:kms
).
If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nThe bucket name.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The bucket name.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket\n and key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf
from the bucket\n awsexamplebucket
, use awsexamplebucket/reports/january.pdf
.\n 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:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
\nAccess points are not supported by directory buckets.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your bucket has versioning enabled, you could have multiple versions of the\n same object. By default, x-amz-copy-source
identifies the current\n version of the source object to copy. \n To copy a specific version of the source object to copy, append ?versionId=
\n to the x-amz-copy-source
request header (for example, \n x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n
If the current version is a delete marker and you\n don't specify a versionId in the x-amz-copy-source
request header, Amazon S3 returns a\n 404 Not Found
error, because the object does not exist. If you specify versionId in the\n x-amz-copy-source
and the versionId is a delete marker, Amazon S3\n returns an HTTP 400 Bad Request
error, because you are not allowed to specify a delete marker\n as a version for the x-amz-copy-source
.
\n Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
\nSpecifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket\n and key of the source object, separated by a slash (/). For example, to copy the\n object reports/january.pdf
from the bucket\n awsexamplebucket
, use awsexamplebucket/reports/january.pdf
.\n 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:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
\nAccess points are not supported by directory buckets.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded.
If your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source
identifies the current version of the\n source object to copy. To copy a specific version of the source object to copy, append\n ?versionId=
to the x-amz-copy-source
request\n header (for example, x-amz-copy-source:\n /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).
If the current version is a delete marker and you don't specify a versionId in the\n x-amz-copy-source
request header, Amazon S3 returns a 404 Not Found
\n error, because the object does not exist. If you specify versionId in the\n x-amz-copy-source
and the versionId is a delete marker, Amazon S3 returns an\n HTTP 400 Bad Request
error, because you are not allowed to specify a delete\n marker as a version for the x-amz-copy-source
.
\n Directory buckets -\n S3 Versioning isn't enabled and supported for directory buckets.
\nCopies the object if its entity tag (ETag) matches the specified tag.
\nIf both of the\n x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-match
condition evaluates to true
,\n and;
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
;
Amazon S3 returns 200 OK
and copies the data.\n
Copies the object if its entity tag (ETag) matches the specified tag.
\nIf both of the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the request as\n follows:
\n x-amz-copy-source-if-match
condition evaluates to true
,\n and;
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
;
Amazon S3 returns 200 OK
and copies the data.\n
Copies the object if it has been modified since the specified time.
\nIf both of the\n x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-none-match
condition evaluates to\n false
, and;
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
;
Amazon S3 returns 412 Precondition Failed
response code.\n
Copies the object if it has been modified since the specified time.
\nIf both of the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the request as\n follows:
\n x-amz-copy-source-if-none-match
condition evaluates to false
,\n and;
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
;
Amazon S3 returns 412 Precondition Failed
response code.\n
Copies the object if its entity tag (ETag) is different than the specified ETag.
\nIf both of the\n x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-none-match
condition evaluates to\n false
, and;
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
;
Amazon S3 returns 412 Precondition Failed
response code.\n
Copies the object if its entity tag (ETag) is different than the specified ETag.
\nIf both of the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the request as\n follows:
\n x-amz-copy-source-if-none-match
condition evaluates to false
,\n and;
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
;
Amazon S3 returns 412 Precondition Failed
response code.\n
Copies the object if it hasn't been modified since the specified time.
\nIf both of the\n x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-match
condition evaluates to true
,\n and;
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
;
Amazon S3 returns 200 OK
and copies the data.\n
Copies the object if it hasn't been modified since the specified time.
\nIf both of the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the request as\n follows:
\n x-amz-copy-source-if-match
condition evaluates to true
,\n and;
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
;
Amazon S3 returns 200 OK
and copies the data.\n
Specifies the algorithm to use when encrypting the object (for example,\n AES256).
\nThis functionality is not supported when the destination bucket is a directory bucket.
\nSpecifies the algorithm to use when encrypting the object (for example, AES256).
\nThis functionality is not supported when the destination bucket is a directory bucket.
\nSpecifies the algorithm to use when decrypting the source object (for example,\n AES256
).
This functionality is not supported when the source object is in a directory bucket.
\nSpecifies the algorithm to use when decrypting the source object (for example,\n AES256
).
This functionality is not supported when the source object is in a directory bucket.
\nThe server-side encryption algorithm used when you store this object in Amazon S3 (for example,\n AES256
, aws:kms
).
The server-side encryption algorithm used when you store this object in Amazon S3 (for\n example, AES256
, aws:kms
).
If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification of\n the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nIf server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide the round-trip message integrity verification\n of the customer-provided encryption key.
\nThis functionality is not supported for directory buckets.
\nThe name of the bucket to which the multipart upload was initiated.
\n\n Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
The name of the bucket to which the multipart upload was initiated.
\n\n Directory buckets -\n When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format \n Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format \n bucket_base_name--az-id--x-s3
(for example, \n DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming\n restrictions, see Directory bucket naming\n rules in the Amazon S3 User Guide.
\n 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.
\nAccess points and Object Lambda access points are not supported by directory buckets.
\n\n 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 \n 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.
Specifies the algorithm to use when encrypting the object (for example,\n AES256).
\nThis functionality is not supported for directory buckets.
\nSpecifies the algorithm to use when encrypting the object (for example, AES256).
\nThis functionality is not supported for directory buckets.
\nThis operation is not supported by directory buckets.
\nPasses transformed objects to a GetObject
operation when using Object Lambda access points. For\n information about Object Lambda access points, see Transforming objects with\n Object Lambda access points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute
, RequestToken
, StatusCode
,\n ErrorCode
, and ErrorMessage
. The GetObject
\n response metadata is supported so that the WriteGetObjectResponse
caller,\n typically an Lambda function, can provide the same metadata when it internally invokes\n GetObject
. When WriteGetObjectResponse
is called by a\n customer-owned Lambda function, the metadata returned to the end user\n GetObject
call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata header, it\n should be prefaced with x-amz-meta
. For example,\n x-amz-meta-my-custom-header: MyCustomValue
. The primary use case for this\n is to forward GetObject
metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to\n detect and redact personally identifiable information (PII) and decompress S3 objects.\n These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and\n can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.
\nExample 1: PII Access Control - This Lambda function uses Amazon Comprehend, a\n natural language processing (NLP) service using machine learning to find insights and\n relationships in text. It automatically detects personally identifiable information (PII)\n such as names, addresses, dates, credit card numbers, and social security numbers from\n documents in your Amazon S3 bucket.
\nExample 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural\n language processing (NLP) service using machine learning to find insights and relationships\n in text. It automatically redacts personally identifiable information (PII) such as names,\n addresses, dates, credit card numbers, and social security numbers from documents in your\n Amazon S3 bucket.
\nExample 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is\n equipped to decompress objects stored in S3 in one of six compressed file formats including\n bzip2, gzip, snappy, zlib, zstandard and ZIP.
\nFor information on how to view and use these functions, see Using Amazon Web Services built Lambda\n functions in the Amazon S3 User Guide.
", + "smithy.api#documentation": "This operation is not supported for directory buckets.
\nPasses transformed objects to a GetObject
operation when using Object Lambda access points. For\n information about Object Lambda access points, see Transforming objects with\n Object Lambda access points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute
, RequestToken
, StatusCode
,\n ErrorCode
, and ErrorMessage
. The GetObject
\n response metadata is supported so that the WriteGetObjectResponse
caller,\n typically an Lambda function, can provide the same metadata when it internally invokes\n GetObject
. When WriteGetObjectResponse
is called by a\n customer-owned Lambda function, the metadata returned to the end user\n GetObject
call might differ from what Amazon S3 would normally return.
You can include any number of metadata headers. When including a metadata header, it\n should be prefaced with x-amz-meta
. For example,\n x-amz-meta-my-custom-header: MyCustomValue
. The primary use case for this\n is to forward GetObject
metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to\n detect and redact personally identifiable information (PII) and decompress S3 objects.\n These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and\n can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.
\nExample 1: PII Access Control - This Lambda function uses Amazon Comprehend, a\n natural language processing (NLP) service using machine learning to find insights and\n relationships in text. It automatically detects personally identifiable information (PII)\n such as names, addresses, dates, credit card numbers, and social security numbers from\n documents in your Amazon S3 bucket.
\nExample 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural\n language processing (NLP) service using machine learning to find insights and relationships\n in text. It automatically redacts personally identifiable information (PII) such as names,\n addresses, dates, credit card numbers, and social security numbers from documents in your\n Amazon S3 bucket.
\nExample 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is\n equipped to decompress objects stored in S3 in one of six compressed file formats including\n bzip2, gzip, snappy, zlib, zstandard and ZIP.
\nFor information on how to view and use these functions, see Using Amazon Web Services built Lambda\n functions in the Amazon S3 User Guide.
", "smithy.api#endpoint": { "hostPrefix": "{RequestRoute}." }, @@ -34969,7 +35100,7 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for stored in Amazon S3 object.
", + "smithy.api#documentation": "If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key\n Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in\n Amazon S3 object.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -35013,6 +35144,9 @@ "smithy.api#input": {} } }, + "com.amazonaws.s3#WriteOffsetBytes": { + "type": "long" + }, "com.amazonaws.s3#Years": { "type": "integer" }