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

UpdateHostedZoneAssociation

Updates the configuration of a hosted zone association.

Request Syntax


PATCH /hosted-zone-associations/hostedZoneAssociationId HTTP/1.1
Content-type: application/json

{
   "name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

hostedZoneAssociationId

The ID of the private hosted zone association.

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

Pattern: [-.a-zA-Z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

name

The name you want to update the hosted zone association to.

Type: String

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

Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "hostedZoneId": "string",
   "hostedZoneName": "string",
   "id": "string",
   "name": "string",
   "resourceArn": "string",
   "status": "string",
   "updatedAt": "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.

createdAt

The time and date the private hosted zone association was created.

Type: Timestamp

hostedZoneId

The ID of the private hosted zone.

Type: String

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

hostedZoneName

The name of the domain associated with the private hosted zone.

Type: String

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

id

The ID of the private hosted zone association.

Type: String

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

Pattern: [-.a-zA-Z0-9]+

name

The name of the private hosted zone association.

Type: String

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

Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_/' ']+)

resourceArn

The Amazon Resource Name (ARN) of the private hosted zone association.

Type: String

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

Pattern: arn:[-.a-z0-9]{1,63}:[-.a-z0-9]{1,63}:[-.a-z0-9]{0,63}:[-.a-z0-9]{0,63}:[^/].{0,1023}

status

The operational status of the private hosted zone association.

Type: String

Valid Values: CREATING | OPERATIONAL | DELETING

updatedAt

The time and date the private hosted zone association was updated.

Type: Timestamp

Errors

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

AccessDeniedException

You don't have permission to perform this operation. Check your IAM permissions and try again.

HTTP Status Code: 403

ConflictException

The request conflicts with the current state of the resource. This can occur when trying to modify a resource that is not in a valid state for the requested operation.

resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

An internal server error occurred. Try again later.

retryAfterSeconds: Number of seconds in which the caller can retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource was not found. Verify the resource ID and try again.

resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to too many requests. Wait a moment and try again.

quotaCode: The quota code recognized by the AWS Service Quotas service.
retryAfterSeconds: Number of seconds in which the caller can retry the request.
serviceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 429

ValidationException

The input parameters are invalid. Check the parameter values and try again.

fieldList: The list of fields that aren't valid.
reason: Reason the request failed validation.

HTTP Status Code: 400