Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cognito-idp ]



Gets information about a domain.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--domain <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--domain (string)

The domain string.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


To describe a user pool client

This example describes a user pool domain named my-domain.


aws cognito-idp describe-user-pool-domain --domain my-domain


  "DomainDescription": {
      "UserPoolId": "us-west-2_aaaaaaaaa",
      "AWSAccountId": "111111111111",
      "Domain": "my-domain",
      "S3Bucket": "aws-cognito-prod-pdx-assets",
      "CloudFrontDistribution": "",
      "Version": "20190128175402",
      "Status": "ACTIVE",
      "CustomDomainConfig": {}


DomainDescription -> (structure)

A domain description object containing information about the domain.

UserPoolId -> (string)

The user pool ID.

AWSAccountId -> (string)

The AWS account ID for the user pool owner.

Domain -> (string)

The domain string.

S3Bucket -> (string)

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

CloudFrontDistribution -> (string)

The ARN of the CloudFront distribution.

Version -> (string)

The app version.

Status -> (string)

The domain status.

CustomDomainConfig -> (structure)

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

CertificateArn -> (string)

The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.