class Aws::S3::Types::CopyObjectRequest
@note When making an API call, you may pass CopyObjectRequest
data as a 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", bucket_key_enabled: false, 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", }
@!attribute [rw] acl
The canned ACL to apply to the object. This action is not supported by Amazon S3 on Outposts. @return [String]
@!attribute [rw] bucket
The name of the destination bucket. 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 using 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 S3 on Outposts][2] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html @return [String]
@!attribute [rw] cache_control
Specifies caching behavior along the request/reply chain. @return [String]
@!attribute [rw] content_disposition
Specifies presentational information for the object. @return [String]
@!attribute [rw] content_encoding
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. @return [String]
@!attribute [rw] content_language
The language the content is in. @return [String]
@!attribute [rw] content_type
A standard MIME type describing the format of the object data. @return [String]
@!attribute [rw] copy_source
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][1]\: * 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. <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]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html @return [String]
@!attribute [rw] copy_source_if_match
Copies the object if its entity tag (ETag) matches the specified tag. @return [String]
@!attribute [rw] copy_source_if_modified_since
Copies the object if it has been modified since the specified time. @return [Time]
@!attribute [rw] copy_source_if_none_match
Copies the object if its entity tag (ETag) is different than the specified ETag. @return [String]
@!attribute [rw] copy_source_if_unmodified_since
Copies the object if it hasn't been modified since the specified time. @return [Time]
@!attribute [rw] expires
The date and time at which the object is no longer cacheable. @return [Time]
@!attribute [rw] grant_full_control
Gives the grantee READ, READ\_ACP, and WRITE\_ACP permissions on the object. This action is not supported by Amazon S3 on Outposts. @return [String]
@!attribute [rw] grant_read
Allows grantee to read the object data and its metadata. This action is not supported by Amazon S3 on Outposts. @return [String]
@!attribute [rw] grant_read_acp
Allows grantee to read the object ACL. This action is not supported by Amazon S3 on Outposts. @return [String]
@!attribute [rw] grant_write_acp
Allows grantee to write the ACL for the applicable object. This action is not supported by Amazon S3 on Outposts. @return [String]
@!attribute [rw] key
The key of the destination object. @return [String]
@!attribute [rw] metadata
A map of metadata to store with the object in S3. @return [Hash<String,String>]
@!attribute [rw] metadata_directive
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. @return [String]
@!attribute [rw] tagging_directive
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request. @return [String]
@!attribute [rw] server_side_encryption
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms). @return [String]
@!attribute [rw] storage_class
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][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html @return [String]
@!attribute [rw] website_redirect_location
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. @return [String]
@!attribute [rw] sse_customer_algorithm
Specifies the algorithm to use to when encrypting the object (for example, AES256). @return [String]
@!attribute [rw] sse_customer_key
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. @return [String]
@!attribute [rw] sse_customer_key_md5
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. @return [String]
@!attribute [rw] ssekms_key_id
Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see [Specifying the Signature Version in Request Authentication][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version @return [String]
@!attribute [rw] ssekms_encryption_context
Specifies the Amazon Web Services 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. @return [String]
@!attribute [rw] bucket_key_enabled
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to `true` causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key. @return [Boolean]
@!attribute [rw] copy_source_sse_customer_algorithm
Specifies the algorithm to use when decrypting the source object (for example, AES256). @return [String]
@!attribute [rw] copy_source_sse_customer_key
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. @return [String]
@!attribute [rw] copy_source_sse_customer_key_md5
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. @return [String]
@!attribute [rw] request_payer
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][1] in the *Amazon S3 User Guide*. [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html @return [String]
@!attribute [rw] tagging
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. @return [String]
@!attribute [rw] object_lock_mode
The Object Lock mode that you want to apply to the copied object. @return [String]
@!attribute [rw] object_lock_retain_until_date
The date and time when you want the copied object's Object Lock to expire. @return [Time]
@!attribute [rw] object_lock_legal_hold_status
Specifies whether you want to apply a Legal Hold to the copied object. @return [String]
@!attribute [rw] expected_bucket_owner
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. @return [String]
@!attribute [rw] expected_source_bucket_owner
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectRequest AWS API Documentation
Constants
- SENSITIVE