describe_affected_entities_for_organization
(**kwargs)¶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.
Note
nextToken
parameter in the next request to return more results.See also: AWS API Documentation
Request Syntax
response = client.describe_affected_entities_for_organization(
organizationEntityFilters=[
{
'eventArn': 'string',
'awsAccountId': 'string'
},
],
locale='string',
nextToken='string',
maxResults=123
)
[REQUIRED]
A JSON set of elements including the awsAccountId
and the eventArn
.
The values used to filter results from the DescribeEventDetailsForOrganization and DescribeAffectedEntitiesForOrganization operations.
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
The 12-digit Amazon Web Services account numbers that contains the affected entities.
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
{
'entities': [
{
'entityArn': 'string',
'eventArn': 'string',
'entityValue': 'string',
'entityUrl': 'string',
'awsAccountId': 'string',
'lastUpdatedTime': datetime(2015, 1, 1),
'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN',
'tags': {
'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
, and UNKNOWN
.
tags (dict) --
A map of entity tags attached to the affected entity.
Note
Currently, the tags
property isn't supported.
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) --
The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION
. For example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT
.
nextToken (string) --
If the results of a search are large, only a portion of the results are returned, and a nextToken
pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.
Exceptions
Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale