:doc:`Inspector2 <../../inspector2>` / Paginator / ListMembers

***********
ListMembers
***********



.. py:class:: Inspector2.Paginator.ListMembers

  ::

    
    paginator = client.get_paginator('list_members')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Inspector2.Client.list_members`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/ListMembers>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          onlyAssociated=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type onlyAssociated: boolean
    :param onlyAssociated: 

      Specifies whether to list only currently associated members if ``True`` or to list all members within the organization if ``False``.

      

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

      
      ::

        {
            'members': [
                {
                    'accountId': 'string',
                    'relationshipStatus': 'CREATED'|'INVITED'|'DISABLED'|'ENABLED'|'REMOVED'|'RESIGNED'|'DELETED'|'EMAIL_VERIFICATION_IN_PROGRESS'|'EMAIL_VERIFICATION_FAILED'|'REGION_DISABLED'|'ACCOUNT_SUSPENDED'|'CANNOT_CREATE_DETECTOR_IN_ORG_MASTER',
                    'delegatedAdminAccountId': 'string',
                    'updatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **members** *(list) --* 

          An object that contains details for each member account.

          
          

          - *(dict) --* 

            Details on a member account in your organization.

            
            

            - **accountId** *(string) --* 

              The Amazon Web Services account ID of the member account.

              
            

            - **relationshipStatus** *(string) --* 

              The status of the member account.

              
            

            - **delegatedAdminAccountId** *(string) --* 

              The Amazon Web Services account ID of the Amazon Inspector delegated administrator for this member account.

              
            

            - **updatedAt** *(datetime) --* 

              A timestamp showing when the status of this member was last updated.

              
        
      
        

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

          A token to resume pagination.

          
    