IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface CopyObjectOutput

    interface CopyObjectOutput {
        CopyObjectResult?: CopyObjectResult;
        Expiration?: string;
        CopySourceVersionId?: string;
        VersionId?: string;
        ServerSideEncryption?: ServerSideEncryption;
        SSECustomerAlgorithm?: string;
        SSECustomerKeyMD5?: string;
        SSEKMSKeyId?: string;
        SSEKMSEncryptionContext?: string;
        BucketKeyEnabled?: boolean;
        RequestCharged?: "requester";
    }

    Hierarchy (View Summary)

    Index

    Properties

    CopyObjectResult? Expiration? CopySourceVersionId? VersionId? ServerSideEncryption? SSECustomerAlgorithm? SSECustomerKeyMD5? SSEKMSKeyId? SSEKMSEncryptionContext? BucketKeyEnabled? RequestCharged?

    Properties

    CopyObjectResult?: CopyObjectResult

    Container for all response elements.

    Expiration?: string

    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.

    CopySourceVersionId?: string

    Version ID of the source object that was copied.

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

    VersionId?: string

    Version ID of the newly created copy.

    This functionality is not supported for directory buckets.

    ServerSideEncryption?: 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.

    SSECustomerAlgorithm?: 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.

    This functionality is not supported for directory buckets.

    SSECustomerKeyMD5?: 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.

    This functionality is not supported for directory buckets.

    SSEKMSKeyId?: string

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

    SSEKMSEncryptionContext?: 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.

    BucketKeyEnabled?: boolean

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

    RequestCharged?: "requester"

    If present, indicates that the requester was successfully charged for the request. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

    This functionality is not supported for directory buckets.

    Settings

    Member Visibility

    On This Page

    Properties