Class: Aws::S3::Types::UploadPartRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::UploadPartRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:sse_customer_key]
Instance Attribute Summary collapse
-
#body ⇒ IO
Object data.
-
#bucket ⇒ String
The name of the bucket to which the multipart upload was initiated.
-
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object when you use the SDK.
-
#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.
-
#content_length ⇒ Integer
Size of the body in bytes.
-
#content_md5 ⇒ String
The base64-encoded 128-bit MD5 digest of the part data.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#key ⇒ String
Object key for which the multipart upload was initiated.
-
#part_number ⇒ Integer
Part number of part being uploaded.
-
#request_payer ⇒ String
Confirms that the requester knows that they will be charged for the request.
-
#sse_customer_algorithm ⇒ String
Specifies the algorithm to use when encrypting the object (for example, AES256).
-
#sse_customer_key ⇒ String
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
-
#sse_customer_key_md5 ⇒ String
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
-
#upload_id ⇒ String
Upload ID identifying the multipart upload whose part is being uploaded.
Instance Attribute Details
#body ⇒ IO
Object data.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#bucket ⇒ String
The 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 in the Amazon S3 User Guide.
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? in the Amazon S3 User Guide.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#checksum_algorithm ⇒ String
Indicates the algorithm used to create the checksum for the object
when you use the SDK. This header will not provide any additional
functionality if you don't use the SDK. When you send this header,
there must be a corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails the request with the HTTP
status code 400 Bad Request
. For more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any
provided ChecksumAlgorithm
parameter.
This checksum algorithm must be the same for all parts and it match
the checksum value supplied in the CreateMultipartUpload
request.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) 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.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) 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.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) 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.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) 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.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#content_length ⇒ Integer
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#content_md5 ⇒ String
The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) 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).
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#key ⇒ String
Object key for which the multipart upload was initiated.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#part_number ⇒ Integer
Part number of part being uploaded. This is a positive integer between 1 and 10,000.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) 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.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_algorithm ⇒ String
Specifies the algorithm to use when encrypting the object (for example, AES256).
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_key ⇒ String
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 must
be the same encryption key specified in the initiate multipart
upload request.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_key_md5 ⇒ String
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#upload_id ⇒ String
Upload ID identifying the multipart upload whose part is being uploaded.
17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17028 class UploadPartRequest < Struct.new( :body, :bucket, :content_length, :content_md5, :checksum_algorithm, :checksum_crc32, :checksum_crc32c, :checksum_sha1, :checksum_sha256, :key, :part_number, :upload_id, :sse_customer_algorithm, :sse_customer_key, :sse_customer_key_md5, :request_payer, :expected_bucket_owner) SENSITIVE = [:sse_customer_key] include Aws::Structure end |