Amazon Route 53
API Reference

Filter

For ListResolverEndpoints, ListResolverRules, and ListResolverRuleAssociations operations, an optional specification to return a subset of objects.

Contents

Name

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.

The valid values for Name depend on the action that you're including the filter in, ListResolverEndpoints, ListResolverRules, or ListResolverRuleAssociations.

ListResolverEndpoints

Valid values for Name include the following:

  • CREATOR_REQUEST_ID: The value that you specified when you created the resolver endpoint.

  • DIRECTION: Whether you want to return inbound or outbound resolver endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for Values.

  • HOST_VPC: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a resolver endpoint is returned in the HostVPCId element.

  • IP_ADDRESS_COUNT: The number of IP addresses that you have associated with the resolver endpoint.

  • NAME: The name of the resolver endpoint.

  • SECURITY_GROUP_IDS: The IDs of the VPC security groups that you specified when you created the resolver endpoint.

  • STATUS: The status of the resolver endpoint. If you specify STATUS for Name, specify the applicable status code for Values. For a list of status codes, see Status in ResolverEndpoint.

ListResolverRules

Valid values for Name include the following:

  • CREATOR_REQUEST_ID: The value that you specified when you created the resolver rule.

  • DOMAIN_NAME: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com:

    example.com.

  • NAME: The name of the resolver rule.

  • RESOLVER_ENDPOINT_ID: The ID of the resolver endpoint that the resolver rule is associated with.

    Note

    You can filter on the resolver endpoint only for rules that have a value of FORWARD for RuleType.

  • STATUS: The status of the resolver rule. If you specify STATUS for Name, specify the applicable status code for Values. For a list of status codes, see Status in ResolverRule.

  • TYPE: The type of the resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for Values.

ListResolverRuleAssociations

Valid values for Name include the following:

  • NAME: The name of the resolver rule association.

  • RESOLVER_RULE_ID: The ID of the resolver rule that is associated with one or more VPCs.

  • STATUS: The status of the resolver rule association. If you specify STATUS for Name, specify the applicable status code for Values. For a list of status codes, see Status in ResolverRuleAssociation.

  • VPC_ID: The ID of the VPC that the resolver rule is associated with.

Type: String

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

Required: No

Values

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.

Type: Array of strings

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: