ListTagsForResource
This operation allows you to list all of the tags for a specified resource. Each tag is a label consisting of a key and value. Tags can help you organize, track costs for, and control access to resources.
Note
This operation is only supported for the following Amazon S3 resources:
- Permissions
-
For Storage Lens groups and S3 Access Grants, you must have the
s3:ListTagsForResource
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:ListTagsForResource
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
GET /v20180820/tags/resourceArn+
HTTP/1.1
Host: s3-control.amazonaws.com.cn
x-amz-account-id: AccountId
URI Request Parameters
The request uses the following URI parameters.
- resourceArn
-
The Amazon Resource Name (ARN) of the S3 resource that you want to list tags for. 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 Web Services account ID of the resource owner.
Length Constraints: Maximum length of 64.
Pattern:
^\d{12}$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
<?xml version="1.0" encoding="UTF-8"?>
<ListTagsForResourceResult>
<Tags>
<Tag>
<Key>string</Key>
<Value>string</Value>
</Tag>
</Tags>
</ListTagsForResourceResult>
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in XML format by the service.
- ListTagsForResourceResult
-
Root level tag for the ListTagsForResourceResult parameters.
Required: Yes
- Tags
-
The Amazon resource tags that are associated with the resource.
Type: Array of Tag data types
Array Members: Minimum number of 0 items. Maximum number of 50 items.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: