Table Of Contents


User Guide

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

[ aws . amplify ]



Retrieves domain info that corresponds to an appId and domainName.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


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


--app-id (string)

Unique Id for an Amplify App.

--domain-name (string)

Name of the domain.

--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.


domainAssociation -> (structure)

Domain Association structure.

domainAssociationArn -> (string)

ARN for the Domain Association.

domainName -> (string)

Name of the domain.

enableAutoSubDomain -> (boolean)

Enables automated creation of Subdomains for branches. (Currently not supported)

domainStatus -> (string)

Status fo the Domain Association.

statusReason -> (string)

Reason for the current status of the Domain Association.

certificateVerificationDNSRecord -> (string)

DNS Record for certificate verification.

subDomains -> (list)

Subdomains for the Domain Association.


Subdomain for the Domain Association.

subDomainSetting -> (structure)

Setting structure for the Subdomain.

prefix -> (string)

Prefix setting for the Subdomain.

branchName -> (string)

Branch name setting for the Subdomain.

verified -> (boolean)

Verified status of the Subdomain

dnsRecord -> (string)

DNS record for the Subdomain.