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

Inherits:
Struct
  • Object
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",
  checksum_algorithm: "CRC32", # accepts CRC32, CRC32C, SHA1, SHA256
  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, GLACIER_IR
  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",
}

Constant Summary collapse

SENSITIVE =
[:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]

Instance Attribute Summary collapse

Instance Attribute Details

#aclString

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#bucketString

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


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#bucket_key_enabledBoolean

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.

Returns:

  • (Boolean)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#cache_controlString

Specifies caching behavior along the request/reply chain.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#checksum_algorithmString

Indicates the algorithm you want Amazon S3 to use to create the checksum for the object. For more information, see [Checking object integrity] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#content_dispositionString

Specifies presentational information for the object.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#content_encodingString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#content_languageString

The language the content is in.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#content_typeString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_sourceString

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.

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


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_if_matchString

Copies the object if its entity tag (ETag) matches the specified tag.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_if_modified_sinceTime

Copies the object if it has been modified since the specified time.

Returns:

  • (Time)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_if_none_matchString

Copies the object if its entity tag (ETag) is different than the specified ETag.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_if_unmodified_sinceTime

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

Returns:

  • (Time)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_sse_customer_algorithmString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_sse_customer_keyString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#copy_source_sse_customer_key_md5String

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#expected_bucket_ownerString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#expected_source_bucket_ownerString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#expiresTime

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

Returns:

  • (Time)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#grant_full_controlString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#grant_readString

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#grant_read_acpString

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#grant_write_acpString

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#keyString

The key of the destination object.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#metadataHash<String,String>

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

Returns:

  • (Hash<String,String>)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#metadata_directiveString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

Specifies whether you want to apply a legal hold to the copied object.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#object_lock_modeString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#object_lock_retain_until_dateTime

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

Returns:

  • (Time)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#request_payerString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#server_side_encryptionString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#sse_customer_algorithmString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#sse_customer_keyString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#sse_customer_key_md5String

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#ssekms_encryption_contextString

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.

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#ssekms_key_idString

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]: docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#storage_classString

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#taggingString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#tagging_directiveString

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

Returns:

  • (String)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end

#website_redirect_locationString

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)


1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
# File 'lib/aws-sdk-s3/types.rb', line 1954

class CopyObjectRequest < Struct.new(
  :acl,
  :bucket,
  :cache_control,
  :checksum_algorithm,
  :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,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :copy_source_sse_customer_algorithm,
  :copy_source_sse_customer_key,
  :copy_source_sse_customer_key_md5,
  :request_payer,
  :tagging,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status,
  :expected_bucket_owner,
  :expected_source_bucket_owner)
  SENSITIVE = [:sse_customer_key, :ssekms_key_id, :ssekms_encryption_context, :copy_source_sse_customer_key]
  include Aws::Structure
end