:doc:`SSO <../../sso>` / Paginator / ListAccounts

************
ListAccounts
************



.. py:class:: SSO.Paginator.ListAccounts

  ::

    
    paginator = client.get_paginator('list_accounts')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SSO.Client.list_accounts`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sso-2019-06-10/ListAccounts>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          accessToken='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type accessToken: string
    :param accessToken: **[REQUIRED]** 

      The token issued by the ``CreateToken`` API call. For more information, see `CreateToken <https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html>`__ in the *IAM Identity Center OIDC API Reference Guide*.

      

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

      
      ::

        {
            'accountList': [
                {
                    'accountId': 'string',
                    'accountName': 'string',
                    'emailAddress': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **accountList** *(list) --* 

          A paginated response with the list of account information and the next token if more results are available.

          
          

          - *(dict) --* 

            Provides information about your AWS account.

            
            

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

              The identifier of the AWS account that is assigned to the user.

              
            

            - **accountName** *(string) --* 

              The display name of the AWS account that is assigned to the user.

              
            

            - **emailAddress** *(string) --* 

              The email address of the AWS account that is assigned to the user.

              
        
      
        

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

          A token to resume pagination.

          
    