Class: Aws::S3::Types::UploadPartRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass UploadPartRequest data as a hash:

{
  body: source_file,
  bucket: "BucketName", # required
  content_length: 1,
  content_md5: "ContentMD5",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  checksum_crc32: "ChecksumCRC32",
  checksum_crc32c: "ChecksumCRC32C",
  checksum_sha1: "ChecksumSHA1",
  checksum_sha256: "ChecksumSHA256",
  key: "ObjectKey", # required
  part_number: 1, # required
  upload_id: "MultipartUploadId", # required
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =
[:sse_customer_key]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyIO

Object data.

Returns:

  • (IO)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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

#bucketString

The name of the bucket to which the multipart upload was initiated.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_algorithmString

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending 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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_crc32String

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_crc32cString

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_sha1String

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_sha256String

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_lengthInteger

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

Returns:

  • (Integer)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_md5String

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_ownerString

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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

#keyString

Object key for which the multipart upload was initiated.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_numberInteger

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

Returns:

  • (Integer)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_payerString

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_algorithmString

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_keyString

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_md5String

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.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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_idString

Upload ID identifying the multipart upload whose part is being uploaded.

Returns:

  • (String)


17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 17106

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