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

    Interface RenameObjectRequest

    interface RenameObjectRequest {
        Bucket: string | undefined;
        Key: string | undefined;
        RenameSource: string | undefined;
        DestinationIfMatch?: string;
        DestinationIfNoneMatch?: string;
        DestinationIfModifiedSince?: Date;
        DestinationIfUnmodifiedSince?: Date;
        SourceIfMatch?: string;
        SourceIfNoneMatch?: string;
        SourceIfModifiedSince?: Date;
        SourceIfUnmodifiedSince?: Date;
        ClientToken?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Bucket Key RenameSource DestinationIfMatch? DestinationIfNoneMatch? DestinationIfModifiedSince? DestinationIfUnmodifiedSince? SourceIfMatch? SourceIfNoneMatch? SourceIfModifiedSince? SourceIfUnmodifiedSince? ClientToken?

    Properties

    Bucket: string | undefined

    The bucket name of the directory bucket containing the object.

    You must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

    Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@ibm-cos/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

    Key: string | undefined

    Key name of the object to rename.

    RenameSource: string | undefined

    Specifies the source for the rename operation. The value must be URL encoded.

    DestinationIfMatch?: string

    Renames the object only if the ETag (entity tag) value provided during the operation matches the ETag of the object in S3. The If-Match header field makes the request method conditional on ETags. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

    Expects the ETag value as a string.

    DestinationIfNoneMatch?: string

    Renames the object only if the destination does not already exist in the specified directory bucket. If the object does exist when you send a request with If-None-Match:*, the S3 API will return a 412 Precondition Failed error, preventing an overwrite. The If-None-Match header prevents overwrites of existing data by validating that there's not an object with the same key name already in your directory bucket.

    Expects the * character (asterisk).

    DestinationIfModifiedSince?: Date

    Renames the object if the destination exists and if it has been modified since the specified time.

    DestinationIfUnmodifiedSince?: Date

    Renames the object if it hasn't been modified since the specified time.

    SourceIfMatch?: string

    Renames the object if the source exists and if its entity tag (ETag) matches the specified ETag.

    SourceIfNoneMatch?: string

    Renames the object if the source exists and if its entity tag (ETag) is different than the specified ETag. If an asterisk (*) character is provided, the operation will fail and return a 412 Precondition Failed error.

    SourceIfModifiedSince?: Date

    Renames the object if the source exists and if it has been modified since the specified time.

    SourceIfUnmodifiedSince?: Date

    Renames the object if the source exists and hasn't been modified since the specified time.

    ClientToken?: string

    A unique string with a max of 64 ASCII characters in the ASCII range of 33 - 126.

    RenameObject supports idempotency using a client token. To make an idempotent API request using RenameObject, specify a client token in the request. You should not reuse the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails and an IdempotentParameterMismatch error is returned.

    Settings

    Member Visibility

    On This Page

    Properties