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

***************************************
DescribeAffectedAccountsForOrganization
***************************************



.. py:class:: Health.Paginator.DescribeAffectedAccountsForOrganization

  ::

    
    paginator = client.get_paginator('describe_affected_accounts_for_organization')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          eventArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type eventArn: string
    :param eventArn: **[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``

      

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

      
      ::

        {
            'affectedAccounts': [
                'string',
            ],
            'eventScopeCode': 'PUBLIC'|'ACCOUNT_SPECIFIC'|'NONE',
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **affectedAccounts** *(list) --* 

          A JSON set of elements of the affected accounts.

          
          

          - *(string) --* 
      
        

        - **eventScopeCode** *(string) --* 

          This parameter specifies if the Health event is a public Amazon Web Services service event or an account-specific event.

           

          
          * If the ``eventScopeCode`` value is ``PUBLIC``, then the ``affectedAccounts`` value is always empty.
           
          * If the ``eventScopeCode`` value is ``ACCOUNT_SPECIFIC``, then the ``affectedAccounts`` value lists the affected Amazon Web Services accounts in your organization. For example, if an event affects a service such as Amazon Elastic Compute Cloud and you have Amazon Web Services accounts that use that service, those account IDs appear in the response.
           
          * If the ``eventScopeCode`` value is ``NONE``, then the ``eventArn`` that you specified in the request is invalid or doesn't exist.
          

          
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    