describe_tags

ApplicationDiscoveryService.Client.describe_tags(**kwargs)

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

Request Syntax

response = client.describe_tags(
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ]
        },
    ],
    maxResults=123,
    nextToken='string'
)

Parameters

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

  • (dict) --

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

    • name (string) -- [REQUIRED]

      A name of the tag filter.

    • values (list) -- [REQUIRED]

      Values for the tag filter.

      • (string) --
• maxResults (integer) -- The total number of items to return in a single page of output. The maximum value is 100.
• nextToken (string) -- A token to start the list. Use this token to get the next set of results.

Return type

dict

Returns

Response Syntax

{
    'tags': [
        {
            'configurationType': 'SERVER'|'PROCESS'|'CONNECTION'|'APPLICATION',
            'configurationId': 'string',
            'key': 'string',
            'value': 'string',
            'timeOfCreation': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

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

    • (dict) --

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

        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.

Exceptions

• ApplicationDiscoveryService.Client.exceptions.AuthorizationErrorException
• ApplicationDiscoveryService.Client.exceptions.ResourceNotFoundException
• ApplicationDiscoveryService.Client.exceptions.InvalidParameterException
• ApplicationDiscoveryService.Client.exceptions.InvalidParameterValueException
• ApplicationDiscoveryService.Client.exceptions.ServerInternalErrorException
• ApplicationDiscoveryService.Client.exceptions.HomeRegionNotSetException