List User Pools

cognitoidentityprovider_list_user_pools

R Documentation

Lists user pools and their details in the current Amazon Web Services account

Description

Lists user pools and their details in the current 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

• Signing Amazon Web Services API Requests

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

Usage

cognitoidentityprovider_list_user_pools(NextToken, MaxResults)

Arguments

NextToken	This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.
MaxResults	[required] The maximum number of user pools that you want Amazon Cognito to return in the response.

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"|"V3_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
)