AWS SDK for PHP 3.x

Client: Aws\Route53Resolver\Route53ResolverClient

Service ID: route53resolver

Version: 2018-04-01

This page describes the parameters and results for the operations of the Amazon Route 53 Resolver (2018-04-01), and shows how to use the Aws\Route53Resolver\Route53ResolverClient object to call the described operations. This documentation is specific to the 2018-04-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateResolverEndpointIpAddress ( array $params = [] )
Adds IP addresses to an inbound or an outbound resolver endpoint.
AssociateResolverRule ( array $params = [] )
Associates a resolver rule with a VPC.
CreateResolverEndpoint ( array $params = [] )
Creates a resolver endpoint.
CreateResolverRule ( array $params = [] )
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.
DeleteResolverEndpoint ( array $params = [] )
Deletes a resolver endpoint.
DeleteResolverRule ( array $params = [] )
Deletes a resolver rule.
DisassociateResolverEndpointIpAddress ( array $params = [] )
Removes IP addresses from an inbound or an outbound resolver endpoint.
DisassociateResolverRule ( array $params = [] )
Removes the association between a specified resolver rule and a specified VPC.
GetResolverEndpoint ( array $params = [] )
Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.
GetResolverRule ( array $params = [] )
Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.
GetResolverRuleAssociation ( array $params = [] )
Gets information about an association between a specified resolver rule and a VPC.
GetResolverRulePolicy ( array $params = [] )
Gets information about a resolver rule policy.
ListResolverEndpointIpAddresses ( array $params = [] )
Gets the IP addresses for a specified resolver endpoint.
ListResolverEndpoints ( array $params = [] )
Lists all the resolver endpoints that were created using the current AWS account.
ListResolverRuleAssociations ( array $params = [] )
Lists the associations that were created between resolver rules and VPCs using the current AWS account.
ListResolverRules ( array $params = [] )
Lists the resolver rules that were created using the current AWS account.
ListTagsForResource ( array $params = [] )
Lists the tags that you associated with the specified resource.
PutResolverRulePolicy ( array $params = [] )
Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
TagResource ( array $params = [] )
Adds one or more tags to a specified resource.
UntagResource ( array $params = [] )
Removes one or more tags from a specified resource.
UpdateResolverEndpoint ( array $params = [] )
Updates the name of an inbound or an outbound resolver endpoint.
UpdateResolverRule ( array $params = [] )
Updates settings for a specified resolver rule.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListResolverEndpointIpAddresses
ListResolverEndpoints
ListResolverRuleAssociations
ListResolverRules

Operations

AssociateResolverEndpointIpAddress

$result = $client->associateResolverEndpointIpAddress([/* ... */]);
$promise = $client->associateResolverEndpointIpAddressAsync([/* ... */]);

Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

Parameter Syntax

