Given a user pool domain name, returns information about the domain configuration¶

Description¶

Given a user pool domain name, returns information about the domain configuration.

This operation doesn't return results when you query a prefix domain in a secondary Region. Prefix domains are Region-specific and can only be described in the Region where they were created. To describe a prefix domain for a replica user pool, make the request to the primary Region's endpoint.

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_describe_user_pool_domain(Domain)

Arguments¶

• Domain

  [required] The domain that you want to describe. 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.

Value¶

A list with the following syntax:

list(
  DomainDescription = list(
    UserPoolId = "string",
    AWSAccountId = "string",
    Domain = "string",
    S3Bucket = "string",
    CloudFrontDistribution = "string",
    Version = "string",
    Status = "CREATING"|"DELETING"|"UPDATING"|"ACTIVE"|"FAILED",
    CustomDomainConfig = list(
      CertificateArn = "string",
      SecurityPolicy = "TLS_V1"|"TLS_V1_2_2021"|"TLS_V1_3_2025"
    ),
    ManagedLoginVersion = 123,
    Routing = list(
      Failover = list(
        SecondaryRegion = "string",
        PrimaryRoute53HealthCheckId = "string"
      )
    )
  )
)

Request syntax¶

svc$describe_user_pool_domain(
  Domain = "string"
)