Describe Event Types

health_describe_event_types

R Documentation

Returns the event types that meet the specified filter criteria¶

Description¶

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.

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.

Usage¶

health_describe_event_types(filter, locale, nextToken, maxResults)

Arguments¶

filter

Values to narrow the results returned.

locale

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

nextToken

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

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

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

Value¶

A list with the following syntax:

list(
  eventTypes = list(
    list(
      service = "string",
      code = "string",
      category = "issue"|"accountNotification"|"scheduledChange"|"investigation"
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$describe_event_types(
  filter = list(
    eventTypeCodes = list(
      "string"
    ),
    services = list(
      "string"
    ),
    eventTypeCategories = list(
      "issue"|"accountNotification"|"scheduledChange"|"investigation"
    )
  ),
  locale = "string",
  nextToken = "string",
  maxResults = 123
)