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

    Class GetBucketProtectionConfigurationCommand

    Gets the protection configuration for a bucket.

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

    import { S3Client, GetBucketProtectionConfigurationCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketProtectionConfigurationCommand } = 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 = { // GetBucketProtectionConfigurationInput
    Bucket: "STRING_VALUE", // required
    };
    const command = new GetBucketProtectionConfigurationCommand(input);
    const response = await client.send(command);
    // { // GetBucketProtectionConfigurationOutput
    // Status: "STRING_VALUE",
    // MinimumRetention: { // MinimumRetentionPeriod
    // Days: Number("int"), // required
    // },
    // DefaultRetention: { // DefaultRetentionPeriod
    // Days: Number("int"), // required
    // },
    // MaximumRetention: { // MaximumRetentionPeriod
    // Days: Number("int"), // required
    // },
    // EnablePermanentRetention: true || false,
    // IbmProtectionManagementState: "STRING_VALUE",
    // };

    GetBucketProtectionConfigurationCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetBucketProtectionConfigurationCommand

    • Parameters

      Returns GetBucketProtectionConfigurationCommand