tag-resource¶
Description¶
Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
tag-resource
--resource-arn <value>
--tags-model <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--resource-arn (string)
The Amazon Resource Name (ARN) of the resource.
--tags-model (structure)
Specifies the tags (keys and values) for an application, campaign, message template, or segment.
tags -> (map)
A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags.
Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
key -> (string)
value -> (string)
Shorthand Syntax:
tags={KeyName1=string,KeyName2=string}
JSON Syntax:
{
"tags": {"string": "string"
...}
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.
--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To add tags to a resource
The following example adds two tags (key names and values) to a resource.
aws pinpoint list-tags-for-resource \
--resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \
--tags-model tags={Stack=Production,Year=2019}
This command produces no output.
For more information, see ‘Tagging Amazon Pinpoint Resources <https://docs.aws.amazon.com/pinpoint/latest/developerguide/tagging-resources.html>’__ in the Amazon Pinpoint Developer Guide.
Output¶
None