View Source AWS.S3 (aws-elixir v0.14.1)
Summary
Functions
This operation aborts a multipart upload.
Completes a multipart upload by assembling previously uploaded parts.
Creates a copy of an object that is already stored in Amazon S3.
This action creates an Amazon S3 bucket.
This action initiates a multipart upload and returns an upload ID.
Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint APIs on directory buckets.
Deletes the S3 bucket.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Deletes the policy of a specified bucket.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Removes an object from a bucket.
This operation is not supported by directory buckets.
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
For an updated version of this API, see
GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter
element, you should see
the updated version of this topic. This topic is provided for backward
compatibility.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Returns the policy of a specified bucket.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Retrieves all the metadata from an object without returning the object itself.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
You can use this operation to determine if a bucket exists and if you have permission to access it.
The HEAD
operation retrieves metadata from an object without returning the
object itself.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request.
This operation lists in-progress multipart uploads in a bucket.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Returns some or all (up to 1,000) of the objects in a bucket with each request.
Lists the parts that have been uploaded for a specific multipart upload.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Adds an object to a bucket.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
This operation is not supported by directory buckets.
Uploads a part in a multipart upload.
Uploads a part by copying data from an existing object as data source.
This operation is not supported by directory buckets.
Functions
This operation aborts a multipart upload.
After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
To verify that all parts have been removed and prevent getting charged for the part storage, you should call the ListParts API operation and ensure that the parts list is empty.
Directory buckets - 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.
Definitions
Permissions
General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to AbortMultipartUpload
:
CreateMultipartUpload UploadPart
complete_multipart_upload(client, bucket, key, input, options \\ [])
View SourceCompletes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the
UploadPart operation or the
UploadPartCopy
operation. After successfully uploading all relevant parts of an upload, you
call this CompleteMultipartUpload
operation to complete the upload. Upon
receiving this request, Amazon S3 concatenates all the parts in ascending order
by part number to create a new object. In the CompleteMultipartUpload request,
you must provide the parts list and ensure that the parts list is complete. The
CompleteMultipartUpload API operation concatenates the parts that you provide in
the list. For each part in the list, you must provide the PartNumber
value and
the ETag
value that are returned after that part was uploaded.
The processing of a CompleteMultipartUpload request could take several minutes
to finalize. After Amazon S3 begins processing the request, it sends an HTTP
response header that specifies a 200 OK
response. While processing is in
progress, Amazon S3 periodically sends white space characters to keep the
connection from timing out. A request could fail after the initial 200 OK
response has been sent. This means that a 200 OK
response can contain either a
success or an error. The error response might be embedded in the 200 OK
response. If you call this API operation directly, make sure to design your
application to parse the contents of the response and handle it appropriately.
If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect
the embedded error and apply error handling per your configuration settings
(including automatically retrying the request as appropriate). If the condition
persists, the SDKs throw an exception (or, for the SDKs that don't use
exceptions, they return an error).
Note that if CompleteMultipartUpload
fails, applications should be prepared to
retry the failed requests. For more information, see Amazon S3 Error Best Practices.
You can't use Content-Type: application/x-www-form-urlencoded
for the
CompleteMultipartUpload requests. Also, if you don't provide a Content-Type
header, CompleteMultipartUpload
can still return a 200 OK
response.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
Definitions
Permissions
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Special errors
Error Code: EntityTooSmall
Description: Your proposed upload is smaller than the
minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
HTTP Status Code: 400 Bad Request
Error Code: InvalidPart
Description: One or more of the specified parts could
not be found. The part might not have been uploaded, or the specified ETag might not have matched the uploaded part's ETag.
HTTP Status Code: 400 Bad Request
Error Code: InvalidPartOrder
Description: The list of parts was not in ascending
order. The parts list must be specified in order by part number.
HTTP Status Code: 400 Bad Request
Error Code: NoSuchUpload
Description: The specified multipart upload does not
exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to CompleteMultipartUpload
:
CreateMultipartUpload UploadPart
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.
You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.
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.
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.
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.
Definitions
Authentication and authorization
All CopyObject
requests must be authenticated and signed by using IAM
credentials (access key ID and secret access key for the IAM identities). All
headers with 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.
Permissions
You must have read access to the source object and write access to the destination bucket.
General purpose bucket permissions - You must have permissions
in an IAM policy based on the source and destination bucket types in a
CopyObject
operation.
If the source object is in a general purpose bucket,
you must have s3:GetObject
permission to read the source object that is
being copied.
If the destination bucket is a general purpose bucket,
you must have s3:PubObject
permission to write the object copy to the
destination bucket.
Directory bucket permissions - You must have permissions in a
bucket policy or an IAM identity-based policy based on the source and
destination bucket types in a CopyObject
operation.
If the source object that you want to copy is in a
directory bucket, you must have the s3express:CreateSession
permission
in the Action
element of a policy to read the object. By default, the session
is in the ReadWrite
mode. If you want to restrict the access, you can
explicitly set the s3express:SessionMode
condition key to ReadOnly
on the
copy source bucket.
If the copy destination is a directory bucket, you must
have the s3express:CreateSession
permission in the Action
element of a
policy to write the object to the destination. The s3express:SessionMode
condition key can't be set to ReadOnly
on the copy destination bucket.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
Response and special errors
When the request is an HTTP 1.1 request, the response is chunk encoded. When the
request is not an HTTP 1.1 request, the response would not contain the
Content-Length
. You always need to read the entire response body to check if
the copy succeeds. to keep the connection alive while we copy the data.
If the copy is successful, you receive a response with information about the copied object.
A copy request might return an error when Amazon S3 receives the
copy request or while Amazon S3 is copying the files. A 200 OK
response can
contain either a success or an error.
If the error occurs before the copy action starts, you
receive a standard Amazon S3 error.
If the error occurs during the copy operation, the
error response is embedded in the 200 OK
response. For example, in a
cross-region copy, you may encounter throttling and receive a 200 OK
response.
For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The
200 OK
status code means the copy was accepted, but it doesn't mean the copy
is complete. Another example is when you disconnect from Amazon S3 before the
copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK
response. You must stay connected to Amazon S3 until the entire response is
successfully received and processed.
If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don't use exceptions, they return an error).
Charge
The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. For pricing information, see Amazon S3 pricing.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to CopyObject
:
This action creates an Amazon S3 bucket.
To create an Amazon S3 on Outposts bucket, see CreateBucket
.
Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.
General purpose buckets - If you send your CreateBucket
request to the s3.amazonaws.com
global endpoint, the request goes to the
us-east-1
Region. So the signature calculations in Signature Version 4 must
use us-east-1
as the Region, even if the location constraint in the request
specifies another Region where the bucket is to be created. If you create a
bucket in a Region other than US East (N. Virginia), your application must be
able to handle 307 redirect. For more information, see Virtual hosting of buckets in
the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make
requests for this API operation to the Regional endpoint. These endpoints
support path-style requests in the format
https://s3express-control.*region_code*.amazonaws.com/*bucket-name*
.
Virtual-hosted-style requests aren't supported. For more information, see
Regional and Zonal endpoints
in the Amazon S3 User Guide.
Definitions
Permissions
General purpose bucket permissions - In addition to the
s3:CreateBucket
permission, the following permissions are required in a policy
when your CreateBucket
request includes specific headers:
**Access control lists (ACLs)** - In your
CreateBucket
request, if you specify an access control list (ACL) and set it
to public-read
, public-read-write
, authenticated-read
, or if you
explicitly specify any other custom ACLs, both s3:CreateBucket
and
s3:PutBucketAcl
permissions are required. In your CreateBucket
request, if
you set the ACL to private
, or if you don't specify any ACLs, only the
s3:CreateBucket
permission is required.
**Object Lock** - In your `CreateBucket` request, if
you set x-amz-bucket-object-lock-enabled
to true, the
s3:PutBucketObjectLockConfiguration
and s3:PutBucketVersioning
permissions
are required.
**S3 Object Ownership** - If your `CreateBucket`
request includes the x-amz-object-ownership
header, then the
s3:PutBucketOwnershipControls
permission is required.
If your CreateBucket
request sets BucketOwnerEnforced
for Amazon S3 Object
Ownership and specifies a bucket ACL that provides access to an external Amazon
Web Services account, your request fails with a 400
error and returns the
InvalidBucketAcLWithObjectOwnership
error code. For more information, see
Setting Object Ownership on an existing bucket
in the Amazon S3 User Guide.
**S3 Block Public Access** - If your specific use case
requires granting public access to your S3 resources, you can disable Block
Public Access. Specifically, you can create a new bucket with Block Public
Access enabled, then separately call the DeletePublicAccessBlock
API. To use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage
in the Amazon S3 User Guide.
Directory bucket permissions - You must have the
s3express:CreateBucket
permission in an IAM identity-based policy instead of a
bucket policy. Cross-account access to this API operation isn't supported. This
operation can only be performed by the Amazon Web Services account that owns the
resource. For more information about directory bucket policies and permissions,
see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone
in the Amazon S3 User Guide.
The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can't be modified.
For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.*region*.amazonaws.com
.
The following operations are related to CreateBucket
:
create_multipart_upload(client, bucket, key, input, options \\ [])
View SourceThis action initiates a multipart upload and returns an upload ID.
This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview in the Amazon S3 User Guide.
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stops charging you for storing them only after you either complete or abort a multipart upload.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
Directory buckets - S3 Lifecycle is not supported by directory buckets.
Directory buckets - For directory buckets, you must make
requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
Definitions
Request signing
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4) in the Amazon S3 User Guide.
Permissions
General purpose bucket permissions - For information about the permissions required to use the multipart upload API, see Multipart upload and permissions in the Amazon S3 User Guide.
To perform a multipart upload with encryption by using an Amazon Web Services
KMS key, the requester must have permission to the kms:Decrypt
and
kms:GenerateDataKey*
actions on the key. These permissions are required
because Amazon S3 must decrypt and read data from the encrypted file parts
before it completes the multipart upload. For more information, see Multipart upload API and
permissions
and Protecting data using server-side encryption with Amazon Web Services KMS
in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Encryption
General purpose buckets - Server-side encryption is for data
encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its
data centers and decrypts it when you access it. Amazon S3 automatically
encrypts all new objects that are uploaded to an S3 bucket. When doing a
multipart upload, if you don't specify encryption information in your request,
the encryption setting of the uploaded parts is set to the default encryption
configuration of the destination bucket. By default, all buckets have a base
level of encryption configuration that uses server-side encryption with Amazon
S3 managed keys (SSE-S3). If the destination bucket has a default encryption
configuration that uses server-side encryption with an Key Management Service
(KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3
uses the corresponding KMS key, or a customer-provided key to encrypt the
uploaded parts. When you perform a CreateMultipartUpload operation, if you want
to use a different type of encryption setting for the uploaded parts, you can
request that Amazon S3 encrypts the object with a different encryption key (such
as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the
encryption setting in your request is different from the default encryption
configuration of the destination bucket, the encryption setting in your request
takes precedence. If you choose to provide your own encryption key, the request
headers you provide in
UploadPart and
UploadPartCopy
requests must match the headers you used in the CreateMultipartUpload
request.
Use KMS keys (SSE-KMS) that include the Amazon Web
Services managed key (aws/s3
) and KMS customer managed keys stored in Key
Management Service (KMS) – If you want Amazon Web Services to manage the keys
used to encrypt data, specify the following headers in the request.
`x-amz-server-side-encryption`
x-amz-server-side-encryption-aws-kms-key-id
`x-amz-server-side-encryption-context`
If you specify x-amz-server-side-encryption:aws:kms
, but don't
provide x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the Amazon
Web Services managed key (aws/s3
key) in KMS to protect the data.
To perform a multipart upload with encryption by using an Amazon
Web Services KMS key, the requester must have permission to the kms:Decrypt
and kms:GenerateDataKey*
actions on the key. These permissions are required
because Amazon S3 must decrypt and read data from the encrypted file parts
before it completes the multipart upload. For more information, see Multipart upload API and
permissions
and Protecting data using server-side encryption with Amazon Web Services KMS
in the Amazon S3 User Guide.
If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.
All GET
and PUT
requests for an object protected by KMS fail if
you don't make them by using Secure Sockets Layer (SSL), Transport Layer
Security (TLS), or Signature Version 4. For information about configuring any of
the officially supported Amazon Web Services SDKs and Amazon Web Services CLI,
see Specifying the Signature Version in Request Authentication
in the Amazon S3 User Guide.
For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.
Use customer-provided encryption keys (SSE-C) – If you
want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
`x-amz-server-side-encryption-customer-key`
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) in the Amazon S3 User Guide.
Directory buckets -For directory buckets, only server-side
encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to CreateMultipartUpload
:
UploadPart CompleteMultipartUpload
create_session(client, bucket, session_mode \\ nil, options \\ [])
View SourceCreates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint APIs on directory buckets.
For more information about Zonal endpoint APIs that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide.
To make Zonal endpoint API requests on a directory bucket, use the
CreateSession
API operation. Specifically, you grant s3express:CreateSession
permission to a bucket in a bucket policy or an IAM identity-based policy. Then,
you use IAM credentials to make the CreateSession
API request on the bucket,
which returns temporary security credentials that include the access key ID,
secret access key, session token, and expiration. These credentials have
associated permissions to access the Zonal endpoint APIs. After the session is
created, you don’t need to use other policies to grant permissions to each Zonal
endpoint API individually. Instead, in your Zonal endpoint API requests, you
sign your requests by applying the temporary security credentials of the session
to the request headers and following the SigV4 protocol for authentication. You
also apply the session token to the x-amz-s3session-token
request header for
authorization. Temporary security credentials are scoped to the bucket and
expire after 5 minutes. After the expiration time, any calls that you make with
those credentials will fail. You must use IAM credentials again to make a
CreateSession
API request that generates a new set of temporary credentials
for use. Temporary credentials cannot be extended or refreshed beyond the
original specified interval.
If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the Amazon S3 User Guide.
You must make requests for this API operation to the Zonal
endpoint. These endpoints support virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*az_id*.*region*.amazonaws.com
. Path-style
requests are not supported. For more information, see Regional and Zonal endpoints
in the Amazon S3 User Guide.
CopyObject
API operation - Unlike other Zonal endpoint APIs,
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 APIs,
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.
Definitions
Permissions
To obtain temporary security credentials, you must create a bucket policy or an
IAM identity-based policy that grants s3express:CreateSession
permission to
the bucket. In a policy, you can have the s3express:SessionMode
condition key
to control who can create a ReadWrite
or ReadOnly
session. For more
information about ReadWrite
or ReadOnly
sessions, see
x-amz-create-session-mode
.
For example policies, see Example bucket policies for S3 Express One Zone
and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One
Zone
in the Amazon S3 User Guide.
To grant cross-account access to Zonal endpoint APIs, the bucket policy should
also grant both accounts the s3express:CreateSession
permission.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
Deletes the S3 bucket.
All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Directory buckets - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.
Directory buckets - For directory buckets, you must make
requests for this API operation to the Regional endpoint. These endpoints
support path-style requests in the format
https://s3express-control.*region_code*.amazonaws.com/*bucket-name*
.
Virtual-hosted-style requests aren't supported. For more information, see
Regional and Zonal endpoints
in the Amazon S3 User Guide.
Definitions
Permissions
General purpose bucket permissions - You must have the
s3:DeleteBucket
permission on the specified bucket in a policy.
Directory bucket permissions - You must have the
s3express:DeleteBucket
permission in an IAM identity-based policy instead of a
bucket policy. Cross-account access to this API operation isn't supported. This
operation can only be performed by the Amazon Web Services account that owns the
resource. For more information about directory bucket policies and permissions,
see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone
in the Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.*region*.amazonaws.com
.
The following operations are related to DeleteBucket
:
delete_bucket_analytics_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration
:
GetBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations
This operation is not supported by directory buckets.
Deletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the
s3:PutBucketCORS
action. The bucket owner has this permission by default and
can grant this permission to others.
For information about cors
, see Enabling Cross-Origin Resource Sharing in the
Amazon S3 User Guide.
Related Resources
This operation is not supported by directory buckets.
This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.
To use this operation, you must have permissions to perform the
s3:PutEncryptionConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to your Amazon S3 Resources
in the Amazon S3 User Guide.
The following operations are related to DeleteBucketEncryption
:
delete_bucket_intelligent_tiering_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to DeleteBucketIntelligentTieringConfiguration
include:
GetBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration
delete_bucket_inventory_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:PutInventoryConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to DeleteBucketInventoryConfiguration
include:
GetBucketInventoryConfiguration PutBucketInventoryConfiguration
This operation is not supported by directory buckets.
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the
s3:PutLifecycleConfiguration
action. By default, the bucket owner has this
permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
PutBucketLifecycleConfiguration GetBucketLifecycleConfiguration
delete_bucket_metrics_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the
s3:PutMetricsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to DeleteBucketMetricsConfiguration
:
GetBucketMetricsConfiguration PutBucketMetricsConfiguration
ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
delete_bucket_ownership_controls(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Removes OwnershipControls
for an Amazon S3 bucket. To use this operation, you
must have the s3:PutBucketOwnershipControls
permission. For more information
about Amazon S3 permissions, see Specifying Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to DeleteBucketOwnershipControls
:
GetBucketOwnershipControls
PutBucketOwnershipControls
Deletes the policy of a specified bucket.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
https://s3express-control.*region_code*.amazonaws.com/*bucket-name*
.
Virtual-hosted-style requests aren't supported. For more information, see
Regional and Zonal endpoints
in the Amazon S3 User Guide.
Definitions
Permissions
If you are using an identity other than the root user of the Amazon Web Services
account that owns the bucket, the calling identity must both have the
DeleteBucketPolicy
permissions on the specified bucket and belong to the
bucket owner's account in order to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using
an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their
own buckets, the root principal in a bucket owner's Amazon Web Services account
can perform the GetBucketPolicy
, PutBucketPolicy
, and DeleteBucketPolicy
API actions, even if their bucket policy explicitly denies the root principal's
access. Bucket owner root principals can only be blocked from performing these
API actions by VPC endpoint policies and Amazon Web Services Organizations
policies.
General purpose bucket permissions - The
s3:DeleteBucketPolicy
permission is required in a policy. For more information
about general purpose buckets bucket policies, see Using Bucket Policies and User
Policies
in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation, you must have the s3express:DeleteBucketPolicy
permission in an IAM
identity-based policy instead of a bucket policy. Cross-account access to this
API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource. For more information about
directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One
Zone
in the Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.*region*.amazonaws.com
.
The following operations are related to DeleteBucketPolicy
This operation is not supported by directory buckets.
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the
s3:PutReplicationConfiguration
action. The bucket owner has these permissions
by default and can grant it to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 User Guide.
The following operations are related to DeleteBucketReplication
:
This operation is not supported by directory buckets.
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the
s3:PutBucketTagging
action. By default, the bucket owner has this permission
and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
This operation is not supported by directory buckets.
This action removes the website configuration for a bucket. Amazon S3 returns a
200 OK
response upon successfully deleting a website configuration on the
specified bucket. You will get a 200 OK
response if the website configuration
you are trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if the bucket specified in the request does not exist.
This DELETE action requires the S3:DeleteBucketWebsite
permission. By default,
only the bucket owner can delete the website configuration attached to a bucket.
However, bucket owners can grant other users permission to delete the website
configuration by writing a bucket policy granting them the
S3:DeleteBucketWebsite
permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to DeleteBucketWebsite
:
Removes an object from a bucket.
The behavior depends on the bucket's versioning state:
If versioning is enabled, the operation removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful.
If versioning is suspended or not enabled, the operation permanently deletes the object.
Directory buckets - S3 Versioning isn't enabled and supported
for directory buckets. For this API operation, only the null
value of the
version ID is supported by directory buckets. You can only specify null
to the
versionId
query parameter in the request.
Directory buckets - For directory buckets, you must make
requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*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.
To remove a specific version, you must use the versionId
query parameter.
Using this query parameter permanently deletes the version. If the object
deleted is a delete marker, Amazon S3 sets the response header
x-amz-delete-marker
to true.
If the object you want to delete is in a bucket where the bucket versioning
configuration is MFA Delete enabled, you must include the x-amz-mfa
request
header in the DELETE versionId
request. Requests that include x-amz-mfa
must
use HTTPS. For more information about MFA Delete, see Using MFA Delete in
the Amazon S3 User Guide. To see sample requests that use versioning, see
Sample Request.
Directory buckets - MFA delete is not supported by directory buckets.
You can delete objects by explicitly calling DELETE Object or calling
(PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or
accounts from removing or deleting objects from your bucket, you must deny them
the s3:DeleteObject
, s3:DeleteObjectVersion
, and
s3:PutLifeCycleConfiguration
actions.
Directory buckets - S3 Lifecycle is not supported by directory buckets.
Definitions
Permissions
General purpose bucket permissions - The following permissions
are required in your policies when your DeleteObjects
request includes
specific headers.
** `s3:DeleteObject` ** - To delete an object from a
bucket, you must always have the s3:DeleteObject
permission.
** `s3:DeleteObjectVersion` ** - To delete a specific
version of an object from a versiong-enabled bucket, you must have the
s3:DeleteObjectVersion
permission.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following action is related to DeleteObject
:
This operation is not supported by directory buckets.
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the
s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query parameter
in the request. You will need permission for the s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteObjectTagging
:
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request can contain a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
Directory buckets - For directory buckets, you must make
requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.
Directory buckets - MFA delete is not supported by directory buckets.
Definitions
Permissions
General purpose bucket permissions - The following permissions
are required in your policies when your DeleteObjects
request includes
specific headers.
** `s3:DeleteObject` ** - To delete an object from a
bucket, you must always specify the s3:DeleteObject
permission.
** `s3:DeleteObjectVersion` ** - To delete a specific
version of an object from a versiong-enabled bucket, you must specify the
s3:DeleteObjectVersion
permission.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Content-MD5 request header
General purpose bucket - The Content-MD5 request header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
Directory bucket - The Content-MD5 request header or a
additional checksum request header (including x-amz-checksum-crc32
,
x-amz-checksum-crc32c
, x-amz-checksum-sha1
, or x-amz-checksum-sha256
) is
required for all Multi-Object Delete requests.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to DeleteObjects
:
CreateMultipartUpload UploadPart
This operation is not supported by directory buckets.
Removes the PublicAccessBlock
configuration for an Amazon S3 bucket. To use
this operation, you must have the s3:PutBucketPublicAccessBlock
permission.
For more information about permissions, see Permissions Related to Bucket Subresource
Operations
and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeletePublicAccessBlock
:
get_bucket_accelerate_configuration(client, bucket, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
This implementation of the GET action uses the accelerate
subresource to
return the Transfer Acceleration state of a bucket, which is either Enabled
or
Suspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that
enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the
s3:GetAccelerateConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to your Amazon S3 Resources
in the Amazon S3 User Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or
Suspended
by using the
PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that has
no transfer acceleration state. A bucket has no Transfer Acceleration state if a
state has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in the Amazon S3 User Guide.
The following operations are related to GetBucketAccelerateConfiguration
:
get_bucket_acl(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
This implementation of the GET
action uses the acl
subresource to return the
access control list (ACL) of a bucket. To use GET
to return the ACL of the
bucket, you must have the READ_ACP
access to the bucket. If READ_ACP
permission is granted to the anonymous user, you can return the ACL of the
bucket without using an authorization header.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name. If the
Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError
is returned. For more information about
InvalidAccessPointAliasError
, see List of Error Codes.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
requests to read ACLs are still supported and return the
bucket-owner-full-control
ACL with the owner being the account that created
the bucket. For more information, see Controlling object ownership and disabling
ACLs
in the Amazon S3 User Guide.
The following operations are related to GetBucketAcl
:
get_bucket_analytics_configuration(client, bucket, id, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources
in the Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.
The following operations are related to GetBucketAnalyticsConfiguration
:
DeleteBucketAnalyticsConfiguration ListBucketAnalyticsConfigurations
get_bucket_cors(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the bucket.
To use this operation, you must have permission to perform the
s3:GetBucketCORS
action. By default, the bucket owner has this permission and
can grant it to others.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name. If the
Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError
is returned. For more information about
InvalidAccessPointAliasError
, see List of Error Codes.
For more information about CORS, see Enabling Cross-Origin Resource Sharing.
The following operations are related to GetBucketCors
:
get_bucket_encryption(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the bucket default encryption feature, see Amazon S3 Bucket Default Encryption in the Amazon S3 User Guide.
To use this operation, you must have permission to perform the
s3:GetEncryptionConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to GetBucketEncryption
:
get_bucket_intelligent_tiering_configuration(client, bucket, id, options \\ [])
View SourceThis operation is not supported by directory buckets.
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to GetBucketIntelligentTieringConfiguration
include:
DeleteBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration
get_bucket_inventory_configuration(client, bucket, id, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration
action. The bucket owner has this permission by
default and can grant this permission to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to GetBucketInventoryConfiguration
:
DeleteBucketInventoryConfiguration ListBucketInventoryConfigurations
get_bucket_lifecycle(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceFor an updated version of this API, see
GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter
element, you should see
the updated version of this topic. This topic is provided for backward
compatibility.
This operation is not supported by directory buckets.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
GetBucketLifecycle
has the following special error:
Error code:
NoSuchLifecycleConfiguration
- Description: The lifecycle configuration does not
exist.
* HTTP Status Code: 404 Not Found
* SOAP Fault Code Prefix: Client
The following operations are related to GetBucketLifecycle
:
get_bucket_lifecycle_configuration(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis 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, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the
s3:GetLifecycleConfiguration
action. The bucket owner has this permission, by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
GetBucketLifecycleConfiguration
has the following special error:
Error code:
NoSuchLifecycleConfiguration
- Description: The lifecycle configuration does not
exist.
* HTTP Status Code: 404 Not Found
* SOAP Fault Code Prefix: Client
The following operations are related to GetBucketLifecycleConfiguration
:
get_bucket_location(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the Region the bucket resides in. You set the bucket's Region using the
LocationConstraint
request parameter in a CreateBucket
request. For more
information, see
CreateBucket. When you use this API operation with an access point, provide the alias of the
access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name. If the
Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError
is returned. For more information about
InvalidAccessPointAliasError
, see List of Error
Codes.
We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.
The following operations are related to GetBucketLocation
:
get_bucket_logging(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the logging status of a bucket and the permissions users have to view and modify that status.
The following operations are related to GetBucketLogging
:
get_bucket_metrics_configuration(client, bucket, id, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to GetBucketMetricsConfiguration
:
PutBucketMetricsConfiguration DeleteBucketMetricsConfiguration
ListBucketMetricsConfigurations Monitoring Metrics with Amazon CloudWatch
get_bucket_notification(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
No longer used, see GetBucketNotificationConfiguration.
get_bucket_notification_configuration(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the action returns an empty
NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration
of a bucket. However, the bucket owner can use a bucket policy to grant
permission to other users to read this configuration with the
s3:GetBucketNotification
permission.
When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.
When you use this API operation with an Object Lambda access point, provide the
alias of the Object Lambda access point in place of the bucket name. If the
Object Lambda access point alias in a request is not valid, the error code
InvalidAccessPointAliasError
is returned. For more information about
InvalidAccessPointAliasError
, see List of Error Codes.
For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following action is related to GetBucketNotification
:
get_bucket_ownership_controls(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Retrieves OwnershipControls
for an Amazon S3 bucket. To use this operation,
you must have the s3:GetBucketOwnershipControls
permission. For more
information about Amazon S3 permissions, see Specifying permissions in a policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to GetBucketOwnershipControls
:
PutBucketOwnershipControls
DeleteBucketOwnershipControls
get_bucket_policy(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceReturns the policy of a specified bucket.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
https://s3express-control.*region_code*.amazonaws.com/*bucket-name*
.
Virtual-hosted-style requests aren't supported. For more information, see
Regional and Zonal endpoints
in the Amazon S3 User Guide.
Definitions
Permissions
If you are using an identity other than the root user of the Amazon Web Services
account that owns the bucket, the calling identity must both have the
GetBucketPolicy
permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an
identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their
own buckets, the root principal in a bucket owner's Amazon Web Services account
can perform the GetBucketPolicy
, PutBucketPolicy
, and DeleteBucketPolicy
API actions, even if their bucket policy explicitly denies the root principal's
access. Bucket owner root principals can only be blocked from performing these
API actions by VPC endpoint policies and Amazon Web Services Organizations
policies.
General purpose bucket permissions - The s3:GetBucketPolicy
permission is required in a policy. For more information about general purpose
buckets bucket policies, see Using Bucket Policies and User Policies
in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation, you must have the s3express:GetBucketPolicy
permission in an IAM
identity-based policy instead of a bucket policy. Cross-account access to this
API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource. For more information about
directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One
Zone
in the Amazon S3 User Guide.
Example bucket policies
General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.*region*.amazonaws.com
.
The following action is related to GetBucketPolicy
:
get_bucket_policy_status(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Retrieves the policy status for an Amazon S3 bucket, indicating whether the
bucket is public. In order to use this operation, you must have the
s3:GetBucketPolicyStatus
permission. For more information about Amazon S3
permissions, see Specifying Permissions in a Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".
The following operations are related to GetBucketPolicyStatus
:
get_bucket_replication(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
For information about replication configuration, see Replication in the Amazon S3 User Guide.
This action requires permissions for the s3:GetReplicationConfiguration
action. For more information about permissions, see Using Bucket Policies and
User
Policies.
If you include the Filter
element in a replication configuration, you must
also include the DeleteMarkerReplication
and Priority
elements. The response
also returns those elements.
For information about GetBucketReplication
errors, see List of replication-related error
codes
The following operations are related to GetBucketReplication
:
get_bucket_request_payment(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.
The following operations are related to GetBucketRequestPayment
:
get_bucket_tagging(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the
s3:GetBucketTagging
action. By default, the bucket owner has this permission
and can grant this permission to others.
GetBucketTagging
has the following special error:
Error code:
NoSuchTagSet
- Description: There is no tag set associated with the
bucket.
The following operations are related to GetBucketTagging
:
get_bucket_versioning(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state.
If the MFA Delete status is enabled
, the bucket owner must use an
authentication device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
get_bucket_website(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET action requires the S3:GetBucketWebsite
permission. By default, only
the bucket owner can read the bucket website configuration. However, bucket
owners can allow other users to read the website configuration by writing a
bucket policy granting them the S3:GetBucketWebsite
permission.
The following operations are related to GetBucketWebsite
:
get_object(client, bucket, key, part_number \\ nil, response_cache_control \\ nil, response_content_disposition \\ nil, response_content_encoding \\ nil, response_content_language \\ nil, response_content_type \\ nil, response_expires \\ nil, version_id \\ nil, checksum_mode \\ nil, expected_bucket_owner \\ nil, if_match \\ nil, if_modified_since \\ nil, if_none_match \\ nil, if_unmodified_since \\ nil, range \\ nil, request_payer \\ nil, sse_customer_algorithm \\ nil, sse_customer_key \\ nil, sse_customer_key_md5 \\ nil, options \\ [])
View SourceRetrieves an object from Amazon S3.
In the GetObject
request, specify the full key name for the object.
General purpose buckets - Both the virtual-hosted-style requests and the
path-style requests are supported. For a virtual hosted-style request example,
if you have the object photos/2006/February/sample.jpg
, specify the object key
name as /photos/2006/February/sample.jpg
. For a path-style request example, if
you have the object photos/2006/February/sample.jpg
in the bucket named
examplebucket
, specify the object key name as
/examplebucket/photos/2006/February/sample.jpg
. For more information about
request types, see HTTP Host Header Bucket Specification
in the Amazon S3 User Guide.
Directory buckets - Only virtual-hosted-style requests are supported. For a
virtual hosted-style request example, if you have the object
photos/2006/February/sample.jpg
in the bucket named
examplebucket--use1-az5--x-s3
, specify the object key name as
/photos/2006/February/sample.jpg
. Also, when you make requests to this API
operation, your requests are sent to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
Definitions
Permissions
General purpose bucket permissions - You must have the required
permissions in a policy. To use GetObject
, you must have the READ
access to
the object (or version). If you grant READ
access to the anonymous user, the
GetObject
operation returns the object without using an authorization header.
For more information, see Specifying permissions in a policy
in the Amazon S3 User Guide.
If you include a versionId
in your request header, you must have the
s3:GetObjectVersion
permission to access a specific version of an object. The
s3:GetObject
permission is not required in this scenario.
If you request the current version of an object without a specific versionId
in the request header, only the s3:GetObject
permission is required. The
s3:GetObjectVersion
permission is not required in this scenario.
If the object that you request doesn’t exist, the error that Amazon S3 returns
depends on whether you also have the s3:ListBucket
permission.
If you have the `s3:ListBucket` permission on the
bucket, Amazon S3 returns an HTTP status code 404 Not Found
error.
If you don’t have the `s3:ListBucket` permission,
Amazon S3 returns an HTTP status code 403 Access Denied
error.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Storage classes
If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval
storage class, the S3 Glacier Deep Archive storage class, the S3
Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep
Archive Access tier, before you can retrieve the object you must first restore a
copy using
RestoreObject. Otherwise, this operation returns an InvalidObjectState
error. For information
about restoring archived objects, see Restoring Archived
Objects
in the Amazon S3 User Guide.
Directory buckets - For directory buckets, only the S3 Express One Zone
storage class is supported to store newly created objects. Unsupported storage
class values won't write a destination object and will respond with the HTTP
status code 400 Bad Request
.
Encryption
Encryption request headers, like x-amz-server-side-encryption
, should not be
sent for 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.
Overriding response header values through the request
There are times when you want to override certain response header values of a
GetObject
response. For example, you might override the Content-Disposition
response header value through your GetObject
request.
You can override values for a set of response headers. These modified response
header values are included only in a successful response, that is, when the HTTP
status code 200 OK
is returned. The headers you can override using the
following query parameters in the request are a subset of the headers that
Amazon S3 accepts when you create an object.
The response headers that you can override for the GetObject
response are
Cache-Control
, Content-Disposition
, Content-Encoding
, Content-Language
,
Content-Type
, and Expires
.
To override values for a set of response headers in the GetObject
response,
you can use the following query parameters in the request.
response-cache-control
response-content-disposition
response-content-encoding
response-content-language
response-content-type
response-expires
When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to GetObject
:
get_object_acl(client, bucket, key, version_id \\ nil, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the access control list (ACL) of an object. To use this operation, you
must have s3:GetObjectAcl
permissions or READ_ACP
access to the object. For
more information, see Mapping of ACL permissions and access policy permissions
in the Amazon S3 User Guide
This functionality is not supported for Amazon S3 on Outposts.
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
requests to read ACLs are still supported and return the
bucket-owner-full-control
ACL with the owner being the account that created
the bucket. For more information, see Controlling object ownership and disabling
ACLs
in the Amazon S3 User Guide.
The following operations are related to GetObjectAcl
:
get_object_attributes(client, bucket, key, version_id \\ nil, expected_bucket_owner \\ nil, max_parts \\ nil, object_attributes, part_number_marker \\ nil, request_payer \\ nil, sse_customer_algorithm \\ nil, sse_customer_key \\ nil, sse_customer_key_md5 \\ nil, options \\ [])
View SourceRetrieves all the metadata from an object without returning the object itself.
This operation is useful if you're interested only in an object's metadata.
GetObjectAttributes
combines the functionality of HeadObject
and
ListParts
. All of the data returned with each of those individual calls can be
returned with a single call to GetObjectAttributes
.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
Definitions
Permissions
General purpose bucket permissions - To use
GetObjectAttributes
, you must have READ access to the object. The permissions
that you need to use this operation with depend on whether the bucket is
versioned. If the bucket is versioned, you need both the s3:GetObjectVersion
and s3:GetObjectVersionAttributes
permissions for this operation. If the
bucket is not versioned, you need the s3:GetObject
and
s3:GetObjectAttributes
permissions. For more information, see Specifying Permissions in a
Policy
in the Amazon S3 User Guide. If the object that you request does not exist,
the error Amazon S3 returns depends on whether you also have the s3:ListBucket
permission.
If you have the `s3:ListBucket` permission on the
bucket, Amazon S3 returns an HTTP status code 404 Not Found
("no such key")
error.
If you don't have the `s3:ListBucket` permission,
Amazon S3 returns an HTTP status code 403 Forbidden
("access denied") error.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Encryption
Encryption request headers, like x-amz-server-side-encryption
, should not be
sent for HEAD
requests if your object uses server-side encryption with Key
Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with
Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon
S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption
header
is used when you PUT
an object to S3 and want to specify the encryption
method. If you include this header in a GET
request for an object that uses
these types of keys, you’ll get an HTTP 400 Bad Request
error. It's because
the encryption method can't be changed when you retrieve the object.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
Directory bucket permissions - For directory buckets, only server-side
encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
Versioning
Directory buckets - S3 Versioning isn't enabled and supported for directory
buckets. For this API operation, only the null
value of the version ID is
supported by directory buckets. You can only specify null
to the versionId
query parameter in the request.
Conditional request headers
Consider the following when using request headers:
If both of the If-Match
and If-Unmodified-Since
headers are
present in the request as follows, then Amazon S3 returns the HTTP status code
200 OK
and the data requested:
`If-Match` condition evaluates to `true`.
`If-Unmodified-Since` condition evaluates to `false`.
For more information about conditional requests, see RFC 7232.
If both of the If-None-Match
and If-Modified-Since
headers are
present in the request as follows, then Amazon S3 returns the HTTP status code
304 Not Modified
:
`If-None-Match` condition evaluates to `false`.
`If-Modified-Since` condition evaluates to `true`.
For more information about conditional requests, see RFC 7232.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following actions are related to GetObjectAttributes
:
GetObjectLegalHold GetObjectLockConfiguration
get_object_legal_hold(client, bucket, key, version_id \\ nil, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Gets an object's current legal hold status. For more information, see Locking Objects.
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectLegalHold
:
get_object_lock_configuration(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
The following action is related to GetObjectLockConfiguration
:
get_object_retention(client, bucket, key, version_id \\ nil, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Retrieves an object's retention settings. For more information, see Locking Objects.
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectRetention
:
get_object_tagging(client, bucket, key, version_id \\ nil, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the
s3:GetObjectTagging
action. By default, the GET action returns information
about current version of an object. For a versioned bucket, you can have
multiple versions of an object in your bucket. To retrieve tags of any other
version, use the versionId query parameter. You also need permission for the
s3:GetObjectVersionTagging
action.
By default, the bucket owner has this permission and can grant this permission to others.
For information about the Amazon S3 object tagging feature, see Object Tagging.
The following actions are related to GetObjectTagging
:
get_object_torrent(client, bucket, key, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This functionality is not supported for Amazon S3 on Outposts.
The following action is related to GetObjectTorrent
:
get_public_access_block(client, bucket, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use
this operation, you must have the s3:GetBucketPublicAccessBlock
permission.
For more information about Amazon S3 permissions, see Specifying Permissions in a
Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or
an object, it checks the PublicAccessBlock
configuration for both the bucket
(or the bucket that contains the object) and the bucket owner's account. If the
PublicAccessBlock
settings are different between the bucket and the account,
Amazon S3 uses the most restrictive combination of the bucket-level and
account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
The following operations are related to GetPublicAccessBlock
:
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 error codes.
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
.
Path-style requests are not supported. For more information, see Regional and Zonal
endpoints
in the Amazon S3 User Guide.
Definitions
Authentication and authorization
All 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 bucket - 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.
Permissions
General purpose bucket permissions - To use this operation, you
must have permissions to perform the s3:ListBucket
action. The bucket owner
has this permission by default and can grant this permission to others. For more
information about permissions, see Managing access permissions to your Amazon S3
resources
in the Amazon S3 User Guide.
Directory bucket permissions## - You must have the
s3express:CreateSession
permission in 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.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The HEAD
operation retrieves metadata from an object without returning the
object itself.
This operation is useful if you're interested only in an object's metadata.
A HEAD
request has the same options as a GET
operation on an object. The
response is identical to the GET
response except that there is no response
body. Because of this, if the HEAD
request generates an error, it returns a
generic code, such as 400 Bad Request
, 403 Forbidden
, 404 Not Found
, 405 Method Not Allowed
, 412 Precondition Failed
, or 304 Not Modified
. It's not
possible to retrieve the exact exception of these error codes.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
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.
Definitions
Permissions
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.
If the object you request doesn't exist, the error that Amazon S3 returns
depends on whether you also have the s3:ListBucket
permission.
If you have the `s3:ListBucket` permission on the
bucket, Amazon S3 returns an HTTP status code 404 Not Found
error.
If you don’t have the `s3:ListBucket` permission,
Amazon S3 returns an HTTP status code 403 Forbidden
error.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Encryption
Encryption request headers, like x-amz-server-side-encryption
, should not be
sent for HEAD
requests if your object uses server-side encryption with Key
Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with
Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon
S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption
header
is used when you PUT
an object to S3 and want to specify the encryption
method. If you include this header in a HEAD
request for an object that uses
these types of keys, you’ll get an HTTP 400 Bad Request
error. It's because
the encryption method can't be changed when you retrieve the object.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers to provide the encryption key for the server to be able to retrieve the object's metadata. The headers are:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
Directory bucket permissions - For directory buckets, only server-side
encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
Versioning
If the current version of the object is a delete marker, Amazon S3
behaves as if the object was deleted and includes x-amz-delete-marker: true
in
the response.
If the specified version is a delete marker, the response returns a
405 Method Not Allowed
error and the Last-Modified: timestamp
response
header.
Directory buckets - Delete marker is not supported by 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.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following actions are related to HeadObject
:
list_bucket_analytics_configurations(client, bucket, continuation_token \\ nil, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at a time. You should always check the IsTruncated
element in
the response. If there are no more configurations to list, IsTruncated
is set
to false. If there are more configurations to list, IsTruncated
is set to
true, and there will be a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing
the value in continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the
s3:GetAnalyticsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to ListBucketAnalyticsConfigurations
:
GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration
list_bucket_intelligent_tiering_configurations(client, bucket, continuation_token \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to ListBucketIntelligentTieringConfigurations
include:
DeleteBucketIntelligentTieringConfiguration PutBucketIntelligentTieringConfiguration
list_bucket_inventory_configurations(client, bucket, continuation_token \\ nil, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at a time. Always check the IsTruncated
element in the
response. If there are no more configurations to list, IsTruncated
is set to
false. If there are more configurations to list, IsTruncated
is set to true,
and there is a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing
the value in continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the
s3:GetInventoryConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to ListBucketInventoryConfigurations
:
GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration
list_bucket_metrics_configurations(client, bucket, continuation_token \\ nil, expected_bucket_owner \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This action supports list pagination and does not return more than 100
configurations at a time. Always check the IsTruncated
element in the
response. If there are no more configurations to list, IsTruncated
is set to
false. If there are more configurations to list, IsTruncated
is set to true,
and there is a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing
the value in continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the
s3:GetMetricsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to ListBucketMetricsConfigurations
:
This operation is not supported by 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.
For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.
list_directory_buckets(client, continuation_token \\ nil, max_directory_buckets \\ nil, options \\ [])
View SourceReturns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request.
For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
https://s3express-control.*region_code*.amazonaws.com/*bucket-name*
.
Virtual-hosted-style requests aren't supported. For more information, see
Regional and Zonal endpoints
in the Amazon S3 User Guide.
Definitions
Permissions
You must have the s3express:ListAllMyDirectoryBuckets
permission in an IAM
identity-based policy instead of a bucket policy. Cross-account access to this
API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource. For more information about
directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One
Zone
in the Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.*region*.amazonaws.com
.
list_multipart_uploads(client, bucket, delimiter \\ nil, encoding_type \\ nil, key_marker \\ nil, max_uploads \\ nil, prefix \\ nil, upload_id_marker \\ nil, expected_bucket_owner \\ nil, request_payer \\ nil, options \\ [])
View SourceThis 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.
The ListMultipartUploads
operation returns a maximum of 1,000 multipart
uploads in the response. The limit of 1,000 multipart uploads is also the
default value. You can further limit the number of uploads in a response by
specifying the max-uploads
request parameter. If there are more than 1,000
multipart uploads that satisfy your ListMultipartUploads
request, the response
returns an IsTruncated
element with the value of true
, a NextKeyMarker
element, and a NextUploadIdMarker
element. To list the remaining multipart
uploads, you need to make subsequent ListMultipartUploads
requests. In these
requests, include two query parameters: key-marker
and upload-id-marker
. Set
the value of key-marker
to the NextKeyMarker
value from the previous
response. Similarly, set the value of upload-id-marker
to the
NextUploadIdMarker
value from the previous response.
Directory buckets - The upload-id-marker
element and the
NextUploadIdMarker
element aren't supported by directory buckets. To list the
additional multipart uploads, you only need to set the value of key-marker
to
the NextKeyMarker
value from the previous response.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
Definitions
Permissions
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Sorting of multipart uploads in response
General purpose bucket - In the ListMultipartUploads
response, the multipart uploads are sorted based on two criteria:
Key-based sorting - Multipart uploads are initially
sorted in ascending order based on their object keys.
Time-based sorting - For uploads that share the same
object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.
Directory bucket - In the ListMultipartUploads
response, the
multipart uploads aren't sorted lexicographically based on the object keys.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to ListMultipartUploads
:
CreateMultipartUpload UploadPart
list_object_versions(client, bucket, delimiter \\ nil, encoding_type \\ nil, key_marker \\ nil, max_keys \\ nil, prefix \\ nil, version_id_marker \\ nil, expected_bucket_owner \\ nil, optional_object_attributes \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
To use this operation, you must have permission to perform the
s3:ListBucketVersions
action. Be aware of the name difference.
A 200 OK
response can contain valid or invalid XML. Make sure to design your
application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
The following operations are related to ListObjectVersions
:
list_objects(client, bucket, delimiter \\ nil, encoding_type \\ nil, marker \\ nil, max_keys \\ nil, prefix \\ nil, expected_bucket_owner \\ nil, optional_object_attributes \\ nil, request_payer \\ nil, options \\ [])
View SourceThis operation is not supported by directory buckets.
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This action has been revised. We recommend that you use the newer version,
ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to
support ListObjects
.
The following operations are related to ListObjects
:
list_objects_v2(client, bucket, continuation_token \\ nil, delimiter \\ nil, encoding_type \\ nil, fetch_owner \\ nil, max_keys \\ nil, prefix \\ nil, start_after \\ nil, expected_bucket_owner \\ nil, optional_object_attributes \\ nil, request_payer \\ nil, options \\ [])
View SourceReturns some or all (up to 1,000) of the objects in a bucket with each request.
You can use the request parameters as selection criteria to return a subset of
the objects in a bucket. A 200 OK
response can contain valid or invalid XML.
Make sure to design your application to parse the contents of the response and
handle it appropriately. For more information about listing objects, see
Listing object keys programmatically
in the Amazon S3 User Guide. To get a list of your buckets, see
ListBuckets. 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.
Definitions
Permissions
General purpose bucket permissions - To use this operation, you
must have READ access to the bucket. You must have permission to perform the
s3:ListBucket
action. The bucket owner has this permission by default and can
grant this permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources
in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Sorting order of returned objects
General purpose bucket - For general purpose buckets,
ListObjectsV2
returns objects in lexicographical order based on their key
names.
Directory bucket - For directory buckets, ListObjectsV2
does
not return objects in lexicographical order.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
This section describes the latest revision of this action. We recommend that you
use this revised API operation for application development. For backward
compatibility, Amazon S3 continues to support the prior version of this API
operation,
ListObjects.
The following operations are related to ListObjectsV2
:
list_parts(client, bucket, key, max_parts \\ nil, part_number_marker \\ nil, upload_id, expected_bucket_owner \\ nil, request_payer \\ nil, sse_customer_algorithm \\ nil, sse_customer_key \\ nil, sse_customer_key_md5 \\ nil, options \\ [])
View SourceLists the parts that have been uploaded for a specific multipart upload.
To use this operation, you must provide the upload ID
in the request. You
obtain this uploadID by sending the initiate multipart upload request through
CreateMultipartUpload. The ListParts
request returns a maximum of 1,000 uploaded parts. The limit of
1,000 parts is also the default value. You can restrict the number of parts in a
response by specifying the max-parts
request parameter. If your multipart
upload consists of more than 1,000 parts, the response returns an IsTruncated
field with the value of true
, and a NextPartNumberMarker
element. To list
remaining uploaded parts, in subsequent ListParts
requests, include the
part-number-marker
query string parameter and set its value to the
NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*bucket_name*.s3express-*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.
Definitions
Permissions
General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
If the upload was created using server-side encryption with Key Management
Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon
Web Services KMS keys (DSSE-KMS), you must have permission to the kms:Decrypt
action for the ListParts
request to succeed.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to ListParts
:
CreateMultipartUpload UploadPart
put_bucket_accelerate_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.
To use this operation, you must have permission to perform the
s3:PutAccelerateConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
The Transfer Acceleration state of a bucket can be set to one of the following two values:
Enabled – Enables accelerated data transfers to the bucket.
Suspended – Disables accelerated data transfers to the bucket.
The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.
After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.
The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").
For more information about transfer acceleration, see Transfer Acceleration.
The following operations are related to PutBucketAccelerateConfiguration
:
This operation is not supported by directory buckets.
Sets the permissions on an existing bucket using access control lists (ACL). For
more information, see Using ACLs.
To set the ACL of a bucket, you must have the WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
ACLs are disabled and no longer affect permissions. You must use policies to
grant access to your bucket and the objects in it. Requests to set ACLs or
update ACLs fail and return the AccessControlListNotSupported
error code.
Requests to read ACLs are still supported. For more information, see
Controlling object ownership
in the Amazon S3 User Guide.
Definitions
Permissions
You can set access permissions by using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3
supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a
predefined set of grantees and permissions. Specify the canned ACL name as the
value of x-amz-acl
. If you use this header, you cannot use other access
control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
,
x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and
grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use the
x-amz-acl
header to set a canned ACL. These parameters map to the set of
permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)
Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
`id` – if the value specified is the canonical user ID
of an Amazon Web Services account
`uri` – if you are granting permissions to a predefined
group
`emailAddress` – if the value specified is the email
address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-write
header grants create, overwrite,
and delete objects permission to LogDelivery group predefined by Amazon S3 and
two Amazon Web Services accounts identified by their email addresses.
x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
The following operations are related to PutBucketAcl
:
put_bucket_analytics_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a
comma-separated values (CSV) flat file. See the DataExport
request element.
Reports are updated daily and are based on the object filters that you
configure. When selecting data export, you specify a destination bucket and an
optional destination prefix where the file is written. You can export the data
to a destination bucket in a different account. However, the destination bucket
must be in the same Region as the bucket that you are making the PUT analytics
configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the
s3:PutAnalyticsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
PutBucketAnalyticsConfiguration
has the following special errors:
* *HTTP Error: HTTP 400 Bad Request*
* *Code: InvalidArgument*
* *Cause: Invalid argument.*
* *HTTP Error: HTTP 400 Bad Request*
* *Code: TooManyConfigurations*
* *Cause: You are attempting to create a new
configuration but have already reached the 1,000-configuration limit.*
* *HTTP Error: HTTP 403 Forbidden*
* *Code: AccessDenied*
* *Cause: You are not the owner of the specified bucket,
or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.*
The following operations are related to PutBucketAnalyticsConfiguration
:
GetBucketAnalyticsConfiguration DeleteBucketAnalyticsConfiguration
This operation is not supported by directory buckets.
Sets the cors
configuration for your bucket. If the configuration exists,
Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
action. By default, the bucket owner has this permission and can grant it to
others.
You set this configuration on a bucket so that the bucket can service
cross-origin requests. For example, you might want to enable a request whose
origin is http://www.example.com
to access your Amazon S3 bucket at
my.example.bucket.com
by using the browser's XMLHttpRequest
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the bucket. The cors
subresource is an XML document in which
you configure rules that identify origins and the HTTP methods that can be
executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request)
against a bucket, it evaluates the cors
configuration on the bucket and uses
the first CORSRule
rule that matches the incoming browser request to enable a
cross-origin request. For a rule to match, the following conditions must be met:
The request's
Origin
header must matchAllowedOrigin
elements.The request method (for example, GET, PUT, HEAD, and so on) or the
Access-Control-Request-Method
header in case of a pre-flightOPTIONS
request must be one of theAllowedMethod
elements.Every header specified in the
Access-Control-Request-Headers
request header of a pre-flight request must match anAllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.
The following operations are related to PutBucketCors
:
This operation is not supported by directory buckets.
This action uses the encryption
subresource to configure default encryption
and Amazon S3 Bucket Keys for an existing bucket.
By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you specify default encryption by using SSE-KMS, you can also configure Amazon S3 Bucket Keys. If you use PutBucketEncryption to set your default bucket encryption to SSE-KMS, you should verify that your KMS key ID is correct. Amazon S3 does not validate the KMS key ID provided in PutBucketEncryption requests.
This action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).
To use this operation, you must have permission to perform the
s3:PutEncryptionConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources
in the Amazon S3 User Guide.
The following operations are related to PutBucketEncryption
:
put_bucket_intelligent_tiering_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.
For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to PutBucketIntelligentTieringConfiguration
include:
DeleteBucketIntelligentTieringConfiguration GetBucketIntelligentTieringConfiguration
* ListBucketIntelligentTieringConfigurations
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.
PutBucketIntelligentTieringConfiguration
has the following special errors:
Definitions
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutIntelligentTieringConfiguration
bucket permission to set the
configuration on the bucket.
put_bucket_inventory_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
This implementation of the PUT
action adds an inventory configuration
(identified by the inventory ID) to the bucket. You can have up to 1,000
inventory configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
Definitions
Permissions
To use this operation, you must have permission to perform the
s3:PutInventoryConfiguration
action. The bucket owner has this permission by
default and can grant this permission to others.
The s3:PutInventoryConfiguration
permission allows a user to create an S3 Inventory
report that includes all object metadata fields available and to specify the
destination bucket to store the inventory. A user with read access to objects in
the destination bucket can also access all object metadata fields that are
available in the inventory report.
To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.
PutBucketInventoryConfiguration
has the following special errors:
Definitions
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the
bucket.
The following operations are related to PutBucketInventoryConfiguration
:
GetBucketInventoryConfiguration DeleteBucketInventoryConfiguration
This operation is not supported by directory buckets.
For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.
By default, all Amazon S3 resources, including buckets, objects, and related
subresources (for example, lifecycle configuration and website configuration)
are private. Only the resource owner, the Amazon Web Services account that
created the resource, can access it. The resource owner can optionally grant
access permissions to others by writing an access policy. For this operation,
users must get the s3:PutLifecycleConfiguration
permission.
You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.
For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.
The following operations are related to PutBucketLifecycle
:
GetBucketLifecycle(Deprecated) GetBucketLifecycleConfiguration
RestoreObject By default, a resource owner—in this case, a bucket owner, which is the Amazon Web Services account that created the bucket—can perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide:
* [Specifying Permissions in a
Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
* [Managing Access Permissions to your Amazon S3 Resources](https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
put_bucket_lifecycle_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Definitions
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists of the following:
A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
A status indicating whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and
related subresources (for example, lifecycle configuration and website
configuration). Only the resource owner (that is, the Amazon Web Services
account that created it) can access the resource. The resource owner can
optionally grant access permissions to others by writing an access policy. For
this operation, a user must get the s3:PutLifecycleConfiguration
permission.
You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to PutBucketLifecycleConfiguration
:
This operation is not supported by directory buckets.
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the
Grantee
request element to grant access to other people. The Permissions
request element specifies the kind of access the grantee has to the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for
S3 Object Ownership, you can't use the Grantee
request element to grant access
to others. Permissions can only be granted using policies. For more information,
see Permissions for server access log delivery
in the Amazon S3 User Guide.
Definitions
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (by using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName
is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the CanonicalUser
and, in a response to a
GETObjectAcl
request, appears as the CanonicalUser.
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
To enable logging, you use LoggingEnabled
and its children request elements.
To disable logging, you use an empty BucketLoggingStatus
request element:
<BucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" />
For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to PutBucketLogging
:
put_bucket_metrics_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the
s3:PutMetricsConfiguration
action. The bucket owner has this permission by
default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration
:
DeleteBucketMetricsConfiguration GetBucketMetricsConfiguration
* ListBucketMetricsConfigurations
PutBucketMetricsConfiguration
has the following special error:
Error code:
TooManyConfigurations
- Description: You are attempting to create a new
configuration but have already reached the 1,000-configuration limit.
* HTTP Status Code: HTTP 400 Bad Request
This operation is not supported by directory buckets.
No longer used, see the PutBucketNotificationConfiguration operation.
put_bucket_notification_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the
notification configuration will be an empty NotificationConfiguration
.
<NotificationConfiguration>
</NotificationConfiguration>
This action replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.
By default, only the bucket owner can configure notifications on a bucket.
However, bucket owners can use a bucket policy to grant permission to other
users to set this configuration with the required s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket.
If the configuration in the request body includes only one TopicConfiguration
specifying only the s3:ReducedRedundancyLostObject
event type, the response
will also include the x-amz-sns-test-message-id
header containing the message
ID of the test notification sent to the topic.
The following action is related to PutBucketNotificationConfiguration
:
put_bucket_ownership_controls(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Creates or modifies OwnershipControls
for an Amazon S3 bucket. To use this
operation, you must have the s3:PutBucketOwnershipControls
permission. For
more information about Amazon S3 permissions, see Specifying permissions in a policy.
For information about Amazon S3 Object Ownership, see Using object ownership.
The following operations are related to PutBucketOwnershipControls
:
GetBucketOwnershipControls
DeleteBucketOwnershipControls
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Regional endpoint. These endpoints support path-style
requests in the format
https://s3express-control.*region_code*.amazonaws.com/*bucket-name*
.
Virtual-hosted-style requests aren't supported. For more information, see
Regional and Zonal endpoints
in the Amazon S3 User Guide.
Definitions
Permissions
If you are using an identity other than the root user of the Amazon Web Services
account that owns the bucket, the calling identity must both have the
PutBucketPolicy
permissions on the specified bucket and belong to the bucket
owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an
identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed
error.
To ensure that bucket owners don't inadvertently lock themselves out of their
own buckets, the root principal in a bucket owner's Amazon Web Services account
can perform the GetBucketPolicy
, PutBucketPolicy
, and DeleteBucketPolicy
API actions, even if their bucket policy explicitly denies the root principal's
access. Bucket owner root principals can only be blocked from performing these
API actions by VPC endpoint policies and Amazon Web Services Organizations
policies.
General purpose bucket permissions - The s3:PutBucketPolicy
permission is required in a policy. For more information about general purpose
buckets bucket policies, see Using Bucket Policies and User Policies
in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation, you must have the s3express:PutBucketPolicy
permission in an IAM
identity-based policy instead of a bucket policy. Cross-account access to this
API operation isn't supported. This operation can only be performed by the
Amazon Web Services account that owns the resource. For more information about
directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One
Zone
in the Amazon S3 User Guide.
Example bucket policies
General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.
Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is
s3express-control.*region*.amazonaws.com
.
The following operations are related to PutBucketPolicy
:
This operation is not supported by directory buckets.
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.
Specify the replication configuration in the request body. In the replication
configuration, you provide the name of the destination bucket or buckets where
you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume
to replicate objects on your behalf, and other relevant information. You can
invoke this request for a specific Amazon Web Services Region by using the
aws:RequestedRegion
condition key.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset.
To specify a subset of the objects in the source bucket to apply a replication
rule to, add the Filter element as a child of the Rule element. You can filter
objects based on an object key prefix, one or more object tags, or both. When
you add the Filter element in the configuration, you must also add the following
elements: DeleteMarkerReplication
, Status
, and Priority
.
If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.
For information about enabling versioning on a bucket, see Using Versioning.
Definitions
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using
server-side encryption with KMS keys. To replicate Amazon Web Services
KMS-encrypted objects, add the following: SourceSelectionCriteria
,
SseKmsEncryptedObjects
, Status
, EncryptionConfiguration
, and
ReplicaKmsKeyID
. For information about replication configuration, see
Replicating Objects Created with SSE Using KMS keys.
For information on PutBucketReplication
errors, see List of replication-related error
codes
Permissions
To create a PutBucketReplication
request, you must have
s3:PutReplicationConfiguration
permissions for the bucket.
By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
To perform this operation, the user or role performing the action must have the iam:PassRole permission.
The following operations are related to PutBucketReplication
:
This operation is not supported by directory buckets.
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.
The following operations are related to PutBucketRequestPayment
:
This operation is not supported by directory buckets.
Sets the tags for a bucket.
Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging and Using Cost Allocation in Amazon S3 Bucket Tags.
When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.
To use this operation, you must have permissions to perform the
s3:PutBucketTagging
action. The bucket owner has this permission by default
and can grant this permission to others. For more information about permissions,
see Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources.
PutBucketTagging
has the following special errors. For more Amazon S3 errors
see, Error Responses.
InvalidTag
- The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.MalformedXML
- The XML provided does not match the schema.OperationAborted
- A conflicting conditional action is currently in progress against this resource. Please try again.InternalError
- The service was unable to apply the provided tag to the bucket.
The following operations are related to PutBucketTagging
:
This operation is not supported by directory buckets.
Sets the versioning state of an existing bucket.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
In order to enable MFA Delete, you must be the bucket owner. If you are the
bucket owner and want to enable MFA Delete in the bucket versioning
configuration, you must include the x-amz-mfa request
header and the Status
and the MfaDelete
request elements in a request to set the versioning state of
the bucket.
If you have an object expiration lifecycle configuration in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
The following operations are related to PutBucketVersioning
:
This operation is not supported by directory buckets.
Sets the configuration of the website that is specified in the website
subresource. To configure a bucket as a website, you can add this subresource on
the bucket with website configuration information such as the file name of the
index document and any redirect rules. For more information, see Hosting Websites on Amazon
S3.
This PUT action requires the S3:PutBucketWebsite
permission. By default, only
the bucket owner can configure the website attached to a bucket; however, bucket
owners can allow other users to set the website configuration by writing a
bucket policy that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.
WebsiteConfiguration
RedirectAllRequestsTo
HostName
If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.
WebsiteConfiguration
IndexDocument
Suffix
ErrorDocument
Key
RoutingRules
RoutingRule
Condition
HttpErrorCodeReturnedEquals
KeyPrefixEquals
Redirect
HostName
ReplaceKeyPrefixWith
ReplaceKeyWith
HttpRedirectCode
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.
The maximum request length is limited to 128 KB.
Adds an object to a bucket.
Amazon S3 never adds partial objects; if you receive a success
response, Amazon S3 added the entire object to the bucket. You cannot use
PutObject
to only update a single piece of metadata for an existing object.
You must put the entire object with updated metadata if you want to update some
values.
If your bucket uses the bucket owner enforced setting for Object Ownership, ACLs are disabled and no longer affect permissions. All objects written to the bucket by any account will be owned by the bucket owner.
Directory buckets - For directory buckets, you must make
requests for this API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*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:
- S3 Object Lock - To prevent objects from being deleted or overwritten, you can use Amazon S3 Object Lock in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
- 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.
Definitions
Permissions
General purpose bucket permissions - The following permissions
are required in your policies when your PutObject
request includes specific
headers.
** `s3:PutObject` ** - To successfully complete the
PutObject
request, you must always have the s3:PutObject
permission on a
bucket to add an object to it.
** `s3:PutObjectAcl` ** - To successfully change the
objects ACL of your PutObject
request, you must have the s3:PutObjectAcl
.
** `s3:PutObjectTagging` ** - To successfully set the
tag-set with your PutObject
request, you must have the s3:PutObjectTagging
.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Data integrity with Content-MD5
General purpose bucket - To ensure that data is not corrupted
traversing the network, use the Content-MD5
header. When you use this header,
Amazon S3 checks the object against the provided MD5 value and, if they do not
match, Amazon S3 returns an error. Alternatively, when the object's ETag is its
MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and
compare the returned ETag to the calculated MD5 value.
Directory bucket - This functionality is not supported for directory buckets.
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
For more information about related Amazon S3 APIs, see the following:
This operation is not supported by directory buckets.
Uses the acl
subresource to set the access control list (ACL) permissions for
a new or existing object in an S3 bucket. You must have the WRITE_ACP
permission to set the ACL of an object. For more information, see What permissions can I
grant?
in the Amazon S3 User Guide.
This functionality is not supported for Amazon S3 on Outposts.
Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,
ACLs are disabled and no longer affect permissions. You must use policies to
grant access to your bucket and the objects in it. Requests to set ACLs or
update ACLs fail and return the AccessControlListNotSupported
error code.
Requests to read ACLs are still supported. For more information, see
Controlling object ownership
in the Amazon S3 User Guide.
Definitions
Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3
supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a
predefined set of grantees and permissions. Specify the canned ACL name as the
value of x-amz-ac
l. If you use this header, you cannot use other access
control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
,
x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and
grantees (Amazon Web Services accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use x-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that
Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)
Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
`id` – if the value specified is the canonical user ID
of an Amazon Web Services account
`uri` – if you are granting permissions to a predefined
group
`emailAddress` – if the value specified is the email
address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
For example, the following x-amz-grant-read
header grants list objects
permission to the two Amazon Web Services accounts identified by their email
addresses.
x-amz-grant-read: emailAddress="xyz@amazon.com", emailAddress="abc@amazon.com"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
Versioning
The ACL of an object is set at the object version level. By default, PUT sets
the ACL of the current version of an object. To set the ACL of a different
version, use the versionId
subresource.
The following operations are related to PutObjectAcl
:
This operation is not supported by directory buckets.
Applies a legal hold configuration to the specified object. For more information, see Locking Objects.
This functionality is not supported for Amazon S3 on Outposts.
put_object_lock_configuration(client, bucket, input, options \\ [])
View SourceThis operation is not supported by directory buckets.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
The DefaultRetention
settings require both a mode and a period.
The DefaultRetention
period can be either Days
or Years
but
you must select one. You cannot specify Days
and Years
at the same time.
You can enable Object Lock for new or existing buckets. For more information, see Configuring Object Lock.
This operation is not supported by directory buckets.
Places an Object Retention configuration on an object. For more information, see
Locking Objects.
Users or accounts require the s3:PutObjectRetention
permission in order to
place an Object Retention configuration on objects. Bypassing a Governance
Retention configuration requires the s3:BypassGovernanceRetention
permission.
This functionality is not supported for Amazon S3 on Outposts.
This operation is not supported by directory buckets.
Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.
You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging. For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.
To use this operation, you must have permission to perform the
s3:PutObjectTagging
action. By default, the bucket owner has this permission
and can grant this permission to others.
To put tags of any other version, use the versionId
query parameter. You also
need permission for the s3:PutObjectVersionTagging
action.
PutObjectTagging
has the following special errors. For more Amazon S3 errors
see, Error Responses.
InvalidTag
- The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.MalformedXML
- The XML provided does not match the schema.OperationAborted
- A conflicting conditional action is currently in progress against this resource. Please try again.InternalError
- The service was unable to apply the provided tag to the object.
The following operations are related to PutObjectTagging
:
This operation is not supported by directory buckets.
Creates or modifies the PublicAccessBlock
configuration for an Amazon S3
bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or
an object, it checks the PublicAccessBlock
configuration for both the bucket
(or the bucket that contains the object) and the bucket owner's account. If the
PublicAccessBlock
configurations are different between the bucket and the
account, Amazon S3 uses the most restrictive combination of the bucket-level and
account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
The following operations are related to PutPublicAccessBlock
:
This operation is not supported by directory buckets.
Restores an archived copy of an object back into Amazon S3
This functionality is not supported for Amazon S3 on Outposts.
This action performs the following types of requests:
select
- Perform a select query on an archived objectrestore an archive
- Restore an archived object
For more information about the S3
structure in the request body, see the
following:
PutObject Managing Access with ACLs in the Amazon S3 User Guide
- Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide
Define the SQL expression for the SELECT
type of restoration for your query in
the request body's SelectParameters
structure. You can use expressions like
the following examples.
- The following expression returns all records from the specified object.
SELECT * FROM Object
- Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
- If you have headers and you set the
fileHeaderInfo
in theCSV
structure in the request body toUSE
, you can specify headers in the query. (If you set thefileHeaderInfo
field toIGNORE
, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.
SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
When making a select request, you can also do the following:
To expedite your queries, specify the
Expedited
tier. For more information about tiers, see "Restoring Archives," later in this topic.Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.
The following are additional important facts about the select feature:
The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle configuration.
You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't duplicate requests, so avoid issuing duplicate requests.
Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response
409
.
Definitions
Permissions
To use this operation, you must have permissions to perform the
s3:RestoreObject
action. The bucket owner has this permission by default and
can grant this permission to others. For more information about permissions, see
Permissions Related to Bucket Subresource Operations
and Managing Access Permissions to Your Amazon S3 Resources
in the Amazon S3 User Guide.
Restoring objects
Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
When restoring an archived object, you can specify one of the following data
access tier options in the Tier
element of the request body:
Expedited
- Expedited retrievals allow you to quickly access your
data stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage
class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for
restoring archives are required. For all but the largest archived objects (250
MB+), data accessed using Expedited retrievals is typically made available
within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for
Expedited retrievals is available when you need it. Expedited retrievals and
provisioned capacity are not available for objects stored in the S3 Glacier Deep
Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
Standard
- Standard retrievals allow you to access any of your
archived objects within several hours. This is the default option for retrieval
requests that do not specify the retrieval option. Standard retrievals typically
finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval
Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They
typically finish within 12 hours for objects stored in the S3 Glacier Deep
Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard
retrievals are free for objects stored in S3 Intelligent-Tiering.
Bulk
- Bulk retrievals free for objects stored in the S3 Glacier
Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to
retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals
typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible
Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive
tier. Bulk retrievals are also the lowest-cost retrieval option when restoring
objects from S3 Glacier Deep Archive. They typically finish within 48 hours for
objects stored in the S3 Glacier Deep Archive storage class or S3
Intelligent-Tiering Deep Archive tier.
For more information about archive retrieval options and provisioned capacity
for Expedited
data access, see Restoring Archived Objects
in the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User Guide.
To get the status of object restoration, you can send a HEAD
request.
Operations return the x-amz-restore
header, which provides information about
the restoration status, in the response. You can use Amazon S3 event
notifications to notify you when a restore is initiated or completed. For more
information, see Configuring Amazon S3 Event Notifications
in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon S3 User Guide.
Responses
A successful action returns either the 200 OK
or 202 Accepted
status code.
If the object is not previously restored, then Amazon S3 returns
202 Accepted
in the response.
If the object is previously restored, Amazon S3 returns 200 OK
in
the response.
Special errors:
*Code: RestoreAlreadyInProgress*
*Cause: Object restore is already in progress. (This
error does not apply to SELECT type requests.)*
*HTTP Status Code: 409 Conflict*
*SOAP Fault Code Prefix: Client*
*Code:
GlacierExpeditedRetrievalNotAvailable*
*Cause: expedited retrievals are currently not
available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)*
*HTTP Status Code: 503*
*SOAP Fault Code Prefix: N/A*
The following operations are related to RestoreObject
:
PutBucketLifecycleConfiguration GetBucketNotificationConfiguration
This operation is not supported by directory buckets.
This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.
This functionality is not supported for Amazon S3 on Outposts.
For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.
Definitions
Permissions
You must have the s3:GetObject
permission for this operation. Amazon S3 Select
does not support anonymous access. For more information about permissions, see
Specifying Permissions in a Policy
in the Amazon S3 User Guide.
Object Data Formats
You can use Amazon S3 Select to query objects that have the following format properties:
CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.
UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.
Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.
Working with the Response Body
Given the response size is unknown, Amazon S3 Select streams the response as a
series of messages and includes a Transfer-Encoding
header with chunked
as
its value in the response. For more information, see Appendix: SelectObjectContent
Response.
GetObject Support
The SelectObjectContent
action does not support the following GetObject
functionality. For more information, see
GetObject. Range
: Although you can specify a scan range for an Amazon S3
Select request (see SelectObjectContentRequest -
ScanRange
in the request parameters), you cannot specify the range of bytes of an object
to return.
The GLACIER
, DEEP_ARCHIVE
, and REDUCED_REDUNDANCY
storage
classes, or the ARCHIVE_ACCESS
and DEEP_ARCHIVE_ACCESS
access tiers of the
INTELLIGENT_TIERING
storage class: You cannot query objects in the GLACIER
,
DEEP_ARCHIVE
, or REDUCED_REDUNDANCY
storage classes, nor objects in the
ARCHIVE_ACCESS
or DEEP_ARCHIVE_ACCESS
access tiers of the
INTELLIGENT_TIERING
storage class. For more information about storage classes,
see Using Amazon S3 storage classes
in the Amazon S3 User Guide.
Special Errors
For a list of special errors for this operation, see List of SELECT Object Content Error Codes
The following operations are related to SelectObjectContent
:
Uploads a part in a multipart upload.
In this operation, you provide new data as a part of an object in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier that you must include in your upload part request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview in the Amazon S3 User Guide .
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*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.
Definitions
Permissions
General purpose bucket permissions - For information on the permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - To grant access to this API
operation on a directory bucket, we recommend that you use the CreateSession
API
operation for session-based authorization. Specifically, you grant the
s3express:CreateSession
permission to the directory bucket in a bucket policy
or an IAM identity-based policy. Then, you make the CreateSession
API call on
the bucket to obtain a session token. With the session token in your request
header, you can make API requests to this operation. After the session token
expires, you make another CreateSession
API call to generate a new session
token for use. Amazon Web Services CLI or SDKs create session and refresh the
session token automatically to avoid service interruptions when a session
expires. For more information about authorization, see CreateSession
.
Data integrity
General purpose bucket - To ensure that data is not corrupted traversing the
network, specify the Content-MD5
header in the upload part request. Amazon S3
checks the part data against the provided MD5 value. If they do not match,
Amazon S3 returns an error. If the upload request is signed with Signature
Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256
header as
a checksum instead of Content-MD5
. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version
4).
Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
Encryption
General purpose bucket - Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).
Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload. If you request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request headers.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
Directory bucket - For directory buckets, only server-side
encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
Special errors
Error Code: NoSuchUpload
Description: The specified multipart upload does not
exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to UploadPart
:
CreateMultipartUpload CompleteMultipartUpload
Uploads a part by copying data from an existing object as data source.
To specify the data source, you add the request header x-amz-copy-source
in
your request. To specify a byte range, you add the request header
x-amz-copy-source-range
in your request.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.
For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.
Directory buckets - For directory buckets, you must make requests for this
API operation to the Zonal endpoint. These endpoints support
virtual-hosted-style requests in the format
https://*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.
Definitions
Authentication and authorization
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.
Permissions
You must have READ
access to the source object and WRITE
access to the
destination bucket.
General purpose bucket permissions - You must have the
permissions in a policy based on the bucket types of your source bucket and
destination bucket in an UploadPartCopy
operation.
If the source object is in a general purpose bucket,
you must have the s3:GetObject
permission to read the source object that
is being copied.
If the destination bucket is a general purpose bucket,
you must have the s3:PubObject
permission to write the object copy to
the destination bucket.
For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.
Directory bucket permissions - You must have permissions in a
bucket policy or an IAM identity-based policy based on the source and
destination bucket types in an UploadPartCopy
operation.
If the source object that you want to copy is in a
directory bucket, you must have the s3express:CreateSession
permission
in the Action
element of a policy to read the object . By default, the session
is in the ReadWrite
mode. If you want to restrict the access, you can
explicitly set the s3express:SessionMode
condition key to ReadOnly
on the
copy source bucket.
If the copy destination is a directory bucket, you must
have the s3express:CreateSession
permission in the Action
element of a
policy to write the object to the destination. The s3express:SessionMode
condition key cannot be set to ReadOnly
on the copy destination.
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.
Encryption
General purpose buckets - For information about using
server-side encryption with customer-provided encryption keys with the
UploadPartCopy
operation, see
CopyObject and
UploadPart.
Directory buckets - For directory buckets, only server-side
encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
Special errors
Error Code: NoSuchUpload
Description: The specified multipart upload does not
exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
Error Code: InvalidRequest
Description: The specified copy source is not supported
as a byte-range copy source.
HTTP Status Code: 400 Bad Request
HTTP Host header syntax
Directory buckets - The HTTP Host header syntax is *Bucket_name*.s3express-*az_id*.*region*.amazonaws.com
.
The following operations are related to UploadPartCopy
:
CreateMultipartUpload UploadPart
This operation is not supported by directory buckets.
Passes transformed objects to a GetObject
operation when using Object Lambda
access points. For information about Object Lambda access points, see
Transforming objects with Object Lambda access points
in the Amazon S3 User Guide.
This operation supports metadata that can be returned by
GetObject, in addition to RequestRoute
, RequestToken
, StatusCode
, ErrorCode
, and
ErrorMessage
. The GetObject
response metadata is supported so that the
WriteGetObjectResponse
caller, typically an Lambda function, can provide the
same metadata when it internally invokes GetObject
. When
WriteGetObjectResponse
is called by a customer-owned Lambda function, the
metadata returned to the end user GetObject
call might differ from what Amazon
S3 would normally return.
You can include any number of metadata headers. When including a metadata
header, it should be prefaced with x-amz-meta
. For example,
x-amz-meta-my-custom-header: MyCustomValue
. The primary use case for this is
to forward GetObject
metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.
Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.
Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.
For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.