:doc:`Health <../../health>` / Paginator / DescribeAffectedEntitiesForOrganization

***************************************
DescribeAffectedEntitiesForOrganization
***************************************



.. py:class:: Health.Paginator.DescribeAffectedEntitiesForOrganization

  ::

    
    paginator = client.get_paginator('describe_affected_entities_for_organization')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Health.Client.describe_affected_entities_for_organization`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/health-2016-08-04/DescribeAffectedEntitiesForOrganization>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          organizationEntityFilters=[
              {
                  'eventArn': 'string',
                  'awsAccountId': 'string'
              },
          ],
          locale='string',
          organizationEntityAccountFilters=[
              {
                  'eventArn': 'string',
                  'awsAccountId': 'string',
                  'statusCodes': [
                      'IMPAIRED'|'UNIMPAIRED'|'UNKNOWN'|'PENDING'|'RESOLVED',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type organizationEntityFilters: list
    :param organizationEntityFilters: 

      A JSON set of elements including the ``awsAccountId`` and the ``eventArn``.

      

    
      - *(dict) --* 

        The values used to filter results from the `DescribeEventDetailsForOrganization <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html>`__ and `DescribeAffectedEntitiesForOrganization <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html>`__ 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.

          

        
      
  
    :type locale: string
    :param locale: 

      The locale (language) to return information in. English (en) is the default and the only supported value at this time.

      

    
    :type organizationEntityAccountFilters: list
    :param organizationEntityAccountFilters: 

      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) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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'
                    }
                },
            ],
            '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``.

              
            

            - **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) --* 
          
        
        
      
        

        - **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 <https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html>`__ 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) --* 

          A token to resume pagination.

          
    