[ aws . amplify ]

list-domain-associations

Description

Returns the domain associations for an Amplify 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

Synopsis

  list-domain-associations
--app-id <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The unique ID for an Amplify app.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Output

domainAssociations -> (list)

A list of domain associations.

(structure)

Describes a domain association that associates a custom domain with an Amplify app.

domainAssociationArn -> (string)

The Amazon Resource Name (ARN) for the domain association.

domainName -> (string)

The name of the domain.

enableAutoSubDomain -> (boolean)

Enables the automated creation of subdomains for branches.

autoSubDomainCreationPatterns -> (list)

Sets branch patterns for automatic subdomain creation.

(string)

autoSubDomainIAMRole -> (string)

The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

domainStatus -> (string)

The current status of the domain association.

statusReason -> (string)

The reason for the current status of the domain association.

certificateVerificationDNSRecord -> (string)

The DNS record for certificate verification.

subDomains -> (list)

The subdomains for the domain association.

(structure)

The subdomain for the domain association.

subDomainSetting -> (structure)

Describes the settings for the subdomain.

prefix -> (string)

The prefix setting for the subdomain.

branchName -> (string)

The branch name setting for the subdomain.

verified -> (boolean)

The verified status of the subdomain

dnsRecord -> (string)

The DNS record for the subdomain.

nextToken -> (string)

A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries.