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

    Class GetBucketVersioningCommand

    This operation is not supported for directory buckets.

    Returns the versioning state of a bucket.

    To retrieve the versioning state of a bucket, you must be the bucket owner.

    This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled, the bucket owner must use an authentication device to change the versioning state of the bucket.

    The following operations are related to GetBucketVersioning:

    You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

    Use a bare-bones client and the command you need to make an API call.

    import { S3Client, GetBucketVersioningCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketVersioningCommand } = require("ibm-cos-sdk-v2"); // CommonJS import
    // import type { S3ClientConfig } from "ibm-cos-sdk-v2";
    const config = {}; // type is S3ClientConfig
    const client = new S3Client(config);
    const input = { // GetBucketVersioningRequest
    Bucket: "STRING_VALUE", // required
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetBucketVersioningCommand(input);
    const response = await client.send(command);
    // { // GetBucketVersioningOutput
    // Status: "Enabled" || "Suspended",
    // MFADelete: "Enabled" || "Disabled",
    // };

    GetBucketVersioningCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    // The following example retrieves bucket versioning configuration.
    const input = {
    Bucket: "examplebucket"
    };
    const command = new GetBucketVersioningCommand(input);
    const response = await client.send(command);
    /* response is
    {
    MFADelete: "Disabled",
    Status: "Enabled"
    }
    */

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetBucketVersioningCommand

    • Parameters

      Returns GetBucketVersioningCommand