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

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

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

LimitExceededException:

The request caused one or more limits to be exceeded.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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>',
        'Ipv6' => '<string>',
        'SubnetId' => '<string>',
    ],
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

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

Parameter Syntax

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

Parameter Details

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

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

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

Errors

LimitExceededException:

The request caused one or more limits to be exceeded.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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
    'FirewallDomainRedirectionAction' => 'INSPECT_REDIRECTION_DOMAIN|TRUST_REDIRECTION_DOMAIN',
    'FirewallRuleGroupId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Priority' => <integer>, // REQUIRED
    'Qtype' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

Errors

LimitExceededException:

The request caused one or more limits to be exceeded.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ThrottlingException:

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

CreateOutpostResolver

$result = $client->createOutpostResolver([/* ... */]);
$promise = $client->createOutpostResolverAsync([/* ... */]);

Creates a Route 53 Resolver on an Outpost.

Parameter Syntax

$result = $client->createOutpostResolver([
    'CreatorRequestId' => '<string>', // REQUIRED
    'InstanceCount' => <integer>,
    'Name' => '<string>', // REQUIRED
    'OutpostArn' => '<string>', // REQUIRED
    'PreferredInstanceType' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'OutpostResolver' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Id' => '<string>',
        'InstanceCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'PreferredInstanceType' => '<string>',
        'Status' => 'CREATING|OPERATIONAL|UPDATING|DELETING|ACTION_NEEDED|FAILED_CREATION|FAILED_DELETION',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ResourceNotFoundException:

The specified resource doesn't exist.

ServiceQuotaExceededException:

Fulfilling the request would cause one or more quotas to be exceeded.

ThrottlingException:

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

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

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>',
            'Ipv6' => '<string>',
            'SubnetId' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'Name' => '<string>',
    'OutpostArn' => '<string>',
    'PreferredInstanceType' => '<string>',
    'Protocols' => ['<string>', ...],
    'ResolverEndpointType' => 'IPV6|IPV4|DUALSTACK',
    'SecurityGroupIds' => ['<string>', ...], // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

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

Result Details

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.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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 Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services 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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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>',
    'Name' => '<string>',
    'ResolverEndpointId' => '<string>',
    'RuleType' => 'FORWARD|SYSTEM|RECURSIVE', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'TargetIps' => [
        [
            'Ip' => '<string>',
            'Ipv6' => '<string>',
            'Port' => <integer>,
            'Protocol' => 'DoH|Do53|DoH-FIPS',
            'ServerNameIndication' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

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>',
                'Ipv6' => '<string>',
                'Port' => <integer>,
                'Protocol' => 'DoH|Do53|DoH-FIPS',
                'ServerNameIndication' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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
    'Qtype' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ThrottlingException:

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

DeleteOutpostResolver

$result = $client->deleteOutpostResolver([/* ... */]);
$promise = $client->deleteOutpostResolverAsync([/* ... */]);

Deletes a Resolver on the Outpost.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'OutpostResolver' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Id' => '<string>',
        'InstanceCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'PreferredInstanceType' => '<string>',
        'Status' => 'CREATING|OPERATIONAL|UPDATING|DELETING|ACTION_NEEDED|FAILED_CREATION|FAILED_DELETION',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

InternalServiceErrorException:

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

ResourceNotFoundException:

The specified resource doesn't exist.

ThrottlingException:

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

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

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

Result Syntax

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

Result Details

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 Amazon Web Services 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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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>',
                'Ipv6' => '<string>',
                'Port' => <integer>,
                'Protocol' => 'DoH|Do53|DoH-FIPS',
                'ServerNameIndication' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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

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

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

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>',
        'Ipv6' => '<string>',
        'SubnetId' => '<string>',
    ],
    'ResolverEndpointId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

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.

Parameter Syntax

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

Parameter Details

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

DisassociateResolverRule

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ThrottlingException:

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

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

GetFirewallDomainList

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

Retrieves the specified firewall domain list.

Parameter Syntax

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

Parameter Details

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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 Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ResourceNotFoundException:

The specified resource doesn't exist.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ThrottlingException:

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

GetOutpostResolver

$result = $client->getOutpostResolver([/* ... */]);
$promise = $client->getOutpostResolverAsync([/* ... */]);

Gets information about a specified Resolver on the Outpost, such as its instance count and type, name, and the current status of the Resolver.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'OutpostResolver' => [
        'Arn' => '<string>',
        'CreationTime' => '<string>',
        'CreatorRequestId' => '<string>',
        'Id' => '<string>',
        'InstanceCount' => <integer>,
        'ModificationTime' => '<string>',
        'Name' => '<string>',
        'OutpostArn' => '<string>',
        'PreferredInstanceType' => '<string>',
        'Status' => 'CREATING|OPERATIONAL|UPDATING|DELETING|ACTION_NEEDED|FAILED_CREATION|FAILED_DELETION',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ResourceNotFoundException:

The specified resource doesn't exist.

ThrottlingException:

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

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

GetResolverConfig

$result = $client->getResolverConfig([/* ... */]);
$promise = $client->getResolverConfigAsync([/* ... */]);

Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'ResolverConfig' => [
        'AutodefinedReverse' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING_TO_USE_LOCAL_RESOURCE_SETTING|USE_LOCAL_RESOURCE_SETTING',
        'Id' => '<string>',
        'OwnerId' => '<string>',
        'ResourceId' => '<string>',
    ],
]

Result Details

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.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

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

Result Syntax

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

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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 Amazon Web Services account to be able to use.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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>',
                'Ipv6' => '<string>',
                'Port' => <integer>,
                'Protocol' => 'DoH|Do53|DoH-FIPS',
                'ServerNameIndication' => '<string>',
            ],
            // ...
        ],
    ],
]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ResourceNotFoundException:

