Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the EventType object.
If you don't specify a filter criteria, the API operation returns all event types, in no particular order.
Note
This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
Request Syntax
{
"filter": {
"eventTypeCategories": [ "string" ],
"eventTypeCodes": [ "string" ],
"services": [ "string" ]
},
"locale": "string",
"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.
- filter
-
Values to narrow the results returned.
Type: EventTypeFilter object
Required: No
- locale
-
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 256.
Pattern:
.{2,256}Required: No
- maxResults
-
The maximum number of items to return in one batch, between 10 and 100, inclusive.
Note
If you don't specify the
maxResultsparameter, this operation returns a maximum of 30 items by default.Type: Integer
Valid Range: Minimum value of 10. 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
{
"eventTypes": [
{
"category": "string",
"code": "string",
"service": "string"
}
],
"nextToken": "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.
- eventTypes
-
A list of event types that match the filter criteria. Event types have a category (
issue,accountNotification, orscheduledChange), a service (for example,EC2,RDS,DATAPIPELINE,BILLING), and a code (in the formatAWS_SERVICE_DESCRIPTION; for example,AWS_EC2_SYSTEM_MAINTENANCE_EVENT).Type: Array of EventType objects
- 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}
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidPaginationToken
-
The specified pagination token (
nextToken) is not valid.HTTP Status Code: 400
- UnsupportedLocale
-
The specified locale is not supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
