Skip to content

CopyObjectOutput

Source code in docs_src/capo_s3/types/copy_object_output.py
class CopyObjectOutput(TypedDict, closed=True):
    copy_object_result: NotRequired["capo_s3.types.copy_object_result.CopyObjectResult"]
    """<p>Container for all response elements.</p>"""
    expiration: NotRequired["capo_s3.types.expiration.Expiration"]
    """<p>If the object expiration is configured, the response includes this header.</p> <note> <p>Object expiration information is not returned in directory buckets and this header returns the value "<code>NotImplemented</code>" in all responses for directory buckets.</p> </note>"""
    copy_source_version_id: NotRequired[
        "capo_s3.types.copy_source_version_id.CopySourceVersionId"
    ]
    """<p>Version ID of the source object that was copied.</p> <note> <p>This functionality is not supported when the source object is in a directory bucket.</p> </note>"""
    version_id: NotRequired["capo_s3.types.object_version_id.ObjectVersionId"]
    """<p>Version ID of the newly created copy.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    server_side_encryption: NotRequired[
        "capo_s3.types.server_side_encryption.ServerSideEncryption"
    ]
    """<p>The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.</p> <note> <p>When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is <code>aws:fsx</code>.</p> </note>"""
    sse_customer_algorithm: NotRequired[
        "capo_s3.types.sse_customer_algorithm.SSECustomerAlgorithm"
    ]
    """<p>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.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    sse_customer_key_md5: NotRequired[
        "capo_s3.types.sse_customer_key_md5.SSECustomerKeyMD5"
    ]
    """<p>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.</p> <note> <p>This functionality is not supported for directory buckets.</p> </note>"""
    ssekms_key_id: NotRequired["capo_s3.types.ssekms_key_id.SSEKMSKeyId"]
    """<p>If present, indicates the ID of the KMS key that was used for object encryption.</p>"""
    ssekms_encryption_context: NotRequired[
        "capo_s3.types.ssekms_encryption_context.SSEKMSEncryptionContext"
    ]
    """<p>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.</p>"""
    bucket_key_enabled: NotRequired["capo_s3.types.bucket_key_enabled.BucketKeyEnabled"]
    """<p>Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).</p>"""
    request_charged: NotRequired["capo_s3.types.request_charged.RequestCharged"]

bucket_key_enabled instance-attribute

bucket_key_enabled: NotRequired[BucketKeyEnabled]

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 instance-attribute

copy_object_result: NotRequired[CopyObjectResult]

Container for all response elements.

copy_source_version_id instance-attribute

copy_source_version_id: NotRequired[CopySourceVersionId]

Version ID of the source object that was copied.

This functionality is not supported when the source object is in a directory bucket.

expiration instance-attribute

expiration: NotRequired[Expiration]

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

Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.

request_charged instance-attribute

request_charged: NotRequired[RequestCharged]

server_side_encryption instance-attribute

server_side_encryption: NotRequired[ServerSideEncryption]

The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.

When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

sse_customer_algorithm instance-attribute

sse_customer_algorithm: NotRequired[SSECustomerAlgorithm]

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.

This functionality is not supported for directory buckets.

sse_customer_key_md5 instance-attribute

sse_customer_key_md5: NotRequired[SSECustomerKeyMD5]

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.

This functionality is not supported for directory buckets.

ssekms_encryption_context instance-attribute

ssekms_encryption_context: NotRequired[SSEKMSEncryptionContext]

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.

ssekms_key_id instance-attribute

ssekms_key_id: NotRequired[SSEKMSKeyId]

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

version_id instance-attribute

version_id: NotRequired[ObjectVersionId]

Version ID of the newly created copy.

This functionality is not supported for directory buckets.