You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Instance Attribute Details

#bucketString

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_sourceString

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_matchString

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_sinceTime

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

Returns:

  • (Time)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_matchString

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_sinceTime

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

Returns:

  • (Time)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_rangeString

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)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_algorithmString

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_keyString

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)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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

#keyString

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_numberInteger

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

Returns:

  • (Integer)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_payerString

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 http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_algorithmString

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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_idString

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

Returns:

  • (String)


7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 7455

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