Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.
If no filter criteria are specified, all events are returned. Results
are sorted by lastModifiedTime
, starting with the most recent event.
When you call the DescribeEvents
operation and specify an entity
for the entityValues
parameter, AWS Health might return public
events that aren't specific to that resource. For example, if you
call DescribeEvents
and specify an ID for an Amazon Elastic
Compute Cloud (Amazon EC2) instance, AWS Health might return events
that aren't specific to that resource or service. To get events that
are specific to a service, use the services
parameter in the
filter
object. For more information, see
Event.
This API operation uses pagination. Specify the nextToken
parameter in the next request to return more results.
health_describe_events(filter, nextToken, maxResults, locale)
Values to narrow the results returned.
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.
The maximum number of items to return in one batch, between 10 and 100, inclusive.
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
svc$describe_events( filter = list( eventArns = list( "string" ), eventTypeCodes = list( "string" ), services = list( "string" ), regions = list( "string" ), availabilityZones = list( "string" ), startTimes = list( list( from = as.POSIXct( "2015-01-01" ), to = as.POSIXct( "2015-01-01" ) ) ), endTimes = list( list( from = as.POSIXct( "2015-01-01" ), to = as.POSIXct( "2015-01-01" ) ) ), lastUpdatedTimes = list( list( from = as.POSIXct( "2015-01-01" ), to = as.POSIXct( "2015-01-01" ) ) ), entityArns = list( "string" ), entityValues = list( "string" ), eventTypeCategories = list( "issue"|"accountNotification"|"scheduledChange"|"investigation" ), tags = list( list( "string" ) ), eventStatusCodes = list( "open"|"closed"|"upcoming" ) ), nextToken = "string", maxResults = 123, locale = "string" )