DomainDescriptionType is a JSON Structure definition published by Amazon Cognito, describing 8 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-domain-description-type-structure.json",
"name": "DomainDescriptionType",
"description": "A container for information about a domain.",
"type": "object",
"properties": {
"UserPoolId": {
"allOf": [
{
"$ref": "#/components/schemas/UserPoolIdType"
},
{
"description": "The user pool ID."
}
]
},
"AWSAccountId": {
"allOf": [
{
"$ref": "#/components/schemas/AWSAccountIdType"
},
{
"description": "The Amazon Web Services ID for the user pool owner."
}
]
},
"Domain": {
"allOf": [
{
"$ref": "#/components/schemas/DomainType"
},
{
"description": "The domain string. For custom domains, this is the fully-qualified domain name, such as <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, such as <code>auth</code>."
}
]
},
"S3Bucket": {
"allOf": [
{
"$ref": "#/components/schemas/S3BucketType"
},
{
"description": "The Amazon S3 bucket where the static files for this domain are stored."
}
]
},
"CloudFrontDistribution": {
"allOf": [
{
"$ref": "#/components/schemas/StringType"
},
{
"description": "The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider."
}
]
},
"Version": {
"allOf": [
{
"$ref": "#/components/schemas/DomainVersionType"
},
{
"description": "The app version."
}
]
},
"Status": {
"allOf": [
{
"$ref": "#/components/schemas/DomainStatusType"
},
{
"description": "The domain status."
}
]
},
"CustomDomainConfig": {
"allOf": [
{
"$ref": "#/components/schemas/CustomDomainConfigType"
},
{
"description": "The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application."
}
]
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.