Skip to content
AWS for Query.Farm

aws.cognito_idp.describe_user_pool_domain

Example SQL Queries

SELECT * FROM
aws.cognito_idp.describe_user_pool_domain
WHERE
"domain" = 'VALUE';

Description

Gets information about a domain.

Table Definition

Column NameColumn Data Type
domain Required Input Column

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

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
domain_description

A domain description object containing information about the domain.

STRUCT(
    "user_pool_id" VARCHAR,
    "aws_account_id" VARCHAR,
    "domain" VARCHAR,
    "s3_bucket" VARCHAR,
    "cloud_front_distribution" VARCHAR,
    "version" VARCHAR,
    "status" VARCHAR,
    "custom_domain_config" STRUCT(
        "certificate_arn" VARCHAR
    )
)
Show child fields
domain_description.aws_account_id

The Amazon Web Services ID for the user pool owner.

domain_description.cloud_front_distribution

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

domain_description.custom_domain_config

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Show child fields
domain_description.custom_domain_config.certificate_arn

The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

domain_description.domain

The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

domain_description.s3_bucket

The Amazon S3 bucket where the static files for this domain are stored.

domain_description.status

The domain status.

domain_description.user_pool_id

The user pool ID.

domain_description.version

The app version.