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

StartDomainVerification

Starts the domain verification process for a custom domain name.

Request Syntax


POST /domainverifications HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "domainName": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client token and parameters, the retry succeeds without performing any actions. If the parameters aren't identical, the retry fails.

Type: String

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

Pattern: .*[!-~]+.*

Required: No

domainName

The domain name to verify ownership for.

Type: String

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

Required: Yes

tags

The tags for the domain verification.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "arn": "string",
   "domainName": "string",
   "id": "string",
   "status": "string",
   "txtMethodConfig": { 
      "name": "string",
      "value": "string"
   }
}

Response Elements

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

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

arn

The Amazon Resource Name (ARN) of the domain verification.

Type: String

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

Pattern: arn:[a-z0-9f\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:domainverification/dv-[a-fA-F0-9]{17}

domainName

The domain name being verified.

Type: String

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

id

The ID of the domain verification.

Type: String

Length Constraints: Fixed length of 20.

Pattern: dv-[a-fA-F0-9]{17}

status

The current status of the domain verification process.

Type: String

Valid Values: VERIFIED | PENDING | VERIFICATION_TIMED_OUT

txtMethodConfig

The TXT record configuration used for domain verification.

Type: TxtMethodConfig object

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. Updating or deleting a resource can cause an inconsistent state.

resourceId: The resource ID.
resourceType: The resource type.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing the request.

retryAfterSeconds: The number of seconds to wait before retrying.

HTTP Status Code: 500

ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

quotaCode: The ID of the service quota that was exceeded.
resourceId: The resource ID.
resourceType: The resource type.
serviceCode: The service code.

HTTP Status Code: 402

ThrottlingException

The limit on the number of requests per second was exceeded.

quotaCode: The ID of the service quota that was exceeded.
retryAfterSeconds: The number of seconds to wait before retrying.
serviceCode: The service code.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

fieldList: The fields that failed validation.
reason: The reason.

HTTP Status Code: 400