DescribeFirewallCommand

Suggest an Edit

Returns the data objects for the specified firewall.

Example Syntax

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

import { NetworkFirewallClient, DescribeFirewallCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
// const { NetworkFirewallClient, DescribeFirewallCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
const client = new NetworkFirewallClient(config);
const input = { // DescribeFirewallRequest
  FirewallName: "STRING_VALUE",
  FirewallArn: "STRING_VALUE",
};
const command = new DescribeFirewallCommand(input);
const response = await client.send(command);
// { // DescribeFirewallResponse
//   UpdateToken: "STRING_VALUE",
//   Firewall: { // Firewall
//     FirewallName: "STRING_VALUE",
//     FirewallArn: "STRING_VALUE",
//     FirewallPolicyArn: "STRING_VALUE", // required
//     VpcId: "STRING_VALUE", // required
//     SubnetMappings: [ // SubnetMappings // required
//       { // SubnetMapping
//         SubnetId: "STRING_VALUE", // required
//         IPAddressType: "DUALSTACK" || "IPV4" || "IPV6",
//       },
//     ],
//     DeleteProtection: true || false,
//     SubnetChangeProtection: true || false,
//     FirewallPolicyChangeProtection: true || false,
//     Description: "STRING_VALUE",
//     FirewallId: "STRING_VALUE", // required
//     Tags: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     EncryptionConfiguration: { // EncryptionConfiguration
//       KeyId: "STRING_VALUE",
//       Type: "CUSTOMER_KMS" || "AWS_OWNED_KMS_KEY", // required
//     },
//     EnabledAnalysisTypes: [ // EnabledAnalysisTypes
//       "TLS_SNI" || "HTTP_HOST",
//     ],
//   },
//   FirewallStatus: { // FirewallStatus
//     Status: "PROVISIONING" || "DELETING" || "READY", // required
//     ConfigurationSyncStateSummary: "PENDING" || "IN_SYNC" || "CAPACITY_CONSTRAINED", // required
//     SyncStates: { // SyncStates
//       "<keys>": { // SyncState
//         Attachment: { // Attachment
//           SubnetId: "STRING_VALUE",
//           EndpointId: "STRING_VALUE",
//           Status: "CREATING" || "DELETING" || "FAILED" || "ERROR" || "SCALING" || "READY",
//           StatusMessage: "STRING_VALUE",
//         },
//         Config: { // SyncStateConfig
//           "<keys>": { // PerObjectStatus
//             SyncStatus: "PENDING" || "IN_SYNC" || "CAPACITY_CONSTRAINED",
//             UpdateToken: "STRING_VALUE",
//           },
//         },
//       },
//     },
//     CapacityUsageSummary: { // CapacityUsageSummary
//       CIDRs: { // CIDRSummary
//         AvailableCIDRCount: Number("int"),
//         UtilizedCIDRCount: Number("int"),
//         IPSetReferences: { // IPSetMetadataMap
//           "<keys>": { // IPSetMetadata
//             ResolvedCIDRCount: Number("int"),
//           },
//         },
//       },
//     },
//   },
// };

DescribeFirewallCommand Input

See DescribeFirewallCommandInput for more details

Parameter
Type
Description
FirewallArn
string | undefined

The Amazon Resource Name (ARN) of the firewall.

You must specify the ARN or the name, and you can specify both.

FirewallName
string | undefined

The descriptive name of the firewall. You can't change the name of a firewall after you create it.

You must specify the ARN or the name, and you can specify both.

DescribeFirewallCommand Output

See DescribeFirewallCommandOutput for details

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

The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.

FirewallStatus
FirewallStatus | undefined

Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.

UpdateToken
string | undefined

An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

Throws

Name
Fault
Details
InternalServerError
server

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidRequestException
client

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ResourceNotFoundException
client

Unable to locate a resource using the parameters that you provided.

ThrottlingException
client

Unable to process the request due to throttling limitations.

NetworkFirewallServiceException
Base exception class for all service exceptions from NetworkFirewall service.