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.

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',
                '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 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) –

          A Lambda trigger that is invoked before token generation.

        • UserMigration (string) –

          The user migration Lambda config type.

        • CustomSMSSender (dict) –

          A custom SMS sender Lambda trigger.

          • LambdaVersion (string) –

            Signature of the “request” attribute in the “event” information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0.

          • LambdaArn (string) –

            The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.

        • CustomEmailSender (dict) –

          A custom email sender Lambda trigger.

          • LambdaVersion (string) –

            Signature of the “request” attribute in the “event” information Amazon Cognito passes to your custom email Lambda function. The only supported value is V1_0.

          • LambdaArn (string) –

            The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.

        • 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 the user pool description was last modified.

      • CreationDate (datetime) –

        The date the user pool description was created.

  • 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