[ aws . apigateway ]

get-tags

Description

Gets the Tags collection for a given resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-tags
--resource-arn <value>
[--position <value>]
[--limit <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--resource-arn (string)

[Required] The ARN of a resource that can be tagged.

--position (string)

(Not currently supported) The current pagination position in the paged result set.

--limit (integer)

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

--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.

Output

tags -> (map)

The collection of tags. Each tag element is associated with a given resource.

key -> (string)

value -> (string)