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

Class: Aws::S3::Types::CopyObjectRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CopyObjectRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  acl: "private", # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
  bucket: "BucketName", # required
  cache_control: "CacheControl",
  content_disposition: "ContentDisposition",
  content_encoding: "ContentEncoding",
  content_language: "ContentLanguage",
  content_type: "ContentType",
  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,
  expires: Time.now,
  grant_full_control: "GrantFullControl",
  grant_read: "GrantRead",
  grant_read_acp: "GrantReadACP",
  grant_write_acp: "GrantWriteACP",
  key: "ObjectKey", # required
  metadata: {
    "MetadataKey" => "MetadataValue",
  },
  metadata_directive: "COPY", # accepts COPY, REPLACE
  tagging_directive: "COPY", # accepts COPY, REPLACE
  server_side_encryption: "AES256", # accepts AES256, aws:kms
  storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  ssekms_encryption_context: "SSEKMSEncryptionContext",
  copy_source_sse_customer_algorithm: "CopySourceSSECustomerAlgorithm",
  copy_source_sse_customer_key: "CopySourceSSECustomerKey",
  copy_source_sse_customer_key_md5: "CopySourceSSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  tagging: "TaggingHeader",
  object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE
  object_lock_retain_until_date: Time.now,
  object_lock_legal_hold_status: "ON", # accepts ON, OFF
  expected_bucket_owner: "AccountId",
  expected_source_bucket_owner: "AccountId",
  use_accelerate_endpoint: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Possible values:

  • private
  • public-read
  • public-read-write
  • authenticated-read
  • aws-exec-read
  • bucket-owner-read
  • bucket-owner-full-control

Returns:

  • (String) —

    The canned ACL to apply to the object.

#bucket ⇒ String

The name of the destination bucket.

When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String) —

    The name of the destination bucket.

#cache_control ⇒ String

Specifies caching behavior along the request/reply chain.

Returns:

  • (String) —

    Specifies caching behavior along the request/reply chain.

#content_disposition ⇒ String

Specifies presentational information for the object.

Returns:

  • (String) —

    Specifies presentational information for the object.

#content_encoding ⇒ String

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Returns:

  • (String) —

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

#content_language ⇒ String

The language the content is in.

Returns:

  • (String) —

    The language the content is in.

#content_type ⇒ String

A standard MIME type describing the format of the object data.

Returns:

  • (String) —

    A standard MIME type describing the format of the object data.

#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 the 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.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (Time) —

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

#copy_source_sse_customer_algorithm ⇒ String

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

Returns:

  • (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. The encryption key provided in this header must be one that was used when the source object was created.

Returns:

  • (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. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

  • (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. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (String) —

    The account id of the expected destination bucket owner.

#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 will fail with an HTTP 403 (Access Denied) error.

Returns:

  • (String) —

    The account id of the expected source bucket owner.

#expires ⇒ Time

The date and time at which the object is no longer cacheable.

Returns:

  • (Time) —

    The date and time at which the object is no longer cacheable.

#grant_full_control ⇒ String

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

#grant_read ⇒ String

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to read the object data and its metadata.

#grant_read_acp ⇒ String

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to read the object ACL.

#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String) —

    Allows grantee to write the ACL for the applicable object.

#key ⇒ String

The key of the destination object.

Returns:

  • (String) —

    The key of the destination object.

#metadata ⇒ Hash<String,String>

A map of metadata to store with the object in S3.

Returns:

  • (Hash<String,String>) —

    A map of metadata to store with the object in S3.

#metadata_directive ⇒ String

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Possible values:

  • COPY
  • REPLACE

Returns:

  • (String) —

    Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

#object_lock_legal_hold_status ⇒ String

Specifies whether you want to apply a Legal Hold to the copied object.

Possible values:

  • ON
  • OFF

Returns:

  • (String) —

    Specifies whether you want to apply a Legal Hold to the copied object.

#object_lock_mode ⇒ String

The Object Lock mode that you want to apply to the copied object.

Possible values:

  • GOVERNANCE
  • COMPLIANCE

Returns:

  • (String) —

    The Object Lock mode that you want to apply to the copied object.

#object_lock_retain_until_date ⇒ Time

The date and time when you want the copied object\'s Object Lock to expire.

Returns:

  • (Time) —

    The date and time when you want the copied object\'s Object Lock to expire.

#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 Requestor Pays Buckets in the Amazon S3 Developer Guide.

Possible values:

  • requester

Returns:

  • (String) —

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

#server_side_encryption ⇒ String

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Possible values:

  • AES256
  • aws:kms

Returns:

  • (String) —

    The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

#sse_customer_algorithm ⇒ String

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

Returns:

  • (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. 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.

Returns:

  • (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. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

  • (String) —

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

#ssekms_encryption_context ⇒ String

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Returns:

  • (String) —

    Specifies the AWS KMS Encryption Context to use for object encryption.

#ssekms_key_id ⇒ String

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.

Returns:

  • (String) —

    Specifies the AWS KMS key ID to use for object encryption.

#storage_class ⇒ String

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Returns:

  • (String) —

    By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.

#tagging ⇒ String

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Returns:

  • (String) —

    The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective.

#tagging_directive ⇒ String

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Possible values:

  • COPY
  • REPLACE

Returns:

  • (String) —

    Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

#use_accelerate_endpoint ⇒ Boolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

#website_redirect_location ⇒ String

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Returns:

  • (String) —

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL.