CognitoIdentityProvider / Client / list_user_pools

list_user_pools

CognitoIdentityProvider.Client.list_user_pools(**kwargs)

Lists the user pools associated with an Amazon Web Services account.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See also: AWS API Documentation

Request Syntax

response = client.list_user_pools(
    NextToken='string',
    MaxResults=123
)

Parameters:

• NextToken (string) – An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

• MaxResults (integer) –

  [REQUIRED]

  The maximum number of results you want the request to return when listing the user pools.

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',
                'UserMigration': 'string',
                'PreTokenGenerationConfig': {
                    'LambdaVersion': 'V1_0'|'V2_0',
                    'LambdaArn': '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)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the response to list user pools.

  • UserPools (list) –

    The user pools from the response to list users.

    • (dict) –

      A short description of a user pool.

      This data type is a response parameter of ListUserPools.

      • 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 in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile, 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 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 in a user pool. This trigger can evaluate and modify user sign-in events.

        • PostAuthentication (string) –

          The configuration of a post authentication Lambda trigger 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.

        • CreateAuthChallenge (string) –

          The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

        • VerifyAuthChallengeResponse (string) –

          The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

        • PreTokenGeneration (string) –

          The legacy configuration of a pre token generation Lambda trigger 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 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 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. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

      • 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.

  • NextToken (string) –

    An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Exceptions

• CognitoIdentityProvider.Client.exceptions.InvalidParameterException

• CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

• CognitoIdentityProvider.Client.exceptions.InternalErrorException