Class: Aws::S3::Types::UploadPartCopyRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::UploadPartCopyRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Note:

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

{
  bucket: "BucketName", # required
  copy_source: "CopySource", # required
  copy_source_if_match: "CopySourceIfMatch",
  copy_source_if_modified_since: Time.now,
  copy_source_if_none_match: "CopySourceIfNoneMatch",
  copy_source_if_unmodified_since: Time.now,
  copy_source_range: "CopySourceRange",
  key: "ObjectKey", # required
  part_number: 1, # required
  upload_id: "MultipartUploadId", # required
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
  copy_source_sse_customer_key: "CopySourceSSECustomerKey",
  copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
}

Instance Attribute Summary collapse

#bucket ⇒ String
#copy_source ⇒ String

The name of the source bucket and key name of the source object, separated by a slash (/).
#copy_source_if_match ⇒ String

Copies the object if its entity tag (ETag) matches the specified tag.
#copy_source_if_modified_since ⇒ Time

Copies the object if it has been modified since the specified time.
#copy_source_if_none_match ⇒ String

Copies the object if its entity tag (ETag) is different than the specified ETag.
#copy_source_if_unmodified_since ⇒ Time

Copies the object if it hasn’t been modified since the specified time.
#copy_source_range ⇒ String

The range of bytes to copy from the source object.
#copy_source_sse_customer_algorithm ⇒ String

Specifies the algorithm to use when decrypting the source object (e.g., AES256).
#copy_source_sse_customer_key ⇒ String

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
#copy_source_sse_customer_key_md5 ⇒ String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
#key ⇒ String
#part_number ⇒ Integer

Part number of part being copied.
#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 copied.

Instance Attribute Details

#bucket ⇒ `String`

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source ⇒ `String`

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_if_match ⇒ `String`

Copies the object if its entity tag (ETag) matches the specified tag.

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_if_modified_since ⇒ `Time`

Copies the object if it has been modified since the specified time.

Returns:

(Time)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_if_none_match ⇒ `String`

Copies the object if its entity tag (ETag) is different than the specified ETag.

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_if_unmodified_since ⇒ `Time`

Copies the object if it hasn’t been modified since the specified time.

Returns:

(Time)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_range ⇒ `String`

The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 GB.

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_sse_customer_algorithm ⇒ `String`

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

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_sse_customer_key ⇒ `String`

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#copy_source_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 8608

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#key ⇒ `String`

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#part_number ⇒ `Integer`

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

Returns:

(Integer)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_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 8608

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_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 8608

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_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 8608

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_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 8608

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

#upload_id ⇒ `String`

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

Returns:

(String)

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

class UploadPartCopyRequest < Struct.new(
  :bucket,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :copy_source_range,
  :key,
  :part_number,
  :upload_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer)
  include Aws::Structure
end

Class: Aws::S3::Types::UploadPartCopyRequest

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

#copy_source ⇒ String

#copy_source_if_match ⇒ String

#copy_source_if_modified_since ⇒ Time

#copy_source_if_none_match ⇒ String

#copy_source_if_unmodified_since ⇒ Time

#copy_source_range ⇒ String

#copy_source_sse_customer_algorithm ⇒ String

#copy_source_sse_customer_key ⇒ String

#copy_source_sse_customer_key_md5 ⇒ String

#key ⇒ String

#part_number ⇒ Integer

#request_payer ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#upload_id ⇒ String

#bucket ⇒ `String`

#copy_source ⇒ `String`

#copy_source_if_match ⇒ `String`

#copy_source_if_modified_since ⇒ `Time`

#copy_source_if_none_match ⇒ `String`

#copy_source_if_unmodified_since ⇒ `Time`

#copy_source_range ⇒ `String`

#copy_source_sse_customer_algorithm ⇒ `String`

#copy_source_sse_customer_key ⇒ `String`

#copy_source_sse_customer_key_md5 ⇒ `String`

#key ⇒ `String`

#part_number ⇒ `Integer`

#request_payer ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#upload_id ⇒ `String`