[ aws . apigatewayv2 ]
Gets a collection of Tag resources.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-tags
--resource-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--resource-arn
(string)
The resource ARN for the tag.
--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.
See ‘aws help’ for descriptions of global parameters.
To retrieve a list of tags for a resource
The following get-tags
example lists all of an API’s tags.
aws apigatewayv2 get-tags \
--resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4
Output:
{
"Tags": {
"owner": "dev-team",
"environment": "prod"
}
}
For more information, see Tagging your API Gateway resources in the Amazon API Gateway Developer Guide.
Tags -> (map)
Represents a collection of tags associated with the resource.
key -> (string)
value -> (string)
A string with a length between [0-1600].