Class: Aws::S3::Types::CopyObjectOutput

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::CopyObjectOutput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:ssekms_key_id, :ssekms_encryption_context]

Instance Attribute Summary

• #bucket_key_enabled ⇒ Boolean

  Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

• #copy_object_result ⇒ Types::CopyObjectResult

  Container for all response elements.

• #copy_source_version_id ⇒ String

  Version ID of the source object that was copied.

• #expiration ⇒ String

  If the object expiration is configured, the response includes this header.

• #request_charged ⇒ String

  If present, indicates that the requester was successfully charged for the request.

• #server_side_encryption ⇒ String

  The server-side encryption algorithm used when you store this object in Amazon S3 (for example, ‘AES256`, `aws:kms`, `aws:kms:dsse`).

• #sse_customer_algorithm ⇒ String

  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that’s used.

• #sse_customer_key_md5 ⇒ String

  If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

• #ssekms_encryption_context ⇒ String

  If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.

• #ssekms_key_id ⇒ String

  If present, indicates the ID of the KMS key that was used for object encryption.

• #version_id ⇒ String

  Version ID of the newly created copy.

Instance Attribute Details

#bucket_key_enabled ⇒ Boolean

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

Returns:

• (Boolean)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#copy_object_result ⇒ Types::CopyObjectResult

Container for all response elements.

Returns:

• (Types::CopyObjectResult)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#copy_source_version_id ⇒ String

Version ID of the source object that was copied.

<note markdown=“1”> This functionality is not supported when the source object is in a directory bucket.

</note>

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#expiration ⇒ String

If the object expiration is configured, the response includes this header.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#request_charged ⇒ String

If present, indicates that the requester was successfully charged for the request.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#server_side_encryption ⇒ String

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, ‘AES256`, `aws:kms`, `aws:kms:dsse`).

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ String

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that’s used.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ String

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_encryption_context ⇒ String

If present, indicates 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)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#ssekms_key_id ⇒ String

If present, indicates the ID of the KMS key that was used for object encryption.

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end

#version_id ⇒ String

Version ID of the newly created copy.

<note markdown=“1”> This functionality is not supported for directory buckets.

</note>

Returns:

• (String)

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

class CopyObjectOutput < Struct.new(
  :copy_object_result,
  :expiration,
  :copy_source_version_id,
  :version_id,
  :server_side_encryption,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :ssekms_encryption_context,
  :bucket_key_enabled,
  :request_charged)
  SENSITIVE = [:ssekms_key_id, :ssekms_encryption_context]
  include Aws::Structure
end