AssociateApi
Maps an endpoint to your custom domain.
Request Syntax
POST /domainnames/domainName
/apiassociation HTTP/1.1
Content-type: application/json
{
"apiId": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- domainName
-
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 accepts the following data in JSON format.
- apiId
-
The API ID. Private APIs can not be associated with custom domains.
Type: String
Required: Yes
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.
- apiAssociation
-
The
ApiAssociation
object.Type: ApiAssociation object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this operation on this resource.
HTTP Status Code: 403
- BadRequestException
-
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
- InternalFailureException
-
An internal Amazon AppSync error occurred. Try your request again.
HTTP Status Code: 500
- NotFoundException
-
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 Amazon SDKs, see the following: