CognitoIdentityProvider / Paginator / ListUserPools

ListUserPools

class CognitoIdentityProvider.Paginator.ListUserPools

paginator = client.get_paginator('list_user_pools')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CognitoIdentityProvider.Client.list_user_pools().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

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.

Return type:

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',
                'PreTokenGenerationConfig': {
                    'LambdaVersion': 'V1_0'|'V2_0',
                    'LambdaArn': 'string'
                },
                'UserMigration': 'string',
                'CustomSMSSender': {
                    'LambdaVersion': 'V1_0',
                    'LambdaArn': 'string'
                },
                'CustomEmailSender': {
                    'LambdaVersion': 'V1_0',
                    'LambdaArn': 'string'
                },
                'KMSKeyID': '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) –

    The user pools from the response to list users.

    • (dict) –

      A user pool description.

      • Id (string) –

        The ID in a user pool description.

      • Name (string) –

        The name in a user pool description.

      • LambdaConfig (dict) –

        The Lambda configuration information in a user pool description.

        • PreSignUp (string) –

          A pre-registration Lambda trigger.

        • CustomMessage (string) –

          A custom Message Lambda trigger.

        • PostConfirmation (string) –

          A post-confirmation Lambda trigger.

        • PreAuthentication (string) –

          A pre-authentication Lambda trigger.

        • PostAuthentication (string) –

          A post-authentication Lambda trigger.

        • DefineAuthChallenge (string) –

          Defines the authentication challenge.

        • CreateAuthChallenge (string) –

          Creates an authentication challenge.

        • VerifyAuthChallengeResponse (string) –

          Verifies the authentication challenge response.

        • PreTokenGeneration (string) –

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

          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.

          You can set

        • PreTokenGenerationConfig (dict) –

          The detailed configuration of a pre token generation trigger. 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.

        • UserMigration (string) –

          The user migration Lambda config type.

        • CustomSMSSender (dict) –

          A custom SMS sender Lambda trigger.

          • 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) –

          A custom email sender Lambda trigger.

          • 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 Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

      • Status (string) –

        The user pool status in a user pool description.

      • LastModifiedDate (datetime) –

        The date and time, in ISO 8601 format, when the item was modified.

      • CreationDate (datetime) –

        The date and time, in ISO 8601 format, when the item was created.