TagResource
Creates a new user-defined tag or updates an existing tag. Each tag is a label consisting of a key and value that is applied to your resource. Tags can help you organize, track costs for, and control access to your resources. You can add up to 50 Amazon resource tags for each S3 resource.
Note
This operation is only supported for the following Amazon S3 resource:
- Permissions
-
For Storage Lens groups and S3 Access Grants, you must have the
s3:TagResource
permission to use this operation.For more information about the required Storage Lens Groups permissions, see Setting account permissions to use S3 Storage Lens groups.
- Directory bucket permissions
-
For directory buckets, you must have the
s3express:TagResource
permission to use this operation. For more information about directory buckets policies and permissions, see Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide. - HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
s3express-control.region.amazonaws.com
.
For information about S3 Tagging errors, see List of Amazon S3 Tagging error codes.
Request Syntax
POST /v20180820/tags/resourceArn+
HTTP/1.1
Host: s3-control.amazonaws.com.cn
x-amz-account-id: AccountId
<?xml version="1.0" encoding="UTF-8"?>
<TagResourceRequest xmlns="http://awss3control.amazonaws.com/doc/2018-08-20/">
<Tags>
<Tag>
<Key>string
</Key>
<Value>string
</Value>
</Tag>
</Tags>
</TagResourceRequest>
URI Request Parameters
The request uses the following URI parameters.
- resourceArn
-
The Amazon Resource Name (ARN) of the S3 resource that you're applying tags to. The tagged resource can be a directory bucket, S3 Storage Lens group or S3 Access Grants instance, registered location, or grant.
Length Constraints: Maximum length of 1011.
Pattern:
arn:[^:]+:s3(express)?:[^:].*
Required: Yes
- x-amz-account-id
-
The Amazon account ID that created the S3 resource that you're trying to add tags to or the requester's account ID.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$
Required: Yes
Request Body
The request accepts the following data in XML format.
- TagResourceRequest
-
Root level tag for the TagResourceRequest parameters.
Required: Yes
- Tags
-
The Amazon resource tags that you want to add to the specified S3 resource.
Type: Array of Tag data types
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
Response Syntax
HTTP/1.1 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: