Health.Client.describe_events(**kwargs)¶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.
Note
DescribeEvents operation and specify an entity for the entityValues parameter, 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, 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.nextToken parameter in the next request to return more results.See also: AWS API Documentation
Request Syntax
response = client.describe_events(
filter={
'eventArns': [
'string',
],
'eventTypeCodes': [
'string',
],
'services': [
'string',
],
'regions': [
'string',
],
'availabilityZones': [
'string',
],
'startTimes': [
{
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
],
'endTimes': [
{
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
],
'lastUpdatedTimes': [
{
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
],
'entityArns': [
'string',
],
'entityValues': [
'string',
],
'eventTypeCategories': [
'issue'|'accountNotification'|'scheduledChange'|'investigation',
],
'tags': [
{
'string': 'string'
},
],
'eventStatusCodes': [
'open'|'closed'|'upcoming',
]
},
nextToken='string',
maxResults=123,
locale='string'
)
Values to narrow the results returned.
A list of event ARNs (unique identifiers). For example: "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
The Amazon Web Services services associated with the event. For example, EC2 , RDS .
A list of Amazon Web Services Regions.
A list of Amazon Web Services Availability Zones.
A list of dates and times that the event began.
A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp ( startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from . If from is not set and to is set: match items where the timestamp value is equal to or before to .
The starting date and time of a time range.
The ending date and time of a time range.
A list of dates and times that the event ended.
A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp ( startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from . If from is not set and to is set: match items where the timestamp value is equal to or before to .
The starting date and time of a time range.
The ending date and time of a time range.
A list of dates and times that the event was last updated.
A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp ( startTime , endTime , or lastUpdatedTime ) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from . If from is not set and to is set: match items where the timestamp value is equal to or before to .
The starting date and time of a time range.
The ending date and time of a time range.
A list of entity ARNs (unique identifiers).
A list of entity identifiers, such as EC2 instance IDs ( i-34ab692e ) or EBS volumes ( vol-426ab23e ).
A list of event type category codes. Possible values are issue , accountNotification , or scheduledChange . Currently, the investigation value isn't supported at this time.
A map of entity tags attached to the affected entity.
Note
Currently, the tags property isn't supported.
A list of event status codes.
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.dict
Response Syntax
{
'events': [
{
'arn': 'string',
'service': 'string',
'eventTypeCode': 'string',
'eventTypeCategory': 'issue'|'accountNotification'|'scheduledChange'|'investigation',
'region': 'string',
'availabilityZone': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'lastUpdatedTime': datetime(2015, 1, 1),
'statusCode': 'open'|'closed'|'upcoming',
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The events that match the specified filter criteria.
(dict) --
Summary information about an Health event.
Health events can be public or account-specific:
You can determine if an event is public or account-specific by using the eventScopeCode parameter. For more information, see eventScopeCode.
arn (string) --
The unique identifier for the event. The event ARN has the arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID format.
For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
service (string) --
The Amazon Web Services service that is affected by the event. For example, EC2 , RDS .
eventTypeCode (string) --
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT .
eventTypeCategory (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.
region (string) --
The Amazon Web Services Region name of the event.
availabilityZone (string) --
The Amazon Web Services Availability Zone of the event. For example, us-east-1a.
startTime (datetime) --
The date and time that the event began.
endTime (datetime) --
The date and time that the event ended.
lastUpdatedTime (datetime) --
The most recent date and time that the event was updated.
statusCode (string) --
The most recent status of the event. Possible values are open , closed , and upcoming .
eventScopeCode (string) --
This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
eventScopeCode value is PUBLIC , then the affectedAccounts value is always empty.eventScopeCode value is ACCOUNT_SPECIFIC , then the affectedAccounts value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.eventScopeCode value is NONE , then the eventArn that you specified in the request is invalid or doesn't exist.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.InvalidPaginationTokenHealth.Client.exceptions.UnsupportedLocale