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

UpdateGlobalResolver

Updates the configuration of a Route 53 Global Resolver instance. You can modify the name, description, and observability Region.

Request Syntax


PATCH /global-resolver/globalResolverId HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "name": "string",
   "observabilityRegion": "string"
}

URI Request Parameters

The request uses the following URI parameters.

globalResolverId

The ID of the Global Resolver.

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.

description

The description of the Global Resolver.

Type: String

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

Required: No

name

The name of the Global Resolver.

Type: String

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

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

Required: No

observabilityRegion

The AWS Regions in which the users' Global Resolver query resolution logs will be propagated.

Type: String

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "clientToken": "string",
   "createdAt": "string",
   "description": "string",
   "dnsName": "string",
   "id": "string",
   "ipv4Addresses": [ "string" ],
   "name": "string",
   "observabilityRegion": "string",
   "regions": [ "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.

arn

The Amazon Resource Name (ARN) of the Global Resolver.

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}

clientToken

A unique, case-sensitive identifier to ensure idempotency. This means that making the same request multiple times with the same clientToken has the same result every time.

Type: String

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

createdAt

The time and date the Global Resolverwas created.

Type: Timestamp

description

Description of the Global Resolver.

Type: String

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

dnsName

The hostname to be used by the customers' DNS clients for certification validation.

Type: String

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

id

The ID of the Global Resolver.

Type: String

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

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

ipv4Addresses

List of anycast IPv4 addresses associated with the Global Resolver instance.

Type: Array of strings

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

Pattern: ((25[0-5]|(2[0-4]|1\d|[1-9]|)\d)\.?\b){4}

name

Name of the Global Resolver.

Type: String

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

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

observabilityRegion

The AWS Regions in which the users' Global Resolver query resolution logs will be propagated.

Type: String

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

regions

The AWS Regions in which the Global Resolver will operate.

Type: Array of strings

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

status

The operational status of the Global Resolver.

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | DELETING

updatedAt

The time and date the Global Resolver 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