class Aws::S3::Types::CreateMultipartUploadRequest

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CreateMultipartUploadRequest AWS API Documentation
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html integrity][1] in the *Amazon S3 User Guide*.
checksum for the object. For more information, see [Checking object
Indicates the algorithm that you want Amazon S3 to use to create the
@!attribute [rw] checksum_algorithm
@return [String]
denied).
request fails with the HTTP status code ‘403 Forbidden` (access
you provide does not match the actual owner of the bucket, the
The account ID of the expected bucket owner. If the account ID that
@!attribute [rw] expected_bucket_owner
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
object.
Specifies whether you want to apply a legal hold to the uploaded
@!attribute [rw] object_lock_legal_hold_status
@return [Time]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Specifies the date and time when you want the Object Lock to expire.
@!attribute [rw] object_lock_retain_until_date
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
uploaded object.
Specifies the Object Lock mode that you want to apply to the
@!attribute [rw] object_lock_mode
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
parameters.
The tag-set for the object. The tag-set must be encoded as URL Query
@!attribute [rw] tagging
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Requester Pays Buckets] in the *Amazon S3 User Guide*.
objects from Requester Pays buckets, see [Downloading Objects in
charges to copy the object. For information about downloading
Requester Pays enabled, the requester will pay for corresponding
requests. If either the source or destination S3 bucket has
request. Bucket owners need not specify this parameter in their
Confirms that the requester knows that they will be charged for the
@!attribute [rw] request_payer
@return [Boolean]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
bucket-level settings for S3 Bucket Key.
Specifying this header with an object action doesn’t affect
to use an S3 Bucket Key for object encryption with SSE-KMS.
(KMS) keys (SSE-KMS). Setting this header to `true` causes Amazon S3
encryption with server-side encryption using Key Management Service
Specifies whether Amazon S3 should use an S3 Bucket Key for object
@!attribute [rw] bucket_key_enabled
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
pairs.
UTF-8 string holding JSON with the encryption context key-value
object encryption. The value of this header is a base64-encoded
Specifies the Amazon Web Services KMS Encryption Context to use for
@!attribute [rw] ssekms_encryption_context
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
encryption customer managed key to use for object encryption.
Specifies the ID (Key ID, Key ARN, or Key Alias) of the symmetric
@!attribute [rw] ssekms_key_id
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
without error.
integrity check to ensure that the encryption key was transmitted
key according to RFC 1321. Amazon S3 uses this header for a message
Specifies the 128-bit MD5 digest of the customer-provided encryption
@!attribute [rw] sse_customer_key_md5
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
`x-amz-server-side-encryption-customer-algorithm` header.
key must be appropriate for use with the algorithm specified in the
it is discarded; Amazon S3 does not store the encryption key. The
in encrypting data. This value is used to store the object and then
Specifies the customer-provided encryption key for Amazon S3 to use
@!attribute [rw] sse_customer_key
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
example, AES256).
Specifies the algorithm to use when encrypting the object (for
@!attribute [rw] sse_customer_algorithm
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
metadata.
URL. Amazon S3 stores the value of this header in the object
this object to another object in the same bucket or to an external
If the bucket is configured as a website, redirects requests for
@!attribute [rw] website_redirect_location
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html </note>
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
is supported to store newly created objects.
<note markdown=“1”> * For directory buckets, only the S3 Express One Zone storage class
[Storage Classes] in the *Amazon S3 User Guide*.
specify a different Storage Class. For more information, see
and high availability. Depending on performance needs, you can
created objects. The STANDARD storage class provides high durability
By default, Amazon S3 uses the STANDARD Storage Class to store newly
@!attribute [rw] storage_class
@return [String]
</note>
managed keys (SSE-S3) (`AES256`) is supported.
<note markdown=“1”> For directory buckets, only server-side encryption with Amazon S3
in Amazon S3 (for example, `AES256`, `aws:kms`).
The server-side encryption algorithm used when you store this object
@!attribute [rw] server_side_encryption
@return [Hash<String,String>]
A map of metadata to store with the object in S3.
@!attribute [rw] metadata
@return [String]
Object key for which the multipart upload is to be initiated.
@!attribute [rw] key
@return [String] : docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html </note>
* This functionality is not supported for Amazon S3 on Outposts.
<note markdown=“1”> * This functionality is not supported for directory buckets.
`x-amz-grant-read: id=“11112222333”, id=“444455556666” `
to read object data and its metadata:
Amazon Web Services accounts identified by account IDs permissions
For example, the following `x-amz-grant-read` header grants the
</note>
Reference.
see [Regions and Endpoints] in the Amazon Web Services General
For a list of all the Amazon S3 supported Regions and endpoints,
* South America (São Paulo)
* Europe (Ireland)
* Asia Pacific (Tokyo)
* Asia Pacific (Sydney)
* Asia Pacific (Singapore)
* US West (Oregon)
* US West (N. California)
* US East (N. Virginia)
the following Amazon Web Services Regions:
<note markdown=“1”> Using email addresses to specify a grantee is only supported in
Amazon Web Services account
* `emailAddress` – if the value specified is the email address of an
* `uri` – if you are granting permissions to a predefined group
Amazon Web Services account
* `id` – if the value specified is the canonical user ID of an
of the following:
You specify each grantee as a type=value pair, where the type is one
Control List (ACL) Overview] in the *Amazon S3 User Guide*.
Amazon S3 supports in an ACL. For more information, see [Access
accounts or groups. This header maps to specific permissions that
explicitly grant access permissions to specific Amazon Web Services
control. When uploading an object, you can use this header to
By default, all objects are private. Only the owner has full access
grantee to write the ACL for the applicable object.
Specify access permissions explicitly to allows grantee to allow
@!attribute [rw] grant_write_acp
@return [String] : docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html </note>
* This functionality is not supported for Amazon S3 on Outposts.
<note markdown=“1”> * This functionality is not supported for directory buckets.
`x-amz-grant-read: id=“11112222333”, id=“444455556666” `
to read object data and its metadata:
Amazon Web Services accounts identified by account IDs permissions
For example, the following `x-amz-grant-read` header grants the
</note>
Reference.
see [Regions and Endpoints] in the Amazon Web Services General
For a list of all the Amazon S3 supported Regions and endpoints,
* South America (São Paulo)
* Europe (Ireland)
* Asia Pacific (Tokyo)
* Asia Pacific (Sydney)
* Asia Pacific (Singapore)
* US West (Oregon)
* US West (N. California)
* US East (N. Virginia)
the following Amazon Web Services Regions:
<note markdown=“1”> Using email addresses to specify a grantee is only supported in
Amazon Web Services account
* `emailAddress` – if the value specified is the email address of an
* `uri` – if you are granting permissions to a predefined group
Amazon Web Services account
* `id` – if the value specified is the canonical user ID of an
of the following:
You specify each grantee as a type=value pair, where the type is one
Control List (ACL) Overview] in the *Amazon S3 User Guide*.
Amazon S3 supports in an ACL. For more information, see [Access
accounts or groups. This header maps to specific permissions that
explicitly grant access permissions to specific Amazon Web Services
control. When uploading an object, you can use this header to
By default, all objects are private. Only the owner has full access
object ACL.
Specify access permissions explicitly to allows grantee to read the
@!attribute [rw] grant_read_acp
@return [String] : docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html </note>
* This functionality is not supported for Amazon S3 on Outposts.
<note markdown=“1”> * This functionality is not supported for directory buckets.
`x-amz-grant-read: id=“11112222333”, id=“444455556666” `
to read object data and its metadata:
Amazon Web Services accounts identified by account IDs permissions
For example, the following `x-amz-grant-read` header grants the
</note>
Reference.
see [Regions and Endpoints] in the Amazon Web Services General
For a list of all the Amazon S3 supported Regions and endpoints,
* South America (São Paulo)
* Europe (Ireland)
* Asia Pacific (Tokyo)
* Asia Pacific (Sydney)
* Asia Pacific (Singapore)
* US West (Oregon)
* US West (N. California)
* US East (N. Virginia)
the following Amazon Web Services Regions:
<note markdown=“1”> Using email addresses to specify a grantee is only supported in
Amazon Web Services account
* `emailAddress` – if the value specified is the email address of an
* `uri` – if you are granting permissions to a predefined group
Amazon Web Services account
* `id` – if the value specified is the canonical user ID of an
of the following:
You specify each grantee as a type=value pair, where the type is one
Control List (ACL) Overview] in the *Amazon S3 User Guide*.
Amazon S3 supports in an ACL. For more information, see [Access
accounts or groups. This header maps to specific permissions that
explicitly grant access permissions to specific Amazon Web Services
control. When uploading an object, you can use this header to
By default, all objects are private. Only the owner has full access
object data and its metadata.
Specify access permissions explicitly to allow grantee to read the
@!attribute [rw] grant_read
@return [String] : docs.aws.amazon.com/general/latest/gr/rande.html#s3_region [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html </note>
* This functionality is not supported for Amazon S3 on Outposts.
<note markdown=“1”> * This functionality is not supported for directory buckets.
`x-amz-grant-read: id=“11112222333”, id=“444455556666” `
to read object data and its metadata:
Amazon Web Services accounts identified by account IDs permissions
For example, the following `x-amz-grant-read` header grants the
</note>
Reference.
see [Regions and Endpoints] in the Amazon Web Services General
For a list of all the Amazon S3 supported Regions and endpoints,
* South America (São Paulo)
* Europe (Ireland)
* Asia Pacific (Tokyo)
* Asia Pacific (Sydney)
* Asia Pacific (Singapore)
* US West (Oregon)
* US West (N. California)
* US East (N. Virginia)
the following Amazon Web Services Regions:
<note markdown=“1”> Using email addresses to specify a grantee is only supported in
Amazon Web Services account
* `emailAddress` – if the value specified is the email address of an
* `uri` – if you are granting permissions to a predefined group
Amazon Web Services account
* `id` – if the value specified is the canonical user ID of an
of the following:
You specify each grantee as a type=value pair, where the type is one
Control List (ACL) Overview] in the *Amazon S3 User Guide*.
Amazon S3 supports in an ACL. For more information, see [Access
accounts or groups. This header maps to specific permissions that
explicitly grant access permissions to specific Amazon Web Services
control. When uploading an object, you can use this header to
By default, all objects are private. Only the owner has full access
READ_ACP, and WRITE_ACP permissions on the object.
Specify access permissions explicitly to give the grantee READ,
@!attribute [rw] grant_full_control
@return [Time]
The date and time at which the object is no longer cacheable.
@!attribute [rw] expires
@return [String]
A standard MIME type describing the format of the object data.
@!attribute [rw] content_type
@return [String]
The language that the content is in.
@!attribute [rw] content_language
@return [String]
</note>
this header field.
<note markdown=“1”> For directory buckets, only the `aws-chunked` value is supported in
media-type referenced by the Content-Type header field.
thus what decoding mechanisms must be applied to obtain the
Specifies what content encodings have been applied to the object and
@!attribute [rw] content_encoding
@return [String]
Specifies presentational information for the object.
@!attribute [rw] content_disposition
@return [String]
Specifies caching behavior along the request/reply chain.
@!attribute [rw] cache_control
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [What is S3 on Outposts?] in the *Amazon S3 User Guide*.
the bucket name. For more information about S3 on Outposts ARNs, see
Services SDKs, you provide the Outposts access point ARN in place of
When you use this action with S3 on Outposts through the Amazon Web
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
The S3 on Outposts hostname takes the form `
Outposts, you must direct requests to the S3 on Outposts hostname.
**S3 on Outposts** - When you use this action with Amazon S3 on
</note>
directory buckets.
<note markdown=“1”> Access points and Object Lambda access points are not supported by
[Using access points] in the *Amazon S3 User Guide*.
bucket name. For more information about access point ARNs, see
Services SDKs, you provide the access point ARN in place of the
When using this action with an access point through the Amazon Web
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
The access point hostname takes the form
point ARN, you must direct requests to the access point hostname.
bucket name or specify the access point ARN. When using the access
you must provide the alias of the access point in place of the
**Access points** - When you use this action with an access point,
*Amazon S3 User Guide*.
naming restrictions, see [Directory bucket naming rules] in the
DOC-EXAMPLE-BUCKET–usw2-az2–x-s3`). For information about bucket
bucket_base_name–az-id–x-s3` (for example, `
the chosen Availability Zone. Bucket names must follow the format `
requests are not supported. Directory bucket names must be unique in
Bucket_name.s3express-az_id.region.amazonaws.com`. Path-style
bucket, you must use virtual-hosted-style requests in the format `
**Directory buckets** - When you use this operation with a directory
where the object is uploaded.
The name of the bucket where the multipart upload is initiated and
@!attribute [rw] bucket
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html [1]: docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL </note>
* This functionality is not supported for Amazon S3 on Outposts.
<note markdown=“1”> * This functionality is not supported for directory buckets.
header.
headers is to specify a canned ACL with the `x-amz-acl` request
[Using ACLs]. One way to grant the permissions using the request
control list (ACL) on the new object. For more information, see
defined by Amazon S3. These permissions are then added to the access
to individual Amazon Web Services accounts or to predefined groups
control. When uploading an object, you can grant access permissions
By default, all objects are private. Only the owner has full access
see [Canned ACL] in the *Amazon S3 User Guide*.
predefined set of grantees and permissions. For more information,
predefined ACLs, known as *canned ACLs*. Each canned ACL has a
The canned ACL to apply to the object. Amazon S3 supports a set of
@!attribute [rw] acl

class Aws::S3::Types::CreateMultipartUploadRequest

Namespace

Included Modules

Defined in