AutoScaling / Client / describe_tags

describe_tags#

AutoScaling.Client.describe_tags(**kwargs)#

Describes the specified tags.

You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.

You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there’s no match, no special message is returned.

For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_tags(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxRecords=123
)
Parameters:
  • Filters (list) –

    One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.

    • (dict) –

      Describes a filter that is used to return a more specific list of results from a describe operation.

      If you specify multiple filters, the filters are automatically logically joined with an AND, and the request returns only the results that match all of the specified filters.

      For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

      • Name (string) –

        The name of the filter.

        The valid values for Name depend on which API operation you’re using with the filter ( DescribeAutoScalingGroups or DescribeTags).

        DescribeAutoScalingGroups

        Valid values for Name include the following:

        • tag-key - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.

        • tag-value - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.

        • tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.

        DescribeTags

        Valid values for Name include the following:

        • auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.

        • key - Accepts tag keys. The results only include information about the tags associated with these tag keys.

        • value - Accepts tag values. The results only include information about the tags associated with these tag values.

        • propagate-at-launch - Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.

      • Values (list) –

        One or more filter values. Filter values are case-sensitive.

        If you specify multiple values for a filter, the values are automatically logically joined with an OR, and the request returns all results that match any of the specified values. For example, specify “tag:environment” for the filter name and “production,development” for the filter values to find Auto Scaling groups with the tag “environment=production” or “environment=development”.

        • (string) –

  • NextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

  • MaxRecords (integer) – The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'ResourceId': 'string',
            'ResourceType': 'string',
            'Key': 'string',
            'Value': 'string',
            'PropagateAtLaunch': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Tags (list) –

      One or more tags.

      • (dict) –

        Describes a tag for an Auto Scaling group.

        • ResourceId (string) –

          The name of the group.

        • ResourceType (string) –

          The type of resource. The only supported value is auto-scaling-group.

        • Key (string) –

          The tag key.

        • Value (string) –

          The tag value.

        • PropagateAtLaunch (boolean) –

          Determines whether the tag is added to new instances as they are launched in the group.

    • NextToken (string) –

      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

Exceptions

Examples

This example describes the tags for the specified Auto Scaling group.

response = client.describe_tags(
    Filters=[
        {
            'Name': 'auto-scaling-group',
            'Values': [
                'my-auto-scaling-group',
            ],
        },
    ],
)

print(response)

Expected Output:

{
    'Tags': [
        {
            'Key': 'Dept',
            'PropagateAtLaunch': True,
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'Research',
        },
        {
            'Key': 'Role',
            'PropagateAtLaunch': True,
            'ResourceId': 'my-auto-scaling-group',
            'ResourceType': 'auto-scaling-group',
            'Value': 'WebServer',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}