Skip to content

List User Pools

cognitoidentityprovider_list_user_pools R Documentation

Lists the user pools associated with an Amazon Web Services account

Description

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

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

Usage

cognitoidentityprovider_list_user_pools(NextToken, MaxResults)

Arguments

NextToken

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

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

Value

A list with the following syntax: 

list(
  UserPools = list(
    list(
      Id = "string",
      Name = "string",
      LambdaConfig = list(
        PreSignUp = "string",
        CustomMessage = "string",
        PostConfirmation = "string",
        PreAuthentication = "string",
        PostAuthentication = "string",
        DefineAuthChallenge = "string",
        CreateAuthChallenge = "string",
        VerifyAuthChallengeResponse = "string",
        PreTokenGeneration = "string",
        UserMigration = "string",
        PreTokenGenerationConfig = list(
          LambdaVersion = "V1_0"|"V2_0",
          LambdaArn = "string"
        ),
        CustomSMSSender = list(
          LambdaVersion = "V1_0",
          LambdaArn = "string"
        ),
        CustomEmailSender = list(
          LambdaVersion = "V1_0",
          LambdaArn = "string"
        ),
        KMSKeyID = "string"
      ),
      Status = "Enabled"|"Disabled",
      LastModifiedDate = as.POSIXct(
        "2015-01-01"
      ),
      CreationDate = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_user_pools(
  NextToken = "string",
  MaxResults = 123
)