S3 / Client / put_object_tagging

put_object_tagging

S3.Client.put_object_tagging(**kwargs)

Sets the supplied tag-set to an object that already exists in a bucket.

A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

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

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

For information about the Amazon S3 object tagging feature, see Object Tagging.

Special Errors

• • Code: InvalidTagError

  • Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging.

• • Code: MalformedXMLError

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

• • Code: OperationAbortedError

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

• • Code: InternalError

  • Cause: The service was unable to apply the provided tag to the object.

Related Resources

• GetObjectTagging

• DeleteObjectTagging

See also: AWS API Documentation

Request Syntax

response = client.put_object_tagging(
    Bucket='string',
    Key='string',
    VersionId='string',
    ContentMD5='string',
    Tagging={
        'TagSet': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    },
    ExpectedBucketOwner='string',
    RequestPayer='requester'
)

Parameters:

• Bucket (string) –

  [REQUIRED]

  The bucket name containing the object.

  Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.*Region*.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

  S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

• Key (string) –

  [REQUIRED]

  Name of the object key.

• VersionId (string) – The versionId of the object that the tag-set will be added to.

• ContentMD5 (string) –

  The MD5 hash for the request body.

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

• 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.

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

Return type:

dict

Returns:

Response Syntax

{
    'VersionId': 'string'
}

Response Structure

• (dict) –

  • VersionId (string) –

    The versionId of the object the tag-set was added to.

Examples

The following example adds tags to an existing object.

response = client.put_object_tagging(
    Bucket='examplebucket',
    Key='HappyFace.jpg',
    Tagging={
        'TagSet': [
            {
                'Key': 'Key3',
                'Value': 'Value3',
            },
            {
                'Key': 'Key4',
                'Value': 'Value4',
            },
        ],
    },
)

print(response)

Expected Output:

{
    'VersionId': 'null',
    'ResponseMetadata': {
        '...': '...',
    },
}