DescribeAffectedEntities¶

class Health.Paginator.DescribeAffectedEntities¶

paginator = client.get_paginator('describe_affected_entities')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Health.Client.describe_affected_entities().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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',
        ]
    },
    locale='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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.
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

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',
            'tags': {
                '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) --
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribeAffectedEntities¶