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

UpdateAccessSource

Updates the configuration of an access source.

Request Syntax


PATCH /access-sources/accessSourceId HTTP/1.1
Content-type: application/json

{
   "cidr": "string",
   "ipAddressType": "string",
   "name": "string",
   "protocol": "string"
}

URI Request Parameters

The request uses the following URI parameters.

accessSourceId

The unique identifier of the access source to update.

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.

cidr

The CIDR block for the access source.

Type: String

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

Required: No

ipAddressType

The IP address type for the access source.

Type: String

Valid Values: IPV4 | IPV6

Required: No

name

The name of the access source.

Type: String

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

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

Required: No

protocol

The protocol for the access source.

Type: String

Valid Values: DO53 | DOH | DOT

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "cidr": "string",
   "createdAt": "string",
   "dnsViewId": "string",
   "id": "string",
   "ipAddressType": "string",
   "name": "string",
   "protocol": "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 updated access source.

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}

cidr

The CIDR block of the updated access source.

Type: String

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

createdAt

The date and time when the access source was originally created.

Type: Timestamp

dnsViewId

The ID of the DNS view associated with the updated access source.

Type: String

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

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

id

The unique identifier of the updated access source.

Type: String

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

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

ipAddressType

The IP address type of the updated access source.

Type: String

Valid Values: IPV4 | IPV6

name

The name of the updated access source.

Type: String

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

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

protocol

The protocol of the updated access source.

Type: String

Valid Values: DO53 | DOH | DOT

status

The current status of the updated access source.

Type: String

Valid Values: CREATING | OPERATIONAL | UPDATING | DELETING

updatedAt

The date and time when the access source was last 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

ServiceQuotaExceededException

The request would exceed one or more service quotas. Check your current usage and quotas, then try again.

quotaCode: The quota code recognized by the AWS Service Quotas service.
resourceId: The unique ID of the resource referenced in the failed request.
resourceType: The resource type of the resource referenced in the failed request.
serviceCode: The code for the AWS service that owns the quota.

HTTP Status Code: 402

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