@Mutable @NotThreadSafe public static interface CreateMultipartUploadRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<CreateMultipartUploadRequest.Builder,CreateMultipartUploadRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateMultipartUploadRequest.Builder |
acl(ObjectCannedACL acl)
The canned ACL to apply to the object.
|
CreateMultipartUploadRequest.Builder |
acl(String acl)
The canned ACL to apply to the object.
|
CreateMultipartUploadRequest.Builder |
bucket(String bucket)
The name of the bucket where the multipart upload is initiated and where the object is uploaded.
|
CreateMultipartUploadRequest.Builder |
bucketKeyEnabled(Boolean bucketKeyEnabled)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption
using Key Management Service (KMS) keys (SSE-KMS).
|
CreateMultipartUploadRequest.Builder |
cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
|
CreateMultipartUploadRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object.
|
CreateMultipartUploadRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object.
|
CreateMultipartUploadRequest.Builder |
checksumType(ChecksumType checksumType)
Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
|
CreateMultipartUploadRequest.Builder |
checksumType(String checksumType)
Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
|
CreateMultipartUploadRequest.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
CreateMultipartUploadRequest.Builder |
contentEncoding(String contentEncoding)
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.
|
CreateMultipartUploadRequest.Builder |
contentLanguage(String contentLanguage)
The language that the content is in.
|
CreateMultipartUploadRequest.Builder |
contentType(String contentType)
A standard MIME type describing the format of the object data.
|
CreateMultipartUploadRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
CreateMultipartUploadRequest.Builder |
expires(Instant expires)
The date and time at which the object is no longer cacheable.
|
CreateMultipartUploadRequest.Builder |
grantFullControl(String grantFullControl)
Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the
object.
|
CreateMultipartUploadRequest.Builder |
grantRead(String grantRead)
Specify access permissions explicitly to allow grantee to read the object data and its metadata.
|
CreateMultipartUploadRequest.Builder |
grantReadACP(String grantReadACP)
Specify access permissions explicitly to allows grantee to read the object ACL.
|
CreateMultipartUploadRequest.Builder |
grantWriteACP(String grantWriteACP)
Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable
object.
|
CreateMultipartUploadRequest.Builder |
key(String key)
Object key for which the multipart upload is to be initiated.
|
CreateMultipartUploadRequest.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
CreateMultipartUploadRequest.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether you want to apply a legal hold to the uploaded object.
|
CreateMultipartUploadRequest.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether you want to apply a legal hold to the uploaded object.
|
CreateMultipartUploadRequest.Builder |
objectLockMode(ObjectLockMode objectLockMode)
Specifies the Object Lock mode that you want to apply to the uploaded object.
|
CreateMultipartUploadRequest.Builder |
objectLockMode(String objectLockMode)
Specifies the Object Lock mode that you want to apply to the uploaded object.
|
CreateMultipartUploadRequest.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
Specifies the date and time when you want the Object Lock to expire.
|
CreateMultipartUploadRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateMultipartUploadRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateMultipartUploadRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
CreateMultipartUploadRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
CreateMultipartUploadRequest.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms). |
CreateMultipartUploadRequest.Builder |
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms). |
CreateMultipartUploadRequest.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use when encrypting the object (for example, AES256).
|
CreateMultipartUploadRequest.Builder |
sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
CreateMultipartUploadRequest.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321.
|
CreateMultipartUploadRequest.Builder |
ssekmsEncryptionContext(String ssekmsEncryptionContext)
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption.
|
CreateMultipartUploadRequest.Builder |
ssekmsKeyId(String ssekmsKeyId)
Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption.
|
CreateMultipartUploadRequest.Builder |
storageClass(StorageClass storageClass)
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
|
CreateMultipartUploadRequest.Builder |
storageClass(String storageClass)
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
|
CreateMultipartUploadRequest.Builder |
tagging(String tagging)
The tag-set for the object.
|
CreateMultipartUploadRequest.Builder |
tagging(Tagging tagging) |
CreateMultipartUploadRequest.Builder |
websiteRedirectLocation(String websiteRedirectLocation)
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldNameToField, sdkFieldscopyapplyMutation, buildCreateMultipartUploadRequest.Builder acl(String acl)
The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.
By default, all objects are private. Only the owner has full access control. When uploading an object, you
can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by
Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more
information, see Using
ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the
x-amz-acl request header.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
acl - The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned
ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see
Canned ACL
in the Amazon S3 User Guide.
By default, all objects are private. Only the owner has full access control. When uploading an object,
you can grant access permissions to individual Amazon Web Services accounts or to predefined groups
defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new
object. For more information, see Using ACLs. One way
to grant the permissions using the request headers is to specify a canned ACL with the
x-amz-acl request header.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
ObjectCannedACL,
ObjectCannedACLCreateMultipartUploadRequest.Builder acl(ObjectCannedACL acl)
The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL in the Amazon S3 User Guide.
By default, all objects are private. Only the owner has full access control. When uploading an object, you
can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by
Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more
information, see Using
ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the
x-amz-acl request header.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
acl - The canned ACL to apply to the object. Amazon S3 supports a set of predefined ACLs, known as canned
ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see
Canned ACL
in the Amazon S3 User Guide.
By default, all objects are private. Only the owner has full access control. When uploading an object,
you can grant access permissions to individual Amazon Web Services accounts or to predefined groups
defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new
object. For more information, see Using ACLs. One way
to grant the permissions using the request headers is to specify a canned ACL with the
x-amz-acl request header.
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
ObjectCannedACL,
ObjectCannedACLCreateMultipartUploadRequest.Builder bucket(String bucket)
The name of the bucket where the multipart upload is initiated and where the object is uploaded.
Directory buckets - When you use this operation with a directory bucket, you must use
virtual-hosted-style requests in the format
Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style
requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or
Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3
(for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN
or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in
the Amazon S3 User Guide.
bucket - The name of the bucket where the multipart upload is initiated and where the object is uploaded.
Directory buckets - When you use this operation with a directory bucket, you must use
virtual-hosted-style requests in the format
Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style
requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability
Zone or Local Zone). Bucket names must follow the format
bucket-base-name--zone-id--x-s3 (for example,
amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access
point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on
Outposts? in the Amazon S3 User Guide.
CreateMultipartUploadRequest.Builder cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
cacheControl - Specifies caching behavior along the request/reply chain.CreateMultipartUploadRequest.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object.
contentDisposition - Specifies presentational information for the object.CreateMultipartUploadRequest.Builder contentEncoding(String contentEncoding)
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 directory buckets, only the aws-chunked value is supported in this header field.
contentEncoding - 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 directory buckets, only the aws-chunked value is supported in this header field.
CreateMultipartUploadRequest.Builder contentLanguage(String contentLanguage)
The language that the content is in.
contentLanguage - The language that the content is in.CreateMultipartUploadRequest.Builder contentType(String contentType)
A standard MIME type describing the format of the object data.
contentType - A standard MIME type describing the format of the object data.CreateMultipartUploadRequest.Builder expires(Instant expires)
The date and time at which the object is no longer cacheable.
expires - The date and time at which the object is no longer cacheable.CreateMultipartUploadRequest.Builder grantFullControl(String grantFullControl)
Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
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 the Amazon Web Services accounts
identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
grantFullControl - Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on
the object.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
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 the Amazon Web Services
accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
CreateMultipartUploadRequest.Builder grantRead(String grantRead)
Specify access permissions explicitly to allow grantee to read the object data and its metadata.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
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 the Amazon Web Services accounts
identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
grantRead - Specify access permissions explicitly to allow grantee to read the object data and its metadata.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
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 the Amazon Web Services
accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
CreateMultipartUploadRequest.Builder grantReadACP(String grantReadACP)
Specify access permissions explicitly to allows grantee to read the object ACL.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
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 the Amazon Web Services accounts
identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
grantReadACP - Specify access permissions explicitly to allows grantee to read the object ACL.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
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 the Amazon Web Services
accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
CreateMultipartUploadRequest.Builder grantWriteACP(String grantWriteACP)
Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
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 the Amazon Web Services accounts
identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
grantWriteACP - Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the
applicable object.
By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
You specify each grantee as a type=value pair, where the type is one of the following:
id – if the value specified is the canonical user ID of an Amazon Web Services account
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 the Amazon Web Services
accounts identified by account IDs permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
This functionality is not supported for directory buckets.
This functionality is not supported for Amazon S3 on Outposts.
CreateMultipartUploadRequest.Builder key(String key)
Object key for which the multipart upload is to be initiated.
key - Object key for which the multipart upload is to be initiated.CreateMultipartUploadRequest.Builder metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
metadata - A map of metadata to store with the object in S3.CreateMultipartUploadRequest.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms).
Directory buckets - For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side
encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption
uses the desired encryption configuration and you don't override the bucket default encryption in your
CreateSession requests or PUT object requests. Then, new objects are automatically
encrypted with the desired encryption settings. For more information, see Protecting
data with server-side encryption in the Amazon S3 User Guide. For more information about the
encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the
REST API, the encryption request headers must match the encryption settings that are specified in the
CreateSession request. You can't override the values of the encryption settings (
x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
x-amz-server-side-encryption-context, and
x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
CreateSession request. You don't need to explicitly specify these encryption settings values in
Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token
refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web
Services SDKs use the bucket's default encryption configuration for the CreateSession request.
It's not supported to override the encryption settings values in the CreateSession 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.
serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms).
Directory buckets - For directory buckets, there are only two supported options for
server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We
recommend that the bucket's default encryption uses the desired encryption configuration and you don't
override the bucket default encryption in your CreateSession requests or PUT
object requests. Then, new objects are automatically encrypted with the desired encryption settings.
For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more
information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy)
using the REST API, the encryption request headers must match the encryption settings that are
specified in the CreateSession request. You can't override the values of the encryption
settings (x-amz-server-side-encryption,
x-amz-server-side-encryption-aws-kms-key-id,
x-amz-server-side-encryption-context, and
x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
CreateSession request. You don't need to explicitly specify these encryption settings
values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session
token refreshes automatically to avoid service interruptions when a session expires. The CLI or the
Amazon Web Services SDKs use the bucket's default encryption configuration for the
CreateSession request. It's not supported to override the encryption settings values in
the CreateSession 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.
ServerSideEncryption,
ServerSideEncryptionCreateMultipartUploadRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms).
Directory buckets - For directory buckets, there are only two supported options for server-side
encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side
encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption
uses the desired encryption configuration and you don't override the bucket default encryption in your
CreateSession requests or PUT object requests. Then, new objects are automatically
encrypted with the desired encryption settings. For more information, see Protecting
data with server-side encryption in the Amazon S3 User Guide. For more information about the
encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the
REST API, the encryption request headers must match the encryption settings that are specified in the
CreateSession request. You can't override the values of the encryption settings (
x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
x-amz-server-side-encryption-context, and
x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
CreateSession request. You don't need to explicitly specify these encryption settings values in
Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token
refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web
Services SDKs use the bucket's default encryption configuration for the CreateSession request.
It's not supported to override the encryption settings values in the CreateSession 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.
serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms).
Directory buckets - For directory buckets, there are only two supported options for
server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We
recommend that the bucket's default encryption uses the desired encryption configuration and you don't
override the bucket default encryption in your CreateSession requests or PUT
object requests. Then, new objects are automatically encrypted with the desired encryption settings.
For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more
information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
In the Zonal endpoint API calls (except CopyObject and UploadPartCopy)
using the REST API, the encryption request headers must match the encryption settings that are
specified in the CreateSession request. You can't override the values of the encryption
settings (x-amz-server-side-encryption,
x-amz-server-side-encryption-aws-kms-key-id,
x-amz-server-side-encryption-context, and
x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
CreateSession request. You don't need to explicitly specify these encryption settings
values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
CreateSession request to protect new objects in the directory bucket.
When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session
token refreshes automatically to avoid service interruptions when a session expires. The CLI or the
Amazon Web Services SDKs use the bucket's default encryption configuration for the
CreateSession request. It's not supported to override the encryption settings values in
the CreateSession 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.
ServerSideEncryption,
ServerSideEncryptionCreateMultipartUploadRequest.Builder storageClass(String storageClass)
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.
Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in
Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated
Local Zones.
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
storageClass - 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.
Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in
Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in
Dedicated Local Zones.
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
StorageClass,
StorageClassCreateMultipartUploadRequest.Builder storageClass(StorageClass storageClass)
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.
Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in
Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated
Local Zones.
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
storageClass - 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.
Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in
Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in
Dedicated Local Zones.
Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
StorageClass,
StorageClassCreateMultipartUploadRequest.Builder websiteRedirectLocation(String websiteRedirectLocation)
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.
This functionality is not supported for directory buckets.
websiteRedirectLocation - 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. This functionality is not supported for directory buckets.
CreateMultipartUploadRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
sseCustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example, AES256). This functionality is not supported for directory buckets.
CreateMultipartUploadRequest.Builder sseCustomerKey(String sseCustomerKey)
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.
This functionality is not supported for directory buckets.
sseCustomerKey - 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. This functionality is not supported for directory buckets.
CreateMultipartUploadRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
This functionality is not supported for directory buckets.
sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Amazon
S3 uses this header for a message integrity check to ensure that the encryption key was transmitted
without error. This functionality is not supported for directory buckets.
CreateMultipartUploadRequest.Builder ssekmsKeyId(String ssekmsKeyId)
Specifies the 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 with
aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key
Alias) of the KMS key to use. 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.
Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the
x-amz-server-side-encryption header to aws:kms. Then, the
x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default KMS
customer managed key ID. If you want to explicitly set the
x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default customer
managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1 customer managed
key per directory bucket's lifetime. The Amazon Web
Services managed key (aws/s3) isn't supported. Incorrect key specification results in an
HTTP 400 Bad Request error.
ssekmsKeyId - Specifies the 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 with
aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or
Key Alias) of the KMS key to use. 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.
Directory buckets - To encrypt data using SSE-KMS, it's recommended to specify the
x-amz-server-side-encryption header to aws:kms. Then, the
x-amz-server-side-encryption-aws-kms-key-id header implicitly uses the bucket's default
KMS customer managed key ID. If you want to explicitly set the
x-amz-server-side-encryption-aws-kms-key-id header, it must match the bucket's default
customer managed key (using key ID or ARN, not alias). Your SSE-KMS configuration can only support 1
customer
managed key per directory bucket's lifetime. The Amazon Web
Services managed key (aws/s3) isn't supported. Incorrect key specification results in
an HTTP 400 Bad Request error.
CreateMultipartUploadRequest.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)
Specifies the Amazon Web Services 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.
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.
ssekmsEncryptionContext - Specifies the Amazon Web Services 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.
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.
CreateMultipartUploadRequest.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).
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 and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy
SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to
general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy
operation in Batch Operations, or the import jobs. In this
case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
bucketKeyEnabled - Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side
encryption using Key Management Service (KMS) keys (SSE-KMS).
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 and PUT
operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy
SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to
general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the
Copy operation in Batch Operations, or the import jobs. In
this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
CreateMultipartUploadRequest.Builder requestPayer(String requestPayer)
requestPayer - The new value for the RequestPayer property for this object.RequestPayer,
RequestPayerCreateMultipartUploadRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer - The new value for the RequestPayer property for this object.RequestPayer,
RequestPayerCreateMultipartUploadRequest.Builder tagging(String tagging)
The tag-set for the object. The tag-set must be encoded as URL Query parameters.
This functionality is not supported for directory buckets.
tagging - The tag-set for the object. The tag-set must be encoded as URL Query parameters. This functionality is not supported for directory buckets.
CreateMultipartUploadRequest.Builder tagging(Tagging tagging)
CreateMultipartUploadRequest.Builder objectLockMode(String objectLockMode)
Specifies the Object Lock mode that you want to apply to the uploaded object.
This functionality is not supported for directory buckets.
objectLockMode - Specifies the Object Lock mode that you want to apply to the uploaded object. This functionality is not supported for directory buckets.
ObjectLockMode,
ObjectLockModeCreateMultipartUploadRequest.Builder objectLockMode(ObjectLockMode objectLockMode)
Specifies the Object Lock mode that you want to apply to the uploaded object.
This functionality is not supported for directory buckets.
objectLockMode - Specifies the Object Lock mode that you want to apply to the uploaded object. This functionality is not supported for directory buckets.
ObjectLockMode,
ObjectLockModeCreateMultipartUploadRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
Specifies the date and time when you want the Object Lock to expire.
This functionality is not supported for directory buckets.
objectLockRetainUntilDate - Specifies the date and time when you want the Object Lock to expire. This functionality is not supported for directory buckets.
CreateMultipartUploadRequest.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether you want to apply a legal hold to the uploaded object.
This functionality is not supported for directory buckets.
objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the uploaded object. This functionality is not supported for directory buckets.
ObjectLockLegalHoldStatus,
ObjectLockLegalHoldStatusCreateMultipartUploadRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether you want to apply a legal hold to the uploaded object.
This functionality is not supported for directory buckets.
objectLockLegalHoldStatus - Specifies whether you want to apply a legal hold to the uploaded object. This functionality is not supported for directory buckets.
ObjectLockLegalHoldStatus,
ObjectLockLegalHoldStatusCreateMultipartUploadRequest.Builder expectedBucketOwner(String expectedBucketOwner)
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).
expectedBucketOwner - 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).CreateMultipartUploadRequest.Builder checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumAlgorithm - Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
information, see Checking
object integrity in the Amazon S3 User Guide.ChecksumAlgorithm,
ChecksumAlgorithmCreateMultipartUploadRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumAlgorithm - Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
information, see Checking
object integrity in the Amazon S3 User Guide.ChecksumAlgorithm,
ChecksumAlgorithmCreateMultipartUploadRequest.Builder checksumType(String checksumType)
Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumType - Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
For more information, see Checking
object integrity in the Amazon S3 User Guide.ChecksumType,
ChecksumTypeCreateMultipartUploadRequest.Builder checksumType(ChecksumType checksumType)
Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
checksumType - Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
For more information, see Checking
object integrity in the Amazon S3 User Guide.ChecksumType,
ChecksumTypeCreateMultipartUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateMultipartUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2026. All rights reserved.