Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cognito-idp ]

list-user-pools

Description

Lists the user pools associated with an account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-user-pools is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: UserPools

Synopsis

  list-user-pools
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To list user pools

This example lists up to 20 user pools.

Command:

aws cognito-idp list-user-pools --max-results 20

Output:

{
  "UserPools": [
      {
         "CreationDate": 1547763720.822,
         "LastModifiedDate": 1547763720.822,
         "LambdaConfig": {},
         "Id": "us-west-2_aaaaaaaaa",
         "Name": "MyUserPool"
      }
  ]
}

Output

UserPools -> (list)

The user pools from the response to list users.

(structure)

A user pool description.

Id -> (string)

The ID in a user pool description.

Name -> (string)

The name in a user pool description.

LambdaConfig -> (structure)

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 -> (structure)

A custom SMS sender Lambda trigger.

LambdaVersion -> (string)

The Lambda version represents the signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom SMS Lambda function. The only supported value is V1_0 .

LambdaArn -> (string)

The Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send SMS notifications to users.

CustomEmailSender -> (structure)

A custom email sender Lambda trigger.

LambdaVersion -> (string)

The Lambda version represents the 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 Lambda Amazon Resource Name of the Lambda function that Amazon Cognito triggers to send email notifications to users.

KMSKeyID -> (string)

The Amazon Resource Name of Key Management Service Customer master keys . 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 -> (timestamp)

The date the user pool description was last modified.

CreationDate -> (timestamp)

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.