Health / Paginator / DescribeEvents
DescribeEvents#
- class Health.Paginator.DescribeEvents#
paginator = client.get_paginator('describe_events')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Health.Client.describe_events()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( 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', ] }, locale='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
filter (dict) –
Values to narrow the results returned.
eventArns (list) –
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"
(string) –
eventTypeCodes (list) –
A list of unique identifiers for event types. For example,
"AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
(string) –
services (list) –
The Amazon Web Services associated with the event. For example,
EC2
,RDS
.(string) –
regions (list) –
A list of Amazon Web Services Regions.
(string) –
availabilityZones (list) –
A list of Amazon Web Services Availability Zones.
(string) –
startTimes (list) –
A list of dates and times that the event began.
(dict) –
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
from
is set andto
is set: match items where the timestamp (startTime
,endTime
, orlastUpdatedTime
) is betweenfrom
andto
inclusive. Iffrom
is set andto
is not set: match items where the timestamp value is equal to or afterfrom
. Iffrom
is not set andto
is set: match items where the timestamp value is equal to or beforeto
.from (datetime) –
The starting date and time of a time range.
to (datetime) –
The ending date and time of a time range.
endTimes (list) –
A list of dates and times that the event ended.
(dict) –
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
from
is set andto
is set: match items where the timestamp (startTime
,endTime
, orlastUpdatedTime
) is betweenfrom
andto
inclusive. Iffrom
is set andto
is not set: match items where the timestamp value is equal to or afterfrom
. Iffrom
is not set andto
is set: match items where the timestamp value is equal to or beforeto
.from (datetime) –
The starting date and time of a time range.
to (datetime) –
The ending date and time of a time range.
lastUpdatedTimes (list) –
A list of dates and times that the event was last updated.
(dict) –
A range of dates and times that is used by the EventFilter and EntityFilter objects. If
from
is set andto
is set: match items where the timestamp (startTime
,endTime
, orlastUpdatedTime
) is betweenfrom
andto
inclusive. Iffrom
is set andto
is not set: match items where the timestamp value is equal to or afterfrom
. Iffrom
is not set andto
is set: match items where the timestamp value is equal to or beforeto
.from (datetime) –
The starting date and time of a time range.
to (datetime) –
The ending date and time of a time range.
entityArns (list) –
A list of entity ARNs (unique identifiers).
(string) –
entityValues (list) –
A list of entity identifiers, such as EC2 instance IDs (
i-34ab692e
) or EBS volumes (vol-426ab23e
).(string) –
eventTypeCategories (list) –
A list of event type category codes. Possible values are
issue
,accountNotification
, orscheduledChange
. Currently, theinvestigation
value isn’t supported at this time.(string) –
tags (list) –
A map of entity tags attached to the affected entity.
Note
Currently, the
tags
property isn’t supported.(dict) –
(string) –
(string) –
eventStatusCodes (list) –
A list of event status codes.
(string) –
locale (string) – The locale (language) to return information in. English (en) is the default and the only supported value at this time.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
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:
Public events might be service events that are not specific to an Amazon Web Services account. For example, if there is an issue with an Amazon Web Services Region, Health provides information about the event, even if you don’t use services or resources in that Region.
Account-specific events are specific to either your Amazon Web Services account or an account in your organization. For example, if there’s an issue with Amazon Elastic Compute Cloud in a Region that you use, Health provides information about the event and the affected resources in the account.
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 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
, orscheduledChange
. Currently, theinvestigation
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
, andupcoming
.eventScopeCode (string) –
This parameter specifies if the Health event is a public Amazon Web Service event or an account-specific event.
If the
eventScopeCode
value isPUBLIC
, then theaffectedAccounts
value is always empty.If the
eventScopeCode
value isACCOUNT_SPECIFIC
, then theaffectedAccounts
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.If the
eventScopeCode
value isNONE
, then theeventArn
that you specified in the request is invalid or doesn’t exist.
NextToken (string) –
A token to resume pagination.