Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . s3api ]

get-bucket-tagging

Description

Returns the tag set associated with the bucket.

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: NoSuchTagSetError
  • Description: There is no tag set associated with the bucket.

The following operations are related to GetBucketTagging :

• PutBucketTagging
• DeleteBucketTagging

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-bucket-tagging
--bucket <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--bucket (string)

The name of the bucket for which to get the tagging information.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

The following command retrieves the tagging configuration for a bucket named my-bucket:

aws s3api get-bucket-tagging --bucket my-bucket

Output:

{
    "TagSet": [
        {
            "Value": "marketing",
            "Key": "organization"
        }
    ]
}

Output

TagSet -> (list)

Contains the tag set.

(structure)

A container of a key value name pair.

Key -> (string)

Name of the object key.

Value -> (string)

Value of the tag.