NetworkFirewall module#
Index > NetworkFirewall
Auto-generated documentation for NetworkFirewall type annotations stubs module types-boto3-network-firewall.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
NetworkFirewall
service. - 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"))
- GetAnalysisReportResultsPaginator
- ListAnalysisReportsPaginator
- ListFirewallPoliciesPaginator
- ListFirewallsPaginator
- ListRuleGroupsPaginator
- ListTLSInspectionConfigurationsPaginator
- ListTagsForResourcePaginator
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"
- AttachmentStatusType
- ConfigurationSyncStateType
- EnabledAnalysisTypeType
- EncryptionTypeType
- FirewallStatusValueType
- GeneratedRulesTypeType
- GetAnalysisReportResultsPaginatorName
- IPAddressTypeType
- IdentifiedTypeType
- ListAnalysisReportsPaginatorName
- ListFirewallPoliciesPaginatorName
- ListFirewallsPaginatorName
- ListRuleGroupsPaginatorName
- ListTLSInspectionConfigurationsPaginatorName
- ListTagsForResourcePaginatorName
- LogDestinationTypeType
- LogTypeType
- OverrideActionType
- PerObjectSyncStatusType
- ResourceManagedStatusType
- ResourceManagedTypeType
- ResourceStatusType
- RevocationCheckActionType
- RuleGroupTypeType
- RuleOrderType
- StatefulActionType
- StatefulRuleDirectionType
- StatefulRuleProtocolType
- StreamExceptionPolicyType
- TCPFlagType
- TargetTypeType
- NetworkFirewallServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AddressTypeDef
- AnalysisReportTypeDef
- AnalysisResultTypeDef
- HitsTypeDef
- UniqueSourcesTypeDef
- AssociateFirewallPolicyRequestTypeDef
- ResponseMetadataTypeDef
- SubnetMappingTypeDef
- AttachmentTypeDef
- IPSetMetadataTypeDef
- CheckCertificateRevocationStatusActionsTypeDef
- EncryptionConfigurationTypeDef
- TagTypeDef
- SourceMetadataTypeDef
- DeleteFirewallPolicyRequestTypeDef
- DeleteFirewallRequestTypeDef
- DeleteResourcePolicyRequestTypeDef
- DeleteRuleGroupRequestTypeDef
- DeleteTLSInspectionConfigurationRequestTypeDef
- DescribeFirewallPolicyRequestTypeDef
- DescribeFirewallRequestTypeDef
- DescribeLoggingConfigurationRequestTypeDef
- DescribeResourcePolicyRequestTypeDef
- DescribeRuleGroupMetadataRequestTypeDef
- StatefulRuleOptionsTypeDef
- DescribeRuleGroupRequestTypeDef
- DescribeTLSInspectionConfigurationRequestTypeDef
- DimensionTypeDef
- DisassociateSubnetsRequestTypeDef
- FirewallMetadataTypeDef
- FirewallPolicyMetadataTypeDef
- StatelessRuleGroupReferenceTypeDef
- FlowTimeoutsTypeDef
- PaginatorConfigTypeDef
- GetAnalysisReportResultsRequestTypeDef
- HeaderTypeDef
- IPSetOutputTypeDef
- IPSetReferenceTypeDef
- IPSetTypeDef
- ListAnalysisReportsRequestTypeDef
- ListFirewallPoliciesRequestTypeDef
- ListFirewallsRequestTypeDef
- ListRuleGroupsRequestTypeDef
- RuleGroupMetadataTypeDef
- ListTLSInspectionConfigurationsRequestTypeDef
- TLSInspectionConfigurationMetadataTypeDef
- ListTagsForResourceRequestTypeDef
- LogDestinationConfigOutputTypeDef
- LogDestinationConfigTypeDef
- PortRangeTypeDef
- TCPFlagFieldOutputTypeDef
- TCPFlagFieldTypeDef
- PerObjectStatusTypeDef
- PortSetOutputTypeDef
- PortSetTypeDef
- PutResourcePolicyRequestTypeDef
- RuleOptionOutputTypeDef
- RuleOptionTypeDef
- RulesSourceListOutputTypeDef
- RulesSourceListTypeDef
- ServerCertificateTypeDef
- StartAnalysisReportRequestTypeDef
- StatefulRuleGroupOverrideTypeDef
- TlsCertificateDataTypeDef
- UntagResourceRequestTypeDef
- UpdateFirewallAnalysisSettingsRequestTypeDef
- UpdateFirewallDeleteProtectionRequestTypeDef
- UpdateFirewallDescriptionRequestTypeDef
- UpdateFirewallPolicyChangeProtectionRequestTypeDef
- UpdateSubnetChangeProtectionRequestTypeDef
- AnalysisTypeReportResultTypeDef
- AssociateFirewallPolicyResponseTypeDef
- DescribeResourcePolicyResponseTypeDef
- ListAnalysisReportsResponseTypeDef
- StartAnalysisReportResponseTypeDef
- UpdateFirewallAnalysisSettingsResponseTypeDef
- UpdateFirewallDeleteProtectionResponseTypeDef
- UpdateFirewallDescriptionResponseTypeDef
- UpdateFirewallPolicyChangeProtectionResponseTypeDef
- UpdateSubnetChangeProtectionResponseTypeDef
- AssociateSubnetsRequestTypeDef
- AssociateSubnetsResponseTypeDef
- DisassociateSubnetsResponseTypeDef
- CIDRSummaryTypeDef
- UpdateFirewallEncryptionConfigurationRequestTypeDef
- UpdateFirewallEncryptionConfigurationResponseTypeDef
- CreateFirewallRequestTypeDef
- FirewallPolicyResponseTypeDef
- FirewallTypeDef
- ListTagsForResourceResponseTypeDef
- TagResourceRequestTypeDef
- RuleGroupResponseTypeDef
- DescribeRuleGroupMetadataResponseTypeDef
- PublishMetricActionOutputTypeDef
- PublishMetricActionTypeDef
- ListFirewallsResponseTypeDef
- ListFirewallPoliciesResponseTypeDef
- StatefulEngineOptionsTypeDef
- GetAnalysisReportResultsRequestPaginateTypeDef
- ListAnalysisReportsRequestPaginateTypeDef
- ListFirewallPoliciesRequestPaginateTypeDef
- ListFirewallsRequestPaginateTypeDef
- ListRuleGroupsRequestPaginateTypeDef
- ListTLSInspectionConfigurationsRequestPaginateTypeDef
- ListTagsForResourceRequestPaginateTypeDef
- PolicyVariablesOutputTypeDef
- ReferenceSetsOutputTypeDef
- ReferenceSetsTypeDef
- PolicyVariablesTypeDef
- ListRuleGroupsResponseTypeDef
- ListTLSInspectionConfigurationsResponseTypeDef
- LoggingConfigurationOutputTypeDef
- LoggingConfigurationTypeDef
- ServerCertificateScopeOutputTypeDef
- ServerCertificateScopeTypeDef
- MatchAttributesOutputTypeDef
- MatchAttributesTypeDef
- SyncStateTypeDef
- RuleVariablesOutputTypeDef
- RuleVariablesTypeDef
- StatefulRuleOutputTypeDef
- StatefulRuleTypeDef
- StatefulRuleGroupReferenceTypeDef
- TLSInspectionConfigurationResponseTypeDef
- GetAnalysisReportResultsResponseTypeDef
- CapacityUsageSummaryTypeDef
- CreateFirewallPolicyResponseTypeDef
- DeleteFirewallPolicyResponseTypeDef
- UpdateFirewallPolicyResponseTypeDef
- CreateRuleGroupResponseTypeDef
- DeleteRuleGroupResponseTypeDef
- UpdateRuleGroupResponseTypeDef
- ActionDefinitionOutputTypeDef
- ActionDefinitionTypeDef
- DescribeLoggingConfigurationResponseTypeDef
- UpdateLoggingConfigurationResponseTypeDef
- LoggingConfigurationUnionTypeDef
- ServerCertificateConfigurationOutputTypeDef
- ServerCertificateConfigurationTypeDef
- RuleDefinitionOutputTypeDef
- RuleDefinitionTypeDef
- CreateTLSInspectionConfigurationResponseTypeDef
- DeleteTLSInspectionConfigurationResponseTypeDef
- UpdateTLSInspectionConfigurationResponseTypeDef
- FirewallStatusTypeDef
- CustomActionOutputTypeDef
- CustomActionTypeDef
- UpdateLoggingConfigurationRequestTypeDef
- TLSInspectionConfigurationOutputTypeDef
- TLSInspectionConfigurationTypeDef
- StatelessRuleOutputTypeDef
- StatelessRuleTypeDef
- CreateFirewallResponseTypeDef
- DeleteFirewallResponseTypeDef
- DescribeFirewallResponseTypeDef
- FirewallPolicyOutputTypeDef
- FirewallPolicyTypeDef
- DescribeTLSInspectionConfigurationResponseTypeDef
- TLSInspectionConfigurationUnionTypeDef
- StatelessRulesAndCustomActionsOutputTypeDef
- StatelessRulesAndCustomActionsTypeDef
- DescribeFirewallPolicyResponseTypeDef
- FirewallPolicyUnionTypeDef
- CreateTLSInspectionConfigurationRequestTypeDef
- UpdateTLSInspectionConfigurationRequestTypeDef
- RulesSourceOutputTypeDef
- RulesSourceTypeDef
- CreateFirewallPolicyRequestTypeDef
- UpdateFirewallPolicyRequestTypeDef
- RuleGroupOutputTypeDef
- RuleGroupTypeDef
- DescribeRuleGroupResponseTypeDef
- RuleGroupUnionTypeDef
- CreateRuleGroupRequestTypeDef
- UpdateRuleGroupRequestTypeDef