BucketTagging / Action / put

put

S3.BucketTagging.put(**kwargs)

Sets the tags for a bucket.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services 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 and Using Cost Allocation in Amazon S3 Bucket Tags.

Note

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of 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 Amazon Web Services-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

Request Syntax

response = bucket_tagging.put(
    Tagging={
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    ExpectedBucketOwner='string'
)

Parameters:

• Tagging (dict) –

  [REQUIRED]

  Container for the TagSet and Tag elements.

  • TagSet (list) – [REQUIRED]

    A collection for a set of tags

    • (dict) –

      A container of a key value name pair.

      • Key (string) – [REQUIRED]

        Name of the object key.

      • Value (string) – [REQUIRED]

        Value of the tag.

• ExpectedBucketOwner (string) – Ignored by COS if present.

Returns:

None