GetApiAssociation - AWS AppSync


Retrieves an ApiAssociation object.

Request Syntax

GET /domainnames/domainName/apiassociation HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The domain name.

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

Pattern: ^(\*[\w\d-]*\.)?([\w\d-]+\.)+[\w\d-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "apiAssociation": { "apiId": "string", "associationStatus": "string", "deploymentDetail": "string", "domainName": "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.


The ApiAssociation object.

Type: ApiAssociation object


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


You don't have access to perform this operation on this resource.

HTTP Status Code: 403


The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

HTTP Status Code: 400


An internal AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500


The resource specified in the request was not found. Check the resource, and then try again.

HTTP Status Code: 404

See Also

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