Skip to content

NetworkFirewall module#

Index > NetworkFirewall

Auto-generated documentation for NetworkFirewall type annotations stubs module types-boto3-network-firewall.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.37.3' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add NetworkFirewall service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and NetworkFirewall.

From PyPI with pip#

Install types-boto3 for NetworkFirewall service.

# install with boto3 type annotations
python -m pip install 'types-boto3[network-firewall]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[network-firewall]'

# standalone installation
python -m pip install types-boto3-network-firewall

How to uninstall#

python -m pip uninstall -y types-boto3-network-firewall

Usage#

Code samples can be found in Examples.

NetworkFirewallClient#

Type annotations and code completion for boto3.client("network-firewall") as NetworkFirewallClient boto3 documentation

# NetworkFirewallClient usage example

from boto3.session import Session

from types_boto3_network_firewall.client import NetworkFirewallClient

def get_client() -> NetworkFirewallClient:
    return Session().client("network-firewall")

Paginators#

Type annotations and code completion for paginators from boto3.client("network-firewall").get_paginator("...").

# GetAnalysisReportResultsPaginator usage example

from boto3.session import Session

from types_boto3_network_firewall.paginator import GetAnalysisReportResultsPaginator

def get_get_analysis_report_results_paginator() -> GetAnalysisReportResultsPaginator:
    return Session().client("network-firewall").get_paginator("get_analysis_report_results"))

Literals#

Type annotations for literals used in methods and schema.

# AttachmentStatusType usage example

from types_boto3_network_firewall.literals import AttachmentStatusType

def get_value() -> AttachmentStatusType:
    return "CREATING"

Type definitions#

Type annotations for type definitions used in methods and schema.