Skip to content
AWS for Query.Farm

aws.cognito_identity.describe_identity_pool

Example SQL Queries

SELECT * FROM
aws.cognito_identity.describe_identity_pool
WHERE
"identity_pool_id" = 'VALUE';

Description

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

Table Definition

Column NameColumn Data Type
identity_pool_id Required Input Column

An identity pool ID in the format REGION:GUID.

VARCHAR
_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
allow_classic_flow

Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.

BOOLEAN
allow_unauthenticated_identities

TRUE if the identity pool supports unauthenticated logins.

BOOLEAN
cognito_identity_providers

A list representing an Amazon Cognito user pool and its client ID.

STRUCT(
    "provider_name" VARCHAR,
    "client_id" VARCHAR,
    "server_side_token_check" BOOLEAN
)[]
Show child fields
cognito_identity_providers[]
Show child fields
cognito_identity_providers[].client_id

The client ID for the Amazon Cognito user pool.

cognito_identity_providers[].provider_name

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

cognito_identity_providers[].server_side_token_check

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

developer_provider_name

The "domain" by which Cognito will refer to your users.

VARCHAR
identity_pool_name

A string that you provide.

VARCHAR
identity_pool_tags

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

MAP(VARCHAR, VARCHAR)
open_id_connect_provider_ar_ns

The ARNs of the OpenID Connect providers.

VARCHAR[]
Show child fields
open_id_connect_provider_ar_ns[]
saml_provider_ar_ns

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

VARCHAR[]
Show child fields
saml_provider_ar_ns[]
supported_login_providers

Optional key:value pairs mapping provider names to provider app IDs.

MAP(VARCHAR, VARCHAR)