class Aws::S3::Types::CopyObjectRequest

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/CopyObjectRequest AWS API Documentation
@return [String]
object.
Specifies whether you want to apply a Legal Hold to the copied
@!attribute [rw] object_lock_legal_hold_status
@return [Time]
expire.
The date and time when you want the copied object’s object lock to
@!attribute [rw] object_lock_retain_until_date
@return [String]
The object lock mode that you want to apply to the copied object.
@!attribute [rw] object_lock_mode
@return [String]
encoded as URL Query parameters
used in conjunction with the TaggingDirective. The tag-set must be
The tag-set for the object destination object this value must be
@!attribute [rw] tagging
@return [String]
buckets can be found at
requests. Documentation on downloading objects from requester pays
the request. Bucket owners need not specify this parameter in their
Confirms that the requester knows that she or he will be charged for
@!attribute [rw] request_payer
@return [String]
to ensure the encryption key was transmitted without error.
RFC 1321. Amazon S3 uses this header for a message integrity check
Specifies the 128-bit MD5 digest of the encryption key according to
@!attribute [rw] copy_source_sse_customer_key_md5
@return [String]
header must be one that was used when the source object was created.
to decrypt the source object. The encryption key provided in this
Specifies the customer-provided encryption key for Amazon S3 to use
@!attribute [rw] copy_source_sse_customer_key
@return [String]
(e.g., AES256).
Specifies the algorithm to use when decrypting the source object
@!attribute [rw] copy_source_sse_customer_algorithm
@return [String]
string holding JSON with the encryption context key-value pairs.
encryption. The value of this header is a base64-encoded UTF-8
Specifies the AWS KMS Encryption Context to use for object
@!attribute [rw] ssekms_encryption_context
@return [String]
officially supported AWS SDKs and CLI can be found at
made via SSL or using SigV4. Documentation on configuring any of the
and PUT requests for an object protected by AWS KMS will fail if not
Specifies the AWS KMS key ID to use for object encryption. All GET
@!attribute [rw] ssekms_key_id
@return [String]
to ensure the encryption key was transmitted without error.
RFC 1321. Amazon S3 uses this header for a message integrity check
Specifies the 128-bit MD5 digest of the encryption key according to
@!attribute [rw] sse_customer_key_md5
@return [String]
x-amz-server-side​-encryption​-customer-algorithm header.
must be appropriate for use with the algorithm specified in the
it is discarded; Amazon does not store the encryption key. The key
in encrypting data. This value is used to store the object and then
Specifies the customer-provided encryption key for Amazon S3 to use
@!attribute [rw] sse_customer_key
@return [String]
AES256).
Specifies the algorithm to use to when encrypting the object (e.g.,
@!attribute [rw] sse_customer_algorithm
@return [String]
metadata.
URL. Amazon S3 stores the value of this header in the object
this object to another object in the same bucket or to an external
If the bucket is configured as a website, redirects requests for
@!attribute [rw] website_redirect_location
@return [String]
The type of storage to use for the object. Defaults to ‘STANDARD’.
@!attribute [rw] storage_class
@return [String]
in S3 (e.g., AES256, aws:kms).
The Server-side encryption algorithm used when storing this object
@!attribute [rw] server_side_encryption
@return [String]
object or replaced with tag-set provided in the request.
Specifies whether the object tag-set are copied from the source
@!attribute [rw] tagging_directive
@return [String]
replaced with metadata provided in the request.
Specifies whether the metadata is copied from the source object or
@!attribute [rw] metadata_directive
@return [Hash<String,String>]
A map of metadata to store with the object in S3.
@!attribute [rw] metadata
@return [String]
@!attribute [rw] key
@return [String]
Allows grantee to write the ACL for the applicable object.
@!attribute [rw] grant_write_acp
@return [String]
Allows grantee to read the object ACL.
@!attribute [rw] grant_read_acp
@return [String]
Allows grantee to read the object data and its metadata.
@!attribute [rw] grant_read
@return [String]
object.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
@!attribute [rw] grant_full_control
@return [Time]
The date and time at which the object is no longer cacheable.
@!attribute [rw] expires
@return [Time]
time.
Copies the object if it hasn’t been modified since the specified
@!attribute [rw] copy_source_if_unmodified_since
@return [String]
specified ETag.
Copies the object if its entity tag (ETag) is different than the
@!attribute [rw] copy_source_if_none_match
@return [Time]
Copies the object if it has been modified since the specified time.
@!attribute [rw] copy_source_if_modified_since
@return [String]
tag.
Copies the object if its entity tag (ETag) matches the specified
@!attribute [rw] copy_source_if_match
@return [String]
separated by a slash (/). Must be URL-encoded.
The name of the source bucket and key name of the source object,
@!attribute [rw] copy_source
@return [String]
A standard MIME type describing the format of the object data.
@!attribute [rw] content_type
@return [String]
The language the content is in.
@!attribute [rw] content_language
@return [String]
media-type referenced by the Content-Type header field.
thus what decoding mechanisms must be applied to obtain the
Specifies what content encodings have been applied to the object and
@!attribute [rw] content_encoding
@return [String]
Specifies presentational information for the object.
@!attribute [rw] content_disposition
@return [String]
Specifies caching behavior along the request/reply chain.
@!attribute [rw] cache_control
@return [String]
@!attribute [rw] bucket
@return [String]
The canned ACL to apply to the object.
@!attribute [rw] acl
}
object_lock_legal_hold_status: “ON”, # accepts ON, OFF
object_lock_retain_until_date: Time.now,
object_lock_mode: “GOVERNANCE”, # accepts GOVERNANCE, COMPLIANCE
tagging: “TaggingHeader”,
request_payer: “requester”, # accepts requester
copy_source_sse_customer_key_md5: “CopySourceSSECustomerKeyMD5”,
copy_source_sse_customer_key: “CopySourceSSECustomerKey”,
copy_source_sse_customer_algorithm: “CopySourceSSECustomerAlgorithm”,
ssekms_encryption_context: “SSEKMSEncryptionContext”,
ssekms_key_id: “SSEKMSKeyId”,
sse_customer_key_md5: “SSECustomerKeyMD5”,
sse_customer_key: “SSECustomerKey”,
sse_customer_algorithm: “SSECustomerAlgorithm”,
website_redirect_location: “WebsiteRedirectLocation”,
storage_class: “STANDARD”, # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
server_side_encryption: “AES256”, # accepts AES256, aws:kms
tagging_directive: “COPY”, # accepts COPY, REPLACE
metadata_directive: “COPY”, # accepts COPY, REPLACE
},
“MetadataKey” => “MetadataValue”,
metadata: {
key: “ObjectKey”, # required
grant_write_acp: “GrantWriteACP”,
grant_read_acp: “GrantReadACP”,
grant_read: “GrantRead”,
grant_full_control: “GrantFullControl”,
expires: Time.now,
copy_source_if_unmodified_since: Time.now,
copy_source_if_none_match: “CopySourceIfNoneMatch”,
copy_source_if_modified_since: Time.now,
copy_source_if_match: “CopySourceIfMatch”,
copy_source: “CopySource”, # required
content_type: “ContentType”,
content_language: “ContentLanguage”,
content_encoding: “ContentEncoding”,
content_disposition: “ContentDisposition”,
cache_control: “CacheControl”,
bucket: “BucketName”, # required
acl: “private”, # accepts private, public-read, public-read-write, authenticated-read, aws-exec-read, bucket-owner-read, bucket-owner-full-control
{
data as a hash:
@note When making an API call, you may pass CopyObjectRequest