Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateDomainName

Creates a custom DomainName object.

Request Syntax


POST /v1/domainnames HTTP/1.1
Content-type: application/json

{
   "certificateArn": "string",
   "description": "string",
   "domainName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

certificateArn

The Amazon Resource Name (ARN) of the certificate. This can be an AWS Certificate Manager (ACM) certificate or an AWS Identity and Access Management (IAM) server certificate.

Type: String

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

Pattern: ^arn:[a-z-]*:(acm|iam):[a-z0-9-]*:\d{12}:(certificate|server-certificate)/[0-9A-Za-z_/-]*$

Required: Yes

description

A description of the DomainName.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Pattern: ^.*$

Required: No

domainName

The domain name.

Type: String

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

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "domainNameConfig": { 
      "appsyncDomainName": "string",
      "certificateArn": "string",
      "description": "string",
      "domainName": "string",
      "hostedZoneId": "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.

domainNameConfig

The configuration for the DomainName.

Type: DomainNameConfig 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 AWS AppSync error occurred. Try your request again.

HTTP Status Code: 500