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

AssociateFirewallRuleGroup ( array $params = [] )
Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.
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.
CreateFirewallDomainList ( array $params = [] )
Creates an empty firewall domain list for use in DNS Firewall rules.
CreateFirewallRule ( array $params = [] )
Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.
CreateFirewallRuleGroup ( array $params = [] )
Creates an empty DNS Firewall rule group for filtering DNS network traffic in 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.
DeleteFirewallDomainList ( array $params = [] )
Deletes the specified domain list.
DeleteFirewallRule ( array $params = [] )
Deletes the specified firewall rule.
DeleteFirewallRuleGroup ( array $params = [] )
Deletes the specified firewall rule group.
DeleteResolverEndpoint ( array $params = [] )
Deletes a Resolver endpoint.
DeleteResolverQueryLogConfig ( array $params = [] )
Deletes a query logging configuration.
DeleteResolverRule ( array $params = [] )
Deletes a Resolver rule.
DisassociateFirewallRuleGroup ( array $params = [] )
Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.
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.
GetFirewallConfig ( array $params = [] )
Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
GetFirewallDomainList ( array $params = [] )
Retrieves the specified firewall domain list.
GetFirewallRuleGroup ( array $params = [] )
Retrieves the specified firewall rule group.
GetFirewallRuleGroupAssociation ( array $params = [] )
Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group.
GetFirewallRuleGroupPolicy ( array $params = [] )
Returns the AWS Identity and Access Management (AWS IAM) policy for sharing the specified rule group.
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.
ImportFirewallDomains ( array $params = [] )
Imports domain names from a file into a domain list, for use in a DNS firewall rule group.
ListFirewallConfigs ( array $params = [] )
Retrieves the firewall configurations that you have defined.
ListFirewallDomainLists ( array $params = [] )
Retrieves the firewall domain lists that you have defined.
ListFirewallDomains ( array $params = [] )
Retrieves the domains that you have defined for the specified firewall domain list.
ListFirewallRuleGroupAssociations ( array $params = [] )
Retrieves the firewall rule group associations that you have defined.
ListFirewallRuleGroups ( array $params = [] )
Retrieves the minimal high-level information for the rule groups that you have defined.
ListFirewallRules ( array $params = [] )
Retrieves the firewall rules that you have defined for the specified firewall rule group.
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.
PutFirewallRuleGroupPolicy ( array $params = [] )
Attaches an AWS Identity and Access Management (AWS IAM) policy for sharing the rule group.
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.
UpdateFirewallConfig ( array $params = [] )
Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
UpdateFirewallDomains ( array $params = [] )
Updates the firewall domain list from an array of domain specifications.
UpdateFirewallRule ( array $params = [] )
Updates the specified firewall rule.
UpdateFirewallRuleGroupAssociation ( array $params = [] )
Changes the association of a FirewallRuleGroup with a VPC.
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:

ListFirewallConfigs
ListFirewallDomainLists
ListFirewallDomains
ListFirewallRuleGroupAssociations
ListFirewallRuleGroups
ListFirewallRules
ListResolverDnssecConfigs
ListResolverEndpointIpAddresses
ListResolverEndpoints
ListResolverQueryLogConfigAssociations
ListResolverQueryLogConfigs
ListResolverRuleAssociations
ListResolverRules
ListTagsForResource

Operations

AssociateFirewallRuleGroup

$result = $client->associateFirewallRuleGroup([/* ... */]);
$promise = $client->associateFirewallRuleGroupAsync([/* ... */]);

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

Parameter Syntax

