2020/05/19 - AWS Health APIs and Notifications - 5 updated api methods
Changes Feature: Health: AWS Health added a new field to differentiate Public events from Account-Specific events in the API request and response. Visit https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html to learn more.
{'eventScopeCode': 'PUBLIC | ACCOUNT_SPECIFIC | NONE'}
Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
See also: AWS API Documentation
Request Syntax
client.describe_affected_accounts_for_organization(
eventArn='string',
nextToken='string',
maxResults=123
)
string
[REQUIRED]
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
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
{
'affectedAccounts': [
'string',
],
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
'nextToken': 'string'
}
Response Structure
(dict) --
affectedAccounts (list) --
A JSON set of elements of the affected accounts.
(string) --
eventScopeCode (string) --
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': {'eventScopeCode': 'PUBLIC | ACCOUNT_SPECIFIC | '
'NONE'}}}
Returns detailed information about one or more specified events. Information includes standard event data (region, service, and so on, 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',
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
},
'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 .
eventScopeCode (string) --
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.
{'successfulSet': {'event': {'eventScopeCode': 'PUBLIC | ACCOUNT_SPECIFIC | '
'NONE'}}}
Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by DescribeEventsForOrganization , 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 DescribeAffectedEntitiesForOrganization operation.
Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
See also: AWS API Documentation
Request Syntax
client.describe_event_details_for_organization(
organizationEventDetailFilters=[
{
'eventArn': 'string',
'awsAccountId': 'string'
},
],
locale='string'
)
list
[REQUIRED]
A set of JSON elements that includes the awsAccountId and the eventArn .
(dict) --
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
eventArn (string) -- [REQUIRED]
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
awsAccountId (string) --
The 12-digit AWS account numbers that contains the affected entities.
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': [
{
'awsAccountId': 'string',
'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',
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE'
},
'eventDescription': {
'latestDescription': 'string'
},
'eventMetadata': {
'string': 'string'
}
},
],
'failedSet': [
{
'awsAccountId': 'string',
'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 DescribeEventDetailsForOrganization operation.
awsAccountId (string) --
The 12-digit AWS account numbers that contains the affected entities.
event (dict) --
Summary information about an AWS Health 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 .
eventScopeCode (string) --
eventDescription (dict) --
The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.
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 DescribeEventDetailsForOrganization operation cannot find a specified event.
awsAccountId (string) --
Error information returned when a DescribeEventDetailsForOrganization 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.
{'events': {'eventScopeCode': 'PUBLIC | ACCOUNT_SPECIFIC | NONE'}}
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',
'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 AWS Health 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 .
eventScopeCode (string) --
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.
{'events': {'eventScopeCode': 'PUBLIC | ACCOUNT_SPECIFIC | NONE'}}
Returns information about events across your organization in AWS Organizations, meeting the specified filter criteria. Events are returned in a summary form and do not include the accounts impacted, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeAffectedAccountsForOrganization , DescribeEventDetailsForOrganization , and DescribeAffectedEntitiesForOrganization operations.
If no filter criteria are specified, all events across your organization are returned. Results are sorted by lastModifiedTime , starting with the most recent.
Before you can call this operation, you must first enable Health to work with AWS Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's master account.
See also: AWS API Documentation
Request Syntax
client.describe_events_for_organization(
filter={
'eventTypeCodes': [
'string',
],
'awsAccountIds': [
'string',
],
'services': [
'string',
],
'regions': [
'string',
],
'startTime': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
'endTime': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
'lastUpdatedTime': {
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
'entityArns': [
'string',
],
'entityValues': [
'string',
],
'eventTypeCategories': [
'issue'|'accountNotification'|'scheduledChange'|'investigation',
],
'eventStatusCodes': [
'open'|'closed'|'upcoming',
]
},
nextToken='string',
maxResults=123,
locale='string'
)
dict
Values to narrow the results returned.
eventTypeCodes (list) --
A list of unique identifiers for event types. For example, "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
(string) --
awsAccountIds (list) --
A list of 12-digit AWS account numbers that contains the affected entities.
(string) --
services (list) --
The AWS services associated with the event. For example, EC2 , RDS .
(string) --
regions (list) --
A list of AWS Regions.
(string) --
startTime (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.
endTime (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.
lastUpdatedTime (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) --
REPLACEME
(string) --
entityValues (list) --
A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
(string) --
eventTypeCategories (list) --
REPLACEME
(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',
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
'region': '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 DescribeEventsForOrganization operation.
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 type.
eventScopeCode (string) --
region (string) --
The AWS Region name of the event.
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.