Class: Aws::S3::Types::CompleteMultipartUploadRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::CompleteMultipartUploadRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:sse_customer_key]
Instance Attribute Summary collapse
-
#bucket ⇒ String
Name of the bucket to which the multipart upload was initiated.
-
#checksum_crc32 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#checksum_crc32c ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#checksum_sha1 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#checksum_sha256 ⇒ String
This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#if_none_match ⇒ String
Uploads the object only if the object key name does not already exist in the bucket specified.
-
#key ⇒ String
Object key for which the multipart upload was initiated.
-
#multipart_upload ⇒ Types::CompletedMultipartUpload
The container for the multipart upload request information.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#sse_customer_algorithm ⇒ String
The server-side encryption (SSE) algorithm used to encrypt the object.
-
#sse_customer_key ⇒ String
The server-side encryption (SSE) customer managed key.
-
#sse_customer_key_md5 ⇒ String
The MD5 server-side encryption (SSE) customer managed key.
-
#upload_id ⇒ String
ID for the initiated multipart upload.
Instance Attribute Details
#bucket ⇒ String
Name of the bucket to which the multipart upload 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 format ` bucket_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 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][2
-
in the *Amazon S3 User Guide*.
<note markdown=“1”> Access points and Object Lambda access points are not supported by directory buckets.
</note>
**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 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?][3
-
in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [3]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#checksum_crc32 ⇒ String
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 CRC32 checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#checksum_crc32c ⇒ String
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 CRC32C checksum of the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#checksum_sha1 ⇒ String
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*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#checksum_sha256 ⇒ String
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*.
[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#expected_bucket_owner ⇒ String
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).
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#if_none_match ⇒ String
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 re-initiate the multipart upload with `CreateMultipartUpload` and re-upload each part.
Expects the ‘*’ (asterisk) character.
For more information about conditional requests, see [RFC 7232], or [Conditional requests] in the *Amazon S3 User Guide*.
[1]: tools.ietf.org/html/rfc7232 [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/conditional-requests.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#key ⇒ String
Object key for which the multipart upload was initiated.
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#multipart_upload ⇒ Types::CompletedMultipartUpload
The container for the multipart upload request information.
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#request_payer ⇒ String
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 markdown=“1”> This functionality is not supported for directory buckets.
</note>
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_algorithm ⇒ String
The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.
<note markdown=“1”> This functionality is not supported for directory buckets.
</note>
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_key ⇒ String
The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.
<note markdown=“1”> This functionality is not supported for directory buckets.
</note>
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_key_md5 ⇒ String
The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see [Protecting data using SSE-C keys] in the *Amazon S3 User Guide*.
<note markdown=“1”> This functionality is not supported for directory buckets.
</note>
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#upload_id ⇒ String
ID for the initiated multipart upload.
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 |
# File 'lib/aws-sdk-s3/types.rb', line 1133 class CompleteMultipartUploadRequest < Struct.new( :bucket, :key, :multipart_upload, :upload_id, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :request_payer, :expected_bucket_owner, :if_none_match, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5) SENSITIVE = [:sse_customer_key] include Aws::Structure end |