ListFirewallRuleGroupAssociations - Amazon Route 53

ListFirewallRuleGroupAssociations

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.

Request Syntax

{ "FirewallRuleGroupId": "string", "MaxResults": number, "NextToken": "string", "Priority": number, "Status": "string", "VpcId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

FirewallRuleGroupId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

MaxResults

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

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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

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

Type: String

Required: No

Priority

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

Type: Integer

Required: No

Status

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

Type: String

Valid Values: COMPLETE | DELETING | UPDATING

Required: No

VpcId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

Response Syntax

{ "FirewallRuleGroupAssociations": [ { "Arn": "string", "CreationTime": "string", "CreatorRequestId": "string", "FirewallRuleGroupId": "string", "Id": "string", "ManagedOwnerName": "string", "ModificationTime": "string", "MutationProtection": "string", "Name": "string", "Priority": number, "Status": "string", "StatusMessage": "string", "VpcId": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FirewallRuleGroupAssociations

A list of your firewall rule group associations.

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

Type: Array of FirewallRuleGroupAssociation objects

NextToken

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

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 400

InternalServiceErrorException

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

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400

ValidationException

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: