We are excited to announce our new API Documentation.
Optional
ACLOptional
BodyObject data.
The bucket name to which the PUT action was initiated.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues
Optional
BucketSpecifies whether Amazon S3 should use an S3 Bucket Key for object encryption with
server-side encryption using Key Management Service (KMS) keys (SSE-KMS). Setting this header to
true
causes Amazon S3 to use an S3 Bucket Key for object encryption with
SSE-KMS.
Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
Optional
CacheCan be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
Optional
ChecksumIndicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any
additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum
or
x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request
. For more
information, see Checking object integrity in
the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided
ChecksumAlgorithm
parameter.
Optional
ChecksumCRC32This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Optional
ChecksumCRC32CThis header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Optional
ChecksumSHA1This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Optional
ChecksumSHA256This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Optional
ContentSpecifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
Optional
ContentSpecifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
Optional
ContentThe language the content is in.
Optional
ContentSize of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
Optional
ContentMD5The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
Optional
ContentA standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
Optional
ExpectedThe account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
Optional
ExpiresThe date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
Optional
GrantGives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
This action is not supported by Amazon S3 on Outposts.
Optional
GrantAllows grantee to read the object data and its metadata.
This action is not supported by Amazon S3 on Outposts.
Optional
GrantAllows grantee to read the object ACL.
This action is not supported by Amazon S3 on Outposts.
Optional
GrantAllows grantee to write the ACL for the applicable object.
This action is not supported by Amazon S3 on Outposts.
Object key for which the PUT action was initiated.
Optional
MetadataA map of metadata to store with the object in S3.
Optional
ObjectSpecifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
Optional
ObjectThe Object Lock mode that you want to apply to this object.
Optional
ObjectThe date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
Optional
RequestConfirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination Amazon S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Optional
SSECustomerSpecifies the algorithm to use to when encrypting the object (for example, AES256).
Optional
SSECustomerSpecifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This
value is used to store the object and then it is discarded; Amazon S3 does not store the
encryption key. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.
Optional
SSECustomerSpecifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
Optional
SSEKMSEncryptionSpecifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of
this header is a base64-encoded UTF-8 string holding JSON with the encryption context
key-value pairs. This value is stored as object metadata and automatically gets passed on
to Amazon Web Services KMS for future GetObject
or CopyObject
operations on
this object.
Optional
SSEKMSKeyIf x-amz-server-side-encryption
has a valid value of aws:kms
or aws:kms:dsse
, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the Key Management Service (KMS)
symmetric encryption customer managed key that was used for the object. If you specify
x-amz-server-side-encryption:aws:kms
or
x-amz-server-side-encryption:aws:kms:dsse
, but do not provide
x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the Amazon Web Services managed key
(aws/s3
) to protect the data. If the KMS key does not exist in the same
account that's issuing the command, you must use the full ARN and not just the ID.
Optional
ServerThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
, aws:kms
, aws:kms:dsse
).
Optional
StorageBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
Optional
TaggingThe tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
Optional
WebsiteIf the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
The canned ACL to apply to the object. For more information, see Canned ACL.
This action is not supported by Amazon S3 on Outposts.