DescribeUserPoolDomain - Amazon Cognito User Pools
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Gets information about a domain.

Request Syntax

{ "Domain": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-z0-9](?:[a-z0-9\-]{0,61}[a-z0-9])?$

Required: Yes

Response Syntax

{ "DomainDescription": { "AWSAccountId": "string", "CloudFrontDistribution": "string", "CustomDomainConfig": { "CertificateArn": "string" }, "Domain": "string", "S3Bucket": "string", "Status": "string", "UserPoolId": "string", "Version": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


A domain description object containing information about the domain.

Type: DomainDescriptionType object


For information about the errors that are common to all actions, see Common Errors.


This exception is thrown when Amazon Cognito encounters an internal error.

HTTP Status Code: 500


This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

HTTP Status Code: 400


This exception is thrown when a user isn't authorized.

HTTP Status Code: 400


This exception is thrown when the Amazon Cognito service can't find the requested resource.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: