UpdateResolverEndpoint
Updates the name of an inbound or an outbound Resolver endpoint.
Request Syntax
{
"Name": "string
",
"ResolverEndpointId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Name
-
The name of the Resolver endpoint that you want to update.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
(?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
Required: No
- ResolverEndpointId
-
The ID of the Resolver endpoint that you want to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
Response Syntax
{
"ResolverEndpoint": {
"Arn": "string",
"CreationTime": "string",
"CreatorRequestId": "string",
"Direction": "string",
"HostVPCId": "string",
"Id": "string",
"IpAddressCount": number,
"ModificationTime": "string",
"Name": "string",
"SecurityGroupIds": [ "string" ],
"Status": "string",
"StatusMessage": "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.
- ResolverEndpoint
-
The response to an
UpdateResolverEndpoint
request.Type: ResolverEndpoint object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceErrorException
-
We encountered an unknown error. Try again in a few minutes.
HTTP Status Code: 400
- InvalidParameterException
-
One or more parameters in this request are not valid.
HTTP Status Code: 400
- InvalidRequestException
-
The request is invalid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource doesn't exist.
HTTP Status Code: 400
- ThrottlingException
-
The request was throttled. Try again in a few minutes.
HTTP Status Code: 400
Examples
UpdateResolverEndpoint Example
This example illustrates one usage of UpdateResolverEndpoint.
Sample Request
POST / HTTP/1.1
Host: route53resolver.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: Route53Resolver.UpdateResolverEndpoint
X-Amz-Date: 20181101T192600Z
User-Agent: aws-cli/1.16.45 Python/2.7.10 Darwin/16.7.0 botocore/1.12.35
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256
Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-2/route53resolver/aws4_request,
SignedHeaders=content-type;host;x-amz-date;x-amz-target,
Signature=[calculated-signature]
{
"Name":"MyInbound",
"ResolverEndpointId": "rslvr-in-60b9fd8fdbexample"
}
Sample Response
HTTP/1.1 200 OK
Date: Thu, 01 Nov 2018 18:52:22 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 479
x-amzn-RequestId: bda80f7b-0f2c-41d1-9043-f36d3example
Connection: keep-alive
{
"ResolverEndpoint":{
"Arn":"arn:aws:route53resolver:us-east-2:0123456789012:resolver-endpoint/rslvr-in-60b9fd8fdbexample",
"CreationTime":"2018-11-01T18:44:50.372Z",
"CreatorRequestId":"1234",
"Direction":"INBOUND",
"HostVPCId":"vpc-03cf94c75cexample",
"Id":"rslvr-in-60b9fd8fdbexample",
"IpAddressCount":3,
"ModificationTime":"2018-11-01T18:44:50.372Z",
"Name":"MyInbound",
"SecurityGroupIds":[
"sg-020a3554aexample"
],
"Status":"UPDATING",
"StatusMessage":"Updating the Resolver Endpoint"
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: