:doc:`CognitoIdentityProvider <../../cognito-idp>` / Paginator / ListUserPoolClients

*******************
ListUserPoolClients
*******************



.. py:class:: CognitoIdentityProvider.Paginator.ListUserPoolClients

  ::

    
    paginator = client.get_paginator('list_user_pool_clients')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CognitoIdentityProvider.Client.list_user_pool_clients`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/ListUserPoolClients>`_    


    **Request Syntax**
    ::

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

      The ID of the user pool where you want to list user pool clients.

      

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

      
      ::

        {
            'UserPoolClients': [
                {
                    'ClientId': 'string',
                    'UserPoolId': 'string',
                    'ClientName': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the response from the server that lists user pool clients.

        
        

        - **UserPoolClients** *(list) --* 

          An array of app clients and their details. Includes app client ID and name.

          
          

          - *(dict) --* 

            A short description of a user pool app client.

            
            

            - **ClientId** *(string) --* 

              The app client ID.

              
            

            - **UserPoolId** *(string) --* 

              The ID of the user pool that's associated with the app client.

              
            

            - **ClientName** *(string) --* 

              The app client name.

              
        
      
    