AWS Network Firewall
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This is the API Reference for Network Firewall. This guide is for developers who need
detailed information about the Network Firewall API actions, data types, and errors.
The REST API requires you to handle connection details, such as calculating
signatures, handling request retries, and error handling. For general information
about using the Amazon Web Services REST APIs, see Amazon Web Services APIs .
To view the complete list of Amazon Web Services Regions where Network Firewall is available, see
Service
endpoints and quotas in the Amazon Web Services General
Reference .
To access Network Firewall using the IPv4 REST API endpoint:
https://network-firewall. .amazonaws.com
To access Network Firewall using the Dualstack (IPv4 and IPv6) REST API endpoint:
https://network-firewall. .aws.api
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to
the programming language or platform that you're using. For more information, see
Amazon Web Services SDKs .
For descriptions of Network Firewall features, including and step-by-step
instructions on how to use them through the Network Firewall console, see the Network Firewall Developer
Guide .
Network Firewall is a stateful, managed, network firewall and intrusion detection and
prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the
perimeter of your VPC. This includes filtering traffic going to and coming from an internet
gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible
with Suricata, a free, open source network analysis and threat detection engine.
Network Firewall supports Suricata version 8.0.3. For information about Suricata,
see the Suricata website and the
Suricata User Guide .
You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.
The following are just a few examples:
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and
block all other forms of traffic.
Use custom lists of known bad domains to limit the types of domain names that your
applications can access.
Perform deep packet inspection on traffic entering or leaving your VPC.
Use stateful protocol detection to filter protocols like HTTPS, regardless of the
port used.
To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in
Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide .
To start using Network Firewall, do the following:
(Optional) If you don't already have a VPC that you want to protect, create it in
Amazon VPC.
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a
subnet for the sole use of Network Firewall.
In Network Firewall, define the firewall behavior as follows:
Create stateless and stateful rule groups,
to define the components of the network traffic filtering behavior that you want your firewall to have.
Create a firewall policy that uses your rule groups and
specifies additional default traffic filtering behavior.
In Network Firewall, create a firewall and specify your new firewall policy and
VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you
specify, with the behavior that's defined in the firewall policy.
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall
endpoints.
After your firewall is established, you can add firewall endpoints for new Availability Zones by following the prior steps for the Amazon VPC setup and
firewall subnet definitions. You can also add endpoints to Availability Zones that you're using in the firewall, either for the same VPC
or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations.
Endpoints 72
- POSTAccept network firewall transit gateway attachment
/#X-Amz-Target=NetworkFirewall_20201112.AcceptNetworkFirewallTransitGatewayAttachmentAccepts a transit gateway attachment request for Network Firewall. When you accept the attachment request, Network Firewall creates the necessary routing… - POSTAssociate availability zones
/#X-Amz-Target=NetworkFirewall_20201112.AssociateAvailabilityZonesAssociates the specified Availability Zones with a transit gateway-attached firewall. For each Availability Zone, Network Firewall creates a firewall endpoint… - POSTAssociate firewall policy
/#X-Amz-Target=NetworkFirewall_20201112.AssociateFirewallPolicyAssociates a FirewallPolicy to a Firewall . A firewall policy defines how to monitor and manage your VPC network traffic, using a collection of inspection… - POSTAssociate subnets
/#X-Amz-Target=NetworkFirewall_20201112.AssociateSubnetsAssociates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans. This… - POSTCreate container association
/#X-Amz-Target=NetworkFirewall_20201112.CreateContainerAssociationCreates a Network Firewall container association. The association monitors container lifecycle events in your Amazon ECS or Amazon EKS clusters and resolves… - POSTCreate firewall
/#X-Amz-Target=NetworkFirewall_20201112.CreateFirewallCreates an Network Firewall Firewall and accompanying FirewallStatus for a VPC. The firewall defines the configuration settings for an Network Firewall… - POSTCreate firewall policy
/#X-Amz-Target=NetworkFirewall_20201112.CreateFirewallPolicyCreates the firewall policy for the firewall according to the specifications. An Network Firewall firewall policy defines the behavior of a firewall, in a… - POSTCreate firewall policy v2
/#X-Amz-Target=NetworkFirewall_20201112.CreateFirewallPolicyV2Creates a Next Generation policy according to the specifications. A Next Generation policy defines the behavior of a firewall in a collection of firewall… - POSTCreate rule group
/#X-Amz-Target=NetworkFirewall_20201112.CreateRuleGroupCreates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags. You provide… - POSTCreate tLS inspection configuration
/#X-Amz-Target=NetworkFirewall_20201112.CreateTLSInspectionConfigurationCreates an Network Firewall TLS inspection configuration. Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound… - POSTCreate vpc endpoint association
/#X-Amz-Target=NetworkFirewall_20201112.CreateVpcEndpointAssociationCreates a firewall endpoint for an Network Firewall firewall. This type of firewall endpoint is independent of the firewall endpoints that you specify in the… - POSTDelete container association
/#X-Amz-Target=NetworkFirewall_20201112.DeleteContainerAssociationDeletes a container association. The resource transitions to a DELETING state. Deletion is asynchronous - Network Firewall returns immediately while cleanup… - POSTDelete firewall
/#X-Amz-Target=NetworkFirewall_20201112.DeleteFirewallDeletes the specified Firewall and its FirewallStatus . This operation requires the firewall's DeleteProtection flag to be FALSE . You can't revert this… - POSTDelete firewall policy
/#X-Amz-Target=NetworkFirewall_20201112.DeleteFirewallPolicyDeletes the specified FirewallPolicy . - POSTDelete firewall policy v2
/#X-Amz-Target=NetworkFirewall_20201112.DeleteFirewallPolicyV2Deletes the specified FirewallPolicyV2 . - POSTDelete network firewall transit gateway attachment
/#X-Amz-Target=NetworkFirewall_20201112.DeleteNetworkFirewallTransitGatewayAttachmentDeletes a transit gateway attachment from a Network Firewall. Either the firewall owner or the transit gateway owner can delete the attachment. After you… - POSTDelete proxy
/#X-Amz-Target=NetworkFirewall_20201112.DeleteProxyDeletes the specified proxy. Detaches a Proxy configuration from a NAT Gateway. - POSTDelete resource policy
/#X-Amz-Target=NetworkFirewall_20201112.DeleteResourcePolicyDeletes a resource policy that you created in a PutResourcePolicy request. - POSTDelete rule group
/#X-Amz-Target=NetworkFirewall_20201112.DeleteRuleGroupDeletes the specified RuleGroup . - POSTDelete tLS inspection configuration
/#X-Amz-Target=NetworkFirewall_20201112.DeleteTLSInspectionConfigurationDeletes the specified TLSInspectionConfiguration . - POSTDelete vpc endpoint association
/#X-Amz-Target=NetworkFirewall_20201112.DeleteVpcEndpointAssociationDeletes the specified VpcEndpointAssociation . You can check whether an endpoint association is in use by reviewing the route tables for the Availability… - POSTDescribe container association
/#X-Amz-Target=NetworkFirewall_20201112.DescribeContainerAssociationRetrieves the configuration and status of a container association. - POSTDescribe firewall
/#X-Amz-Target=NetworkFirewall_20201112.DescribeFirewallReturns the data objects for the specified firewall. - POSTDescribe firewall metadata
/#X-Amz-Target=NetworkFirewall_20201112.DescribeFirewallMetadataReturns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use. - POSTDescribe firewall policy
/#X-Amz-Target=NetworkFirewall_20201112.DescribeFirewallPolicyReturns the data objects for the specified firewall policy. - POSTDescribe firewall policy v2
/#X-Amz-Target=NetworkFirewall_20201112.DescribeFirewallPolicyV2Returns the data objects for the specified Next Generation policy. - POSTDescribe flow operation
/#X-Amz-Target=NetworkFirewall_20201112.DescribeFlowOperationReturns key information about a specific flow operation. - POSTDescribe logging configuration
/#X-Amz-Target=NetworkFirewall_20201112.DescribeLoggingConfigurationReturns the logging configuration for the specified firewall. - POSTDescribe proxy
/#X-Amz-Target=NetworkFirewall_20201112.DescribeProxyReturns the data objects for the specified proxy. - POSTDescribe resource policy
/#X-Amz-Target=NetworkFirewall_20201112.DescribeResourcePolicyRetrieves a resource policy that you created in a PutResourcePolicy request. - POSTDescribe rule group
/#X-Amz-Target=NetworkFirewall_20201112.DescribeRuleGroupReturns the data objects for the specified rule group. - POSTDescribe rule group metadata
/#X-Amz-Target=NetworkFirewall_20201112.DescribeRuleGroupMetadataHigh-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve… - POSTDescribe rule group summary
/#X-Amz-Target=NetworkFirewall_20201112.DescribeRuleGroupSummaryReturns detailed information for a stateful rule group. For active threat defense Amazon Web Services managed rule groups, this operation provides insight… - POSTDescribe tLS inspection configuration
/#X-Amz-Target=NetworkFirewall_20201112.DescribeTLSInspectionConfigurationReturns the data objects for the specified TLS inspection configuration. - POSTDescribe vpc endpoint association
/#X-Amz-Target=NetworkFirewall_20201112.DescribeVpcEndpointAssociationReturns the data object for the specified VPC endpoint association. - POSTDisassociate availability zones
/#X-Amz-Target=NetworkFirewall_20201112.DisassociateAvailabilityZonesRemoves the specified Availability Zone associations from a transit gateway-attached firewall. This removes the firewall endpoints from these Availability… - POSTDisassociate subnets
/#X-Amz-Target=NetworkFirewall_20201112.DisassociateSubnetsRemoves the specified subnet associations from the firewall. This removes the firewall endpoints from the subnets and removes any network filtering… - POSTGet analysis report results
/#X-Amz-Target=NetworkFirewall_20201112.GetAnalysisReportResultsThe results of a COMPLETED analysis report generated with StartAnalysisReport . For more information, see AnalysisTypeReportResult . - POSTList analysis reports
/#X-Amz-Target=NetworkFirewall_20201112.ListAnalysisReportsReturns a list of all traffic analysis reports generated within the last 30 days. - POSTList container associations
/#X-Amz-Target=NetworkFirewall_20201112.ListContainerAssociationsLists the container associations in your account and Region. Use the NextToken parameter in subsequent requests to retrieve additional results. - POSTList context stores
/#X-Amz-Target=NetworkFirewall_20201112.ListContextStoresLists the active context stores that are associated with your firewalls. A context store records network resources that can be used to evaluate context-aware… - POSTList firewall policies
/#X-Amz-Target=NetworkFirewall_20201112.ListFirewallPoliciesRetrieves the metadata for the firewall policies that you have defined. Depending on your setting for max results and the number of firewall policies, a… - POSTList firewall policies v2
/#X-Amz-Target=NetworkFirewall_20201112.ListFirewallPoliciesV2Retrieves the metadata for the Next Generation policies that you have defined. Depending on your setting for max results and the number of firewall policies,… - POSTList firewalls
/#X-Amz-Target=NetworkFirewall_20201112.ListFirewallsRetrieves the metadata for the firewalls that you have defined. If you provide VPC identifiers in your request, this returns only the firewalls for those… - POSTList flow operation results
/#X-Amz-Target=NetworkFirewall_20201112.ListFlowOperationResultsReturns the results of a specific flow operation. Flow operations let you manage the flows tracked in the flow table, also known as the firewall table. A flow… - POSTList flow operations
/#X-Amz-Target=NetworkFirewall_20201112.ListFlowOperationsReturns a list of all flow operations ran in a specific firewall. You can optionally narrow the request scope by specifying the operation type or Availability… - POSTList resources in context store
/#X-Amz-Target=NetworkFirewall_20201112.ListResourcesInContextStoreLists the resources that a context store records. The context store must be associated with a transit gateway that your firewall is attached to. You can… - POSTList rule groups
/#X-Amz-Target=NetworkFirewall_20201112.ListRuleGroupsRetrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might… - POSTList tLS inspection configurations
/#X-Amz-Target=NetworkFirewall_20201112.ListTLSInspectionConfigurationsRetrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection… - POSTList tags for resource
/#X-Amz-Target=NetworkFirewall_20201112.ListTagsForResourceRetrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes… - POSTList vpc endpoint associations
/#X-Amz-Target=NetworkFirewall_20201112.ListVpcEndpointAssociationsRetrieves the metadata for the VPC endpoint associations that you have defined. If you specify a fireawll, this returns only the endpoint associations for… - POSTPut resource policy
/#X-Amz-Target=NetworkFirewall_20201112.PutResourcePolicyCreates or updates an IAM policy for your rule group, firewall policy, or firewall. Use this to share these resources between accounts. This operation works… - POSTReject network firewall transit gateway attachment
/#X-Amz-Target=NetworkFirewall_20201112.RejectNetworkFirewallTransitGatewayAttachmentRejects a transit gateway attachment request for Network Firewall. When you reject the attachment request, Network Firewall cancels the creation of routing… - POSTStart analysis report
/#X-Amz-Target=NetworkFirewall_20201112.StartAnalysisReportGenerates a traffic analysis report for the timeframe and traffic type you specify. For information on the contents of a traffic analysis report, see… - POSTStart flow capture
/#X-Amz-Target=NetworkFirewall_20201112.StartFlowCaptureBegins capturing the flows in a firewall, according to the filters you define. Captures are similar, but not identical to snapshots. Capture operations… - POSTStart flow flush
/#X-Amz-Target=NetworkFirewall_20201112.StartFlowFlushBegins the flushing of traffic from the firewall, according to the filters you define. When the operation starts, impacted flows are temporarily marked as… - POSTTag resource
/#X-Amz-Target=NetworkFirewall_20201112.TagResourceAdds the specified tags to the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like… - POSTUntag resource
/#X-Amz-Target=NetworkFirewall_20201112.UntagResourceRemoves the tags with the specified keys from the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for… - POSTUpdate availability zone change protection
/#X-Amz-Target=NetworkFirewall_20201112.UpdateAvailabilityZoneChangeProtectionModifies the AvailabilityZoneChangeProtection setting for a transit gateway-attached firewall. When enabled, this setting prevents accidental changes to the… - POSTUpdate container association
/#X-Amz-Target=NetworkFirewall_20201112.UpdateContainerAssociationUpdates the monitoring configurations and description of a container association. You can't change the container type after creation. Provide an update token… - POSTUpdate firewall analysis settings
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallAnalysisSettingsEnables specific types of firewall analysis on a specific firewall you define. - POSTUpdate firewall delete protection
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallDeleteProtectionModifies the flag, DeleteProtection , which indicates whether it is possible to delete the firewall. If the flag is set to TRUE , the firewall is protected… - POSTUpdate firewall description
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallDescriptionModifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it. - POSTUpdate firewall encryption configuration
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallEncryptionConfigurationA complex type that contains settings for encryption of your firewall resources. - POSTUpdate firewall policy
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallPolicyUpdates the properties of the specified firewall policy. - POSTUpdate firewall policy change protection
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallPolicyChangeProtectionModifies the flag, ChangeProtection , which indicates whether it is possible to change the firewall. If the flag is set to TRUE , the firewall is protected… - POSTUpdate firewall policy v2
/#X-Amz-Target=NetworkFirewall_20201112.UpdateFirewallPolicyV2Updates the properties of the specified Next Generation policy. - POSTUpdate logging configuration
/#X-Amz-Target=NetworkFirewall_20201112.UpdateLoggingConfigurationSets the logging configuration for the specified firewall. To change the logging configuration, retrieve the LoggingConfiguration by calling… - POSTUpdate proxy settings
/#X-Amz-Target=NetworkFirewall_20201112.UpdateProxySettingsModifies the proxy settings of a proxy mode firewall. Use this operation to change the ports and protocols on which the firewall's proxy listens for traffic.… - POSTUpdate rule group
/#X-Amz-Target=NetworkFirewall_20201112.UpdateRuleGroupUpdates the rule settings for the specified rule group. You use a rule group by reference in one or more firewall policies. When you modify a rule group, you… - POSTUpdate subnet change protection
/#X-Amz-Target=NetworkFirewall_20201112.UpdateSubnetChangeProtection - POSTUpdate tLS inspection configuration
/#X-Amz-Target=NetworkFirewall_20201112.UpdateTLSInspectionConfigurationUpdates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in…
API details
- Base URL
https://network-firewall.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 72 operations on 72 pathsPOST 72
- Description format
- AWS Smithy model, API version
2020-11-12 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Network Firewall in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Network Firewall collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept network firewall transit gateway attachment” (POST /#X-Amz-Target=NetworkFirewall_20201112.AcceptNetworkFirewallTransitGatewayAttachment), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Network Firewall?
This is the API Reference for Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types,… It is listed under Developer tools and has 72 endpoints.
Who publishes the AWS Network Firewall?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Network Firewall?
Requests go to https://network-firewall.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Network Firewall?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Network Firewall have?
72 operations on 72 paths (72 POST).
Is forking the AWS Network Firewall free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.