The specified resource doesn't exist.

LimitExceededException:

The request caused one or more limits to be exceeded.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

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

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ThrottlingException:

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

ListOutpostResolvers

$result = $client->listOutpostResolvers([/* ... */]);
$promise = $client->listOutpostResolversAsync([/* ... */]);

Lists all the Resolvers on Outposts that were created using the current Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'OutpostResolvers' => [
        [
            'Arn' => '<string>',
            'CreationTime' => '<string>',
            'CreatorRequestId' => '<string>',
            'Id' => '<string>',
            'InstanceCount' => <integer>,
            'ModificationTime' => '<string>',
            'Name' => '<string>',
            'OutpostArn' => '<string>',
            'PreferredInstanceType' => '<string>',
            'Status' => 'CREATING|OPERATIONAL|UPDATING|DELETING|ACTION_NEEDED|FAILED_CREATION|FAILED_DELETION',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ResourceNotFoundException:

The specified resource doesn't exist.

ThrottlingException:

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

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ListResolverConfigs

$result = $client->listResolverConfigs([/* ... */]);
$promise = $client->listResolverConfigsAsync([/* ... */]);

Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ResolverConfigs' => [
        [
            'AutodefinedReverse' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING_TO_USE_LOCAL_RESOURCE_SETTING|USE_LOCAL_RESOURCE_SETTING',
            'Id' => '<string>',
            'OwnerId' => '<string>',
            'ResourceId' => '<string>',
        ],
        // ...
    ],
]

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ListResolverDnssecConfigs

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

Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

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>',
            'OutpostArn' => '<string>',
            'PreferredInstanceType' => '<string>',
            'Protocols' => ['<string>', ...],
            'ResolverEndpointType' => 'IPV6|IPV4|DUALSTACK',
            'SecurityGroupIds' => ['<string>', ...],
            'Status' => 'CREATING|OPERATIONAL|UPDATING|AUTO_RECOVERING|ACTION_NEEDED|DELETING',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ListResolverRuleAssociations

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

Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.

Parameter Syntax

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

Parameter Details

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

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 Amazon Web Services account.

Parameter Syntax

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

Parameter Details

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>',
                    'Ipv6' => '<string>',
                    'Port' => <integer>,
                    'Protocol' => 'DoH|Do53|DoH-FIPS',
                    'ServerNameIndication' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

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

Result Syntax

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

Result Details

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 Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM).

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ResourceNotFoundException:

The specified resource doesn't exist.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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 Amazon Web Services 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

Result Syntax

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

Result Details

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.

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

PutResolverRulePolicy

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

Specifies an Amazon Web Services 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

Result Syntax

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

Result Details

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.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ResourceNotFoundException:

The specified resource doesn't exist.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

Result Syntax

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

Result Details

Errors

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

ResourceNotFoundException:

The specified resource doesn't exist.

LimitExceededException:

The request caused one or more limits to be exceeded.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

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
    'FirewallDomainRedirectionAction' => 'INSPECT_REDIRECTION_DOMAIN|TRUST_REDIRECTION_DOMAIN',
    'FirewallRuleGroupId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'Priority' => <integer>,
    'Qtype' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

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

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

Errors

ResourceNotFoundException:

The specified resource doesn't exist.

ValidationException:

You have provided an invalid command. If you ran the UpdateFirewallDomains request. supported values are ADD, REMOVE, or REPLACE a domain.

ConflictException:

The requested state transition isn't valid. For example, you can't delete a firewall domain list if it is in the process of being deleted, or you can't import domains into a domain list that is in the process of being deleted.

AccessDeniedException:

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

This error can also be thrown when a customer has reached the 5120 character limit for a resource policy for CloudWatch Logs.

InternalServiceErrorException:

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

ThrottlingException:

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