$result = $client->associateFirewallRuleGroup([
    'CreatorRequestId' => '<string>', // REQUIRED
    'FirewallRuleGroupId' => '<string>', // REQUIRED
    'MutationProtection' => 'ENABLED|DISABLED',
    'Name' => '<string>', // REQUIRED
    'Priority' => <integer>, // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'VpcId' => '<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 running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group.

MutationProtection

Type: string

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. When you create the association, the default setting is DISABLED.

Name

Required: Yes
Type: string

A name that lets you identify the association, to manage and use it.

Priority

Required: Yes
Type: int

The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.

The allowed values for Priority are between 100 and 9900.

Tags

Type: Array of Tag structures

A list of the tag keys and values that you want to associate with the rule group association.

VpcId

Required: Yes
Type: string

The unique identifier of the VPC that you want to associate with the rule group.

Result Syntax

[
    'FirewallRuleGroupAssociation' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'MutationProtection' => 'ENABLED|DISABLED',
        'Name' => '<string>',
        'Priority' => <integer>,
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroupAssociation

Type: FirewallRuleGroupAssociation structure

The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
ValidationException:
LimitExceededException:
The request caused one or more limits to be exceeded.
ConflictException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

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.

CreateFirewallDomainList

$result = $client->createFirewallDomainList([/* ... */]);
$promise = $client->createFirewallDomainListAsync([/* ... */]);

Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.

Parameter Syntax

$result = $client->createFirewallDomainList([
    'CreatorRequestId' => '<string>', // REQUIRED
    'Name' => '<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 you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

Name

Required: Yes
Type: string

A name that lets you identify the domain list to manage and use it.

Tags

Type: Array of Tag structures

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

Result Syntax

[
    'FirewallDomainList' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainCount' => <integer>,
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'Status' => 'COMPLETE|COMPLETE_IMPORT_FAILED|IMPORTING|DELETING|UPDATING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

FirewallDomainList

Type: FirewallDomainList structure

The domain list that you just created.

Errors

LimitExceededException:
The request caused one or more limits to be exceeded.
ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

CreateFirewallRule

$result = $client->createFirewallRule([/* ... */]);
$promise = $client->createFirewallRuleAsync([/* ... */]);

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

Parameter Syntax

$result = $client->createFirewallRule([
    'Action' => 'ALLOW|BLOCK|ALERT', // REQUIRED
    'BlockOverrideDnsType' => 'CNAME',
    'BlockOverrideDomain' => '<string>',
    'BlockOverrideTtl' => <integer>,
    'BlockResponse' => 'NODATA|NXDOMAIN|OVERRIDE',
    'CreatorRequestId' => '<string>', // REQUIRED
    'FirewallDomainListId' => '<string>', // REQUIRED
    'FirewallRuleGroupId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Priority' => <integer>, // REQUIRED
]);

Parameter Details

Members

Action

Required: Yes
Type: string

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

ALLOW - Permit the request to go through.
ALERT - Permit the request and send metrics and logs to Cloud Watch.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

BlockOverrideDnsType

Type: string

The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

BlockOverrideDomain

Type: string

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

BlockOverrideTtl

Type: int

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

This setting is required if the BlockResponse setting is OVERRIDE.

BlockResponse

Type: string

The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.

NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

This setting is required if the rule action setting is BLOCK.

CreatorRequestId

Required: Yes
Type: string

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list that you want to use in the rule.

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group where you want to create the rule.

Name

Required: Yes
Type: string

A name that lets you identify the rule in the rule group.

Priority

Required: Yes
Type: int

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

Result Syntax

[
    'FirewallRule' => [
        'Action' => 'ALLOW|BLOCK|ALERT',
        'BlockOverrideDnsType' => 'CNAME',
        'BlockOverrideDomain' => '<string>',
        'BlockOverrideTtl' => <integer>,
        'BlockResponse' => 'NODATA|NXDOMAIN|OVERRIDE',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallDomainListId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'Priority' => <integer>,
    ],
]

Result Details

Members

FirewallRule

Type: FirewallRule structure

The firewall rule that you just created.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
ValidationException:
LimitExceededException:
The request caused one or more limits to be exceeded.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

CreateFirewallRuleGroup

$result = $client->createFirewallRuleGroup([/* ... */]);
$promise = $client->createFirewallRuleGroupAsync([/* ... */]);

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling CreateFirewallRule.

Parameter Syntax

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

Parameter Details

Members

CreatorRequestId

Required: Yes
Type: string

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

Name

Required: Yes
Type: string

A name that lets you identify the rule group, to manage and use it.

Tags

Type: Array of Tag structures

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

Result Syntax

[
    'FirewallRuleGroup' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'RuleCount' => <integer>,
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroup

Type: FirewallRuleGroup structure

A collection of rules used to filter DNS network traffic.

Errors

LimitExceededException:
The request caused one or more limits to be exceeded.
ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
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

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

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.

DeleteFirewallDomainList

$result = $client->deleteFirewallDomainList([/* ... */]);
$promise = $client->deleteFirewallDomainListAsync([/* ... */]);

Deletes the specified domain list.

Parameter Syntax

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

Parameter Details

Members

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list that you want to delete.

Result Syntax

[
    'FirewallDomainList' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainCount' => <integer>,
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'Status' => 'COMPLETE|COMPLETE_IMPORT_FAILED|IMPORTING|DELETING|UPDATING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

FirewallDomainList

Type: FirewallDomainList structure

The domain list that you just deleted.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
ConflictException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

DeleteFirewallRule

$result = $client->deleteFirewallRule([/* ... */]);
$promise = $client->deleteFirewallRuleAsync([/* ... */]);

Deletes the specified firewall rule.

Parameter Syntax

$result = $client->deleteFirewallRule([
    'FirewallDomainListId' => '<string>', // REQUIRED
    'FirewallRuleGroupId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list that's used in the rule.

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group that you want to delete the rule from.

Result Syntax

[
    'FirewallRule' => [
        'Action' => 'ALLOW|BLOCK|ALERT',
        'BlockOverrideDnsType' => 'CNAME',
        'BlockOverrideDomain' => '<string>',
        'BlockOverrideTtl' => <integer>,
        'BlockResponse' => 'NODATA|NXDOMAIN|OVERRIDE',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallDomainListId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'Priority' => <integer>,
    ],
]

Result Details

Members

FirewallRule

Type: FirewallRule structure

The specification for the firewall rule that you just deleted.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

DeleteFirewallRuleGroup

$result = $client->deleteFirewallRuleGroup([/* ... */]);
$promise = $client->deleteFirewallRuleGroupAsync([/* ... */]);

Deletes the specified firewall rule group.

Parameter Syntax

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

Parameter Details

Members

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group that you want to delete.

Result Syntax

[
    'FirewallRuleGroup' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'RuleCount' => <integer>,
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroup

Type: FirewallRuleGroup structure

A collection of rules used to filter DNS network traffic.

Errors

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

DisassociateFirewallRuleGroup

$result = $client->disassociateFirewallRuleGroup([/* ... */]);
$promise = $client->disassociateFirewallRuleGroupAsync([/* ... */]);

Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.

Parameter Syntax

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

Parameter Details

Members

FirewallRuleGroupAssociationId

Required: Yes
Type: string

The identifier of the FirewallRuleGroupAssociation.

Result Syntax

[
    'FirewallRuleGroupAssociation' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'MutationProtection' => 'ENABLED|DISABLED',
        'Name' => '<string>',
        'Priority' => <integer>,
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroupAssociation

Type: FirewallRuleGroupAssociation structure

The firewall rule group association that you just removed.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
ConflictException:
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 AWS Resource Access Manager (AWS 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.

GetFirewallConfig

$result = $client->getFirewallConfig([/* ... */]);
$promise = $client->getFirewallConfigAsync([/* ... */]);

Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

Parameter Syntax

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

Parameter Details

Members

ResourceId

Required: Yes
Type: string

The ID of the VPC from Amazon VPC that the configuration is for.

Result Syntax

[
    'FirewallConfig' => [
        'FirewallFailOpen' => 'ENABLED|DISABLED',
        'Id' => '<string>',
        'OwnerId' => '<string>',
        'ResourceId' => '<string>',
    ],
]

Result Details

Members

FirewallConfig

Type: FirewallConfig structure

Configuration of the firewall behavior provided by DNS Firewall for a single VPC from AmazonVPC.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.
ValidationException:

GetFirewallDomainList

$result = $client->getFirewallDomainList([/* ... */]);
$promise = $client->getFirewallDomainListAsync([/* ... */]);

Retrieves the specified firewall domain list.

Parameter Syntax

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

Parameter Details

Members

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list.

Result Syntax

[
    'FirewallDomainList' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'DomainCount' => <integer>,
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'Status' => 'COMPLETE|COMPLETE_IMPORT_FAILED|IMPORTING|DELETING|UPDATING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

FirewallDomainList

Type: FirewallDomainList structure

The domain list that you requested.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetFirewallRuleGroup

$result = $client->getFirewallRuleGroup([/* ... */]);
$promise = $client->getFirewallRuleGroupAsync([/* ... */]);

Retrieves the specified firewall rule group.

Parameter Syntax

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

Parameter Details

Members

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group.

Result Syntax

[
    'FirewallRuleGroup' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Id' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'OwnerId' => '<string>',
        'RuleCount' => <integer>,
        'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroup

Type: FirewallRuleGroup structure

A collection of rules used to filter DNS network traffic.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetFirewallRuleGroupAssociation

$result = $client->getFirewallRuleGroupAssociation([/* ... */]);
$promise = $client->getFirewallRuleGroupAssociationAsync([/* ... */]);

Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.

Parameter Syntax

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

Parameter Details

Members

FirewallRuleGroupAssociationId

Required: Yes
Type: string

The identifier of the FirewallRuleGroupAssociation.

Result Syntax

[
    'FirewallRuleGroupAssociation' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'MutationProtection' => 'ENABLED|DISABLED',
        'Name' => '<string>',
        'Priority' => <integer>,
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroupAssociation

Type: FirewallRuleGroupAssociation structure

The association that you requested.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

GetFirewallRuleGroupPolicy

$result = $client->getFirewallRuleGroupPolicy([/* ... */]);
$promise = $client->getFirewallRuleGroupPolicyAsync([/* ... */]);

Returns the AWS Identity and Access Management (AWS IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using AWS Resource Access Manager (AWS RAM).

Parameter Syntax

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

Parameter Details

Members

Arn

Required: Yes
Type: string

The ARN (Amazon Resource Name) for the rule group.

Result Syntax

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

Result Details

Members

FirewallRuleGroupPolicy

Type: string

The AWS Identity and Access Management (AWS IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using AWS Resource Access Manager (AWS RAM).

Errors

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

ImportFirewallDomains

$result = $client->importFirewallDomains([/* ... */]);
$promise = $client->importFirewallDomainsAsync([/* ... */]);

Imports domain names from a file into a domain list, for use in a DNS firewall rule group.

Each domain specification in your domain list must satisfy the following requirements:

It can optionally start with * (asterisk).
With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.

Parameter Syntax

$result = $client->importFirewallDomains([
    'DomainFileUrl' => '<string>', // REQUIRED
    'FirewallDomainListId' => '<string>', // REQUIRED
    'Operation' => 'REPLACE', // REQUIRED
]);

Parameter Details

Members

DomainFileUrl

Required: Yes
Type: string

The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list that you want to modify with the import operation.

Operation

Required: Yes
Type: string

What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list in the file.

Result Syntax

[
    'Id' => '<string>',
    'Name' => '<string>',
    'Status' => 'COMPLETE|COMPLETE_IMPORT_FAILED|IMPORTING|DELETING|UPDATING',
    'StatusMessage' => '<string>',
]

Result Details

Members

Id

Type: string

The Id of the firewall domain list that DNS Firewall just updated.

Name

Type: string

The name of the domain list.

Status

Type: string

StatusMessage

Type: string

Additional information about the status of the list, if available.

Errors

ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
ResourceNotFoundException:
The specified resource doesn't exist.
LimitExceededException:
The request caused one or more limits to be exceeded.
ConflictException:
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListFirewallConfigs

$result = $client->listFirewallConfigs([/* ... */]);
$promise = $client->listFirewallConfigsAsync([/* ... */]);

Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.

A single call might return only a partial list of the configurations. For information, see MaxResults.

Parameter Syntax

$result = $client->listFirewallConfigs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

NextToken

Type: string

For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Result Syntax

[
    'FirewallConfigs' => [
        [
            'FirewallFailOpen' => 'ENABLED|DISABLED',
            'Id' => '<string>',
            'OwnerId' => '<string>',
            'ResourceId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FirewallConfigs

Type: Array of FirewallConfig structures

The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC).

NextToken

Type: string

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

Errors

ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListFirewallDomainLists

$result = $client->listFirewallDomainLists([/* ... */]);
$promise = $client->listFirewallDomainListsAsync([/* ... */]);

Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling ListFirewallDomains.

A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.

Parameter Syntax

$result = $client->listFirewallDomainLists([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

NextToken

Type: string

For the first call to this list request, omit this value.

Result Syntax

[
    'FirewallDomainLists' => [
        [
            'Arn' => '<string>',
            'CreatorRequestId' => '<string>',
            'Id' => '<string>',
            'ManagedOwnerName' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FirewallDomainLists

Type: Array of FirewallDomainListMetadata structures

A list of the domain lists that you have defined.

This might be a partial list of the domain lists that you've defined. For information, see MaxResults.

NextToken

Type: string

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

Errors

ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListFirewallDomains

$result = $client->listFirewallDomains([/* ... */]);
$promise = $client->listFirewallDomainsAsync([/* ... */]);

Retrieves the domains that you have defined for the specified firewall domain list.

A single call might return only a partial list of the domains. For information, see MaxResults.

Parameter Syntax

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

Parameter Details

Members

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list whose domains you want to retrieve.

MaxResults

Type: int

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

NextToken

Type: string

For the first call to this list request, omit this value.

Result Syntax

[
    'Domains' => ['<string>', ...],
    'NextToken' => '<string>',
]

Result Details

Members

Domains

Type: Array of strings

A list of the domains in the firewall domain list.

This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.

NextToken

Type: string

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListFirewallRuleGroupAssociations

$result = $client->listFirewallRuleGroupAssociations([/* ... */]);
$promise = $client->listFirewallRuleGroupAssociationsAsync([/* ... */]);

Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.

A single call might return only a partial list of the associations. For information, see MaxResults.

Parameter Syntax

$result = $client->listFirewallRuleGroupAssociations([
    'FirewallRuleGroupId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Priority' => <integer>,
    'Status' => 'COMPLETE|DELETING|UPDATING',
    'VpcId' => '<string>',
]);

Parameter Details

Members

FirewallRuleGroupId

Type: string

The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group.

MaxResults

Type: int

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

NextToken

Type: string

For the first call to this list request, omit this value.

Priority

Type: int

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

Status

Type: string

The association Status setting that you want DNS Firewall to filter on for the list. If you don't specify this, then DNS Firewall returns all associations, regardless of status.

VpcId

Type: string

The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC.

Result Syntax

[
    'FirewallRuleGroupAssociations' => [
        [
            'Arn' => '<string>',
            'CreationTime' => '<string>',
            'CreatorRequestId' => '<string>',
            'FirewallRuleGroupId' => '<string>',
            'Id' => '<string>',
            'ManagedOwnerName' => '<string>',
            'ModificationTime' => '<string>',
            'MutationProtection' => 'ENABLED|DISABLED',
            'Name' => '<string>',
            'Priority' => <integer>,
            'Status' => 'COMPLETE|DELETING|UPDATING',
            'StatusMessage' => '<string>',
            'VpcId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FirewallRuleGroupAssociations

Type: Array of FirewallRuleGroupAssociation structures

A list of your firewall rule group associations.

This might be a partial list of the associations that you have defined. For information, see MaxResults.

NextToken

Type: string

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

Errors

ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListFirewallRuleGroups

$result = $client->listFirewallRuleGroups([/* ... */]);
$promise = $client->listFirewallRuleGroupsAsync([/* ... */]);

Retrieves the minimal high-level information for the rule groups that you have defined.

A single call might return only a partial list of the rule groups. For information, see MaxResults.

Parameter Syntax

$result = $client->listFirewallRuleGroups([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

NextToken

Type: string

For the first call to this list request, omit this value.

Result Syntax

[
    'FirewallRuleGroups' => [
        [
            'Arn' => '<string>',
            'CreatorRequestId' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'OwnerId' => '<string>',
            'ShareStatus' => 'NOT_SHARED|SHARED_WITH_ME|SHARED_BY_ME',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FirewallRuleGroups

Type: Array of FirewallRuleGroupMetadata structures

A list of your firewall rule groups.

This might be a partial list of the rule groups that you have defined. For information, see MaxResults.

NextToken

Type: string

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

Errors

ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

ListFirewallRules

$result = $client->listFirewallRules([/* ... */]);
$promise = $client->listFirewallRulesAsync([/* ... */]);

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

Parameter Syntax

$result = $client->listFirewallRules([
    'Action' => 'ALLOW|BLOCK|ALERT',
    'FirewallRuleGroupId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Priority' => <integer>,
]);

Parameter Details

Members

Action

Type: string

Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group that you want to retrieve the rules for.

MaxResults

Type: int

If you don't specify a value for MaxResults, Resolver returns up to 100 objects.

NextToken

Type: string

For the first call to this list request, omit this value.

Priority

Type: int

Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

Result Syntax

[
    'FirewallRules' => [
        [
            'Action' => 'ALLOW|BLOCK|ALERT',
            'BlockOverrideDnsType' => 'CNAME',
            'BlockOverrideDomain' => '<string>',
            'BlockOverrideTtl' => <integer>,
            'BlockResponse' => 'NODATA|NXDOMAIN|OVERRIDE',
            'CreationTime' => '<string>',
            'CreatorRequestId' => '<string>',
            'FirewallDomainListId' => '<string>',
            'FirewallRuleGroupId' => '<string>',
            'ModificationTime' => '<string>',
            'Name' => '<string>',
            'Priority' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FirewallRules

Type: Array of FirewallRule structures

A list of the rules that you have defined.

This might be a partial list of the firewall rules that you've defined. For information, see MaxResults.

NextToken

Type: string

If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.

Errors

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

PutFirewallRuleGroupPolicy

$result = $client->putFirewallRuleGroupPolicy([/* ... */]);
$promise = $client->putFirewallRuleGroupPolicyAsync([/* ... */]);

Attaches an AWS Identity and Access Management (AWS IAM) policy for sharing the rule group. You can use the policy to share the rule group using AWS Resource Access Manager (AWS RAM).

Parameter Syntax

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

Parameter Details

Members

Arn

Required: Yes
Type: string

The ARN (Amazon Resource Name) for the rule group that you want to share.

FirewallRuleGroupPolicy

Required: Yes
Type: string

The AWS Identity and Access Management (AWS IAM) policy to attach to the rule group.

Result Syntax

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

Result Details

Members

ReturnValue

Type: boolean

Errors

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

UpdateFirewallConfig

$result = $client->updateFirewallConfig([/* ... */]);
$promise = $client->updateFirewallConfigAsync([/* ... */]);

Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

Parameter Syntax

$result = $client->updateFirewallConfig([
    'FirewallFailOpen' => 'ENABLED|DISABLED', // REQUIRED
    'ResourceId' => '<string>', // REQUIRED
]);

Parameter Details

Members

FirewallFailOpen

Required: Yes
Type: string

Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

ResourceId

Required: Yes
Type: string

The ID of the VPC that the configuration is for.

Result Syntax

[
    'FirewallConfig' => [
        'FirewallFailOpen' => 'ENABLED|DISABLED',
        'Id' => '<string>',
        'OwnerId' => '<string>',
        'ResourceId' => '<string>',
    ],
]

Result Details

Members

FirewallConfig

Type: FirewallConfig structure

Configuration of the firewall behavior provided by DNS Firewall for a single VPC.

Errors

ValidationException:
ResourceNotFoundException:
The specified resource doesn't exist.
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

UpdateFirewallDomains

$result = $client->updateFirewallDomains([/* ... */]);
$promise = $client->updateFirewallDomainsAsync([/* ... */]);

Updates the firewall domain list from an array of domain specifications.

Parameter Syntax

$result = $client->updateFirewallDomains([
    'Domains' => ['<string>', ...], // REQUIRED
    'FirewallDomainListId' => '<string>', // REQUIRED
    'Operation' => 'ADD|REMOVE|REPLACE', // REQUIRED
]);

Parameter Details

Members

Domains

Required: Yes
Type: Array of strings

A list of domains to use in the update operation.

Each domain specification in your domain list must satisfy the following requirements:

It can optionally start with * (asterisk).
With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list whose domains you want to update.

Operation

Required: Yes
Type: string

What you want DNS Firewall to do with the domains that you are providing:

ADD - Add the domains to the ones that are already in the domain list.
REMOVE - Search the domain list for the domains and remove them from the list.
REPLACE - Update the domain list to exactly match the list that you are providing.

Result Syntax

[
    'Id' => '<string>',
    'Name' => '<string>',
    'Status' => 'COMPLETE|COMPLETE_IMPORT_FAILED|IMPORTING|DELETING|UPDATING',
    'StatusMessage' => '<string>',
]

Result Details

Members

Id

Type: string

The ID of the firewall domain list that DNS Firewall just updated.

Name

Type: string

The name of the domain list.

Status

Type: string

StatusMessage

Type: string

Additional information about the status of the list, if available.

Errors

ValidationException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
ResourceNotFoundException:
The specified resource doesn't exist.
LimitExceededException:
The request caused one or more limits to be exceeded.
ConflictException:
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

UpdateFirewallRule

$result = $client->updateFirewallRule([/* ... */]);
$promise = $client->updateFirewallRuleAsync([/* ... */]);

Updates the specified firewall rule.

Parameter Syntax

$result = $client->updateFirewallRule([
    'Action' => 'ALLOW|BLOCK|ALERT',
    'BlockOverrideDnsType' => 'CNAME',
    'BlockOverrideDomain' => '<string>',
    'BlockOverrideTtl' => <integer>,
    'BlockResponse' => 'NODATA|NXDOMAIN|OVERRIDE',
    'FirewallDomainListId' => '<string>', // REQUIRED
    'FirewallRuleGroupId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'Priority' => <integer>,
]);

Parameter Details

Members

Action

Type: string

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.

BlockOverrideDnsType

Type: string

The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

BlockOverrideDomain

Type: string

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

BlockOverrideTtl

Type: int

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

BlockResponse

Type: string

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

FirewallDomainListId

Required: Yes
Type: string

The ID of the domain list to use in the rule.

FirewallRuleGroupId

Required: Yes
Type: string

The unique identifier of the firewall rule group for the rule.

Name

Type: string

The name of the rule.

Priority

Type: int

The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

Result Syntax

[
    'FirewallRule' => [
        'Action' => 'ALLOW|BLOCK|ALERT',
        'BlockOverrideDnsType' => 'CNAME',
        'BlockOverrideDomain' => '<string>',
        'BlockOverrideTtl' => <integer>,
        'BlockResponse' => 'NODATA|NXDOMAIN|OVERRIDE',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallDomainListId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'Priority' => <integer>,
    ],
]

Result Details

Members

FirewallRule

Type: FirewallRule structure

The firewall rule that you just updated.

Errors

ResourceNotFoundException:
The specified resource doesn't exist.
ValidationException:
ConflictException:
AccessDeniedException:
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
InternalServiceErrorException:
We encountered an unknown error. Try again in a few minutes.
ThrottlingException:
The request was throttled. Try again in a few minutes.

UpdateFirewallRuleGroupAssociation

$result = $client->updateFirewallRuleGroupAssociation([/* ... */]);
$promise = $client->updateFirewallRuleGroupAssociationAsync([/* ... */]);

Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.

Parameter Syntax

$result = $client->updateFirewallRuleGroupAssociation([
    'FirewallRuleGroupAssociationId' => '<string>', // REQUIRED
    'MutationProtection' => 'ENABLED|DISABLED',
    'Name' => '<string>',
    'Priority' => <integer>,
]);

Parameter Details

Members

FirewallRuleGroupAssociationId

Required: Yes
Type: string

The identifier of the FirewallRuleGroupAssociation.

MutationProtection

Type: string

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

Name

Type: string

The name of the rule group association.

Priority

Type: int

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.

Result Syntax

[
    'FirewallRuleGroupAssociation' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'FirewallRuleGroupId' => '<string>',
        'Id' => '<string>',
        'ManagedOwnerName' => '<string>',
        'ModificationTime' => '<string>',
        'MutationProtection' => 'ENABLED|DISABLED',
        'Name' => '<string>',
        'Priority' => <integer>,
        'Status' => 'COMPLETE|DELETING|UPDATING',
        'StatusMessage' => '<string>',
        'VpcId' => '<string>',
    ],
]

Result Details

Members

FirewallRuleGroupAssociation

Type: FirewallRuleGroupAssociation structure

The association that you just updated.

Errors

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

ConflictException

Description

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

Valid values for Name include the following:

CreatorRequestId: The value that you specified when you created the Resolver endpoint.
Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for Values.
HostVpcId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId element.
IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.
Name: The name of the Resolver endpoint.
SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.
Status: The status of the Resolver endpoint. If you specify Status for Name, specify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in ResolverEndpoint.

ListResolverRules

Valid values for Name include the following:

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

example.com.
Name: The name of the Resolver rule.
ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.

You can filter on the Resolver endpoint only for rules that have a value of FORWARD for RuleType.
Status: The status of the Resolver rule. If you specify Status for Name, specify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, or FAILED.
Type: The type of the Resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for Values.

ListResolverRuleAssociations

Valid values for Name include the following:

Name: The name of the Resolver rule association.
ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.
Status: The status of the Resolver rule association. If you specify Status for Name, specify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or FAILED.
VPCId: The ID of the VPC that the Resolver rule is associated with.

ListResolverQueryLogConfigs

Valid values for Name include the following:

Arn: The ARN for the query logging configuration.
AssociationCount: The number of VPCs that are associated with the query logging configuration.
CreationTime: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId: A unique string that identifies the request that created the query logging configuration.
Destination: The AWS service that you want to forward query logs to. Valid values include the following:
- S3
- CloudWatchLogs
- KinesisFirehose
DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
Id: The ID of the query logging configuration
Name: The name of the query logging configuration
OwnerId: The AWS account ID for the account that created the query logging configuration.
ShareStatus: An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
Status: The status of the query logging configuration. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.

ListResolverQueryLogConfigAssociations

Valid values for Name include the following:

CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
Error: If the value of Status is FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED.
Id: The ID of the query logging association.
ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.
Status: The status of the query logging association. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.

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 Direction for Name and specify INBOUND for Values.

FirewallConfig

Description

Configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).

Members

FirewallFailOpen

Type: string

Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

Id

Type: string

The ID of the firewall configuration.

OwnerId

Type: string

The AWS account ID of the owner of the VPC that this firewall configuration applies to.

ResourceId

Type: string

The ID of the VPC that this firewall configuration applies to.

FirewallDomainList

Description

High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList.

To retrieve the domains that are defined for this domain list, call ListFirewallDomains.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the firewall domain list.

CreationTime

Type: string

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

CreatorRequestId

Type: string

DomainCount

Type: int

The number of domain names that are specified in the domain list.

Id

Type: string

The ID of the domain list.

ManagedOwnerName

Type: string

The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

ModificationTime

Type: string

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

Name

Type: string

The name of the domain list.

Status

Type: string

The status of the domain list.

StatusMessage

Type: string

Additional information about the status of the list, if available.

FirewallDomainListMetadata

Description

Minimal high-level information for a firewall domain list. The action ListFirewallDomainLists returns an array of these objects.

To retrieve full information for a firewall domain list, call GetFirewallDomainList and ListFirewallDomains.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the firewall domain list metadata.

CreatorRequestId

Type: string

Id

Type: string

The ID of the domain list.

ManagedOwnerName

Type: string

Name

Type: string

The name of the domain list.

FirewallRule

Description

A single firewall rule in a rule group.

Members

Action

Type: string

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:

ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.

BlockOverrideDnsType

Type: string

The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

BlockOverrideDomain

Type: string

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

BlockOverrideTtl

Type: int

The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

BlockResponse

Type: string

The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.

NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.

CreationTime

Type: string

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

CreatorRequestId

Type: string

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.

FirewallDomainListId

Type: string

The ID of the domain list that's used in the rule.

FirewallRuleGroupId

Type: string

The unique identifier of the firewall rule group of the rule.

ModificationTime

Type: string

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

Name

Type: string

The name of the rule.

Priority

Type: int

The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.

FirewallRuleGroup

Description

High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call ListFirewallRules.

Members

Arn

Type: string

The ARN (Amazon Resource Name) of the rule group.

CreationTime

Type: string

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

CreatorRequestId

Type: string

Id

Type: string

The ID of the rule group.

ModificationTime

Type: string

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

Name

Type: string

The name of the rule group.

OwnerId

Type: string

The AWS account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

RuleCount

Type: int

The number of rules in the rule group.

ShareStatus

Type: string

Whether the rule group is shared with other AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

Status

Type: string

The status of the domain list.

StatusMessage

Type: string

Additional information about the status of the rule group, if available.

FirewallRuleGroupAssociation

Description

An association between a firewall rule group and a VPC, which enables DNS filtering for the VPC.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the firewall rule group association.

CreationTime

Type: string

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

CreatorRequestId

Type: string

FirewallRuleGroupId

Type: string

The unique identifier of the firewall rule group.

Id

Type: string

The identifier for the association.

ManagedOwnerName

Type: string

The owner of the association, used only for associations that are not managed by you. If you use AWS Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

ModificationTime

Type: string

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

MutationProtection

Type: string

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

Name

Type: string

The name of the association.

Priority

Type: int

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.

Status

Type: string

The current status of the association.

StatusMessage

Type: string

Additional information about the status of the response, if available.

VpcId

Type: string

The unique identifier of the VPC that is associated with the rule group.

FirewallRuleGroupMetadata

Description

Minimal high-level information for a firewall rule group. The action ListFirewallRuleGroups returns an array of these objects.

To retrieve full information for a firewall rule group, call GetFirewallRuleGroup and ListFirewallRules.

Members

Arn

Type: string

The ARN (Amazon Resource Name) of the rule group.

CreatorRequestId

Type: string

Id

Type: string

The ID of the rule group.

Name

Type: string

The name of the rule group.

OwnerId

Type: string

The AWS account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

ShareStatus

Type: string

Whether the rule group is shared with other AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

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 a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). IpAddressRequest also includes the ID of the subnet that contains the IP address.

Members

Ip

Type: string

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

SubnetId

Required: Yes
Type: string

The ID of 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.

ResolverDnssecConfig

Description

A complex type that contains information about a configuration for DNSSEC validation.

Members

Id

Type: string

The ID for a configuration for DNSSEC validation.

OwnerId

Type: string

The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.

ResourceId

Type: string

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

ValidationStatus

Type: string

The validation status for a DNSSEC configuration. The status can be one of the following:

ENABLING: DNSSEC validation is being enabled but is not complete.
ENABLED: DNSSEC validation is enabled.
DISABLING: DNSSEC validation is being disabled but is not complete.
DISABLED DNSSEC validation is disabled.

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 running 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
OUTBOUND: allows DNS queries from your VPC to your network

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 rules (for inbound endpoints) or outbound rules (for outbound 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.

Status

Type: string

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
- One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
- The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.

StatusMessage

Type: string

A detailed description of the status of the Resolver endpoint.

ResolverQueryLogConfig

Description

In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains settings for one query logging configuration.

Members

Arn

Type: string

The ARN for the query logging configuration.

AssociationCount

Type: int

The number of VPCs that are associated with the query logging configuration.

CreationTime

Type: string

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

CreatorRequestId

Type: string

A unique string that identifies the request that created the query logging configuration. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

DestinationArn

Type: string

The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

Id

Type: string

The ID for the query logging configuration.

Name

Type: string

The name of the query logging configuration.

OwnerId

Type: string

The AWS account ID for the account that created the query logging configuration.

ShareStatus

Type: string

An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).

Status

Type: string

The status of the specified query logging 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 can't deliver logs to the location that is specified in 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.

ResolverQueryLogConfigAssociation

Description

In the response to an AssociateResolverQueryLogConfig, DisassociateResolverQueryLogConfig, GetResolverQueryLogConfigAssociation, or ListResolverQueryLogConfigAssociations, request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.

Members

CreationTime

Type: string

The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

Error

Type: string

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 the value of Status is a value other than FAILED, Error is null.

ErrorMessage

Type: string

Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

Id

Type: string

The ID of the query logging association.

ResolverQueryLogConfigId

Type: string

The ID of the query logging configuration that a VPC is associated with.

ResourceId

Type: string

The ID of the Amazon VPC that is associated with the query logging configuration.

Status

Type: string

The status of the specified query logging association. 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.

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.

CreationTime

Type: string

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

CreatorRequestId

Type: string

A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running 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.

ModificationTime

Type: string

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

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

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.

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

ShareStatus

Type: string

Whether the rule 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 an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.

ResolverRuleAssociation

Description

In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.

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

ValidationException

Description

Members

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Route 53 Resolver 2018-04-01

Operation Summary

Paginators

Operations

AssociateFirewallRuleGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateResolverEndpointIpAddress

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateResolverQueryLogConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociateResolverRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFirewallDomainList

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFirewallRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateFirewallRuleGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateResolverEndpoint

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateResolverQueryLogConfig

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details