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

Inherits:

Struct

Object
Struct
Aws::S3::Types::CopyObjectRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

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
  website_redirect_location: "WebsiteRedirectLocation",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  ssekms_key_id: "SSEKMSKeyId",
  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",
}

Instance Attribute Summary collapse

#acl ⇒ String

The canned ACL to apply to the object.
#bucket ⇒ String
#cache_control ⇒ String

Specifies caching behavior along the request/reply chain.
#content_disposition ⇒ 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.
#content_language ⇒ String

The language the content is in.
#content_type ⇒ String

A standard MIME type describing the format of the object data.
#copy_source ⇒ String

The name of the source bucket and key name of the source object, separated by a slash (/).
#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_sse_customer_algorithm ⇒ String

Specifies the algorithm to use when decrypting the source object (e.g., 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.
#expires ⇒ 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.
#grant_read ⇒ String

Allows grantee to read the object data and its metadata.
#grant_read_acp ⇒ String

Allows grantee to read the object ACL.
#grant_write_acp ⇒ String

Allows grantee to write the ACL for the applicable object.
#key ⇒ String
#metadata ⇒ 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.
#request_payer ⇒ String

Confirms that the requester knows that she or he will be charged for the request.
#server_side_encryption ⇒ String

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
#sse_customer_algorithm ⇒ String

Specifies the algorithm to use to when encrypting the object (e.g., 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.
#ssekms_key_id ⇒ String

Specifies the AWS KMS key ID to use for object encryption.
#storage_class ⇒ String

The type of storage to use for the object.
#tagging ⇒ 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.
#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.

Instance Attribute Details

#acl ⇒ `String`

The canned ACL to apply to the object.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#bucket ⇒ `String`

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#cache_control ⇒ `String`

Specifies caching behavior along the request/reply chain.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#content_disposition ⇒ `String`

Specifies presentational information for the object.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

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

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#content_language ⇒ `String`

The language the content is in.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#content_type ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#copy_source ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 1140

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 1140

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 1140

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 1140

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#copy_source_sse_customer_algorithm ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 1140

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 the encryption key was transmitted without error.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#expires ⇒ `Time`

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

Returns:

(Time)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#grant_full_control ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#grant_read ⇒ `String`

Allows grantee to read the object data and its metadata.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#grant_read_acp ⇒ `String`

Allows grantee to read the object ACL.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#grant_write_acp ⇒ `String`

Allows grantee to write the ACL for the applicable object.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#key ⇒ `String`

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#metadata ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#metadata_directive ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#request_payer ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#server_side_encryption ⇒ `String`

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 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)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  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 the encryption key was transmitted without error.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#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. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#storage_class ⇒ `String`

The type of storage to use for the object. Defaults to ‘STANDARD’.

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

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

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

#tagging_directive ⇒ `String`

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

Returns:

(String)

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

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

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

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :copy_source,
  :copy_source_if_match,
  :copy_source_if_modified_since,
  :copy_source_if_none_match,
  :copy_source_if_unmodified_since,
  :expires,
  :grant_full_control,
  :grant_read,
  :grant_read_acp,
  :grant_write_acp,
  :key,
  :metadata,
  :metadata_directive,
  :tagging_directive,
  :server_side_encryption,
  :storage_class,
  :website_redirect_location,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#acl ⇒ String

#bucket ⇒ String

#cache_control ⇒ String

#content_disposition ⇒ String

#content_encoding ⇒ String

#content_language ⇒ String

#content_type ⇒ String

#copy_source ⇒ String

#copy_source_if_match ⇒ String

#copy_source_if_modified_since ⇒ Time

#copy_source_if_none_match ⇒ String

#copy_source_if_unmodified_since ⇒ Time

#copy_source_sse_customer_algorithm ⇒ String

#copy_source_sse_customer_key ⇒ String

#copy_source_sse_customer_key_md5 ⇒ String

#expires ⇒ Time

#grant_full_control ⇒ String

#grant_read ⇒ String

#grant_read_acp ⇒ String

#grant_write_acp ⇒ String

#key ⇒ String

#metadata ⇒ Hash<String,String>

#metadata_directive ⇒ String

#request_payer ⇒ String

#server_side_encryption ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#ssekms_key_id ⇒ String

#storage_class ⇒ String

#tagging ⇒ String

#tagging_directive ⇒ String

#website_redirect_location ⇒ String

#acl ⇒ `String`

#bucket ⇒ `String`

#cache_control ⇒ `String`

#content_disposition ⇒ `String`

#content_encoding ⇒ `String`

#content_language ⇒ `String`

#content_type ⇒ `String`

#copy_source ⇒ `String`

#copy_source_if_match ⇒ `String`

#copy_source_if_modified_since ⇒ `Time`

#copy_source_if_none_match ⇒ `String`

#copy_source_if_unmodified_since ⇒ `Time`

#copy_source_sse_customer_algorithm ⇒ `String`

#copy_source_sse_customer_key ⇒ `String`

#copy_source_sse_customer_key_md5 ⇒ `String`

#expires ⇒ `Time`

#grant_full_control ⇒ `String`

#grant_read ⇒ `String`

#grant_read_acp ⇒ `String`

#grant_write_acp ⇒ `String`

#key ⇒ `String`

#metadata ⇒ `Hash<String,String>`

#metadata_directive ⇒ `String`

#request_payer ⇒ `String`

#server_side_encryption ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#ssekms_key_id ⇒ `String`

#storage_class ⇒ `String`

#tagging ⇒ `String`

#tagging_directive ⇒ `String`

#website_redirect_location ⇒ `String`