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.
AssociateResolverQueryLogConfig ( array $params = [] )
Associates an Amazon VPC with a specified query logging configuration.
AssociateResolverRule ( array $params = [] )
Associates a Resolver rule with a VPC.
CreateResolverEndpoint ( array $params = [] )
Creates a Resolver endpoint.
CreateResolverQueryLogConfig ( array $params = [] )
Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs.
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.
DeleteResolverQueryLogConfig ( array $params = [] )
Deletes a query logging configuration.
DeleteResolverRule ( array $params = [] )
Deletes a Resolver rule.
DisassociateResolverEndpointIpAddress ( array $params = [] )
Removes IP addresses from an inbound or an outbound Resolver endpoint.
DisassociateResolverQueryLogConfig ( array $params = [] )
Disassociates a VPC from a query logging configuration.
DisassociateResolverRule ( array $params = [] )
Removes the association between a specified Resolver rule and a specified VPC.
GetResolverDnssecConfig ( array $params = [] )
Gets DNSSEC validation information for a specified resource.
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.
GetResolverQueryLogConfig ( array $params = [] )
Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.
GetResolverQueryLogConfigAssociation ( array $params = [] )
Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC.
GetResolverQueryLogConfigPolicy ( array $params = [] )
Gets information about a query logging policy.
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 the Resolver rule policy for a specified rule.
ListResolverDnssecConfigs ( array $params = [] )
Lists the configurations for DNSSEC validation that are associated with the current AWS account.
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.
ListResolverQueryLogConfigAssociations ( array $params = [] )
Lists information about associations between Amazon VPCs and query logging configurations.
ListResolverQueryLogConfigs ( array $params = [] )
Lists information about the specified query logging configurations.
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.
PutResolverQueryLogConfigPolicy ( array $params = [] )
Specifies an AWS account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.
PutResolverRulePolicy ( array $params = [] )
Specifies an AWS rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.
TagResource ( array $params = [] )
Adds one or more tags to a specified resource.
UntagResource ( array $params = [] )
Removes one or more tags from a specified resource.
UpdateResolverDnssecConfig ( array $params = [] )
Updates an existing DNSSEC validation configuration.
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:

ListResolverDnssecConfigs
ListResolverEndpointIpAddresses
ListResolverEndpoints
ListResolverQueryLogConfigAssociations
ListResolverQueryLogConfigs
ListResolverRuleAssociations
ListResolverRules
ListTagsForResource

Operations

AssociateResolverEndpointIpAddress

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

Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add 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.

AssociateResolverQueryLogConfig

$result = $client->associateResolverQueryLogConfig([/* ... */]);
$promise = $client->associateResolverQueryLogConfigAsync([/* ... */]);

Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.

The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.

To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.

Parameter Syntax

