GetFirewallRuleGroupCommand

Retrieves the specified firewall rule group.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { Route53ResolverClient, GetFirewallRuleGroupCommand } from "@aws-sdk/client-route53resolver"; // ES Modules import
// const { Route53ResolverClient, GetFirewallRuleGroupCommand } = require("@aws-sdk/client-route53resolver"); // CommonJS import
const client = new Route53ResolverClient(config);
const input = { // GetFirewallRuleGroupRequest
  FirewallRuleGroupId: "STRING_VALUE", // required
};
const command = new GetFirewallRuleGroupCommand(input);
const response = await client.send(command);
// { // GetFirewallRuleGroupResponse
//   FirewallRuleGroup: { // FirewallRuleGroup
//     Id: "STRING_VALUE",
//     Arn: "STRING_VALUE",
//     Name: "STRING_VALUE",
//     RuleCount: Number("int"),
//     Status: "COMPLETE" || "DELETING" || "UPDATING",
//     StatusMessage: "STRING_VALUE",
//     OwnerId: "STRING_VALUE",
//     CreatorRequestId: "STRING_VALUE",
//     ShareStatus: "NOT_SHARED" || "SHARED_WITH_ME" || "SHARED_BY_ME",
//     CreationTime: "STRING_VALUE",
//     ModificationTime: "STRING_VALUE",
//   },
// };

GetFirewallRuleGroupCommand Input

Parameter
Type
Description
FirewallRuleGroupId
Required
string | undefined

The unique identifier of the firewall rule group.

GetFirewallRuleGroupCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FirewallRuleGroup
FirewallRuleGroup | undefined

A collection of rules used to filter DNS network traffic.

Throws

Name
Fault
Details
AccessDeniedException
client

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
client

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

ResourceNotFoundException
client

The specified resource doesn't exist.

ThrottlingException
client

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

Route53ResolverServiceException
Base exception class for all service exceptions from Route53Resolver service.