---
title: "GET /apps/{appId}/domains"
method: GET
path: "/apps/{appId}/domains"
---

# GET /apps/{appId}/domains

`GET /apps/{appId}/domains`

Returns the domain associations for an Amplify app.

## Path parameters

- `appId` string, required

## Query parameters

- `nextToken` string
- `maxResults` integer

## Response `200`

Success

- ListDomainAssociationsResult — The result structure for the list domain association request.
  - `domainAssociations` DomainAssociation[], required — A list of domain associations.
    - `domainAssociationArn` string, required — The Amazon Resource Name (ARN) for the domain association.
    - `domainName` string, required — The name of the domain.
    - `enableAutoSubDomain` boolean, required — Enables the automated creation of subdomains for branches.
    - `autoSubDomainCreationPatterns` AutoSubDomainCreationPattern[] — Sets branch patterns for automatic subdomain creation.
    - `autoSubDomainIAMRole` string — The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
    - `domainStatus` 'PENDING_VERIFICATION' | 'IN_PROGRESS' | 'AVAILABLE' | 'PENDING_DEPLOYMENT' | 'FAILED' | 'CREATING' | 'REQUESTING_CERTIFICATE' | 'UPDATING', required — The current status of the domain association.
    - `statusReason` string, required — The reason for the current status of the domain association.
    - `certificateVerificationDNSRecord` string — The DNS record for certificate verification.
    - `subDomains` SubDomain[], required — The subdomains for the domain association.
      - `subDomainSetting` object, required — Describes the settings for the subdomain.
        - `prefix` string, required — The prefix setting for the subdomain.
        - `branchName` string, required — The branch name setting for the subdomain.
      - `verified` boolean, required — The verified status of the subdomain
      - `dnsRecord` string, required — 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.

## Other responses

- `480` — BadRequestException
- `481` — UnauthorizedException
- `482` — InternalFailureException

---

[API](https://skmtc.net/aws/apis/amplify.md) · [All operations](https://skmtc.net/aws/apis/amplify/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/amplify/revisions/573daadbd119/schema)