$result = $client->associateResolverEndpointIpAddress([
    'IpAddress' => [ // REQUIRED
        'Ip' => '<string>',
        'IpId' => '<string>',
        'SubnetId' => '<string>',
    ],
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IpAddress

Required: Yes
Type: IpAddressUpdate structure

Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

ResolverEndpointId

Required: Yes
Type: string

The ID of the resolver endpoint that you want to associate IP addresses with.

Result Syntax

[
    'ResolverEndpoint' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Direction' => 'INBOUND|OUTBOUND',
        'HostVPCId' => '<string>',
        'Id' => '<string>',
        'IpAddressCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'SecurityGroupIds' => ['<string>', ...],
        'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ResolverEndpoint

Type: ResolverEndpoint structure

The response to an AssociateResolverEndpointIpAddress request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
ResourceExistsException:
The resource that you tried to create already exists.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
LimitExceededException:
The request caused one or more limits to be exceeded.
ThrottlingException:
The request was throttled. Try again in a few minutes.

AssociateResolverRule

$result = $client->associateResolverRule([/* ... */]);
$promise = $client->associateResolverRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateResolverRule([
    'Name' => '<string>',
    'ResolverRuleId' => '<string>', // REQUIRED
    'VPCId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Type: string

A name for the association that you're creating between a resolver rule and a VPC.

ResolverRuleId

Required: Yes
Type: string

The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules.

VPCId

Required: Yes
Type: string

The ID of the VPC that you want to associate the resolver rule with.

Result Syntax

[
    'ResolverRuleAssociation' => [
        'Id' => '<string>',
        'Name' => '<string>',
        'ResolverRuleId' => '<string>',
        'Status' => 'CREATING|COMPLETE|DELETING|FAILED|OVERRIDDEN',
        'StatusMessage' => '<string>',
        'VPCId' => '<string>',
    ],
]

Result Details

Members

ResolverRuleAssociation

Type: ResolverRuleAssociation structure

Information about the AssociateResolverRule request, including the status of the request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidRequestException:
The request is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
ResourceUnavailableException:
The specified resource isn't available.
ResourceExistsException:
The resource that you tried to create already exists.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

CreateResolverEndpoint

$result = $client->createResolverEndpoint([/* ... */]);
$promise = $client->createResolverEndpointAsync([/* ... */]);

Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound:

An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC.
An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.

Parameter Syntax

$result = $client->createResolverEndpoint([
    'CreatorRequestId' => '<string>', // REQUIRED
    'Direction' => 'INBOUND|OUTBOUND', // REQUIRED
    'IpAddresses' => [ // REQUIRED
        [
            'Ip' => '<string>',
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>',
    'SecurityGroupIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

CreatorRequestId

Required: Yes
Type: string

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.

Direction

Required: Yes
Type: string

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

Required: Yes
Type: Array of IpAddressRequest structures

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

Name

Type: string

A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

SecurityGroupIds

Required: Yes
Type: Array of strings

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

Tags

Type: Array of Tag structures

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

Result Syntax

[
    'ResolverEndpoint' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Direction' => 'INBOUND|OUTBOUND',
        'HostVPCId' => '<string>',
        'Id' => '<string>',
        'IpAddressCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'SecurityGroupIds' => ['<string>', ...],
        'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ResolverEndpoint

Type: ResolverEndpoint structure

Information about the CreateResolverEndpoint request, including the status of the request.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
ResourceNotFoundException:
The specified resource doesn't exist.
InvalidRequestException:
The request is invalid.
ResourceExistsException:
The resource that you tried to create already exists.
LimitExceededException:
The request caused one or more limits to be exceeded.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

CreateResolverRule

$result = $client->createResolverRule([/* ... */]);
$promise = $client->createResolverRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createResolverRule([
    'CreatorRequestId' => '<string>', // REQUIRED
    'DomainName' => '<string>', // REQUIRED
    'Name' => '<string>',
    'ResolverEndpointId' => '<string>',
    'RuleType' => 'FORWARD|SYSTEM|RECURSIVE', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetIps' => [
        [
            'Ip' => '<string>', // REQUIRED
            'Port' => <integer>,
        ],
        // ...
    ],
]);

Parameter Details

Members

CreatorRequestId

Required: Yes
Type: string

DomainName

Required: Yes
Type: string

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

Name

Type: string

A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

ResolverEndpointId

Type: 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.

RuleType

Required: Yes
Type: string

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

Tags

Type: Array of Tag structures

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

TargetIps

Type: Array of TargetAddress structures

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

Result Syntax

[
    'ResolverRule' => [
        'Arn' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ResolverEndpointId' => '<string>',
        'RuleType' => 'FORWARD|SYSTEM|RECURSIVE',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|FAILED',
        'StatusMessage' => '<string>',
        'TargetIps' => [
            [
                'Ip' => '<string>',
                'Port' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

ResolverRule

Type: ResolverRule structure

Information about the CreateResolverRule request, including the status of the request.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
LimitExceededException:
The request caused one or more limits to be exceeded.
ResourceNotFoundException:
The specified resource doesn't exist.
ResourceExistsException:
The resource that you tried to create already exists.
ResourceUnavailableException:
The specified resource isn't available.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

DeleteResolverEndpoint

$result = $client->deleteResolverEndpoint([/* ... */]);
$promise = $client->deleteResolverEndpointAsync([/* ... */]);

Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint:

Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC.
Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.

Parameter Syntax

$result = $client->deleteResolverEndpoint([
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverEndpointId

Required: Yes
Type: string

The ID of the resolver endpoint that you want to delete.

Result Syntax

[
    'ResolverEndpoint' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Direction' => 'INBOUND|OUTBOUND',
        'HostVPCId' => '<string>',
        'Id' => '<string>',
        'IpAddressCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'SecurityGroupIds' => ['<string>', ...],
        'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ResolverEndpoint

Type: ResolverEndpoint structure

Information about the DeleteResolverEndpoint request, including the status of the request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

DeleteResolverRule

$result = $client->deleteResolverRule([/* ... */]);
$promise = $client->deleteResolverRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteResolverRule([
    'ResolverRuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverRuleId

Required: Yes
Type: string

The ID of the resolver rule that you want to delete.

Result Syntax

[
    'ResolverRule' => [
        'Arn' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ResolverEndpointId' => '<string>',
        'RuleType' => 'FORWARD|SYSTEM|RECURSIVE',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|FAILED',
        'StatusMessage' => '<string>',
        'TargetIps' => [
            [
                'Ip' => '<string>',
                'Port' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

ResolverRule

Type: ResolverRule structure

Information about the DeleteResolverRule request, including the status of the request.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
ResourceNotFoundException:
The specified resource doesn't exist.
ResourceInUseException:
The resource that you tried to update or delete is currently in use.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

DisassociateResolverEndpointIpAddress

$result = $client->disassociateResolverEndpointIpAddress([/* ... */]);
$promise = $client->disassociateResolverEndpointIpAddressAsync([/* ... */]);

Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

Parameter Syntax

$result = $client->disassociateResolverEndpointIpAddress([
    'IpAddress' => [ // REQUIRED
        'Ip' => '<string>',
        'IpId' => '<string>',
        'SubnetId' => '<string>',
    ],
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

IpAddress

Required: Yes
Type: IpAddressUpdate structure

The IPv4 address that you want to remove from a resolver endpoint.

ResolverEndpointId

Required: Yes
Type: string

The ID of the resolver endpoint that you want to disassociate an IP address from.

Result Syntax

[
    'ResolverEndpoint' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Direction' => 'INBOUND|OUTBOUND',
        'HostVPCId' => '<string>',
        'Id' => '<string>',
        'IpAddressCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'SecurityGroupIds' => ['<string>', ...],
        'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ResolverEndpoint

Type: ResolverEndpoint structure

The response to an DisassociateResolverEndpointIpAddress request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
ResourceExistsException:
The resource that you tried to create already exists.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

DisassociateResolverRule

$result = $client->disassociateResolverRule([/* ... */]);
$promise = $client->disassociateResolverRuleAsync([/* ... */]);

Removes the association between a specified resolver rule and a specified VPC.

If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.

Parameter Syntax

$result = $client->disassociateResolverRule([
    'ResolverRuleId' => '<string>', // REQUIRED
    'VPCId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverRuleId

Required: Yes
Type: string

The ID of the resolver rule that you want to disassociate from the specified VPC.

VPCId

Required: Yes
Type: string

The ID of the VPC that you want to disassociate the resolver rule from.

Result Syntax

[
    'ResolverRuleAssociation' => [
        'Id' => '<string>',
        'Name' => '<string>',
        'ResolverRuleId' => '<string>',
        'Status' => 'CREATING|COMPLETE|DELETING|FAILED|OVERRIDDEN',
        'StatusMessage' => '<string>',
        'VPCId' => '<string>',
    ],
]

Result Details

Members

ResolverRuleAssociation

Type: ResolverRuleAssociation structure

Information about the DisassociateResolverRule request, including the status of the request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetResolverEndpoint

$result = $client->getResolverEndpoint([/* ... */]);
$promise = $client->getResolverEndpointAsync([/* ... */]);

Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.

Parameter Syntax

$result = $client->getResolverEndpoint([
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverEndpointId

Required: Yes
Type: string

The ID of the resolver endpoint that you want to get information about.

Result Syntax

[
    'ResolverEndpoint' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Direction' => 'INBOUND|OUTBOUND',
        'HostVPCId' => '<string>',
        'Id' => '<string>',
        'IpAddressCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'SecurityGroupIds' => ['<string>', ...],
        'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ResolverEndpoint

Type: ResolverEndpoint structure

Information about the resolver endpoint that you specified in a GetResolverEndpoint request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetResolverRule

$result = $client->getResolverRule([/* ... */]);
$promise = $client->getResolverRuleAsync([/* ... */]);

Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.

Parameter Syntax

$result = $client->getResolverRule([
    'ResolverRuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverRuleId

Required: Yes
Type: string

The ID of the resolver rule that you want to get information about.

Result Syntax

[
    'ResolverRule' => [
        'Arn' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ResolverEndpointId' => '<string>',
        'RuleType' => 'FORWARD|SYSTEM|RECURSIVE',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|FAILED',
        'StatusMessage' => '<string>',
        'TargetIps' => [
            [
                'Ip' => '<string>',
                'Port' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

ResolverRule

Type: ResolverRule structure

Information about the resolver rule that you specified in a GetResolverRule request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetResolverRuleAssociation

$result = $client->getResolverRuleAssociation([/* ... */]);
$promise = $client->getResolverRuleAssociationAsync([/* ... */]);

Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.

Parameter Syntax

$result = $client->getResolverRuleAssociation([
    'ResolverRuleAssociationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverRuleAssociationId

Required: Yes
Type: string

The ID of the resolver rule association that you want to get information about.

Result Syntax

[
    'ResolverRuleAssociation' => [
        'Id' => '<string>',
        'Name' => '<string>',
        'ResolverRuleId' => '<string>',
        'Status' => 'CREATING|COMPLETE|DELETING|FAILED|OVERRIDDEN',
        'StatusMessage' => '<string>',
        'VPCId' => '<string>',
    ],
]

Result Details

Members

ResolverRuleAssociation

Type: ResolverRuleAssociation structure

Information about the resolver rule association that you specified in a GetResolverRuleAssociation request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetResolverRulePolicy

$result = $client->getResolverRulePolicy([/* ... */]);
$promise = $client->getResolverRulePolicyAsync([/* ... */]);

Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

Parameter Syntax

$result = $client->getResolverRulePolicy([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The ID of the resolver rule policy that you want to get information about.

Result Syntax

[
    'ResolverRulePolicy' => '<string>',
]

Result Details

Members

ResolverRulePolicy

Type: string

Information about the resolver rule policy that you specified in a GetResolverRulePolicy request.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
UnknownResourceException:
The specified resource doesn't exist.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.

ListResolverEndpointIpAddresses

$result = $client->listResolverEndpointIpAddresses([/* ... */]);
$promise = $client->listResolverEndpointIpAddressesAsync([/* ... */]);

Gets the IP addresses for a specified resolver endpoint.

Parameter Syntax

$result = $client->listResolverEndpointIpAddresses([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

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

Type: 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.

ResolverEndpointId

Required: Yes
Type: string

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

Result Syntax

[
    'IpAddresses' => [
        [
            'CreationTime' => '<string>',
            'Ip' => '<string>',
            'IpId' => '<string>',
            'ModificationTime' => '<string>',
            'Status' => 'CREATING|FAILED_CREATION|ATTACHING|ATTACHED|REMAP_DETACHING|REMAP_ATTACHING|DETACHING|FAILED_RESOURCE_GONE|DELETING|DELETE_FAILED_FAS_EXPIRED',
            'StatusMessage' => '<string>',
            'SubnetId' => '<string>',
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]

Result Details

Members

IpAddresses

Type: Array of IpAddressResponse structures

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

MaxResults

Type: int

The value that you specified for MaxResults in the request.

NextToken

Type: string

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.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
InvalidNextTokenException:
The value that you specified for NextToken in a List request isn't valid.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListResolverEndpoints

$result = $client->listResolverEndpoints([/* ... */]);
$promise = $client->listResolverEndpointsAsync([/* ... */]);

Lists all the resolver endpoints that were created using the current AWS account.

Parameter Syntax

$result = $client->listResolverEndpoints([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

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

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.

MaxResults

Type: int

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

Type: 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.

Result Syntax

[
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResolverEndpoints' => [
        [
            'Arn' => '<string>',
            'CreationTime' => '<string>',
            'CreatorRequestId' => '<string>',
            'Direction' => 'INBOUND|OUTBOUND',
            'HostVPCId' => '<string>',
            'Id' => '<string>',
            'IpAddressCount' => <integer>,
            'ModificationTime' => '<string>',
            'Name' => '<string>',
            'SecurityGroupIds' => ['<string>', ...],
            'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

MaxResults

Type: int

The value that you specified for MaxResults in the request.

NextToken

Type: string

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.

ResolverEndpoints

Type: Array of ResolverEndpoint structures

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

Errors

InvalidNextTokenException:
The value that you specified for NextToken in a List request isn't valid.
InvalidRequestException:
The request is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListResolverRuleAssociations

$result = $client->listResolverRuleAssociations([/* ... */]);
$promise = $client->listResolverRuleAssociationsAsync([/* ... */]);

Lists the associations that were created between resolver rules and VPCs using the current AWS account.

Parameter Syntax

$result = $client->listResolverRuleAssociations([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

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

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.

MaxResults

Type: int

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

Type: 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.

Result Syntax

[
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResolverRuleAssociations' => [
        [
            'Id' => '<string>',
            'Name' => '<string>',
            'ResolverRuleId' => '<string>',
            'Status' => 'CREATING|COMPLETE|DELETING|FAILED|OVERRIDDEN',
            'StatusMessage' => '<string>',
            'VPCId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

MaxResults

Type: int

The value that you specified for MaxResults in the request.

NextToken

Type: string

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.

ResolverRuleAssociations

Type: Array of ResolverRuleAssociation structures

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

Errors

InvalidNextTokenException:
The value that you specified for NextToken in a List request isn't valid.
InvalidRequestException:
The request is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListResolverRules

$result = $client->listResolverRules([/* ... */]);
$promise = $client->listResolverRulesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listResolverRules([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

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

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.

MaxResults

Type: int

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

Type: 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.

Result Syntax

[
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResolverRules' => [
        [
            'Arn' => '<string>',
            'CreatorRequestId' => '<string>',
            'DomainName' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'OwnerId' => '<string>',
            'ResolverEndpointId' => '<string>',
            'RuleType' => 'FORWARD|SYSTEM|RECURSIVE',
            'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
            'Status' => 'COMPLETE|DELETING|UPDATING|FAILED',
            'StatusMessage' => '<string>',
            'TargetIps' => [
                [
                    'Ip' => '<string>',
                    'Port' => <integer>,
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Members

MaxResults

Type: int

The value that you specified for MaxResults in the request.

NextToken

Type: 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.

ResolverRules

Type: Array of ResolverRule structures

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

Errors

InvalidNextTokenException:
The value that you specified for NextToken in a List request isn't valid.
InvalidRequestException:
The request is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags that you associated with the specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

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

Type: 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.

ResourceArn

Required: Yes
Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: 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.

Tags

Type: Array of Tag structures

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

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidNextTokenException:
The value that you specified for NextToken in a List request isn't valid.
InvalidRequestException:
The request is invalid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

PutResolverRulePolicy

$result = $client->putResolverRulePolicy([/* ... */]);
$promise = $client->putResolverRulePolicyAsync([/* ... */]);

Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

Parameter Syntax

$result = $client->putResolverRulePolicy([
    'Arn' => '<string>', // REQUIRED
    'ResolverRulePolicy' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the account that you want to grant permissions to.

ResolverRulePolicy

Required: Yes
Type: string

An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account.

Result Syntax

[
    'ReturnValue' => true || false,
]

Result Details

Members

ReturnValue

Type: boolean

Whether the PutResolverRulePolicy request was successful.

Errors

InvalidPolicyDocument:
The specified resolver rule policy is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
UnknownResourceException:
The specified resource doesn't exist.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to a specified resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

GetResolverEndpoint
GetResolverRule
GetResolverRuleAssociation
ListResolverEndpoints
ListResolverRuleAssociations
ListResolverRules

Tags

Required: Yes
Type: Array of Tag structures

The tags that you want to add to the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

LimitExceededException:
The request caused one or more limits to be exceeded.
ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidTagException:
The specified tag is invalid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:

GetResolverEndpoint
GetResolverRule
GetResolverRuleAssociation
ListResolverEndpoints
ListResolverRuleAssociations
ListResolverRules

TagKeys

Required: Yes
Type: Array of strings

The tags that you want to remove to the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

UpdateResolverEndpoint

$result = $client->updateResolverEndpoint([/* ... */]);
$promise = $client->updateResolverEndpointAsync([/* ... */]);

Updates the name of an inbound or an outbound resolver endpoint.

Parameter Syntax

$result = $client->updateResolverEndpoint([
    'Name' => '<string>',
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Name

Type: string

The name of the resolver endpoint that you want to update.

ResolverEndpointId

Required: Yes
Type: string

The ID of the resolver endpoint that you want to update.

Result Syntax

[
    'ResolverEndpoint' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Direction' => 'INBOUND|OUTBOUND',
        'HostVPCId' => '<string>',
        'Id' => '<string>',
        'IpAddressCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'SecurityGroupIds' => ['<string>', ...],
        'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

ResolverEndpoint

Type: ResolverEndpoint structure

The response to an UpdateResolverEndpoint request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

UpdateResolverRule

$result = $client->updateResolverRule([/* ... */]);
$promise = $client->updateResolverRuleAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateResolverRule([
    'Config' => [ // REQUIRED
        'Name' => '<string>',
        'ResolverEndpointId' => '<string>',
        'TargetIps' => [
            [
                'Ip' => '<string>', // REQUIRED
                'Port' => <integer>,
            ],
            // ...
        ],
    ],
    'ResolverRuleId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Config

Required: Yes
Type: ResolverRuleConfig structure

The new settings for the resolver rule.

ResolverRuleId

Required: Yes
Type: string

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

Result Syntax

[
    'ResolverRule' => [
        'Arn' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ResolverEndpointId' => '<string>',
        'RuleType' => 'FORWARD|SYSTEM|RECURSIVE',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING|FAILED',
        'StatusMessage' => '<string>',
        'TargetIps' => [
            [
                'Ip' => '<string>',
                'Port' => <integer>,
            ],
            // ...
        ],
    ],
]

Result Details

Members

ResolverRule

Type: ResolverRule structure

The response to an UpdateResolverRule request.

Errors

InvalidRequestException:
The request is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
ResourceNotFoundException:
The specified resource doesn't exist.
ResourceUnavailableException:
The specified resource isn't available.
LimitExceededException:
The request caused one or more limits to be exceeded.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

Shapes

Filter

Description

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

Members

Name

Type: 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

Type: Array of strings

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.

InternalServiceErrorException

Description

We encountered an unknown error. Try again in a few minutes.

Members

Message

Type: string

InvalidNextTokenException

Description

The value that you specified for NextToken in a List request isn't valid.

Members

Message

Type: string

InvalidParameterException

Description

One or more parameters in this request are not valid.

Members

FieldName

Type: string

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

Message

Required: Yes
Type: string

InvalidPolicyDocument

Description

The specified resolver rule policy is invalid.

Members

Message

Type: string

InvalidRequestException

Description

The request is invalid.

Members

Message

Type: string

InvalidTagException

Description

The specified tag is invalid.

Members

Message

Type: string

IpAddressRequest

Description

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

Members

Ip

Type: string

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

SubnetId

Required: Yes
Type: string

The subnet that contains the IP address.

IpAddressResponse

Description

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

Members

CreationTime

Type: string

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

Ip

Type: string

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

IpId

Type: string

The ID of one IP address.

ModificationTime

Type: string

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

Status

Type: string

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

StatusMessage

Type: string

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

SubnetId

Type: string

The ID of one subnet.

IpAddressUpdate

Description

In an UpdateResolverEndpoint request, information about an IP address to update.

Members

Ip

Type: string

The new IP address.

IpId

Type: string

Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

SubnetId

Type: string

The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

LimitExceededException

Description

The request caused one or more limits to be exceeded.

Members

Message

Type: string

ResourceType

Type: string

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

ResolverEndpoint

Description

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.

Members

Arn

Type: string

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

CreationTime

Type: string

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

CreatorRequestId

Type: 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.

Direction

Type: string

Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

INBOUND: allows DNS queries to your VPC from your network or another VPC
OUTBOUND: allows DNS queries from your VPC to your network or another VPC

HostVPCId

Type: string

The ID of the VPC that you want to create the resolver endpoint in.

Id

Type: string

The ID of the resolver endpoint.

IpAddressCount

Type: int

The number of IP addresses that the resolver endpoint can use for DNS queries.

ModificationTime

Type: string

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

Name

Type: string

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

SecurityGroupIds

Type: Array of strings

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.

Status

Type: string

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

StatusMessage

Type: string

A detailed description of the status of the resolver endpoint.

ResolverRule

Description

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.

Members

Arn

Type: string

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

CreatorRequestId

Type: string

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

DomainName

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

Id

Type: string

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

Name

Type: string

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

OwnerId

Type: string

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

ResolverEndpointId

Type: string

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

RuleType

Type: string

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

ShareStatus

Type: 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.

Status

Type: string

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

StatusMessage

Type: string

A detailed description of the status of a resolver rule.

TargetIps

Type: Array of TargetAddress structures

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

ResolverRuleAssociation

Description

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

Members

Id

Type: string

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

Name

Type: string

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

ResolverRuleId

Type: string

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

Status

Type: string

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

StatusMessage

Type: string

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

VPCId

Type: string

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

ResolverRuleConfig

Description

In an UpdateResolverRule request, information about the changes that you want to make.

Members

Name

Type: string

The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

ResolverEndpointId

Type: string

The ID of the new outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

TargetIps

Type: Array of TargetAddress structures

For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

ResourceExistsException

Description

The resource that you tried to create already exists.

Members

Message

Type: string

ResourceType

Type: string

For a ResourceExistsException error, the type of resource that the error applies to.

ResourceInUseException

Description

The resource that you tried to update or delete is currently in use.

Members

Message

Type: string

ResourceType

Type: string

For a ResourceInUseException error, the type of resource that is currently in use.

ResourceNotFoundException

Description

The specified resource doesn't exist.

Members

Message

Type: string

ResourceType

Type: string

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

ResourceUnavailableException

Description

The specified resource isn't available.

Members

Message

Type: string

ResourceType

Type: string

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

TargetAddress

Description

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

Members

Ip

Required: Yes
Type: string

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

Port

Type: int

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

ThrottlingException

Description

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

Members

Message

Type: string

UnknownResourceException

Description

The specified resource doesn't exist.

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Route 53 Resolver 2018-04-01

Operation Summary

Paginators

Operations

AssociateResolverEndpointIpAddress

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateResolverRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateResolverEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateResolverRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteResolverEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteResolverRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateResolverEndpointIpAddress

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisassociateResolverRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetResolverEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details