Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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:
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
tag-resource
--resource-arn <value>
--tags <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--resource-arn
(string)
The ARN of the topic to which to add tags.
--tags
(list)
The tags to be added to the specified topic. A tag consists of a required key and an optional value.
(structure)
The list of tags to be added to the specified topic.
Key -> (string)
The required key portion of the tag.Value -> (string)
The optional value portion of the tag.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
To add a tag to a topic
The following tag-resource
example adds a metadata tag to the specified Amazon SNS topic.
aws sns tag-resource \
--resource-arn arn:aws:sns:us-west-2:123456789012:MyTopic \
--tags Key=Team,Value=Alpha
This command produces no output.
None