Health / Client / describe_affected_entities

describe_affected_entities#

Health.Client.describe_affected_entities(**kwargs)#

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.

Note

This API operation uses pagination. Specify the nextToken parameter in the next request to return more results.
This operation supports resource-level permissions. You can use this operation to allow or deny access to specific Health events. For more information, see Resource- and action-based conditions in the Health User Guide.

Request Syntax

response = 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
)

Parameters:

filter (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 (list) –
  
  A map of entity tags attached to the affected entity.
  
  Note
  Currently, the tags property isn’t supported.
  - (dict) –
    - (string) –
      - (string) –
- statusCodes (list) –
  
  A list of entity status codes ( IMPAIRED, UNIMPAIRED, or UNKNOWN).
  - (string) –
locale (string) – The locale (language) to return information in. English (en) is the default and the only supported value at this time.
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.
maxResults (integer) – The maximum number of items to return in one batch, between 10 and 100, inclusive.

Return type:

dict

Returns:

Response Syntax

{
    'entities': [
        {
            'entityArn': 'string',
            'eventArn': 'string',
            'entityValue': 'string',
            'entityUrl': 'string',
            'awsAccountId': 'string',
            'lastUpdatedTime': datetime(2015, 1, 1),
            'statusCode': 'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN'|'PENDING'|'RESOLVED',
            '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, and UNKNOWN.
    - tags (dict) –
      
      A map of entity tags attached to the affected entity.
      
      Note
      Currently, the tags property isn’t supported.
      - (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.

Exceptions

Health.Client.exceptions.InvalidPaginationToken
Health.Client.exceptions.UnsupportedLocale