:doc:`Health <../../health>` / Client / describe_affected_entities_for_organization

*******************************************
describe_affected_entities_for_organization
*******************************************



.. py:method:: Health.Client.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 <https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html>`__ operation from your organization's management account.

   

  .. note::

    

    
    * This API operation uses pagination. Specify the ``nextToken`` parameter in the next request to return more results.
     
    * This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific Health events. For more information, see `Resource- and action-based conditions <https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions>`__ in the *Health User Guide*.
    

    

  

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


  **Request Syntax**
  ::

    response = 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',
                ]
            },
        ]
    )
    
  :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 nextToken: string
  :param nextToken: 

    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.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of items to return in one batch, between 1 and 100, inclusive.

    

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

        
    
    

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

        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**
  
  *   :py:class:`Health.Client.exceptions.InvalidPaginationToken`

  
  *   :py:class:`Health.Client.exceptions.UnsupportedLocale`

  