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



List domains with an app

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

list-domain-associations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: domainAssociations


--app-id <value>
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]


--app-id (string)

Unique Id for an Amplify App.

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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


domainAssociations -> (list)

List of Domain Associations.


Structure for Domain Association, which associates a custom domain with an Amplify App.

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.

nextToken -> (string)

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.