describe_user_pool_domain

CognitoIdentityProvider.Client.describe_user_pool_domain(**kwargs)

Gets information about a domain.

See also: AWS API Documentation

Request Syntax

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

Parameters

Domain (string) --

[REQUIRED]

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 .

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'
        }
    }
}

Response Structure

• (dict) --
  • DomainDescription (dict) --

    A domain description object containing information about the domain.

    • UserPoolId (string) --

      The user pool ID.

    • AWSAccountId (string) --

      The Amazon Web Services ID for the user pool owner.

    • 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 Resource Name (ARN) of the Amazon CloudFront distribution.

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

Exceptions

• CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
• CognitoIdentityProvider.Client.exceptions.InvalidParameterException
• CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException
• CognitoIdentityProvider.Client.exceptions.InternalErrorException