Skip to content

aws.cognito_idp.list_user_pools

Example SQL Queries

SELECT * FROM
aws.cognito_idp.list_user_pools
WHERE
"max_results" = 'VALUE';

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

Table Definition

Column NameColumn Data Type
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
creation_date

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.

TIMESTAMP_S
id

The ID in a user pool description.

VARCHAR
lambda_config

The Lambda configuration information in a user pool description.

STRUCT(
"pre_sign_up" VARCHAR,
"custom_message" VARCHAR,
"post_confirmation" VARCHAR,
"pre_authentication" VARCHAR,
"post_authentication" VARCHAR,
"define_auth_challenge" VARCHAR,
"create_auth_challenge" VARCHAR,
"verify_auth_challenge_response" VARCHAR,
"pre_token_generation" VARCHAR,
"user_migration" VARCHAR,
"pre_token_generation_config" STRUCT(
"lambda_version" VARCHAR,
"lambda_arn" VARCHAR
),
"custom_sms_sender" STRUCT(
"lambda_version" VARCHAR,
"lambda_arn" VARCHAR
),
"custom_email_sender" STRUCT(
"lambda_version" VARCHAR,
"lambda_arn" VARCHAR
),
"kms_key_id" VARCHAR
)
Show child fields
lambda_config.create_auth_challenge

Creates an authentication challenge.

lambda_config.custom_email_sender

A custom email sender Lambda trigger.

Show child fields
lambda_config.custom_email_sender.lambda_arn

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambda_config.custom_email_sender.lambda_version

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.

lambda_config.custom_message

A custom Message Lambda trigger.

lambda_config.custom_sms_sender

A custom SMS sender Lambda trigger.

Show child fields
lambda_config.custom_sms_sender.lambda_arn

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

lambda_config.custom_sms_sender.lambda_version

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.

lambda_config.define_auth_challenge

Defines the authentication challenge.

lambda_config.kms_key_id

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.

lambda_config.post_authentication

A post-authentication Lambda trigger.

lambda_config.post_confirmation

A post-confirmation Lambda trigger.

lambda_config.pre_authentication

A pre-authentication Lambda trigger.

lambda_config.pre_sign_up

A pre-registration Lambda trigger.

lambda_config.pre_token_generation

The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.

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.

You can set

lambda_config.pre_token_generation_config

The detailed configuration of a pre token generation trigger. If you also set an ARN in PreTokenGeneration, its value must be identical to PreTokenGenerationConfig.

Show child fields
lambda_config.pre_token_generation_config.lambda_arn

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.

lambda_config.pre_token_generation_config.lambda_version

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.

lambda_config.user_migration

The user migration Lambda config type.

lambda_config.verify_auth_challenge_response

Verifies the authentication challenge response.

last_modified_date

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.

TIMESTAMP_S
name

The name in a user pool description.

VARCHAR
status

The user pool status in a user pool description.

VARCHAR