DescribeTags
Returns the resource tags associated with Health events for your account. Use this operation to retrieve the actual tag key-value pairs attached to affected entities.
Request Syntax
{
"maxResults": number,
"nextToken": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- maxResults
-
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- nextToken
-
If the results of a search are large, only a portion of the results are returned, and a
nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern:
[a-zA-Z0-9=/+_.-]{4,10000}Required: No
Response Syntax
{
"nextToken": "string",
"tags": [
{
"key": "string",
"type": "string",
"value": "string"
}
]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- nextToken
-
If the results of a search are large, only a portion of the results are returned, and a
nextTokenpagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.Type: String
Length Constraints: Minimum length of 4. Maximum length of 10000.
Pattern:
[a-zA-Z0-9=/+_.-]{4,10000} -
The list of resource tags associated with Health events.
Type: Array of AccountTag objects
Errors
For information about the errors that are common to all actions, see Common Error Types.
- InvalidPaginationToken
-
The specified pagination token (
nextToken) is not valid.HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: