2026/11/16 - AWS Health APIs and Notifications - 12 new8 updated api methods
Changes Adds resource tags functionality to the AWS Health service
Configures which resource tag keys are tracked by Health for your account. This operation replaces the existing configuration with the specified tag keys. Only configured tag keys will appear in Health event data.
See also: AWS API Documentation
Request Syntax
client.configure_tags(
tagKeys=[
{
'key': 'string',
'enabledForEventBridge': True|False,
'status': 'PENDING'|'ACTIVE'
},
]
)
list
[REQUIRED]
The list of resource tag keys to configure for Health event tracking.
(dict) --
A resource tag key configured for Health event tracking.
key (string) --
The tag key name.
enabledForEventBridge (boolean) --
Whether this tag key is enabled for EventBridge notifications.
status (string) --
The current status of the tag key configuration.
dict
Response Syntax
{
'configuredTagKeys': [
{
'key': 'string',
'enabledForEventBridge': True|False,
'status': 'PENDING'|'ACTIVE'
},
]
}
Response Structure
(dict) --
configuredTagKeys (list) --
The list of resource tag keys that were successfully configured.
(dict) --
A resource tag key configured for Health event tracking.
key (string) --
The tag key name.
enabledForEventBridge (boolean) --
Whether this tag key is enabled for EventBridge notifications.
status (string) --
The current status of the tag key configuration.
Enables the Health tags feature for all accounts in your organization. Once enabled, Health events will include resource tag information for affected entities across your organization.
See also: AWS API Documentation
Request Syntax
client.enable_tags_for_organization()
None
Configures which tag keys are tracked by Health for all accounts in your organization. This operation replaces the existing configuration with the specified tag keys. Only configured tag keys will appear in Health event data across the organization.
See also: AWS API Documentation
Request Syntax
client.configure_tags_for_organization(
tagKeys=[
{
'key': 'string',
'enabledForEventBridge': True|False
},
]
)
list
[REQUIRED]
The list of tag keys to configure for Health event tracking across the organization.
(dict) --
A tag key configured for an organization.
key (string) --
The tag key name.
enabledForEventBridge (boolean) --
Whether this tag key is enabled for EventBridge notifications.
dict
Response Syntax
{
'configuredTagKeys': [
{
'key': 'string',
'enabledForEventBridge': True|False
},
]
}
Response Structure
(dict) --
configuredTagKeys (list) --
The list of tag keys that were successfully configured for the organization.
(dict) --
A tag key configured for an organization.
key (string) --
The tag key name.
enabledForEventBridge (boolean) --
Whether this tag key is enabled for EventBridge notifications.
Disables the Health tags feature for all accounts in your organization.
See also: AWS API Documentation
Request Syntax
client.disable_tags_for_organization()
None
Enables the Health tags feature for your account. Once enabled, Health events will include resource tag information for affected entities. If the feature is already enabled, this operation has no effect.
See also: AWS API Documentation
Request Syntax
client.enable_tags()
None
Returns the list of resource tag keys configured for Health event tracking in your account.
See also: AWS API Documentation
Request Syntax
client.describe_tag_keys()
dict
Response Syntax
{
'keys': [
{
'key': 'string',
'enabledForEventBridge': True|False,
'status': 'PENDING'|'ACTIVE'
},
]
}
Response Structure
(dict) --
keys (list) --
The list of configured resource tag keys and their status.
(dict) --
A resource tag key configured for Health event tracking.
key (string) --
The tag key name.
enabledForEventBridge (boolean) --
Whether this tag key is enabled for EventBridge notifications.
status (string) --
The current status of the tag key configuration.
Returns the list of tag keys configured for Health event tracking across your organization.
See also: AWS API Documentation
Request Syntax
client.describe_tag_keys_for_organization()
dict
Response Syntax
{
'keys': [
{
'key': 'string',
'enabledForEventBridge': True|False,
'status': 'PENDING'|'ACTIVE'
},
]
}
Response Structure
(dict) --
keys (list) --
The list of configured tag keys for the organization and their status.
(dict) --
A tag key configured for Health event tracking across an organization.
key (string) --
The tag key name.
enabledForEventBridge (boolean) --
Whether this tag key is enabled for EventBridge notifications.
status (string) --
The current status of the tag key configuration.
Returns the resource tags associated with Health events for your account. Use this operation to retrieve the actual tag key-value pairs attached to affected entities.
See also: AWS API Documentation
Request Syntax
client.describe_tags(
nextToken='string',
maxResults=123
)
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
{
'tags': [
{
'key': 'string',
'value': 'string',
'type': 'ACCOUNT_RESOURCE_TAG'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
The list of resource tags associated with Health events.
(dict) --
A tag key-value pair associated with a resource in an account.
key (string) --
The tag key.
value (string) --
The tag value.
type (string) --
The type of tag (resource tag or account tag).
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.
Returns the current onboarding status of the Health tags feature for your account.
See also: AWS API Documentation
Request Syntax
client.describe_tags_onboarding_status()
dict
Response Syntax
{
'status': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
status (string) --
The current onboarding status of the tags feature for the account.
Returns the current onboarding status of the Health tags feature for your organization.
See also: AWS API Documentation
Request Syntax
client.describe_tags_onboarding_status_for_organization()
dict
Response Syntax
{
'status': 'ENABLED'|'DISABLED'
}
Response Structure
(dict) --
status (string) --
The current onboarding status of the tags feature for the organization.
Returns the tags associated with Health events across all accounts in your organization.
See also: AWS API Documentation
Request Syntax
client.describe_tags_for_organization(
filter={
'tagTypes': [
'ORGANIZATION_RESOURCE_TAG'|'ORGANIZATION_ACCOUNT_TAG',
]
},
nextToken='string',
maxResults=123
)
dict
Values to narrow the results returned.
tagTypes (list) --
The types of tags to include in the results.
(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.
dict
Response Syntax
{
'tags': [
{
'key': 'string',
'value': 'string',
'type': 'ORGANIZATION_RESOURCE_TAG'|'ORGANIZATION_ACCOUNT_TAG'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
tags (list) --
The list of tags associated with Health events across the organization.
(dict) --
A tag key-value pair associated with a resource across an organization.
key (string) --
The tag key.
value (string) --
The tag value.
type (string) --
The type of organization tag.
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.
Disables the Health tags feature for your account. After disabling, Health events will no longer include resource tag information. Previously configured tag keys are discarded.
See also: AWS API Documentation
Request Syntax
client.disable_tags()
None
{'filter': {'eventArn': 'string', 'tags': {'string': ['string']}}}
Response {'affectedAccountEntities': [{'accountId': 'string',
'accountTags': {'string': 'string'}}]}
Returns a list of accounts in the organization from Organizations that are affected by the provided event. For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
See also: AWS API Documentation
Request Syntax
client.describe_affected_accounts_for_organization(
eventArn='string',
nextToken='string',
maxResults=123,
filter={
'eventArn': 'string',
'tags': {
'string': [
'string',
]
}
}
)
string
[REQUIRED]
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
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
Values to narrow the results returned.
eventArn (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
tags (dict) --
A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.
An account is returned when its own tags, or the tags of one of its affected resources, match.
(string) --
(list) --
(string) --
dict
Response Syntax
{
'affectedAccounts': [
'string',
],
'affectedAccountEntities': [
{
'accountId': 'string',
'accountTags': {
'string': 'string'
}
},
],
'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
'nextToken': 'string'
}
Response Structure
(dict) --
affectedAccounts (list) --
A JSON set of elements of the affected accounts.
(string) --
affectedAccountEntities (list) --
The list of affected account entities, including account IDs and their associated tags.
(dict) --
An entity representing an affected account, including its account ID and associated tags.
accountId (string) --
The 12-digit Amazon Web Services account numbers that contains the affected entities.
accountTags (dict) --
A map of tag key-value pairs attached to the affected account.
(string) --
(string) --
eventScopeCode (string) --
This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
If the 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.
If the 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.
{'filter': {'tags': {'string': ['string']}}}
Response {'entities': {'accountTags': {'string': 'string'},
'resourceTags': {'string': 'string'}}}
Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.
At least one event ARN is required.
See also: AWS API Documentation
Request Syntax
client.describe_affected_entities(
filter={
'eventArns': [
'string',
],
'entityArns': [
'string',
],
'entityValues': [
'string',
],
'lastUpdatedTimes': [
{
'from': datetime(2015, 1, 1),
'to': datetime(2015, 1, 1)
},
],
'tags': {
'string': [
'string',
]
},
'statusCodes': [
'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN'|'PENDING'|'RESOLVED',
]
},
locale='string',
nextToken='string',
maxResults=123
)
dict
[REQUIRED]
Values to narrow the results returned. At least one event ARN is required.
eventArns (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) --
entityArns (list) --
A list of entity ARNs (unique identifiers).
(string) --
entityValues (list) --
A list of IDs for affected entities.
(string) --
lastUpdatedTimes (list) --
A list of the most recent dates and times that the entity was 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.
tags (dict) --
A map of resource tag key-value pairs to filter affected entities.
(string) --
(list) --
(string) --
statusCodes (list) --
A list of entity status codes ( IMPAIRED, UNIMPAIRED, or UNKNOWN).
(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 1 and 100, inclusive.
dict
Response Syntax
{
'entities': [
{
'entityArn': 'string',
'eventArn': 'string',
'entityValue': 'string',
'entityUrl': 'string',
'awsAccountId': 'string',
'lastUpdatedTime': datetime(2015, 1, 1),
'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN'|'PENDING'|'RESOLVED',
'resourceTags': {
'string': 'string'
},
'accountTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'entityMetadata': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
The entities that match the filter criteria.
(dict) --
Information about an entity that is affected by a Health event.
entityArn (string) --
The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id ``. Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
eventArn (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
entityValue (string) --
The ID of the affected entity.
entityUrl (string) --
The URL of the affected entity.
awsAccountId (string) --
The 12-digit Amazon Web Services account number that contains the affected entity.
lastUpdatedTime (datetime) --
The most recent time that the entity was updated.
statusCode (string) --
The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, UNKNOWN, PENDING, and RESOLVED.
resourceTags (dict) --
A map of resource tag key-value pairs attached to the affected entity.
(string) --
(string) --
accountTags (dict) --
A map of account tag key-value pairs attached to the affected entity.
(string) --
(string) --
tags (dict) --
A map of resource tag key-value pairs attached to the affected entity.
(string) --
(string) --
entityMetadata (dict) --
Additional metadata about the affected entity.
(string) --
(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.
{'organizationEntityAccountFilters': {'tags': {'string': ['string']}}}
Response {'entities': {'accountTags': {'string': 'string'},
'resourceTags': {'string': 'string'}}}
Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the Amazon Web Services service.
At least one event Amazon Resource Name (ARN) and account ID are required.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
See also: AWS API Documentation
Request Syntax
client.describe_affected_entities_for_organization(
organizationEntityFilters=[
{
'eventArn': 'string',
'awsAccountId': 'string'
},
],
locale='string',
nextToken='string',
maxResults=123,
organizationEntityAccountFilters=[
{
'eventArn': 'string',
'awsAccountId': 'string',
'statusCodes': [
'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN'|'PENDING'|'RESOLVED',
],
'tags': {
'string': [
'string',
]
}
},
]
)
list
A JSON set of elements including 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. 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
awsAccountId (string) --
The 12-digit Amazon Web Services 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.
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 1 and 100, inclusive.
list
A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.
(dict) --
A JSON set of elements including the awsAccountId, eventArn and a set of statusCodes.
eventArn (string) -- [REQUIRED]
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
awsAccountId (string) --
The 12-digit Amazon Web Services account numbers that contains the affected entities.
statusCodes (list) --
A list of entity status codes.
(string) --
tags (dict) --
A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.
An entity is returned when the tags of the resource, or of the account it belongs to, match. When you specify several filters in organizationEntityAccountFilters, the tags must be identical in every filter.
(string) --
(list) --
(string) --
dict
Response Syntax
{
'entities': [
{
'entityArn': 'string',
'eventArn': 'string',
'entityValue': 'string',
'entityUrl': 'string',
'awsAccountId': 'string',
'lastUpdatedTime': datetime(2015, 1, 1),
'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN'|'PENDING'|'RESOLVED',
'resourceTags': {
'string': 'string'
},
'accountTags': {
'string': 'string'
},
'tags': {
'string': 'string'
},
'entityMetadata': {
'string': 'string'
}
},
],
'failedSet': [
{
'awsAccountId': 'string',
'eventArn': 'string',
'errorName': 'string',
'errorMessage': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
A JSON set of elements including the awsAccountId and its entityArn, entityValue and its entityArn, lastUpdatedTime, and statusCode.
(dict) --
Information about an entity that is affected by a Health event.
entityArn (string) --
The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id ``. Example: ``arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
eventArn (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
entityValue (string) --
The ID of the affected entity.
entityUrl (string) --
The URL of the affected entity.
awsAccountId (string) --
The 12-digit Amazon Web Services account number that contains the affected entity.
lastUpdatedTime (datetime) --
The most recent time that the entity was updated.
statusCode (string) --
The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, UNKNOWN, PENDING, and RESOLVED.
resourceTags (dict) --
A map of resource tag key-value pairs attached to the affected entity.
(string) --
(string) --
accountTags (dict) --
A map of account tag key-value pairs attached to the affected entity.
(string) --
(string) --
tags (dict) --
A map of resource tag key-value pairs attached to the affected entity.
(string) --
(string) --
entityMetadata (dict) --
Additional metadata about the affected entity.
(string) --
(string) --
failedSet (list) --
A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.
(dict) --
Error information returned when a DescribeAffectedEntitiesForOrganization operation can't find or process a specific entity.
awsAccountId (string) --
The 12-digit Amazon Web Services account numbers that contains the affected entities.
eventArn (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
errorName (string) --
The name of the error.
errorMessage (string) --
A message that describes the error. Follow the error message and retry your request.
For example, the InvalidAccountInputError error message appears if you call the DescribeAffectedEntitiesForOrganization operation and specify the AccountSpecific value for the EventScopeCode parameter, but don't specify an Amazon Web Services account.
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': {'tags': {'string': ['string']}}}
Returns the number of entities that are affected by each of the specified events.
See also: AWS API Documentation
Request Syntax
client.describe_entity_aggregates(
eventArns=[
'string',
],
filter={
'tags': {
'string': [
'string',
]
}
}
)
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) --
dict
Values to narrow the results returned.
tags (dict) --
A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.
Only entities whose tags match are included in the aggregates.
(string) --
(list) --
(string) --
dict
Response Syntax
{
'entityAggregates': [
{
'eventArn': 'string',
'count': 123,
'statuses': {
'string': 123
}
},
]
}
Response Structure
(dict) --
entityAggregates (list) --
The number of entities that are affected by each of the specified events.
(dict) --
The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.
eventArn (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
count (integer) --
The number of entities that match the criteria for the specified events.
statuses (dict) --
The number of affected entities aggregated by the entity status codes.
(string) --
(integer) --
{'filter': {'tags': {'string': ['string']}}}
Returns a list of entity aggregates for your Organizations that are affected by each of the specified events.
See also: AWS API Documentation
Request Syntax
client.describe_entity_aggregates_for_organization(
eventArns=[
'string',
],
awsAccountIds=[
'string',
],
filter={
'tags': {
'string': [
'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) --
list
A list of 12-digit Amazon Web Services account numbers that contains the affected entities.
(string) --
dict
Values to narrow the results returned.
tags (dict) --
A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.
Only entities whose tags match are included in the aggregates.
(string) --
(list) --
(string) --
dict
Response Syntax
{
'organizationEntityAggregates': [
{
'eventArn': 'string',
'count': 123,
'statuses': {
'string': 123
},
'accounts': [
{
'accountId': 'string',
'count': 123,
'statuses': {
'string': 123
}
},
]
},
]
}
Response Structure
(dict) --
organizationEntityAggregates (list) --
The list of entity aggregates for each of the specified accounts that are affected by each of the specified events.
(dict) --
The aggregate results of entities affected by the specified event in your organization. The results are aggregated by the entity status codes for the specified set of accountsIDs.
eventArn (string) --
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"
count (integer) --
The number of entities for the organization that match the filter criteria for the specified events.
statuses (dict) --
The number of affected entities aggregated by the entitiy status codes.
(string) --
(integer) --
accounts (list) --
A list of entity aggregates for each of the specified accounts in your organization that are affected by a specific event. If there are no awsAccountIds provided in the request, this field will be empty in the response.
(dict) --
The number of entities in an account that are impacted by a specific event aggregated by the entity status codes.
accountId (string) --
The 12-digit Amazon Web Services account numbers that contains the affected entities.
count (integer) --
The number of entities that match the filter criteria for the specified events.
statuses (dict) --
The number of affected entities aggregated by the entity status codes.
(string) --
(integer) --
{'filter': {'tags': {'string': ['string']}}}
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={
'actionabilities': [
'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
],
'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',
],
'personas': [
'OPERATIONS'|'SECURITY'|'BILLING',
]
},
aggregateField='eventTypeCategory',
maxResults=123,
nextToken='string'
)
dict
Values to narrow the results returned.
actionabilities (list) --
A list of actionability values to filter events. Use this to filter events based on whether they require action ( ACTION_REQUIRED), may require action ( ACTION_MAY_BE_REQUIRED) or are informational ( INFORMATIONAL).
(string) --
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 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 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. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
(string) --
tags (dict) --
A map of resource tag key-value pairs to filter affected entities.
(string) --
(list) --
(string) --
eventStatusCodes (list) --
A list of event status codes.
(string) --
personas (list) --
A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.
(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.
{'filter': {'tags': {'string': ['string']}}}
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.
See also: AWS API Documentation
Request Syntax
client.describe_events(
filter={
'actionabilities': [
'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
],
'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',
],
'personas': [
'OPERATIONS'|'SECURITY'|'BILLING',
]
},
nextToken='string',
maxResults=123,
locale='string'
)
dict
Values to narrow the results returned.
actionabilities (list) --
A list of actionability values to filter events. Use this to filter events based on whether they require action ( ACTION_REQUIRED), may require action ( ACTION_MAY_BE_REQUIRED) or are informational ( INFORMATIONAL).
(string) --
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 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 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. Possible values are issue, accountNotification, or scheduledChange. Currently, the investigation value isn't supported at this time.
(string) --
tags (dict) --
A map of resource tag key-value pairs to filter affected entities.
(string) --
(list) --
(string) --
eventStatusCodes (list) --
A list of event status codes.
(string) --
personas (list) --
A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.
(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 1 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',
'actionability': 'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
'personas': [
'OPERATIONS'|'SECURITY'|'BILLING',
]
},
],
'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 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.
If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
If the 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.
If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
actionability (string) --
The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.
personas (list) --
A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
(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.
{'filter': {'tags': {'string': ['string']}}}
Returns information about events across your organization in Organizations. You can use the filters parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:
If you don't specify a filter, the DescribeEventsForOrganizations returns all events across your organization. Results are sorted by lastModifiedTime, starting with the most recent event.
For more information about the different types of Health events, see Event.
Before you can call this operation, you must first enable Health to work with Organizations. To do this, call the EnableHealthServiceAccessForOrganization operation from your organization's management account.
See also: AWS API Documentation
Request Syntax
client.describe_events_for_organization(
filter={
'actionabilities': [
'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
],
'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',
],
'personas': [
'OPERATIONS'|'SECURITY'|'BILLING',
],
'tags': {
'string': [
'string',
]
}
},
nextToken='string',
maxResults=123,
locale='string'
)
dict
Values to narrow the results returned.
actionabilities (list) --
A list of actionability values to filter events. Use this to filter events based on whether they require action ( ACTION_REQUIRED), may require action ( ACTION_MAY_BE_REQUIRED) or are informational ( INFORMATIONAL).
(string) --
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 Amazon Web Services account numbers that contains the affected entities.
(string) --
services (list) --
The Amazon Web Services services associated with the event. For example, EC2, RDS.
(string) --
regions (list) --
A list of Amazon Web Services 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) --
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, or scheduledChange. Currently, the investigation value isn't supported at this time.
(string) --
eventStatusCodes (list) --
A list of event status codes.
(string) --
personas (list) --
A list of persona values to filter events. Use this to filter events based on their target audience: OPERATIONS, SECURITY, or BILLING.
(string) --
tags (dict) --
A map of tag keys to lists of tag values. A tag matches when its key is in the map and its value is one of the values listed for that key. Matching is case sensitive, and the filter matches when at least one key in the map matches.
An event is returned when one of its affected accounts, or one of the entities of those accounts, has tags that match.
(string) --
(list) --
(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 1 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',
'actionability': 'ACTION_REQUIRED'|'ACTION_MAY_BE_REQUIRED'|'INFORMATIONAL',
'personas': [
'OPERATIONS'|'SECURITY'|'BILLING',
]
},
],
'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. 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, such as EC2 and 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.
eventScopeCode (string) --
This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.
If the eventScopeCode value is PUBLIC, then the affectedAccounts value is always empty.
If the 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.
If the eventScopeCode value is NONE, then the eventArn that you specified in the request is invalid or doesn't exist.
region (string) --
The Amazon Web Services 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.
actionability (string) --
The actionability classification of the event. Possible values are ACTION_REQUIRED, ACTION_MAY_BE_REQUIRED and INFORMATIONAL. Events with ACTION_REQUIRED actionability require customer action to resolve or mitigate the event. Events with ACTION_MAY_BE_REQUIRED actionability indicates that the current status is unknown or conditional and inspection is needed to determine if action is required. Events with INFORMATIONAL actionability are provided for awareness and do not require immediate action.
personas (list) --
A list of persona classifications that indicate the target audience for the event. Possible values are OPERATIONS, SECURITY, and BILLING. Events can be associated with multiple personas to indicate relevance to different teams or roles within an organization.
(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.