DescribeTags
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Filters.member.N
-
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.Type: Array of Filter objects
Required: No
- MaxRecords
-
The maximum number of items to return with this call. The default value is
50
and the maximum value is100
.Type: Integer
Required: No
- NextToken
-
The token for the next set of items to return. (You received this token from a previous call.)
Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
Required: No
Response Elements
The following elements are returned by the service.
- NextToken
-
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.Type: String
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*
- Tags.member.N
-
One or more tags.
Type: Array of TagDescription objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextToken
-
The
NextToken
value is not valid.HTTP Status Code: 400
- ResourceContention
-
You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of DescribeTags.
Sample Request
https://autoscaling.amazonaws.com/?Action=DescribeTags
&Version=2011-01-01
&AUTHPARAMS
Sample Response
<DescribeTagsResponse xmlns="https://autoscaling.amazonaws.com/doc/2011-01-01/">
<DescribeTagsResult>
<Tags>
<member>
<ResourceId>my-asg</ResourceId>
<PropagateAtLaunch>true</PropagateAtLaunch>
<Value>test</Value>
<Key>environment</Key>
<ResourceType>auto-scaling-group</ResourceType>
</member>
</Tags>
</DescribeTagsResult>
<ResponseMetadata>
<RequestId>7c6e177f-f082-11e1-ac58-3714bEXAMPLE</RequestId>
</ResponseMetadata>
</DescribeTagsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: