We are excited to announce our new API Documentation.
Optional
ACLThe name of the bucket to which to initiate the upload
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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.
Optional
CacheSpecifies caching behavior along the request/reply chain.
Optional
ChecksumIndicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
Optional
ContentSpecifies presentational information for the object.
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.
Optional
ContentThe language the content is in.
Optional
ContentA standard MIME type describing the format of the object data.
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.
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 multipart upload is to be initiated.
Optional
MetadataA map of metadata to store with the object in S3.
Optional
ObjectSpecifies whether you want to apply a legal hold to the uploaded object.
Optional
ObjectSpecifies the Object Lock mode that you want to apply to the uploaded object.
Optional
ObjectSpecifies the date and time when you want the Object Lock to expire.
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.
Optional
SSEKMSKeySpecifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric encryption customer managed key to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
Optional
ServerThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256
, aws:kms
).
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.
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.
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.