/ - Amazon Cognito Identity Provider

Gets information about a domain.

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

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

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.

>= 1 characters<= 63 characters

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

DomainDescription

object

optional

A domain description object containing information about the domain.

UserPoolId

string

optional

The user pool ID.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

AWSAccountId

string

optional

The Amazon Web Services ID for the user pool owner.

Domain

string

optional

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.

>= 1 characters<= 63 characters

Match pattern:

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

S3Bucket

string

optional

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

>= 3 characters<= 1024 characters

Match pattern:

^[0-9A-Za-z\.\-_]*(?<!\.)$

CloudFrontDistribution

string

optional

The Amazon Resource Name (ARN) of the Amazon CloudFront distribution.

Version

string

optional

The app version.

>= 1 characters<= 20 characters

Status

enum<string>

optional

The domain status.

Allowed values:

CREATINGDELETINGUPDATINGACTIVEFAILED

CustomDomainConfig

object

optional

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

🟠480NotAuthorizedException

🟠481InvalidParameterException

🟠482ResourceNotFoundException

🟠483InternalErrorException