[ aws . s3api ]

put-bucket-tagging

Description

Sets the tags for a bucket.

Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging .

Note

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags .

To use this operation, you must have permissions to perform the s3:PutBucketTagging action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources .

PutBucketTagging has the following special errors:

• Error code: InvalidTagError

  • Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions .

• Error code: MalformedXMLError

  • Description: The XML provided does not match the schema.

• Error code: OperationAbortedError

  • Description: A conflicting conditional action is currently in progress against this resource. Please try again.

• Error code: InternalError

  • Description: The service was unable to apply the provided tag to the bucket.

The following operations are related to PutBucketTagging :

• GetBucketTagging

• DeleteBucketTagging

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  put-bucket-tagging
--bucket <value>
[--content-md5 <value>]
--tagging <value>
[--expected-bucket-owner <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--bucket (string)

The bucket name.

--content-md5 (string)

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864 .

For requests made using the AWS Command Line Interface (CLI) or AWS SDKs, this field is calculated automatically.

--tagging (structure)

Container for the TagSet and Tag elements.

TagSet -> (list)

A collection for a set of tags

(structure)

A container of a key value name pair.

Key -> (string)

Name of the object key.

Value -> (string)

Value of the tag.

Shorthand Syntax:

TagSet=[{Key=string,Value=string},{Key=string,Value=string}]

JSON Syntax:

{
  "TagSet": [
    {
      "Key": "string",
      "Value": "string"
    }
    ...
  ]
}

--expected-bucket-owner (string)

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 applies a tagging configuration to a bucket named my-bucket:

aws s3api put-bucket-tagging --bucket my-bucket --tagging file://tagging.json

The file tagging.json is a JSON document in the current folder that specifies tags:

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

Or apply a tagging configuration to my-bucket directly from the command line:

aws s3api put-bucket-tagging --bucket my-bucket --tagging 'TagSet=[{Key=organization,Value=marketing}]'

Output

None