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

Inherits:

Struct

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

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
  expected_bucket_owner: "AccountId",
  expected_source_bucket_owner: "AccountId",
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:sse_customer_key, :copy_source_sse_customer_key]

Instance Attribute Summary

• #bucket ⇒ String

  The bucket name.

• #copy_source ⇒ String

  Specifies the source object for the copy operation.

• #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 (for example, 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.

• #expected_bucket_owner ⇒ String

  The account ID of the expected destination bucket owner.

• #expected_source_bucket_owner ⇒ String

  The account ID of the expected source bucket owner.

• #key ⇒ String

  Object key for which the multipart upload was initiated.

• #part_number ⇒ Integer

  Part number of part being copied.

• #request_payer ⇒ String

  Confirms that the requester knows that they will be charged for the request.

• #sse_customer_algorithm ⇒ String

  Specifies the algorithm to use to when encrypting the object (for example, 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

The bucket name.

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][1

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][2

in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source ⇒ String

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an [access point]:

• For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object ‘reports/january.pdf` from the bucket `awsexamplebucket`, use `awsexamplebucket/reports/january.pdf`. The value must be URL-encoded.

• For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format ‘arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>`. For example, to copy the object `reports/january.pdf` through access point `my-access-point` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf`. The value must be URL encoded.

  <note markdown=“1”> Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

  </note>
  

  Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format ‘arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>`. For example, to copy the object `reports/january.pdf` through outpost `my-outpost` owned by account `123456789012` in Region `us-west-2`, use the URL encoding of `arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf`. The value must be URL-encoded.

To copy a specific version of an object, append ‘?versionId=<version-id>` to the value (for example, `awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893`). If you don’t specify a version ID, Amazon S3 copies the latest version of the source object.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_sse_customer_algorithm ⇒ String

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

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 that the encryption key was transmitted without error.

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end

#expected_bucket_owner ⇒ String

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

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end

#expected_source_bucket_owner ⇒ String

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

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end

#request_payer ⇒ String

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ String

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

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 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)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 that the encryption key was transmitted without error.

Returns:

• (String)

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

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  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 16786

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,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :copy_source_sse_customer_key]
  include Aws::Structure
end