Amazon Cognito · Schema

DomainDescriptionType

A container for information about a domain.

AuthenticationIdentityOIDCSAMLUser ManagementFederated Identity

Properties

Name Type Description
UserPoolId object
AWSAccountId object
Domain object
S3Bucket object
CloudFrontDistribution object
Version object
Status object
CustomDomainConfig object
View JSON Schema on GitHub

JSON Schema

user-pools-domain-description-type-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-domain-description-type-schema.json",
  "title": "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."
        }
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/user-pools-domain-description-type"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

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.

A second provider on the same verified email joins the account you already have.