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

    This operation is not supported for directory buckets.

    Returns the tag set associated with the general purpose bucket.

    if ABAC is not enabled for the bucket. When you enable ABAC for a general purpose bucket, you can no longer use this operation for that bucket and must use ListTagsForResource instead.

    To use this operation, you must have permission to perform the s3:GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

    GetBucketTagging has the following special error:

    • Error code: NoSuchTagSet

      • Description: There is no tag set associated with the bucket.

    The following operations are related to GetBucketTagging:

    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, GetBucketTaggingCommand } from "ibm-cos-sdk-v2"; // ES Modules import
    // const { S3Client, GetBucketTaggingCommand } = 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 = { // GetBucketTaggingRequest
    Bucket: "STRING_VALUE", // required
    ExpectedBucketOwner: "STRING_VALUE",
    };
    const command = new GetBucketTaggingCommand(input);
    const response = await client.send(command);
    // { // GetBucketTaggingOutput
    // TagSet: [ // TagSet // required
    // { // Tag
    // Key: "STRING_VALUE", // required
    // Value: "STRING_VALUE", // required
    // },
    // ],
    // };

    GetBucketTaggingCommandInput

    S3ServiceException

    Base exception class for all service exceptions from S3 service.

    // The following example returns tag set associated with a bucket
    const input = {
    Bucket: "examplebucket"
    };
    const command = new GetBucketTaggingCommand(input);
    const response = await client.send(command);
    /* response is
    {
    TagSet: [
    {
    Key: "key1",
    Value: "value1"
    },
    {
    Key: "key2",
    Value: "value2"
    }
    ]
    }
    */

    Hierarchy

    Index

    Constructors

    Constructors

    • Returns GetBucketTaggingCommand

    • Parameters

      Returns GetBucketTaggingCommand