Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule .

operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").

A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Name (string) -- A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

SecurityGroupIds (list) --

[REQUIRED]

The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints).

(string) --

Direction (string) --

[REQUIRED]

Specify the applicable value:

INBOUND : Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC

OUTBOUND : Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC

IpAddresses (list) --

[REQUIRED]

The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints).

(dict) --

In an CreateResolverEndpoint request, a subnet and IP address that you want to use for DNS queries.

SubnetId(string) --[REQUIRED]

The subnet that contains the IP address.

Ip(string) --

The IP address that you want to use for DNS queries.

Tags (list) --

A list of the tag keys and values that you want to associate with the endpoint.

(dict) --

One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

Key(string) --

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

Value(string) --

The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Name (string) -- A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

RuleType (string) --

[REQUIRED]

Specify FORWARD . Other resolver rule types aren't supported.

DomainName (string) --

[REQUIRED]

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

TargetIps (list) --

The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

(dict) --

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

Ip(string) --[REQUIRED]

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 outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps .

Tags (list) --

A list of the tag keys and values that you want to associate with the endpoint.

(dict) --

One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

Key(string) --

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

Value(string) --

The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

Information about the CreateResolverRule request, including the status of the 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).

Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule .

Information about the DeleteResolverRule request, including the status of the 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).

operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable.

Information about the resolver rule that you specified in a GetResolverRule 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).

The ID of the resolver endpoint that you want to get IP addresses for.

MaxResults (integer) -- The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults , Resolver returns up to 100 IP addresses.

NextToken (string) --

For the first ListResolverEndpointIpAddresses request, omit this value.

If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. 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.

IpAddresses(list) --

The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to Resolver (inbound endpoint).

(dict) --

In the response to a GetResolverEndpoint request, information about the IP addresses that the resolver endpoint uses for DNS queries.

IpId(string) --

The ID of one IP address.

SubnetId(string) --

The ID of one subnet.

Ip(string) --

One IP address that the resolver endpoint uses for DNS queries.

Status(string) --

A status code that gives the current status of the request.

StatusMessage(string) --

A message that provides additional information about the status of the request.

CreationTime(string) --

The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

ModificationTime(string) --

The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

MaxResults (integer) -- The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults , Resolver returns up to 100 resolver endpoints.

NextToken (string) --

For the first ListResolverEndpoints request, omit this value.

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

Filters (list) --

An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints.

Note

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

(dict) --

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 .

If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint 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.

ResolverEndpoints(list) --

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

(dict) --

In the response to a CreateResolverEndpoint , DeleteResolverEndpoint , GetResolverEndpoint , ListResolverEndpoints , or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound resolver endpoint.

Id(string) --

The ID of the resolver endpoint.

CreatorRequestId(string) --

A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

Arn(string) --

The ARN (Amazon Resource Name) for the resolver endpoint.

Name(string) --

The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

SecurityGroupIds(list) --

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

MaxResults (integer) -- The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults , Resolver returns up to 100 rule associations.

NextToken (string) --

For the first ListResolverRuleAssociation request, omit this value.

If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. 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 resolver rules that are associated with the same VPC ID.

Note

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

(dict) --

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 .

If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation 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.

ResolverRuleAssociations(list) --

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

(dict) --

In the response to an AssociateResolverRule , DisassociateResolverRule , or ListResolverRuleAssociations request, information about an association between a resolver rule and a VPC.

Id(string) --

The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

ResolverRuleId(string) --

The ID of the resolver rule that you associated with the VPC that is specified by VPCId .

Name(string) --

The name of an association between a resolver rule and a VPC.

VPCId(string) --

The ID of the VPC that you associated the resolver rule with.

Status(string) --

A code that specifies the current status of the association between a resolver rule and a VPC.

StatusMessage(string) --

A detailed description of the status of the association between a resolver rule and a VPC.

MaxResults (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.

NextToken (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.

(dict) --

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 .

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.

(dict) --

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).

The Amazon Resource Name (ARN) for the resource that you want to list tags for.

MaxResults (integer) -- The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults , Resolver returns up to 100 tags.

NextToken (string) --

For the first ListTagsForResource request, omit this value.

If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

Return type

dict

Returns

Response Syntax

{'Tags':[{'Key':'string','Value':'string'},],'NextToken':'string'}

Response Structure

(dict) --

Tags(list) --

The tags that are associated with the resource that you specified in the ListTagsForResource request.

(dict) --

One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

Key(string) --

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

Value(string) --

The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.

NextToken(string) --

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

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).

The Amazon Resource Name (ARN) for the resource that you want to list tags for.

PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

MaxItems(integer) --

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{'Tags':[{'Key':'string','Value':'string'},],}

Response Structure

(dict) --

Tags(list) --

The tags that are associated with the resource that you specified in the ListTagsForResource request.

(dict) --

One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value .

Key(string) --

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id .

Value(string) --

The value for the tag. For example, if Key is account-id , then Value might be the ID of the customer account that you're creating the resource for.