2019/06/20 - AWS Health APIs and Notifications - 4 updated api methods
Changes Update health client to latest version
{'filter': {'eventTypeCategories': {'investigation'}}}
Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.
See also: AWS API Documentation
Request Syntax
client.describe_event_aggregates(
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',
]
},
aggregateField='eventTypeCategory',
maxResults=123,
nextToken='string'
)
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 AWS services associated with the event. For example, EC2, RDS.
(string) --
regions (list) --
A list of AWS regions.
(string) --
availabilityZones (list) --
A list of AWS 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 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.
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 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.
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 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.
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 ( issue, scheduledChange, or accountNotification).
(string) --
tags (list) --
A map of entity tags attached to the affected entity.
(dict) --
(string) --
(string) --
eventStatusCodes (list) --
A list of event status codes.
(string) --
string
[REQUIRED]
The only currently supported value is eventTypeCategory.
integer
The maximum number of items to return in one batch, between 10 and 100, inclusive.
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.
dict
Response Syntax
{
'eventAggregates': [
{
'aggregateValue': 'string',
'count': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
eventAggregates (list) --
The number of events in each category that meet the optional filter criteria.
(dict) --
The number of events of each issue type. Returned by the DescribeEventAggregates operation.
aggregateValue (string) --
The issue type for the associated count.
count (integer) --
The number of events of the associated issue type.
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.
{'successfulSet': {'event': {'eventTypeCategory': {'investigation'}}}}
Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation.
If a specified event cannot be retrieved, an error message is returned for that event.
See also: AWS API Documentation
Request Syntax
client.describe_event_details(
eventArns=[
'string',
],
locale='string'
)
list
[REQUIRED]
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) --
string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
dict
Response Syntax
{
'successfulSet': [
{
'event': {
'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'
},
'eventDescription': {
'latestDescription': 'string'
},
'eventMetadata': {
'string': 'string'
}
},
],
'failedSet': [
{
'eventArn': 'string',
'errorName': 'string',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
successfulSet (list) --
Information about the events that could be retrieved.
(dict) --
Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.
event (dict) --
Summary information about the event.
arn (string) --
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID ``. Example: ``Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
service (string) --
The AWS 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) --
The category of the event. Possible values are issue, scheduledChange, and accountNotification.
region (string) --
The AWS region name of the event.
availabilityZone (string) --
The AWS 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.
eventDescription (dict) --
The most recent description of the event.
latestDescription (string) --
The most recent description of the event.
eventMetadata (dict) --
Additional metadata about the event.
(string) --
(string) --
failedSet (list) --
Error messages for any events that could not be retrieved.
(dict) --
Error information returned when a DescribeEventDetails operation cannot find a specified event.
eventArn (string) --
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID ``. Example: ``Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
errorName (string) --
The name of the error.
errorMessage (string) --
A message that describes the error.
{'filter': {'eventTypeCategories': {'investigation'}}}
Response {'eventTypes': {'category': {'investigation'}}}
Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.
See also: AWS API Documentation
Request Syntax
client.describe_event_types(
filter={
'eventTypeCodes': [
'string',
],
'services': [
'string',
],
'eventTypeCategories': [
'issue'|'accountNotification'|'scheduledChange'|'investigation',
]
},
locale='string',
nextToken='string',
maxResults=123
)
dict
Values to narrow the results returned.
eventTypeCodes (list) --
A list of event type codes.
(string) --
services (list) --
The AWS services associated with the event. For example, EC2, RDS.
(string) --
eventTypeCategories (list) --
A list of event type category codes ( issue, scheduledChange, or accountNotification).
(string) --
string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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.
integer
The maximum number of items to return in one batch, between 10 and 100, inclusive.
dict
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) --
Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, issue), the service (for example, EC2), and the event type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
service (string) --
The AWS 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 ( issue, scheduledChange, or accountNotification).
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.
{'filter': {'eventTypeCategories': {'investigation'}}}
Response {'events': {'eventTypeCategory': {'investigation'}}}
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.
See also: AWS API Documentation
Request Syntax
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'
)
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 AWS services associated with the event. For example, EC2, RDS.
(string) --
regions (list) --
A list of AWS regions.
(string) --
availabilityZones (list) --
A list of AWS 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 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.
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 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.
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 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.
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 ( issue, scheduledChange, or accountNotification).
(string) --
tags (list) --
A map of entity tags attached to the affected entity.
(dict) --
(string) --
(string) --
eventStatusCodes (list) --
A list of event status codes.
(string) --
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.
integer
The maximum number of items to return in one batch, between 10 and 100, inclusive.
string
The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
events (list) --
The events that match the specified filter criteria.
(dict) --
Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.
arn (string) --
The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID ``. Example: ``Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
service (string) --
The AWS 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) --
The category of the event. Possible values are issue, scheduledChange, and accountNotification.
region (string) --
The AWS region name of the event.
availabilityZone (string) --
The AWS 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.
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.