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",
  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
}

Constant Summary collapse

SENSITIVE =
[:sse_customer_key]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyIO

Object data.

Returns:

  • (IO)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#bucketString

Name of the bucket to which the multipart upload was initiated.

Returns:

  • (String)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#keyString

Object key for which the multipart upload was initiated.

Returns:

  • (String)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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 Requestor Pays Buckets in the Amazon S3 Developer Guide.

Returns:

  • (String)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  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)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#upload_idString

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

Returns:

  • (String)


13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 13016

class UploadPartRequest < Struct.new(
  :body,
  :bucket,
  :content_length,
  :content_md5,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end