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

*************
ListUserPools
*************



.. py:class:: CognitoIdentityProvider.Paginator.ListUserPools

  ::

    
    paginator = client.get_paginator('list_user_pools')

  
  

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

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

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


    **Request Syntax**
    ::

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

      
      ::

        {
            'UserPools': [
                {
                    'Id': 'string',
                    'Name': 'string',
                    'LambdaConfig': {
                        'PreSignUp': 'string',
                        'CustomMessage': 'string',
                        'PostConfirmation': 'string',
                        'PreAuthentication': 'string',
                        'PostAuthentication': 'string',
                        'DefineAuthChallenge': 'string',
                        'CreateAuthChallenge': 'string',
                        'VerifyAuthChallengeResponse': 'string',
                        'PreTokenGeneration': 'string',
                        'UserMigration': 'string',
                        'PreTokenGenerationConfig': {
                            'LambdaVersion': 'V1_0'|'V2_0'|'V3_0',
                            'LambdaArn': 'string'
                        },
                        'CustomSMSSender': {
                            'LambdaVersion': 'V1_0',
                            'LambdaArn': 'string'
                        },
                        'CustomEmailSender': {
                            'LambdaVersion': 'V1_0',
                            'LambdaArn': 'string'
                        },
                        'KMSKeyID': 'string',
                        'InboundFederation': {
                            'LambdaVersion': 'V1_0',
                            'LambdaArn': 'string'
                        }
                    },
                    'Status': 'Enabled'|'Disabled',
                    'LastModifiedDate': datetime(2015, 1, 1),
                    'CreationDate': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the response to list user pools.

        
        

        - **UserPools** *(list) --* 

          An array of user pools and their configuration details.

          
          

          - *(dict) --* 

            A short description of a user pool.

            
            

            - **Id** *(string) --* 

              The user pool ID.

              
            

            - **Name** *(string) --* 

              The user pool name.

              
            

            - **LambdaConfig** *(dict) --* 

              A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

              
              

              - **PreSignUp** *(string) --* 

                The configuration of a `pre sign-up Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html>`__ in a user pool. This trigger evaluates new users and can bypass confirmation, `link a federated user profile <https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html>`__, or block sign-up requests.

                
              

              - **CustomMessage** *(string) --* 

                A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.

                
              

              - **PostConfirmation** *(string) --* 

                The configuration of a `post confirmation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html>`__ in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

                
              

              - **PreAuthentication** *(string) --* 

                The configuration of a `pre authentication trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html>`__ in a user pool. This trigger can evaluate and modify user sign-in events.

                
              

              - **PostAuthentication** *(string) --* 

                The configuration of a `post authentication Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html>`__ in a user pool. This trigger can take custom actions after a user signs in.

                
              

              - **DefineAuthChallenge** *(string) --* 

                The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`__.

                
              

              - **CreateAuthChallenge** *(string) --* 

                The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`__.

                
              

              - **VerifyAuthChallengeResponse** *(string) --* 

                The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the `custom authentication challenge triggers <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html>`__.

                
              

              - **PreTokenGeneration** *(string) --* 

                The legacy configuration of a `pre token generation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html>`__ in a user pool.

                 

                Set this parameter for legacy purposes. If you also set an ARN in ``PreTokenGenerationConfig``, its value must be identical to ``PreTokenGeneration``. For new instances of pre token generation triggers, set the ``LambdaArn`` of ``PreTokenGenerationConfig``.

                
              

              - **UserMigration** *(string) --* 

                The configuration of a `migrate user Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html>`__ in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

                
              

              - **PreTokenGenerationConfig** *(dict) --* 

                The detailed configuration of a `pre token generation Lambda trigger <https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html>`__ in a user pool. If you also set an ARN in ``PreTokenGeneration``, its value must be identical to ``PreTokenGenerationConfig``.

                
                

                - **LambdaVersion** *(string) --* 

                  The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

                  
                

                - **LambdaArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

                   

                  This parameter and the ``PreTokenGeneration`` property of ``LambdaConfig`` have the same value. For new instances of pre token generation triggers, set ``LambdaArn``.

                  
            
              

              - **CustomSMSSender** *(dict) --* 

                The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

                
                

                - **LambdaVersion** *(string) --* 

                  The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

                   

                  You must use a ``LambdaVersion`` of ``V1_0`` with a custom sender function.

                  
                

                - **LambdaArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

                  
            
              

              - **CustomEmailSender** *(dict) --* 

                The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

                
                

                - **LambdaVersion** *(string) --* 

                  The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

                   

                  You must use a ``LambdaVersion`` of ``V1_0`` with a custom sender function.

                  
                

                - **LambdaArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

                  
            
              

              - **KMSKeyID** *(string) --* 

                The ARN of an `KMS key <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys>`__. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

                
              

              - **InboundFederation** *(dict) --* 

                The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

                
                

                - **LambdaVersion** *(string) --* 

                  The user pool trigger version of the request that Amazon Cognito sends to your Lambda function. Higher-numbered versions add fields that support new features.

                   

                  You must use a ``LambdaVersion`` of ``V1_0`` with an inbound federation function.

                  
                

                - **LambdaArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

                  
            
          
            

            - **Status** *(string) --* 

              The user pool status.

              
            

            - **LastModifiedDate** *(datetime) --* 

              The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ``Date`` object.

              
            

            - **CreationDate** *(datetime) --* 

              The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ``Date`` object.

              
        
      
    