list-resolver-rules¶

Description¶

Lists the resolver rules that were created using the current AWS account.

Synopsis¶

  list-resolver-rules
[--max-results <value>]
[--next-token <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--max-results (integer)

The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. If you don’t specify a value for MaxResults , Resolver returns up to 100 resolver rules.

--next-token (string)

For the first ListResolverRules request, omit this value.

If you have more than MaxResults resolver rules, you can submit another ListResolverRules request to get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response.

--filters (list)

An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint.

Note

If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters , if any, as in the previous request.

(structure)

For List operations, an optional specification to return a subset of objects, such as resolver endpoints or resolver rules.

Name -> (string)

When you’re using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name .

Values -> (list)

When you’re using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values .

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list Resolver rules

The following list-resolver-rules example lists all the Resolver rules in the current AWS account.

aws route53resolver list-resolver-rules

Output:

{
    "MaxResults": 30,
    "ResolverRules": [
        {
            "Id": "rslvr-autodefined-rr-internet-resolver",
            "CreatorRequestId": "",
            "Arn": "arn:aws:route53resolver:us-west-2::autodefined-rule/rslvr-autodefined-rr-internet-resolver",
            "DomainName": ".",
            "Status": "COMPLETE",
            "RuleType": "RECURSIVE",
            "Name": "Internet Resolver",
            "OwnerId": "Route 53 Resolver",
            "ShareStatus": "NOT_SHARED"
        },
        {
            "Id": "rslvr-rr-42b60677c0example",
            "CreatorRequestId": "2020-01-01-18:47",
            "Arn": "arn:aws:route53resolver:us-west-2:111122223333:resolver-rule/rslvr-rr-42b60677c0bc4e299",
            "DomainName": "example.com.",
            "Status": "COMPLETE",
            "StatusMessage": "[Trace id: 1-5dc4b177-ff1d9d001a0f80005example] Successfully created Resolver Rule.",
            "RuleType": "FORWARD",
            "Name": "my-rule",
            "TargetIps": [
                {
                    "Ip": "192.0.2.45",
                    "Port": 53
                }
            ],
            "ResolverEndpointId": "rslvr-out-d5e5920e37example",
            "OwnerId": "111122223333",
            "ShareStatus": "NOT_SHARED"
        }
    ]
}

For more information, see How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.

Output¶

NextToken -> (string)

If more than MaxResults resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

MaxResults -> (integer)

The value that you specified for MaxResults in the request.

ResolverRules -> (list)

The resolver rules that were created using the current AWS account and that match the specified filters, if any.

(structure)

For queries that originate in your VPC, detailed information about a resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule , DeleteResolverRule , GetResolverRule , ListResolverRules , or UpdateResolverRule request.

Id -> (string)

The ID that Resolver assigned to the resolver rule when you created it.

CreatorRequestId -> (string)

A unique string that you specified when you created the resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

Arn -> (string)

The ARN (Amazon Resource Name) for the resolver rule specified by Id .

DomainName -> (string)

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps . If a query matches multiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name (www.example.com).

Status -> (string)

A code that specifies the current status of the resolver rule.

StatusMessage -> (string)

A detailed description of the status of a resolver rule.

RuleType -> (string)

This value is always FORWARD . Other resolver rule types aren’t supported.

Name -> (string)

The name for the resolver rule, which you specified when you created the resolver rule.

TargetIps -> (list)

An array that contains the IP addresses and ports that you want to forward

(structure)

In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

Ip -> (string)

One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

Port -> (integer)

The port at Ip that you want to forward DNS queries to.

ResolverEndpointId -> (string)

The ID of the endpoint that the rule is associated with.

OwnerId -> (string)

When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

ShareStatus -> (string)

Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

Table of Contents

Feedback

User Guide