Health / Client / describe_event_types

describe_event_types

Health.Client.describe_event_types(**kwargs)

Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the Health event, such as the category, Amazon Web 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.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_types(
    filter={
        'eventTypeCodes': [
            'string',
        ],
        'services': [
            'string',
        ],
        'eventTypeCategories': [
            'issue'|'accountNotification'|'scheduledChange'|'investigation',
        ]
    },
    locale='string',
    nextToken='string',
    maxResults=123
)

Parameters:

• filter (dict) –

  Values to narrow the results returned.

  • eventTypeCodes (list) –

    A list of event type codes.

    • (string) –

  • services (list) –

    The Amazon Web Services associated with the event. For example, EC2, RDS.

    • (string) –

  • eventTypeCategories (list) –

    A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn’t supported at this time.

    • (string) –

• locale (string) – The locale (language) to return information in. English (en) is the default and the only supported value at this time.

• nextToken (string) – If the results of a search are large, only a portion of the results are returned, and a nextToken pagination 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.

• maxResults (integer) –

  The maximum number of items to return in one batch, between 10 and 100, inclusive.

  Note

  If you don’t specify the maxResults parameter, this operation returns a maximum of 30 items by default.

Return type:

dict

Returns:

Response Syntax

{
    'eventTypes': [
        {
            'service': 'string',
            'code': 'string',
            'category': 'issue'|'accountNotification'|'scheduledChange'|'investigation'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • eventTypes (list) –

    A list of event types that match the filter criteria. Event types have a category ( issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ``; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

    • (dict) –

      Contains the metadata about a type of event that is reported by Health. The EventType shows the category, service, and the event type code of the event. For example, an issue might be the category, EC2 the service, and AWS_EC2_SYSTEM_MAINTENANCE_EVENT the event type code.

      You can use the DescribeEventTypes API operation to return this information about an event.

      You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when Health delivers a specific event to your Amazon Web Services account. For more information, see Monitor for Health events with Amazon CloudWatch Events in the Health User Guide.

      • service (string) –

        The Amazon Web Service that is affected by the event. For example, EC2, RDS.

      • code (string) –

        The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ``; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

      • category (string) –

        A list of event type category codes. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn’t supported at this time.

  • nextToken (string) –

    If the results of a search are large, only a portion of the results are returned, and a nextToken pagination 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.

Exceptions

• Health.Client.exceptions.InvalidPaginationToken

• Health.Client.exceptions.UnsupportedLocale