Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.
When you use topic tags, keep the following guidelines in mind:
-
Adding more than 50 tags to a topic isn't recommended.
-
Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.
-
Tags are case-sensitive.
-
A new tag with a key identical to that of an existing tag overwrites the existing tag.
-
Tagging actions are limited to 10 TPS per AWS account, per AWS Region. If your application requires a higher throughput, file a technical support request
.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ResourceArn
-
The ARN of the topic to which to add tags.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Required: Yes
- Tags.member.N
-
The tags to be added to the specified topic. A tag consists of a required key and an optional value.
Type: Array of Tag objects
Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- AuthorizationError
-
Indicates that the user has been denied access to the requested resource.
HTTP Status Code: 403
- ConcurrentAccess
-
Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.
HTTP Status Code: 400
- InvalidParameter
-
Indicates that a request parameter does not comply with the associated constraints.
HTTP Status Code: 400
- ResourceNotFound
-
Can’t perform the action on the specified resource. Make sure that the resource exists.
HTTP Status Code: 404
- StaleTag
-
A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.
HTTP Status Code: 400
- TagLimitExceeded
-
Can't add more than 50 tags to a topic.
HTTP Status Code: 400
- TagPolicy
-
The request doesn't comply with the IAM tag policy. Correct your request and then retry it.
HTTP Status Code: 400
Examples
The structure of AUTHPARAMS depends on the signature of the API request.
For more information, see Examples
of the complete Signature Version 4 signing process (Python) in the
AWS General Reference.
Example
This example illustrates one usage of TagResource.
Sample Request
http://sns.us-west-2.amazonaws.com/?&Action=TagResource
&ResourceArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Atagging
&Tags.Tag.1.Key=tagKey
&Tags.Tag.1.Value=tagValue
&Version=2010-03-31
&AUTHPARAMSSample Response
<TagResourceResponse>
<TagResourceResult/>
<ResponseMetadata>
<RequestId>a1b2c3de-fg45-67h8-i9j0-k1lm234n5678</RequestId>
</ResponseMetadata>
</TagResourceResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