$result = $client->associateResolverQueryLogConfig([
    'ResolverQueryLogConfigId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverQueryLogConfigId

Required: Yes
Type: string

The ID of the query logging configuration that you want to associate a VPC with.

ResourceId

Required: Yes
Type: string

The ID of an Amazon VPC that you want this query logging configuration to log queries for.

The VPCs and the query logging configuration must be in the same Region.

Result Syntax

[
    'ResolverQueryLogConfigAssociation' => [
        'CreationTime' => '<string>',
        'Error' => 'NONE|DESTINATION_NOT_FOUND|ACCESS_DENIED|INTERNAL_SERVICE_ERROR',
        'ErrorMessage' => '<string>',
        'Id' => '<string>',
        'ResolverQueryLogConfigId' => '<string>',
        'ResourceId' => '<string>',
        'Status' => 'CREATING|ACTIVE|ACTION_NEEDED|DELETING|FAILED',
    ],
]

Result Details

Members

ResolverQueryLogConfigAssociation

Type: ResolverQueryLogConfigAssociation structure

A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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.
LimitExceededException:
The request caused one or more limits to be exceeded.
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.
An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.

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>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

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
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network

IpAddresses

Required: Yes
Type: Array of IpAddressRequest structures

The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.

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). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

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.

CreateResolverQueryLogConfig

$result = $client->createResolverQueryLogConfig([/* ... */]);
$promise = $client->createResolverQueryLogConfigAsync([/* ... */]);

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.

To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig.

You can optionally use AWS Resource Access Manager (AWS RAM) to share a query logging configuration with other AWS accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.

Parameter Syntax

$result = $client->createResolverQueryLogConfig([
    'CreatorRequestId' => '<string>', // REQUIRED
    'DestinationArn' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

CreatorRequestId

Required: Yes
Type: string

DestinationArn

Required: Yes
Type: string

The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:

S3 bucket:

arn:aws:s3:::examplebucket

You can optionally append a file prefix to the end of the ARN.

arn:aws:s3:::examplebucket/development/
CloudWatch Logs log group:

arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:

arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name

Name

Required: Yes
Type: string

The name that you want to give the query logging configuration

Tags

Type: Array of Tag structures

A list of the tag keys and values that you want to associate with the query logging configuration.

Result Syntax

[
    'ResolverQueryLogConfig' => [
        'Arn' => '<string>',
        'AssociationCount' => <integer>,
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DestinationArn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'CREATING|CREATED|DELETING|FAILED',
    ],
]

Result Details

Members

ResolverQueryLogConfig

Type: ResolverQueryLogConfig structure

Information about the CreateResolverQueryLogConfig 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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    '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

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

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.

TargetIps is available only when the value of Rule type is FORWARD.

Result Syntax

[
    'ResolverRule' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<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 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.

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.

DeleteResolverQueryLogConfig

$result = $client->deleteResolverQueryLogConfig([/* ... */]);
$promise = $client->deleteResolverQueryLogConfigAsync([/* ... */]);

Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other AWS accounts, and the other accounts have associated VPCs with the shared configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.

If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.

Parameter Syntax

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

Parameter Details

Members

ResolverQueryLogConfigId

Required: Yes
Type: string

The ID of the query logging configuration that you want to delete.

Result Syntax

[
    'ResolverQueryLogConfig' => [
        'Arn' => '<string>',
        'AssociationCount' => <integer>,
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DestinationArn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'CREATING|CREATED|DELETING|FAILED',
    ],
]

Result Details

Members

ResolverQueryLogConfig

Type: ResolverQueryLogConfig structure

Information about the query logging configuration that you deleted, 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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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 information, 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>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<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.

DisassociateResolverQueryLogConfig

$result = $client->disassociateResolverQueryLogConfig([/* ... */]);
$promise = $client->disassociateResolverQueryLogConfigAsync([/* ... */]);

Disassociates a VPC from a query logging configuration.

Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:

The accounts that you shared the configuration with can disassociate VPCs from the configuration.
You can stop sharing the configuration.

Parameter Syntax

$result = $client->disassociateResolverQueryLogConfig([
    'ResolverQueryLogConfigId' => '<string>', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResolverQueryLogConfigId

Required: Yes
Type: string

The ID of the query logging configuration that you want to disassociate a specified VPC from.

ResourceId

Required: Yes
Type: string

The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.

Result Syntax

[
    'ResolverQueryLogConfigAssociation' => [
        'CreationTime' => '<string>',
        'Error' => 'NONE|DESTINATION_NOT_FOUND|ACCESS_DENIED|INTERNAL_SERVICE_ERROR',
        'ErrorMessage' => '<string>',
        'Id' => '<string>',
        'ResolverQueryLogConfigId' => '<string>',
        'ResourceId' => '<string>',
        'Status' => 'CREATING|ACTIVE|ACTION_NEEDED|DELETING|FAILED',
    ],
]

Result Details

Members

ResolverQueryLogConfigAssociation

Type: ResolverQueryLogConfigAssociation structure

A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.

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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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.

GetResolverDnssecConfig

$result = $client->getResolverDnssecConfig([/* ... */]);
$promise = $client->getResolverDnssecConfigAsync([/* ... */]);

Gets DNSSEC validation information for a specified resource.

Parameter Syntax

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

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The ID of the virtual private cloud (VPC) for the DNSSEC validation status.

Result Syntax

[
    'ResolverDNSSECConfig' => [
        'Id' => '<string>',
        'OwnerId' => '<string>',
        'ResourceId' => '<string>',
        'ValidationStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED',
    ],
]

Result Details

Members

ResolverDNSSECConfig

Type: ResolverDnssecConfig structure

The information about a configuration for DNSSEC validation.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
ResourceNotFoundException:
The specified resource doesn't exist.
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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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.

GetResolverQueryLogConfig

$result = $client->getResolverQueryLogConfig([/* ... */]);
$promise = $client->getResolverQueryLogConfigAsync([/* ... */]);

Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.

Parameter Syntax

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

Parameter Details

Members

ResolverQueryLogConfigId

Required: Yes
Type: string

The ID of the Resolver query logging configuration that you want to get information about.

Result Syntax

[
    'ResolverQueryLogConfig' => [
        'Arn' => '<string>',
        'AssociationCount' => <integer>,
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DestinationArn' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'CREATING|CREATED|DELETING|FAILED',
    ],
]

Result Details

Members

ResolverQueryLogConfig

Type: ResolverQueryLogConfig structure

Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig 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.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

GetResolverQueryLogConfigAssociation

$result = $client->getResolverQueryLogConfigAssociation([/* ... */]);
$promise = $client->getResolverQueryLogConfigAssociationAsync([/* ... */]);

Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.

Parameter Syntax

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

Parameter Details

Members

ResolverQueryLogConfigAssociationId

Required: Yes
Type: string

The ID of the Resolver query logging configuration association that you want to get information about.

Result Syntax

[
    'ResolverQueryLogConfigAssociation' => [
        'CreationTime' => '<string>',
        'Error' => 'NONE|DESTINATION_NOT_FOUND|ACCESS_DENIED|INTERNAL_SERVICE_ERROR',
        'ErrorMessage' => '<string>',
        'Id' => '<string>',
        'ResolverQueryLogConfigId' => '<string>',
        'ResourceId' => '<string>',
        'Status' => 'CREATING|ACTIVE|ACTION_NEEDED|DELETING|FAILED',
    ],
]

Result Details

Members

ResolverQueryLogConfigAssociation

Type: ResolverQueryLogConfigAssociation structure

Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation 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.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

GetResolverQueryLogConfigPolicy

$result = $client->getResolverQueryLogConfigPolicy([/* ... */]);
$promise = $client->getResolverQueryLogConfigPolicyAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Members

Arn

Required: Yes
Type: string

The ARN of the query logging configuration that you want to get the query logging policy for.

Result Syntax

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

Result Details

Members

ResolverQueryLogConfigPolicy

Type: string

Information about the query logging policy for the query logging configuration that you specified in a GetResolverQueryLogConfigPolicy request.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
UnknownResourceException:
The specified resource doesn't exist.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<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 the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use.

Parameter Syntax

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

Parameter Details

Members

Arn

Required: Yes
Type: string

The ID of the Resolver rule that you want to get the Resolver rule policy for.

Result Syntax

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

Result Details

Members

ResolverRulePolicy

Type: string

The Resolver rule policy for the rule 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.

ListResolverDnssecConfigs

$result = $client->listResolverDnssecConfigs([/* ... */]);
$promise = $client->listResolverDnssecConfigsAsync([/* ... */]);

Lists the configurations for DNSSEC validation that are associated with the current AWS account.

Parameter Syntax

$result = $client->listResolverDnssecConfigs([
    '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 objects.

MaxResults

Type: int

Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 100 configuration per page.

NextToken

Type: string

(Optional) If the current AWS account has more than MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverDnssecConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

Result Syntax

[
    'NextToken' => '<string>',
    'ResolverDnssecConfigs' => [
        [
            'Id' => '<string>',
            'OwnerId' => '<string>',
            'ResourceId' => '<string>',
            'ValidationStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

If a response includes the last of the DNSSEC configurations that are associated with the current AWS account, NextToken doesn't appear in the response.

If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverDnssecConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

ResolverDnssecConfigs

Type: Array of ResolverDnssecConfig structures

An array that contains one ResolverDnssecConfig element for each configuration for DNSSEC validation that is associated with the current AWS account.

Errors

InvalidNextTokenException:
The value that you specified for NextToken in a List request isn't valid.
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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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

Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

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.

ListResolverQueryLogConfigAssociations

$result = $client->listResolverQueryLogConfigAssociations([/* ... */]);
$promise = $client->listResolverQueryLogConfigAssociationsAsync([/* ... */]);

Lists information about associations between Amazon VPCs and query logging configurations.

Parameter Syntax

$result = $client->listResolverQueryLogConfigAssociations([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => '<string>',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

An optional specification to return a subset of query logging associations.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations 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 query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging associations.

NextToken

Type: string

For the first ListResolverQueryLogConfigAssociations request, omit this value.

If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

SortBy

Type: string

The element that you want Resolver to sort query logging associations by.

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

Valid values include the following elements:

CreationTime: The ID of the query logging association.
Error: If the value of Status is FAILED, the value of Error indicates the cause:
- DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
- ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If Status is a value other than FAILED, ERROR is null.
Id: The ID of the query logging association
ResolverQueryLogConfigId: The ID of the query logging configuration
ResourceId: The ID of the VPC that is associated with the query logging configuration
Status: The current status of the configuration. Valid values include the following:
- CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
- CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
- DELETING: Resolver is deleting this query logging association.
- FAILED: Resolver either couldn't create or couldn't delete the query logging association. Here are two common causes:
  - The specified destination (for example, an Amazon S3 bucket) was deleted.
  - Permissions don't allow sending logs to the destination.

SortOrder

Type: string

If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.

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

Result Syntax

[
    'NextToken' => '<string>',
    'ResolverQueryLogConfigAssociations' => [
        [
            'CreationTime' => '<string>',
            'Error' => 'NONE|DESTINATION_NOT_FOUND|ACCESS_DENIED|INTERNAL_SERVICE_ERROR',
            'ErrorMessage' => '<string>',
            'Id' => '<string>',
            'ResolverQueryLogConfigId' => '<string>',
            'ResourceId' => '<string>',
            'Status' => 'CREATING|ACTIVE|ACTION_NEEDED|DELETING|FAILED',
        ],
        // ...
    ],
    'TotalCount' => <integer>,
    'TotalFilteredCount' => <integer>,
]

Result Details

Members

NextToken

Type: string

If there are more than MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

ResolverQueryLogConfigAssociations

Type: Array of ResolverQueryLogConfigAssociation structures

A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for Filter.

TotalCount

Type: int

The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.

TotalFilteredCount

Type: int

The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.

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.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

ListResolverQueryLogConfigs

$result = $client->listResolverQueryLogConfigs([/* ... */]);
$promise = $client->listResolverQueryLogConfigsAsync([/* ... */]);

Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.

Parameter Syntax

$result = $client->listResolverQueryLogConfigs([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortBy' => '<string>',
    'SortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Members

Filters

Type: Array of Filter structures

An optional specification to return a subset of query logging configurations.

If you submit a second or subsequent ListResolverQueryLogConfigs 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 query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

NextToken

Type: string

For the first ListResolverQueryLogConfigs request, omit this value.

If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

SortBy

Type: string

The element that you want Resolver to sort query logging configurations by.

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

Valid values include the following elements:

Arn: The ARN of the query logging configuration
AssociationCount: The number of VPCs that are associated with the specified configuration
CreationTime: The date and time that Resolver returned when the configuration was created
CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created
DestinationArn: The location that logs are sent to
Id: The ID of the configuration
Name: The name of the configuration
OwnerId: The AWS account number of the account that created the configuration
ShareStatus: Whether the configuration is shared with other AWS accounts or shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).
Status: The current status of the configuration. Valid values include the following:
- CREATING: Resolver is creating the query logging configuration.
- CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
- DELETING: Resolver is deleting this query logging configuration.
- FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:
  - The specified destination (for example, an Amazon S3 bucket) was deleted.
  - Permissions don't allow sending logs to the destination.

SortOrder

Type: string

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

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

Result Syntax

[
    'NextToken' => '<string>',
    'ResolverQueryLogConfigs' => [
        [
            'Arn' => '<string>',
            'AssociationCount' => <integer>,
            'CreationTime' => '<string>',
            'CreatorRequestId' => '<string>',
            'DestinationArn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'OwnerId' => '<string>',
            'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
            'Status' => 'CREATING|CREATED|DELETING|FAILED',
        ],
        // ...
    ],
    'TotalCount' => <integer>,
    'TotalFilteredCount' => <integer>,
]

Result Details

Members

NextToken

Type: string

If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

ResolverQueryLogConfigs

Type: Array of ResolverQueryLogConfig structures

A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.

TotalCount

Type: int

The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.

TotalFilteredCount

Type: int

The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see TotalCount.

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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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>',
            'CreationTime' => '<string>',
            'CreatorRequestId' => '<string>',
            'DomainName' => '<string>',
            'Id' => '<string>',
            'ModificationTime' => '<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.

PutResolverQueryLogConfigPolicy

$result = $client->putResolverQueryLogConfigPolicy([/* ... */]);
$promise = $client->putResolverQueryLogConfigPolicyAsync([/* ... */]);

Specifies an AWS account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.

Parameter Syntax

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

Parameter Details

Members

Arn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the account that you want to share rules with.

ResolverQueryLogConfigPolicy

Required: Yes
Type: string

An AWS Identity and Access Management policy statement that lists the query logging configurations that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

route53resolver:AssociateResolverQueryLogConfig
route53resolver:DisassociateResolverQueryLogConfig
route53resolver:ListResolverQueryLogConfigAssociations
route53resolver:ListResolverQueryLogConfigs

In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.

Result Syntax

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

Result Details

Members

ReturnValue

Type: boolean

Whether the PutResolverQueryLogConfigPolicy request was successful.

Errors

InvalidPolicyDocument:
The specified Resolver rule policy is invalid.
InvalidParameterException:
One or more parameters in this request are not valid.
InvalidRequestException:
The request is invalid.
UnknownResourceException:
The specified resource doesn't exist.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

PutResolverRulePolicy

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

Specifies an AWS rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.

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 rule that you want to share with another account.

ResolverRulePolicy

Required: Yes
Type: string

An AWS Identity and Access Management policy statement that lists the rules that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:

route53resolver:GetResolverRule
route53resolver:AssociateResolverRule
route53resolver:DisassociateResolverRule
route53resolver:ListResolverRules
route53resolver:ListResolverRuleAssociations

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.

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>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

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:

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.
InvalidRequestException:
The request is invalid.
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:

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

UpdateResolverDnssecConfig

$result = $client->updateResolverDnssecConfig([/* ... */]);
$promise = $client->updateResolverDnssecConfigAsync([/* ... */]);

Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.

Parameter Syntax

$result = $client->updateResolverDnssecConfig([
    'ResourceId' => '<string>', // REQUIRED
    'Validation' => 'ENABLE|DISABLE', // REQUIRED
]);

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for.

Validation

Required: Yes
Type: string

The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status change to be completed.

Result Syntax

[
    'ResolverDNSSECConfig' => [
        'Id' => '<string>',
        'OwnerId' => '<string>',
        'ResourceId' => '<string>',
        'ValidationStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED',
    ],
]

Result Details

Members

ResolverDNSSECConfig

Type: ResolverDnssecConfig structure

A complex type that contains settings for the specified DNSSEC configuration.

Errors

InvalidParameterException:
One or more parameters in this request are not valid.
ResourceNotFoundException:
The specified resource doesn't exist.
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.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.

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>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainName' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<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

AccessDeniedException

Description

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

Members

Message

Type: string

Filter

Description

For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.

To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

Members

Name

Type: string

The name of the parameter that you want to use to filter objects.

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

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

ListResolverEndpoints