PutObject
Adds an object to a bucket.
Note
-
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.
Note
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.
Note
This functionality is not supported for directory buckets.
- 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 thePutObject
request, you must always have thes3:PutObject
permission on a bucket to add an object to it. -
s3:PutObjectAcl
- To successfully change the objects ACL of yourPutObject
request, you must have thes3:PutObjectAcl
. -
s3:PutObjectTagging
- To successfully set the tag-set with yourPutObject
request, you must have thes3: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 thes3express:CreateSession
permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make theCreateSession
API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make anotherCreateSession
API call to generate a new session token for use. AWS CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, seeCreateSession
.If the object is encrypted with SSE-KMS, you must also have the
kms:GenerateDataKey
andkms:Decrypt
permissions in IAM identity-based policies and AWS KMS key policies for the AWS KMS key.
-
- 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:
Request Syntax
PUT /Key+
HTTP/1.1
Host: Bucket
.s3.amazonaws.com
x-amz-acl: ACL
Cache-Control: CacheControl
Content-Disposition: ContentDisposition
Content-Encoding: ContentEncoding
Content-Language: ContentLanguage
Content-Length: ContentLength
Content-MD5: ContentMD5
Content-Type: ContentType
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-checksum-crc32: ChecksumCRC32
x-amz-checksum-crc32c: ChecksumCRC32C
x-amz-checksum-sha1: ChecksumSHA1
x-amz-checksum-sha256: ChecksumSHA256
Expires: Expires
If-None-Match: IfNoneMatch
x-amz-grant-full-control: GrantFullControl
x-amz-grant-read: GrantRead
x-amz-grant-read-acp: GrantReadACP
x-amz-grant-write-acp: GrantWriteACP
x-amz-server-side-encryption: ServerSideEncryption
x-amz-storage-class: StorageClass
x-amz-website-redirect-location: WebsiteRedirectLocation
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key: SSECustomerKey
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-context: SSEKMSEncryptionContext
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-request-payer: RequestPayer
x-amz-tagging: Tagging
x-amz-object-lock-mode: ObjectLockMode
x-amz-object-lock-retain-until-date: ObjectLockRetainUntilDate
x-amz-object-lock-legal-hold: ObjectLockLegalHoldStatus
x-amz-expected-bucket-owner: ExpectedBucketOwner
Body
URI Request Parameters
The request uses the following URI parameters.
- Bucket
-
The bucket name to which the PUT action was initiated.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS 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.
Note
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the AWS 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.Required: Yes
- Cache-Control
-
Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
. - Content-Disposition
-
Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4
. - Content-Encoding
-
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding
. - Content-Language
-
The language the content is in.
- Content-Length
-
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length
. - Content-MD5
-
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
Note
The
Content-MD5
orx-amz-sdk-checksum-algorithm
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.Note
This functionality is not supported for directory buckets.
- Content-Type
-
A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type
. - Expires
-
The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3
. - If-None-Match
-
Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a
412 Precondition Failed
error.If a conflicting operation occurs during the upload S3 returns a
409 ConditionalRequestConflict
response. On a 409 failure you should retry the upload.Expects the '*' (asterisk) character.
For more information about conditional requests, see RFC 7232
, or Conditional requests in the Amazon S3 User Guide. - Key
-
Object key for which the PUT action was initiated.
Length Constraints: Minimum length of 1.
Required: Yes
- x-amz-acl
-
The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.
When adding a new object, you can use headers to grant ACL-based permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.
If the bucket that you're uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the
bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain AWS accounts) fail and return a400
error with the error codeAccessControlListNotSupported
. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.Note
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
Valid Values:
private | public-read | public-read-write | authenticated-read | aws-exec-read | bucket-owner-read | bucket-owner-full-control
-
- x-amz-checksum-crc32
-
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-checksum-crc32c
-
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-checksum-sha1
-
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-checksum-sha256
-
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-expected-bucket-owner
-
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden
(access denied). - x-amz-grant-full-control
-
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
Note
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
- x-amz-grant-read
-
Allows grantee to read the object data and its metadata.
Note
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
- x-amz-grant-read-acp
-
Allows grantee to read the object ACL.
Note
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
- x-amz-grant-write-acp
-
Allows grantee to write the ACL for the applicable object.
Note
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
-
- x-amz-object-lock-legal-hold
-
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
Valid Values:
ON | OFF
- x-amz-object-lock-mode
-
The Object Lock mode that you want to apply to this object.
Note
This functionality is not supported for directory buckets.
Valid Values:
GOVERNANCE | COMPLIANCE
- x-amz-object-lock-retain-until-date
-
The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
Note
This functionality is not supported for directory buckets.
- x-amz-request-payer
-
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
Valid Values:
requester
- x-amz-sdk-checksum-algorithm
-
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksum-algorithm
orx-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 Bad Request
.For the
x-amz-checksum-algorithm
header, replacealgorithm
with the supported algorithm from the following list:-
CRC32
-
CRC32C
-
SHA1
-
SHA256
For more information, see Checking object integrity in the Amazon S3 User Guide.
If the individual checksum value you provide through
x-amz-checksum-algorithm
doesn't match the checksum algorithm you set throughx-amz-sdk-checksum-algorithm
, Amazon S3 ignores any providedChecksumAlgorithm
parameter and uses the checksum algorithm that matches the provided value inx-amz-checksum-algorithm
.Note
The
Content-MD5
orx-amz-sdk-checksum-algorithm
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.For directory buckets, when you use AWS SDKs,
CRC32
is the default checksum algorithm that's used for performance.Valid Values:
CRC32 | CRC32C | SHA1 | SHA256
-
- x-amz-server-side-encryption
-
The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).-
General purpose buckets - You have four mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), AWS KMS keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side Encryption in the Amazon S3 User Guide.
-
Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) and server-side encryption with AWS KMS keys (SSE-KMS) (aws:kms
). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in yourCreateSession
requests orPUT
object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with AWS KMS for new object uploads.In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the
CreateSession
request. You can't override the values of the encryption settings (x-amz-server-side-encryption
,x-amz-server-side-encryption-aws-kms-key-id
,x-amz-server-side-encryption-context
, andx-amz-server-side-encryption-bucket-key-enabled
) that are specified in theCreateSession
request. You don't need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from theCreateSession
request to protect new objects in the directory bucket.Note
When you use the CLI or the AWS SDKs, for
CreateSession
, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the AWS SDKs use the bucket's default encryption configuration for theCreateSession
request. It's not supported to override the encryption settings values in theCreateSession
request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.
Valid Values:
AES256 | aws:kms | aws:kms:dsse
-
- x-amz-server-side-encryption-aws-kms-key-id
-
Specifies the AWS KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
General purpose buckets - If you specify
x-amz-server-side-encryption
withaws:kms
oraws:kms:dsse
, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the AWS KMS key to use. If you specifyx-amz-server-side-encryption:aws:kms
orx-amz-server-side-encryption:aws:kms:dsse
, but do not providex-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed key (aws/s3
) to protect the data.Directory buckets - If you specify
x-amz-server-side-encryption
withaws:kms
, thex-amz-server-side-encryption-aws-kms-key-id
header is implicitly assigned the ID of the AWS KMS symmetric encryption customer managed key that's configured for your directory bucket's default encryption setting. If you want to specify thex-amz-server-side-encryption-aws-kms-key-id
header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the AWS KMS customer managed key that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP400 Bad Request
error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The AWS managed key (aws/s3
) isn't supported. - x-amz-server-side-encryption-bucket-key-enabled
-
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS Key Management Service (AWS KMS) keys (SSE-KMS).
General purpose buckets - Setting this header to
true
causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect bucket-level settings for S3 Bucket Key.Directory buckets - S3 Bucket Keys are always enabled for
GET
andPUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to AWS KMS every time a copy request is made for a KMS-encrypted object. - x-amz-server-side-encryption-context
-
Specifies the AWS KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to AWS KMS for future
GetObject
operations on this object.General purpose buckets - This value must be explicitly added during
CopyObject
operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.
- x-amz-server-side-encryption-customer-algorithm
-
Specifies the algorithm to use when encrypting the object (for example,
AES256
).Note
This functionality is not supported for directory buckets.
- x-amz-server-side-encryption-customer-key
-
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.Note
This functionality is not supported for directory buckets.
- x-amz-server-side-encryption-customer-key-MD5
-
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
Note
This functionality is not supported for directory buckets.
- x-amz-storage-class
-
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
Note
-
For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
-
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
Valid Values:
STANDARD | REDUCED_REDUNDANCY | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_IR | SNOW | EXPRESS_ONEZONE
-
- x-amz-tagging
-
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
Note
This functionality is not supported for directory buckets.
- x-amz-website-redirect-location
-
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata in the Amazon S3 User Guide.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects in the Amazon S3 User Guide.
Note
This functionality is not supported for directory buckets.
Request Body
The request accepts the following binary data.
Response Syntax
HTTP/1.1 200
x-amz-expiration: Expiration
ETag: ETag
x-amz-checksum-crc32: ChecksumCRC32
x-amz-checksum-crc32c: ChecksumCRC32C
x-amz-checksum-sha1: ChecksumSHA1
x-amz-checksum-sha256: ChecksumSHA256
x-amz-server-side-encryption: ServerSideEncryption
x-amz-version-id: VersionId
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-context: SSEKMSEncryptionContext
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-request-charged: RequestCharged
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The response returns the following HTTP headers.
- ETag
-
Entity tag for the uploaded object.
General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
- x-amz-checksum-crc32
-
The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-checksum-crc32c
-
The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-checksum-sha1
-
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-checksum-sha256
-
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- x-amz-expiration
-
If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the
expiry-date
andrule-id
key-value pairs that provide information about object expiration. The value of therule-id
is URL-encoded.Note
This functionality is not supported for directory buckets.
- x-amz-request-charged
-
If present, indicates that the requester was successfully charged for the request.
Note
This functionality is not supported for directory buckets.
Valid Values:
requester
- x-amz-server-side-encryption
-
The server-side encryption algorithm used when you store this object in Amazon S3.
Valid Values:
AES256 | aws:kms | aws:kms:dsse
- x-amz-server-side-encryption-aws-kms-key-id
-
If present, indicates the ID of the KMS key that was used for object encryption.
- x-amz-server-side-encryption-bucket-key-enabled
-
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).
- x-amz-server-side-encryption-context
-
If present, indicates the AWS KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to AWS KMS for future
GetObject
operations on this object. - x-amz-server-side-encryption-customer-algorithm
-
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
Note
This functionality is not supported for directory buckets.
- x-amz-server-side-encryption-customer-key-MD5
-
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
Note
This functionality is not supported for directory buckets.
- x-amz-version-id
-
Version ID of the object.
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
Note
This functionality is not supported for directory buckets.
Examples
Example 1 for general purpose buckets: Upload an object
The following request stores the my-image.jpg
file in the
myBucket
bucket.
PUT /my-image.jpg HTTP/1.1 Host: myBucket.s3.<Region>.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: text/plain Content-Length: 11434 x-amz-meta-author: Janet Expect: 100-continue [11434 bytes of object data]
Sample Response for general purpose buckets: Versioning suspended
This example illustrates one usage of PutObject.
HTTP/1.1 100 Continue HTTP/1.1 200 OK x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC Date: Wed, 12 Oct 2009 17:50:00 GMT ETag: "1b2cf535f27731c974343645a3985328" Content-Length: 0 Connection: close Server: AmazonS3
Sample Response for general purpose buckets: Expiration rule created using lifecycle configuration
If an expiration rule that was created on the bucket using lifecycle configuration
applies to the object, you get a response with an x-amz-expiration
header, as shown in the following response. For more information, see Transitioning Objects: General Considerations.
HTTP/1.1 100 Continue HTTP/1.1 200 OK x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC Date: Wed, 12 Oct 2009 17:50:00 GMT x-amz-expiration: expiry-date="Fri, 23 Dec 2012 00:00:00 GMT", rule-id="1" ETag: "1b2cf535f27731c974343645a3985328" Content-Length: 0 Connection: close Server: AmazonS3
Sample Response for general purpose buckets: Versioning enabled
If the bucket has versioning enabled, the response includes the
x-amz-version-id
header.
HTTP/1.1 100 Continue HTTP/1.1 200 OK x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC x-amz-version-id: 43jfkodU8493jnFJD9fjj3HHNVfdsQUIFDNsidf038jfdsjGFDSIRp Date: Wed, 12 Oct 2009 17:50:00 GMT ETag: "fbacf535f27731c9771645a39863328" Content-Length: 0 Connection: close Server: AmazonS3
Example 2 for general purpose buckets: Specifying the Reduced Redundancy Storage Class
The following request stores the image, my-image.jpg
, in the
myBucket
bucket. The request specifies the
x-amz-storage-class
header to request that the object is stored using
the REDUCED_REDUNDANCY storage class.
PUT /my-image.jpg HTTP/1.1 Host: myBucket.s3.<Region>.amazonaws.com Date: Wed, 12 Oct 2009 17:50:00 GMT Authorization: authorization string Content-Type: image/jpeg Content-Length: 11434 Expect: 100-continue x-amz-storage-class: REDUCED_REDUNDANCY
Sample Response for general purpose buckets
This example illustrates one usage of PutObject.
HTTP/1.1 100 Continue HTTP/1.1 200 OK x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC Date: Wed, 12 Oct 2009 17:50:00 GMT ETag: "1b2cf535f27731c974343645a3985328" Content-Length: 0 Connection: close Server: AmazonS3
Example 3 for general purpose buckets: Uploading an object and specifying access permissions explicitly
The following request stores the TestObject.txt
file in the
myBucket
bucket. The request specifies various ACL headers to grant
permission to AWS accounts that are specified with a canonical user ID and an email
address.
PUT TestObject.txt HTTP/1.1 Host: myBucket.s3.<Region>.amazonaws.com x-amz-date: Fri, 13 Apr 2012 05:40:14 GMT Authorization: authorization string x-amz-grant-write-acp: id=8a6925ce4adf588a4532142d3f74dd8c71fa124ExampleCanonicalUserID x-amz-grant-full-control: emailAddress="ExampleUser@amazon.com" x-amz-grant-write: emailAddress="ExampleUser1@amazon.com", emailAddress="ExampleUser2@amazon.com" Content-Length: 300 Expect: 100-continue Connection: Keep-Alive ...Object data in the body...
Sample Response for general purpose buckets
This example illustrates one usage of PutObject.
HTTP/1.1 200 OK x-amz-id-2: RUxG2sZJUfS+ezeAS2i0Xj6w/ST6xqF/8pFNHjTjTrECW56SCAUWGg+7QLVoj1GH x-amz-request-id: 8D017A90827290BA Date: Fri, 13 Apr 2012 05:40:25 GMT ETag: "dd038b344cf9553547f8b395a814b274" Content-Length: 0 Server: AmazonS3
Example 4 for general purpose buckets: Using a canned ACL to set access permissions
The following request stores the TestObject.txt
file in the myBucket
bucket. The request uses an x-amz-acl
header to specify a canned ACL
that grants READ permission to the public.
PUT TestObject.txt HTTP/1.1 Host: myBucket.s3.<Region>.amazonaws.com x-amz-date: Fri, 13 Apr 2012 05:54:57 GMT x-amz-acl: public-read Authorization: authorization string Content-Length: 300 Expect: 100-continue Connection: Keep-Alive ...Object data in the body...
Sample Response for general purpose buckets
This example illustrates one usage of PutObject.
HTTP/1.1 200 OK x-amz-id-2: Yd6PSJxJFQeTYJ/3dDO7miqJfVMXXW0S2Hijo3WFs4bz6oe2QCVXasxXLZdMfASd x-amz-request-id: 80DF413BB3D28A25 Date: Fri, 13 Apr 2012 05:54:59 GMT ETag: "dd038b344cf9553547f8b395a814b274" Content-Length: 0 Server: AmazonS3
Example 5 for general purpose buckets: Upload an object (Request server-side encryption using a customer-provided encryption key)
This example of an upload object requests server-side encryption and provides an encryption key.
PUT /example-object HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Accept: */* Authorization:authorization string Date: Wed, 28 May 2014 19:31:11 +0000 x-amz-server-side-encryption-customer-key:g0lCfA3Dv40jZz5SQJ1ZukLRFqtI5WorC/8SEEXAMPLE x-amz-server-side-encryption-customer-key-MD5:ZjQrne1X/iTcskbY2example x-amz-server-side-encryption-customer-algorithm:AES256
Sample Response for general purpose buckets
In the response, Amazon S3 returns the encryption algorithm and MD5 of the encryption key that you specified when uploading the object. The ETag that is returned is not the MD5 of the object.
HTTP/1.1 200 OK x-amz-id-2: 7qoYGN7uMuFuYS6m7a4lszH6in+hccE+4DXPmDZ7C9KqucjnZC1gI5mshai6fbMG x-amz-request-id: 06437EDD40C407C7 Date: Wed, 28 May 2014 19:31:12 GMT x-amz-server-side-encryption-customer-algorithm: AES256 x-amz-server-side-encryption-customer-key-MD5: ZjQrne1X/iTcskbY2example ETag: "ae89237c20e759c5f479ece02c642f59"
Example 6 for general purpose buckets: Upload an object and specify tags
This example of an upload object request specifies the optional
x-amz-tagging
header to add tags to the object.
After the object is created, Amazon S3 stores the specified object tags in the tagging subresource that is associated with the object. For more information about tagging, see Object Tagging and Access Control Policies in the Amazon S3 User Guide.
PUT /example-object HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com Accept: */* Authorization:authorization string Date: Thu, 22 Sep 2016 21:58:13 GMT x-amz-tagging: tag1=value1&tag2=value2 [... bytes of object data]
Sample Response for general purpose buckets
This example illustrates one usage of PutObject.
HTTP/1.1 200 OK x-amz-id-2: 7qoYGN7uMuFuYS6m7a4lszH6in+hccE+4DXPmDZ7C9KqucjnZC1gI5mshai6fbMG x-amz-request-id: 06437EDD40C407C7 Date: Thu, 22 Sep 2016 21:58:17 GMT
Example 7 for general purpose buckets: Upload an object and specify the checksum algorithm
This example of an upload object request specifies the additional checksum algorithm to use to verify the content of the object. For more information about using additional checksums, see Checking object integrity in the Amazon S3 User Guide.
PUT /example-object HTTP/1.1 Host: example-bucket.s3.<Region>.amazonaws.com x-amz-date: Mon, 22 Mar 2021 23:00:00 GMT Authorization: authorization string Content-Length: 268435456 x-amz-checksum-sha256: 0ea4be78f6c3948588172edc6d8789ffe3cec461f385e0ac447e581731c429b5 [268435456 bytes of object data in the body]
Sample Response for general purpose buckets
This example illustrates one usage of PutObject.
HTTP/1.1 200 OK x-amz-id-2: 7qoYGN7uMuFuYS6m7a4lszH6in+hccE+4DXPmDZ7C9KqucjnZC1gI5mshai6fbMG x-amz-request-id: 49CFA2051300FBE9 Date: Mon, 22 Mar 2021 23:00:12 GMT
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: