GetDomainAssociation - Amplify


Returns the domain information for an Amplify app.

Request Syntax

GET /apps/appId/domains/domainName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The unique id for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: d[a-z0-9]+

Required: Yes


The name of the domain.

Length Constraints: Maximum length of 64.

Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])(\.)?$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "domainAssociation": { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificate": { "certificateVerificationDNSRecord": "string", "customCertificateArn": "string", "type": "string" }, "certificateVerificationDNSRecord": "string", "domainAssociationArn": "string", "domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


Describes the structure of a domain association, which associates a custom domain with an Amplify app.

Type: DomainAssociation object


For information about the errors that are common to all actions, see Common Errors.


A request contains unexpected data.

HTTP Status Code: 400


The service failed to perform an operation due to an internal issue.

HTTP Status Code: 500


An entity was not found during an operation.

HTTP Status Code: 404


An operation failed due to a lack of access.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: