Menu
Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

DescribeUserPoolDomain

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.

Domain

The domain string.

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.

DomainDescription

A domain description object containing information about the domain.

Type: DomainDescriptionType object

Errors

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

InternalErrorException

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

HTTP Status Code: 500

InvalidParameterException

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

HTTP Status Code: 400

NotAuthorizedException

This exception is thrown when a user is not authorized.

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when the Amazon Cognito service cannot find the requested resource.

HTTP Status Code: 400

See Also

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