[ aws . discovery ]

describe-tags

Description

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters .

There are three valid tag filter names:

• tagKey

• tagValue

• configurationId

Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-tags is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: tags

Synopsis

  describe-tags
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--filters (list)

You can filter the list using a key -value format. You can separate these items by using logical operators. Allowed filters include tagKey , tagValue , and configurationId .

(structure)

The tag filter. Valid names are: tagKey , tagValue , configurationId .

name -> (string)

A name of the tag filter.

values -> (list)

Values for the tag filter.

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "values": ["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.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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 -> (list)

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

(structure)

Tags for a configuration item. Tags are metadata that help you categorize IT assets.

configurationType -> (string)

A type of IT asset to tag.

configurationId -> (string)

The configuration ID for the item to tag. You can specify a list of keys and values.

key -> (string)

A type of tag on which to filter. For example, serverType .

value -> (string)

A value on which to filter. For example key = serverType and value = web server .

timeOfCreation -> (timestamp)

The time the configuration tag was created in Coordinated Universal Time (UTC).

nextToken -> (string)

The call returns a token. Use this token to get the next set of results.