CognitoIdentityProvider / Client / describe_user_pool_domain

describe_user_pool_domain#

CognitoIdentityProvider.Client.describe_user_pool_domain(**kwargs)#

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

Note

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

See also: AWS API Documentation

Request Syntax

response = client.describe_user_pool_domain(
    Domain='string'
)
Parameters:

Domain (string) –

[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.

Return type:

dict

Returns:

Response Syntax

{
    'DomainDescription': {
        'UserPoolId': 'string',
        'AWSAccountId': 'string',
        'Domain': 'string',
        'S3Bucket': 'string',
        'CloudFrontDistribution': 'string',
        'Version': 'string',
        'Status': 'CREATING'|'DELETING'|'UPDATING'|'ACTIVE'|'FAILED',
        'CustomDomainConfig': {
            'CertificateArn': 'string'
        },
        'ManagedLoginVersion': 123
    }
}

Response Structure

  • (dict) –

    • DomainDescription (dict) –

      The details of the requested user pool domain.

      • UserPoolId (string) –

        The ID of the user pool that the domain is attached to.

      • AWSAccountId (string) –

        The Amazon Web Services account that you created the user pool in.

      • Domain (string) –

        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.

      • S3Bucket (string) –

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

      • CloudFrontDistribution (string) –

        The Amazon CloudFront endpoint that hosts your custom domain.

      • Version (string) –

        The app version.

      • Status (string) –

        The domain status.

      • CustomDomainConfig (dict) –

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

        • CertificateArn (string) –

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

      • ManagedLoginVersion (integer) –

        The version of managed login branding that you want to apply to your domain. A value of 1 indicates hosted UI (classic) branding and a version of 2 indicates managed login branding.

        Managed login requires that your user pool be configured for any feature plan other than Lite.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException