Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdateResolverRule

Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.

Request Syntax


{
   "Config": { 
      "Name": "string",
      "ResolverEndpointId": "string",
      "TargetIps": [ 
         { 
            "Ip": "string",
            "Ipv6": "string",
            "Port": number,
            "Protocol": "string",
            "ServerNameIndication": "string"
         }
      ]
   },
   "ResolverRuleId": "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.

Config

The new settings for the Resolver rule.

Type: ResolverRuleConfig object

Required: Yes

ResolverRuleId

The ID of the Resolver rule that you want to update.

Type: String

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

Required: Yes

Response Syntax


{
   "ResolverRule": { 
      "Arn": "string",
      "CreationTime": "string",
      "CreatorRequestId": "string",
      "DelegationRecord": "string",
      "DomainName": "string",
      "Id": "string",
      "ModificationTime": "string",
      "Name": "string",
      "OwnerId": "string",
      "ResolverEndpointId": "string",
      "RuleType": "string",
      "ShareStatus": "string",
      "Status": "string",
      "StatusMessage": "string",
      "TargetIps": [ 
         { 
            "Ip": "string",
            "Ipv6": "string",
            "Port": number,
            "Protocol": "string",
            "ServerNameIndication": "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.

ResolverRule

The response to an UpdateResolverRule request.

Type: ResolverRule object

Errors

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

AccessDeniedException

The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

HTTP Status Code: 400

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.

FieldName: For an InvalidParameterException error, the name of the parameter that's invalid.

HTTP Status Code: 400

InvalidRequestException

The request is invalid.

HTTP Status Code: 400

LimitExceededException

The request caused one or more limits to be exceeded.

ResourceType: For a LimitExceededException error, the type of resource that exceeded the current limit.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource doesn't exist.

ResourceType: For a ResourceNotFoundException error, the type of resource that doesn't exist.

HTTP Status Code: 400

ResourceUnavailableException

The specified resource isn't available.

ResourceType: For a ResourceUnavailableException error, the type of resource that isn't available.

HTTP Status Code: 400

ThrottlingException

The request was throttled. Try again in a few minutes.

HTTP Status Code: 400

Examples

UpdateResolverRule Example

This example illustrates one usage of UpdateResolverRule.

Sample Request


POST / HTTP/1.1
Host: route53resolver.us-east-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 170
X-Amz-Target: Route53Resolver.UpdateResolverRule
X-Amz-Date: 20181101T192331Z
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]

{
    "Config": {
        "Name": "MyRule",
        "ResolverEndpointId": "rslvr-out-fdc049932dexample",
        "TargetIps": [
            {
                "Ip": "192.0.2.6"
            }
        ]
    },
    "ResolverRuleId": "rslvr-rr-5328a0899aexample"
}

Sample Response


HTTP/1.1 200 OK
Date: Thu, 01 Nov 2018 19:23:31 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 464
x-amzn-RequestId: f51a7bc8-e9c6-4399-b408-086ecexample
Connection: keep-alive

{
    "ResolverRule": {
        "Arn": "arn:aws:route53resolver:us-east-2:123456789012:resolver-rule/rslvr-rr-5328a0899aexample",
        "CreatorRequestId": "999",
        "DomainName": "example.net",
        "Id": "rslvr-rr-5328a0899aexample",
        "Name": "MyRule",
        "OwnerId": "123456789012",
        "ResolverEndpointId": "rslvr-out-fdc049932dexample",
        "RuleType": "FORWARD",
        "ShareStatus": "NOT_SHARED",
        "Status": "COMPLETE",
        "StatusMessage": "[Trace id: 1-5bdb52b3-68082ffc336d18153example] Successfully updated Resolver Rule.",
        "TargetIps": [
            {
                "Ip": "192.0.2.6",
                "Port": 53
            }
        ]
    }
}