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

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::UploadPartRequest

Includes:

Aws::Structure

Defined in:

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #body ⇒ IO

  Object data.

• #bucket ⇒ String

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

• #content_length ⇒ Integer

  Size of the body in bytes.

• #content_md5 ⇒ String

  The base64-encoded 128-bit MD5 digest of the part data.

• #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 she or he will be charged for the request.

• #sse_customer_algorithm ⇒ String

  Specifies the algorithm to use to when encrypting the object (e.g., 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.

Returns:

• (IO)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#bucket ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  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.

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#content_md5 ⇒ String

The base64-encoded 128-bit MD5 digest of the part data.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#key ⇒ String

Object key for which the multipart upload was initiated.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#part_number ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#sse_customer_algorithm ⇒ String

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  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 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)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  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 the encryption key was transmitted without error.

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end

#upload_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3/types.rb', line 10035

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)
  include Aws::Structure
end