NetworkFirewallClient#
Index > NetworkFirewall > NetworkFirewallClient
Auto-generated documentation for NetworkFirewall type annotations stubs module mypy-boto3-network-firewall.
NetworkFirewallClient#
Type annotations and code completion for boto3.client("network-firewall").
 boto3 documentation
# NetworkFirewallClient usage example
from boto3.session import Session
from mypy_boto3_network_firewall.client import NetworkFirewallClient
def get_network-firewall_client() -> NetworkFirewallClient:
    return Session().client("network-firewall")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("network-firewall").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("network-firewall")
try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InsufficientCapacityException,
    client.exceptions.InternalServerError,
    client.exceptions.InvalidOperationException,
    client.exceptions.InvalidRequestException,
    client.exceptions.InvalidResourcePolicyException,
    client.exceptions.InvalidTokenException,
    client.exceptions.LimitExceededException,
    client.exceptions.LogDestinationPermissionException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceOwnerCheckException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnsupportedOperationException,
) as e:
    print(e)# Exceptions.exceptions type checking example
from mypy_boto3_network_firewall.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
    ...Methods#
can_paginate#
Type annotations and code completion for boto3.client("network-firewall").can_paginate method.
 boto3 documentation
# can_paginate method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...generate_presigned_url#
Type annotations and code completion for boto3.client("network-firewall").generate_presigned_url method.
 boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...accept_network_firewall_transit_gateway_attachment#
Accepts a transit gateway attachment request for Network Firewall.
Type annotations and code completion for boto3.client("network-firewall").accept_network_firewall_transit_gateway_attachment method.
 boto3 documentation
# accept_network_firewall_transit_gateway_attachment method definition
def accept_network_firewall_transit_gateway_attachment(
    self,
    *,
    TransitGatewayAttachmentId: str,
) -> AcceptNetworkFirewallTransitGatewayAttachmentResponseTypeDef:  # (1)
    ...# accept_network_firewall_transit_gateway_attachment method usage example with argument unpacking
kwargs: AcceptNetworkFirewallTransitGatewayAttachmentRequestTypeDef = {  # (1)
    "TransitGatewayAttachmentId": ...,
}
parent.accept_network_firewall_transit_gateway_attachment(**kwargs)associate_availability_zones#
Associates the specified Availability Zones with a transit gateway-attached firewall.
Type annotations and code completion for boto3.client("network-firewall").associate_availability_zones method.
 boto3 documentation
# associate_availability_zones method definition
def associate_availability_zones(
    self,
    *,
    AvailabilityZoneMappings: Sequence[AvailabilityZoneMappingTypeDef],  # (1)
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> AssociateAvailabilityZonesResponseTypeDef:  # (2)
    ...- See Sequence[AvailabilityZoneMappingTypeDef]
- See AssociateAvailabilityZonesResponseTypeDef
# associate_availability_zones method usage example with argument unpacking
kwargs: AssociateAvailabilityZonesRequestTypeDef = {  # (1)
    "AvailabilityZoneMappings": ...,
}
parent.associate_availability_zones(**kwargs)associate_firewall_policy#
Associates a FirewallPolicy to a Firewall.
Type annotations and code completion for boto3.client("network-firewall").associate_firewall_policy method.
 boto3 documentation
# associate_firewall_policy method definition
def associate_firewall_policy(
    self,
    *,
    FirewallPolicyArn: str,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> AssociateFirewallPolicyResponseTypeDef:  # (1)
    ...# associate_firewall_policy method usage example with argument unpacking
kwargs: AssociateFirewallPolicyRequestTypeDef = {  # (1)
    "FirewallPolicyArn": ...,
}
parent.associate_firewall_policy(**kwargs)associate_subnets#
Associates the specified subnets in the Amazon VPC to the firewall.
Type annotations and code completion for boto3.client("network-firewall").associate_subnets method.
 boto3 documentation
# associate_subnets method definition
def associate_subnets(
    self,
    *,
    SubnetMappings: Sequence[SubnetMappingTypeDef],  # (1)
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> AssociateSubnetsResponseTypeDef:  # (2)
    ...- See Sequence[SubnetMappingTypeDef]
- See AssociateSubnetsResponseTypeDef
# associate_subnets method usage example with argument unpacking
kwargs: AssociateSubnetsRequestTypeDef = {  # (1)
    "SubnetMappings": ...,
}
parent.associate_subnets(**kwargs)create_firewall#
Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
Type annotations and code completion for boto3.client("network-firewall").create_firewall method.
 boto3 documentation
# create_firewall method definition
def create_firewall(
    self,
    *,
    FirewallName: str,
    FirewallPolicyArn: str,
    VpcId: str = ...,
    SubnetMappings: Sequence[SubnetMappingTypeDef] = ...,  # (1)
    DeleteProtection: bool = ...,
    SubnetChangeProtection: bool = ...,
    FirewallPolicyChangeProtection: bool = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
    EnabledAnalysisTypes: Sequence[EnabledAnalysisTypeType] = ...,  # (4)
    TransitGatewayId: str = ...,
    AvailabilityZoneMappings: Sequence[AvailabilityZoneMappingTypeDef] = ...,  # (5)
    AvailabilityZoneChangeProtection: bool = ...,
) -> CreateFirewallResponseTypeDef:  # (6)
    ...- See Sequence[SubnetMappingTypeDef]
- See Sequence[TagTypeDef]
- See EncryptionConfigurationTypeDef
- See Sequence[EnabledAnalysisTypeType]
- See Sequence[AvailabilityZoneMappingTypeDef]
- See CreateFirewallResponseTypeDef
# create_firewall method usage example with argument unpacking
kwargs: CreateFirewallRequestTypeDef = {  # (1)
    "FirewallName": ...,
    "FirewallPolicyArn": ...,
}
parent.create_firewall(**kwargs)create_firewall_policy#
Creates the firewall policy for the firewall according to the specifications.
Type annotations and code completion for boto3.client("network-firewall").create_firewall_policy method.
 boto3 documentation
# create_firewall_policy method definition
def create_firewall_policy(
    self,
    *,
    FirewallPolicyName: str,
    FirewallPolicy: FirewallPolicyUnionTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
) -> CreateFirewallPolicyResponseTypeDef:  # (4)
    ...- See FirewallPolicyUnionTypeDef
- See Sequence[TagTypeDef]
- See EncryptionConfigurationTypeDef
- See CreateFirewallPolicyResponseTypeDef
# create_firewall_policy method usage example with argument unpacking
kwargs: CreateFirewallPolicyRequestTypeDef = {  # (1)
    "FirewallPolicyName": ...,
    "FirewallPolicy": ...,
}
parent.create_firewall_policy(**kwargs)create_rule_group#
Creates the specified stateless or stateful rule group, which includes the rules for network traffic inspection, a capacity setting, and tags.
Type annotations and code completion for boto3.client("network-firewall").create_rule_group method.
 boto3 documentation
# create_rule_group method definition
def create_rule_group(
    self,
    *,
    RuleGroupName: str,
    Type: RuleGroupTypeType,  # (1)
    Capacity: int,
    RuleGroup: RuleGroupUnionTypeDef = ...,  # (2)
    Rules: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (4)
    SourceMetadata: SourceMetadataTypeDef = ...,  # (5)
    AnalyzeRuleGroup: bool = ...,
    SummaryConfiguration: SummaryConfigurationUnionTypeDef = ...,  # (6)
) -> CreateRuleGroupResponseTypeDef:  # (7)
    ...- See RuleGroupTypeType
- See RuleGroupUnionTypeDef
- See Sequence[TagTypeDef]
- See EncryptionConfigurationTypeDef
- See SourceMetadataTypeDef
- See SummaryConfigurationUnionTypeDef
- See CreateRuleGroupResponseTypeDef
# create_rule_group method usage example with argument unpacking
kwargs: CreateRuleGroupRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
    "Type": ...,
    "Capacity": ...,
}
parent.create_rule_group(**kwargs)create_tls_inspection_configuration#
Creates an Network Firewall TLS inspection configuration.
Type annotations and code completion for boto3.client("network-firewall").create_tls_inspection_configuration method.
 boto3 documentation
# create_tls_inspection_configuration method definition
def create_tls_inspection_configuration(
    self,
    *,
    TLSInspectionConfigurationName: str,
    TLSInspectionConfiguration: TLSInspectionConfigurationUnionTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
) -> CreateTLSInspectionConfigurationResponseTypeDef:  # (4)
    ...- See TLSInspectionConfigurationUnionTypeDef
- See Sequence[TagTypeDef]
- See EncryptionConfigurationTypeDef
- See CreateTLSInspectionConfigurationResponseTypeDef
# create_tls_inspection_configuration method usage example with argument unpacking
kwargs: CreateTLSInspectionConfigurationRequestTypeDef = {  # (1)
    "TLSInspectionConfigurationName": ...,
    "TLSInspectionConfiguration": ...,
}
parent.create_tls_inspection_configuration(**kwargs)create_vpc_endpoint_association#
Creates a firewall endpoint for an Network Firewall firewall.
Type annotations and code completion for boto3.client("network-firewall").create_vpc_endpoint_association method.
 boto3 documentation
# create_vpc_endpoint_association method definition
def create_vpc_endpoint_association(
    self,
    *,
    FirewallArn: str,
    VpcId: str,
    SubnetMapping: SubnetMappingTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateVpcEndpointAssociationResponseTypeDef:  # (3)
    ...- See SubnetMappingTypeDef
- See Sequence[TagTypeDef]
- See CreateVpcEndpointAssociationResponseTypeDef
# create_vpc_endpoint_association method usage example with argument unpacking
kwargs: CreateVpcEndpointAssociationRequestTypeDef = {  # (1)
    "FirewallArn": ...,
    "VpcId": ...,
    "SubnetMapping": ...,
}
parent.create_vpc_endpoint_association(**kwargs)delete_firewall#
Deletes the specified Firewall and its FirewallStatus.
Type annotations and code completion for boto3.client("network-firewall").delete_firewall method.
 boto3 documentation
# delete_firewall method definition
def delete_firewall(
    self,
    *,
    FirewallName: str = ...,
    FirewallArn: str = ...,
) -> DeleteFirewallResponseTypeDef:  # (1)
    ...# delete_firewall method usage example with argument unpacking
kwargs: DeleteFirewallRequestTypeDef = {  # (1)
    "FirewallName": ...,
}
parent.delete_firewall(**kwargs)delete_firewall_policy#
Deletes the specified FirewallPolicy.
Type annotations and code completion for boto3.client("network-firewall").delete_firewall_policy method.
 boto3 documentation
# delete_firewall_policy method definition
def delete_firewall_policy(
    self,
    *,
    FirewallPolicyName: str = ...,
    FirewallPolicyArn: str = ...,
) -> DeleteFirewallPolicyResponseTypeDef:  # (1)
    ...# delete_firewall_policy method usage example with argument unpacking
kwargs: DeleteFirewallPolicyRequestTypeDef = {  # (1)
    "FirewallPolicyName": ...,
}
parent.delete_firewall_policy(**kwargs)delete_network_firewall_transit_gateway_attachment#
Deletes a transit gateway attachment from a Network Firewall.
Type annotations and code completion for boto3.client("network-firewall").delete_network_firewall_transit_gateway_attachment method.
 boto3 documentation
# delete_network_firewall_transit_gateway_attachment method definition
def delete_network_firewall_transit_gateway_attachment(
    self,
    *,
    TransitGatewayAttachmentId: str,
) -> DeleteNetworkFirewallTransitGatewayAttachmentResponseTypeDef:  # (1)
    ...# delete_network_firewall_transit_gateway_attachment method usage example with argument unpacking
kwargs: DeleteNetworkFirewallTransitGatewayAttachmentRequestTypeDef = {  # (1)
    "TransitGatewayAttachmentId": ...,
}
parent.delete_network_firewall_transit_gateway_attachment(**kwargs)delete_resource_policy#
Deletes a resource policy that you created in a PutResourcePolicy request.
Type annotations and code completion for boto3.client("network-firewall").delete_resource_policy method.
 boto3 documentation
# delete_resource_policy method definition
def delete_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> Dict[str, Any]:
    ...# delete_resource_policy method usage example with argument unpacking
kwargs: DeleteResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}
parent.delete_resource_policy(**kwargs)delete_rule_group#
Deletes the specified RuleGroup.
Type annotations and code completion for boto3.client("network-firewall").delete_rule_group method.
 boto3 documentation
# delete_rule_group method definition
def delete_rule_group(
    self,
    *,
    RuleGroupName: str = ...,
    RuleGroupArn: str = ...,
    Type: RuleGroupTypeType = ...,  # (1)
) -> DeleteRuleGroupResponseTypeDef:  # (2)
    ...# delete_rule_group method usage example with argument unpacking
kwargs: DeleteRuleGroupRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
}
parent.delete_rule_group(**kwargs)delete_tls_inspection_configuration#
Deletes the specified TLSInspectionConfiguration.
Type annotations and code completion for boto3.client("network-firewall").delete_tls_inspection_configuration method.
 boto3 documentation
# delete_tls_inspection_configuration method definition
def delete_tls_inspection_configuration(
    self,
    *,
    TLSInspectionConfigurationArn: str = ...,
    TLSInspectionConfigurationName: str = ...,
) -> DeleteTLSInspectionConfigurationResponseTypeDef:  # (1)
    ...# delete_tls_inspection_configuration method usage example with argument unpacking
kwargs: DeleteTLSInspectionConfigurationRequestTypeDef = {  # (1)
    "TLSInspectionConfigurationArn": ...,
}
parent.delete_tls_inspection_configuration(**kwargs)delete_vpc_endpoint_association#
Deletes the specified VpcEndpointAssociation.
Type annotations and code completion for boto3.client("network-firewall").delete_vpc_endpoint_association method.
 boto3 documentation
# delete_vpc_endpoint_association method definition
def delete_vpc_endpoint_association(
    self,
    *,
    VpcEndpointAssociationArn: str,
) -> DeleteVpcEndpointAssociationResponseTypeDef:  # (1)
    ...# delete_vpc_endpoint_association method usage example with argument unpacking
kwargs: DeleteVpcEndpointAssociationRequestTypeDef = {  # (1)
    "VpcEndpointAssociationArn": ...,
}
parent.delete_vpc_endpoint_association(**kwargs)describe_firewall#
Returns the data objects for the specified firewall.
Type annotations and code completion for boto3.client("network-firewall").describe_firewall method.
 boto3 documentation
# describe_firewall method definition
def describe_firewall(
    self,
    *,
    FirewallName: str = ...,
    FirewallArn: str = ...,
) -> DescribeFirewallResponseTypeDef:  # (1)
    ...# describe_firewall method usage example with argument unpacking
kwargs: DescribeFirewallRequestTypeDef = {  # (1)
    "FirewallName": ...,
}
parent.describe_firewall(**kwargs)describe_firewall_metadata#
Returns the high-level information about a firewall, including the Availability Zones where the Firewall is currently in use.
Type annotations and code completion for boto3.client("network-firewall").describe_firewall_metadata method.
 boto3 documentation
# describe_firewall_metadata method definition
def describe_firewall_metadata(
    self,
    *,
    FirewallArn: str = ...,
) -> DescribeFirewallMetadataResponseTypeDef:  # (1)
    ...# describe_firewall_metadata method usage example with argument unpacking
kwargs: DescribeFirewallMetadataRequestTypeDef = {  # (1)
    "FirewallArn": ...,
}
parent.describe_firewall_metadata(**kwargs)describe_firewall_policy#
Returns the data objects for the specified firewall policy.
Type annotations and code completion for boto3.client("network-firewall").describe_firewall_policy method.
 boto3 documentation
# describe_firewall_policy method definition
def describe_firewall_policy(
    self,
    *,
    FirewallPolicyName: str = ...,
    FirewallPolicyArn: str = ...,
) -> DescribeFirewallPolicyResponseTypeDef:  # (1)
    ...# describe_firewall_policy method usage example with argument unpacking
kwargs: DescribeFirewallPolicyRequestTypeDef = {  # (1)
    "FirewallPolicyName": ...,
}
parent.describe_firewall_policy(**kwargs)describe_flow_operation#
Returns key information about a specific flow operation.
Type annotations and code completion for boto3.client("network-firewall").describe_flow_operation method.
 boto3 documentation
# describe_flow_operation method definition
def describe_flow_operation(
    self,
    *,
    FirewallArn: str,
    FlowOperationId: str,
    AvailabilityZone: str = ...,
    VpcEndpointAssociationArn: str = ...,
    VpcEndpointId: str = ...,
) -> DescribeFlowOperationResponseTypeDef:  # (1)
    ...# describe_flow_operation method usage example with argument unpacking
kwargs: DescribeFlowOperationRequestTypeDef = {  # (1)
    "FirewallArn": ...,
    "FlowOperationId": ...,
}
parent.describe_flow_operation(**kwargs)describe_logging_configuration#
Returns the logging configuration for the specified firewall.
Type annotations and code completion for boto3.client("network-firewall").describe_logging_configuration method.
 boto3 documentation
# describe_logging_configuration method definition
def describe_logging_configuration(
    self,
    *,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> DescribeLoggingConfigurationResponseTypeDef:  # (1)
    ...# describe_logging_configuration method usage example with argument unpacking
kwargs: DescribeLoggingConfigurationRequestTypeDef = {  # (1)
    "FirewallArn": ...,
}
parent.describe_logging_configuration(**kwargs)describe_resource_policy#
Retrieves a resource policy that you created in a PutResourcePolicy request.
Type annotations and code completion for boto3.client("network-firewall").describe_resource_policy method.
 boto3 documentation
# describe_resource_policy method definition
def describe_resource_policy(
    self,
    *,
    ResourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef:  # (1)
    ...# describe_resource_policy method usage example with argument unpacking
kwargs: DescribeResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}
parent.describe_resource_policy(**kwargs)describe_rule_group#
Returns the data objects for the specified rule group.
Type annotations and code completion for boto3.client("network-firewall").describe_rule_group method.
 boto3 documentation
# describe_rule_group method definition
def describe_rule_group(
    self,
    *,
    RuleGroupName: str = ...,
    RuleGroupArn: str = ...,
    Type: RuleGroupTypeType = ...,  # (1)
    AnalyzeRuleGroup: bool = ...,
) -> DescribeRuleGroupResponseTypeDef:  # (2)
    ...# describe_rule_group method usage example with argument unpacking
kwargs: DescribeRuleGroupRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
}
parent.describe_rule_group(**kwargs)describe_rule_group_metadata#
High-level information about a rule group, returned by operations like create and describe.
Type annotations and code completion for boto3.client("network-firewall").describe_rule_group_metadata method.
 boto3 documentation
# describe_rule_group_metadata method definition
def describe_rule_group_metadata(
    self,
    *,
    RuleGroupName: str = ...,
    RuleGroupArn: str = ...,
    Type: RuleGroupTypeType = ...,  # (1)
) -> DescribeRuleGroupMetadataResponseTypeDef:  # (2)
    ...# describe_rule_group_metadata method usage example with argument unpacking
kwargs: DescribeRuleGroupMetadataRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
}
parent.describe_rule_group_metadata(**kwargs)describe_rule_group_summary#
Returns detailed information for a stateful rule group.
Type annotations and code completion for boto3.client("network-firewall").describe_rule_group_summary method.
 boto3 documentation
# describe_rule_group_summary method definition
def describe_rule_group_summary(
    self,
    *,
    RuleGroupName: str = ...,
    RuleGroupArn: str = ...,
    Type: RuleGroupTypeType = ...,  # (1)
) -> DescribeRuleGroupSummaryResponseTypeDef:  # (2)
    ...# describe_rule_group_summary method usage example with argument unpacking
kwargs: DescribeRuleGroupSummaryRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
}
parent.describe_rule_group_summary(**kwargs)describe_tls_inspection_configuration#
Returns the data objects for the specified TLS inspection configuration.
Type annotations and code completion for boto3.client("network-firewall").describe_tls_inspection_configuration method.
 boto3 documentation
# describe_tls_inspection_configuration method definition
def describe_tls_inspection_configuration(
    self,
    *,
    TLSInspectionConfigurationArn: str = ...,
    TLSInspectionConfigurationName: str = ...,
) -> DescribeTLSInspectionConfigurationResponseTypeDef:  # (1)
    ...# describe_tls_inspection_configuration method usage example with argument unpacking
kwargs: DescribeTLSInspectionConfigurationRequestTypeDef = {  # (1)
    "TLSInspectionConfigurationArn": ...,
}
parent.describe_tls_inspection_configuration(**kwargs)describe_vpc_endpoint_association#
Returns the data object for the specified VPC endpoint association.
Type annotations and code completion for boto3.client("network-firewall").describe_vpc_endpoint_association method.
 boto3 documentation
# describe_vpc_endpoint_association method definition
def describe_vpc_endpoint_association(
    self,
    *,
    VpcEndpointAssociationArn: str,
) -> DescribeVpcEndpointAssociationResponseTypeDef:  # (1)
    ...# describe_vpc_endpoint_association method usage example with argument unpacking
kwargs: DescribeVpcEndpointAssociationRequestTypeDef = {  # (1)
    "VpcEndpointAssociationArn": ...,
}
parent.describe_vpc_endpoint_association(**kwargs)disassociate_availability_zones#
Removes the specified Availability Zone associations from a transit gateway-attached firewall.
Type annotations and code completion for boto3.client("network-firewall").disassociate_availability_zones method.
 boto3 documentation
# disassociate_availability_zones method definition
def disassociate_availability_zones(
    self,
    *,
    AvailabilityZoneMappings: Sequence[AvailabilityZoneMappingTypeDef],  # (1)
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> DisassociateAvailabilityZonesResponseTypeDef:  # (2)
    ...- See Sequence[AvailabilityZoneMappingTypeDef]
- See DisassociateAvailabilityZonesResponseTypeDef
# disassociate_availability_zones method usage example with argument unpacking
kwargs: DisassociateAvailabilityZonesRequestTypeDef = {  # (1)
    "AvailabilityZoneMappings": ...,
}
parent.disassociate_availability_zones(**kwargs)disassociate_subnets#
Removes the specified subnet associations from the firewall.
Type annotations and code completion for boto3.client("network-firewall").disassociate_subnets method.
 boto3 documentation
# disassociate_subnets method definition
def disassociate_subnets(
    self,
    *,
    SubnetIds: Sequence[str],
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> DisassociateSubnetsResponseTypeDef:  # (1)
    ...# disassociate_subnets method usage example with argument unpacking
kwargs: DisassociateSubnetsRequestTypeDef = {  # (1)
    "SubnetIds": ...,
}
parent.disassociate_subnets(**kwargs)get_analysis_report_results#
The results of a COMPLETED analysis report generated with
StartAnalysisReport.
Type annotations and code completion for boto3.client("network-firewall").get_analysis_report_results method.
 boto3 documentation
# get_analysis_report_results method definition
def get_analysis_report_results(
    self,
    *,
    AnalysisReportId: str,
    FirewallName: str = ...,
    FirewallArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetAnalysisReportResultsResponseTypeDef:  # (1)
    ...# get_analysis_report_results method usage example with argument unpacking
kwargs: GetAnalysisReportResultsRequestTypeDef = {  # (1)
    "AnalysisReportId": ...,
}
parent.get_analysis_report_results(**kwargs)list_analysis_reports#
Returns a list of all traffic analysis reports generated within the last 30 days.
Type annotations and code completion for boto3.client("network-firewall").list_analysis_reports method.
 boto3 documentation
# list_analysis_reports method definition
def list_analysis_reports(
    self,
    *,
    FirewallName: str = ...,
    FirewallArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAnalysisReportsResponseTypeDef:  # (1)
    ...# list_analysis_reports method usage example with argument unpacking
kwargs: ListAnalysisReportsRequestTypeDef = {  # (1)
    "FirewallName": ...,
}
parent.list_analysis_reports(**kwargs)list_firewall_policies#
Retrieves the metadata for the firewall policies that you have defined.
Type annotations and code completion for boto3.client("network-firewall").list_firewall_policies method.
 boto3 documentation
# list_firewall_policies method definition
def list_firewall_policies(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFirewallPoliciesResponseTypeDef:  # (1)
    ...# list_firewall_policies method usage example with argument unpacking
kwargs: ListFirewallPoliciesRequestTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_firewall_policies(**kwargs)list_firewalls#
Retrieves the metadata for the firewalls that you have defined.
Type annotations and code completion for boto3.client("network-firewall").list_firewalls method.
 boto3 documentation
# list_firewalls method definition
def list_firewalls(
    self,
    *,
    NextToken: str = ...,
    VpcIds: Sequence[str] = ...,
    MaxResults: int = ...,
) -> ListFirewallsResponseTypeDef:  # (1)
    ...# list_firewalls method usage example with argument unpacking
kwargs: ListFirewallsRequestTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_firewalls(**kwargs)list_flow_operation_results#
Returns the results of a specific flow operation.
Type annotations and code completion for boto3.client("network-firewall").list_flow_operation_results method.
 boto3 documentation
# list_flow_operation_results method definition
def list_flow_operation_results(
    self,
    *,
    FirewallArn: str,
    FlowOperationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    AvailabilityZone: str = ...,
    VpcEndpointId: str = ...,
    VpcEndpointAssociationArn: str = ...,
) -> ListFlowOperationResultsResponseTypeDef:  # (1)
    ...# list_flow_operation_results method usage example with argument unpacking
kwargs: ListFlowOperationResultsRequestTypeDef = {  # (1)
    "FirewallArn": ...,
    "FlowOperationId": ...,
}
parent.list_flow_operation_results(**kwargs)list_flow_operations#
Returns a list of all flow operations ran in a specific firewall.
Type annotations and code completion for boto3.client("network-firewall").list_flow_operations method.
 boto3 documentation
# list_flow_operations method definition
def list_flow_operations(
    self,
    *,
    FirewallArn: str,
    AvailabilityZone: str = ...,
    VpcEndpointAssociationArn: str = ...,
    VpcEndpointId: str = ...,
    FlowOperationType: FlowOperationTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFlowOperationsResponseTypeDef:  # (2)
    ...# list_flow_operations method usage example with argument unpacking
kwargs: ListFlowOperationsRequestTypeDef = {  # (1)
    "FirewallArn": ...,
}
parent.list_flow_operations(**kwargs)list_rule_groups#
Retrieves the metadata for the rule groups that you have defined.
Type annotations and code completion for boto3.client("network-firewall").list_rule_groups method.
 boto3 documentation
# list_rule_groups method definition
def list_rule_groups(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Scope: ResourceManagedStatusType = ...,  # (1)
    ManagedType: ResourceManagedTypeType = ...,  # (2)
    Type: RuleGroupTypeType = ...,  # (3)
) -> ListRuleGroupsResponseTypeDef:  # (4)
    ...- See ResourceManagedStatusType
- See ResourceManagedTypeType
- See RuleGroupTypeType
- See ListRuleGroupsResponseTypeDef
# list_rule_groups method usage example with argument unpacking
kwargs: ListRuleGroupsRequestTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_rule_groups(**kwargs)list_tls_inspection_configurations#
Retrieves the metadata for the TLS inspection configurations that you have defined.
Type annotations and code completion for boto3.client("network-firewall").list_tls_inspection_configurations method.
 boto3 documentation
# list_tls_inspection_configurations method definition
def list_tls_inspection_configurations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTLSInspectionConfigurationsResponseTypeDef:  # (1)
    ...# list_tls_inspection_configurations method usage example with argument unpacking
kwargs: ListTLSInspectionConfigurationsRequestTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_tls_inspection_configurations(**kwargs)list_tags_for_resource#
Retrieves the tags associated with the specified resource.
Type annotations and code completion for boto3.client("network-firewall").list_tags_for_resource method.
 boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)list_vpc_endpoint_associations#
Retrieves the metadata for the VPC endpoint associations that you have defined.
Type annotations and code completion for boto3.client("network-firewall").list_vpc_endpoint_associations method.
 boto3 documentation
# list_vpc_endpoint_associations method definition
def list_vpc_endpoint_associations(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    FirewallArn: str = ...,
) -> ListVpcEndpointAssociationsResponseTypeDef:  # (1)
    ...# list_vpc_endpoint_associations method usage example with argument unpacking
kwargs: ListVpcEndpointAssociationsRequestTypeDef = {  # (1)
    "NextToken": ...,
}
parent.list_vpc_endpoint_associations(**kwargs)put_resource_policy#
Creates or updates an IAM policy for your rule group, firewall policy, or firewall.
Type annotations and code completion for boto3.client("network-firewall").put_resource_policy method.
 boto3 documentation
# put_resource_policy method definition
def put_resource_policy(
    self,
    *,
    ResourceArn: str,
    Policy: str,
) -> Dict[str, Any]:
    ...# put_resource_policy method usage example with argument unpacking
kwargs: PutResourcePolicyRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Policy": ...,
}
parent.put_resource_policy(**kwargs)reject_network_firewall_transit_gateway_attachment#
Rejects a transit gateway attachment request for Network Firewall.
Type annotations and code completion for boto3.client("network-firewall").reject_network_firewall_transit_gateway_attachment method.
 boto3 documentation
# reject_network_firewall_transit_gateway_attachment method definition
def reject_network_firewall_transit_gateway_attachment(
    self,
    *,
    TransitGatewayAttachmentId: str,
) -> RejectNetworkFirewallTransitGatewayAttachmentResponseTypeDef:  # (1)
    ...# reject_network_firewall_transit_gateway_attachment method usage example with argument unpacking
kwargs: RejectNetworkFirewallTransitGatewayAttachmentRequestTypeDef = {  # (1)
    "TransitGatewayAttachmentId": ...,
}
parent.reject_network_firewall_transit_gateway_attachment(**kwargs)start_analysis_report#
Generates a traffic analysis report for the timeframe and traffic type you specify.
Type annotations and code completion for boto3.client("network-firewall").start_analysis_report method.
 boto3 documentation
# start_analysis_report method definition
def start_analysis_report(
    self,
    *,
    AnalysisType: EnabledAnalysisTypeType,  # (1)
    FirewallName: str = ...,
    FirewallArn: str = ...,
) -> StartAnalysisReportResponseTypeDef:  # (2)
    ...# start_analysis_report method usage example with argument unpacking
kwargs: StartAnalysisReportRequestTypeDef = {  # (1)
    "AnalysisType": ...,
}
parent.start_analysis_report(**kwargs)start_flow_capture#
Begins capturing the flows in a firewall, according to the filters you define.
Type annotations and code completion for boto3.client("network-firewall").start_flow_capture method.
 boto3 documentation
# start_flow_capture method definition
def start_flow_capture(
    self,
    *,
    FirewallArn: str,
    FlowFilters: Sequence[FlowFilterUnionTypeDef],  # (1)
    AvailabilityZone: str = ...,
    VpcEndpointAssociationArn: str = ...,
    VpcEndpointId: str = ...,
    MinimumFlowAgeInSeconds: int = ...,
) -> StartFlowCaptureResponseTypeDef:  # (2)
    ...- See Sequence[FlowFilterUnionTypeDef]
- See StartFlowCaptureResponseTypeDef
# start_flow_capture method usage example with argument unpacking
kwargs: StartFlowCaptureRequestTypeDef = {  # (1)
    "FirewallArn": ...,
    "FlowFilters": ...,
}
parent.start_flow_capture(**kwargs)start_flow_flush#
Begins the flushing of traffic from the firewall, according to the filters you define.
Type annotations and code completion for boto3.client("network-firewall").start_flow_flush method.
 boto3 documentation
# start_flow_flush method definition
def start_flow_flush(
    self,
    *,
    FirewallArn: str,
    FlowFilters: Sequence[FlowFilterUnionTypeDef],  # (1)
    AvailabilityZone: str = ...,
    VpcEndpointAssociationArn: str = ...,
    VpcEndpointId: str = ...,
    MinimumFlowAgeInSeconds: int = ...,
) -> StartFlowFlushResponseTypeDef:  # (2)
    ...- See Sequence[FlowFilterUnionTypeDef]
- See StartFlowFlushResponseTypeDef
# start_flow_flush method usage example with argument unpacking
kwargs: StartFlowFlushRequestTypeDef = {  # (1)
    "FirewallArn": ...,
    "FlowFilters": ...,
}
parent.start_flow_flush(**kwargs)tag_resource#
Adds the specified tags to the specified resource.
Type annotations and code completion for boto3.client("network-firewall").tag_resource method.
 boto3 documentation
# tag_resource method definition
def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...- See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes the tags with the specified keys from the specified resource.
Type annotations and code completion for boto3.client("network-firewall").untag_resource method.
 boto3 documentation
# untag_resource method definition
def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}
parent.untag_resource(**kwargs)update_availability_zone_change_protection#
Modifies the AvailabilityZoneChangeProtection setting for a
transit gateway-attached firewall.
Type annotations and code completion for boto3.client("network-firewall").update_availability_zone_change_protection method.
 boto3 documentation
# update_availability_zone_change_protection method definition
def update_availability_zone_change_protection(
    self,
    *,
    AvailabilityZoneChangeProtection: bool,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> UpdateAvailabilityZoneChangeProtectionResponseTypeDef:  # (1)
    ...# update_availability_zone_change_protection method usage example with argument unpacking
kwargs: UpdateAvailabilityZoneChangeProtectionRequestTypeDef = {  # (1)
    "AvailabilityZoneChangeProtection": ...,
}
parent.update_availability_zone_change_protection(**kwargs)update_firewall_analysis_settings#
Enables specific types of firewall analysis on a specific firewall you define.
Type annotations and code completion for boto3.client("network-firewall").update_firewall_analysis_settings method.
 boto3 documentation
# update_firewall_analysis_settings method definition
def update_firewall_analysis_settings(
    self,
    *,
    EnabledAnalysisTypes: Sequence[EnabledAnalysisTypeType] = ...,  # (1)
    FirewallArn: str = ...,
    FirewallName: str = ...,
    UpdateToken: str = ...,
) -> UpdateFirewallAnalysisSettingsResponseTypeDef:  # (2)
    ...- See Sequence[EnabledAnalysisTypeType]
- See UpdateFirewallAnalysisSettingsResponseTypeDef
# update_firewall_analysis_settings method usage example with argument unpacking
kwargs: UpdateFirewallAnalysisSettingsRequestTypeDef = {  # (1)
    "EnabledAnalysisTypes": ...,
}
parent.update_firewall_analysis_settings(**kwargs)update_firewall_delete_protection#
Modifies the flag, DeleteProtection, which indicates whether it is
possible to delete the firewall.
Type annotations and code completion for boto3.client("network-firewall").update_firewall_delete_protection method.
 boto3 documentation
# update_firewall_delete_protection method definition
def update_firewall_delete_protection(
    self,
    *,
    DeleteProtection: bool,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> UpdateFirewallDeleteProtectionResponseTypeDef:  # (1)
    ...# update_firewall_delete_protection method usage example with argument unpacking
kwargs: UpdateFirewallDeleteProtectionRequestTypeDef = {  # (1)
    "DeleteProtection": ...,
}
parent.update_firewall_delete_protection(**kwargs)update_firewall_description#
Modifies the description for the specified firewall.
Type annotations and code completion for boto3.client("network-firewall").update_firewall_description method.
 boto3 documentation
# update_firewall_description method definition
def update_firewall_description(
    self,
    *,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
    Description: str = ...,
) -> UpdateFirewallDescriptionResponseTypeDef:  # (1)
    ...# update_firewall_description method usage example with argument unpacking
kwargs: UpdateFirewallDescriptionRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}
parent.update_firewall_description(**kwargs)update_firewall_encryption_configuration#
A complex type that contains settings for encryption of your firewall resources.
Type annotations and code completion for boto3.client("network-firewall").update_firewall_encryption_configuration method.
 boto3 documentation
# update_firewall_encryption_configuration method definition
def update_firewall_encryption_configuration(
    self,
    *,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (1)
) -> UpdateFirewallEncryptionConfigurationResponseTypeDef:  # (2)
    ...# update_firewall_encryption_configuration method usage example with argument unpacking
kwargs: UpdateFirewallEncryptionConfigurationRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}
parent.update_firewall_encryption_configuration(**kwargs)update_firewall_policy#
Updates the properties of the specified firewall policy.
Type annotations and code completion for boto3.client("network-firewall").update_firewall_policy method.
 boto3 documentation
# update_firewall_policy method definition
def update_firewall_policy(
    self,
    *,
    UpdateToken: str,
    FirewallPolicy: FirewallPolicyUnionTypeDef,  # (1)
    FirewallPolicyArn: str = ...,
    FirewallPolicyName: str = ...,
    Description: str = ...,
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
) -> UpdateFirewallPolicyResponseTypeDef:  # (3)
    ...- See FirewallPolicyUnionTypeDef
- See EncryptionConfigurationTypeDef
- See UpdateFirewallPolicyResponseTypeDef
# update_firewall_policy method usage example with argument unpacking
kwargs: UpdateFirewallPolicyRequestTypeDef = {  # (1)
    "UpdateToken": ...,
    "FirewallPolicy": ...,
}
parent.update_firewall_policy(**kwargs)update_firewall_policy_change_protection#
Modifies the flag, ChangeProtection, which indicates whether it is
possible to change the firewall.
Type annotations and code completion for boto3.client("network-firewall").update_firewall_policy_change_protection method.
 boto3 documentation
# update_firewall_policy_change_protection method definition
def update_firewall_policy_change_protection(
    self,
    *,
    FirewallPolicyChangeProtection: bool,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> UpdateFirewallPolicyChangeProtectionResponseTypeDef:  # (1)
    ...# update_firewall_policy_change_protection method usage example with argument unpacking
kwargs: UpdateFirewallPolicyChangeProtectionRequestTypeDef = {  # (1)
    "FirewallPolicyChangeProtection": ...,
}
parent.update_firewall_policy_change_protection(**kwargs)update_logging_configuration#
Sets the logging configuration for the specified firewall.
Type annotations and code completion for boto3.client("network-firewall").update_logging_configuration method.
 boto3 documentation
# update_logging_configuration method definition
def update_logging_configuration(
    self,
    *,
    FirewallArn: str = ...,
    FirewallName: str = ...,
    LoggingConfiguration: LoggingConfigurationUnionTypeDef = ...,  # (1)
    EnableMonitoringDashboard: bool = ...,
) -> UpdateLoggingConfigurationResponseTypeDef:  # (2)
    ...# update_logging_configuration method usage example with argument unpacking
kwargs: UpdateLoggingConfigurationRequestTypeDef = {  # (1)
    "FirewallArn": ...,
}
parent.update_logging_configuration(**kwargs)update_rule_group#
Updates the rule settings for the specified rule group.
Type annotations and code completion for boto3.client("network-firewall").update_rule_group method.
 boto3 documentation
# update_rule_group method definition
def update_rule_group(
    self,
    *,
    UpdateToken: str,
    RuleGroupArn: str = ...,
    RuleGroupName: str = ...,
    RuleGroup: RuleGroupUnionTypeDef = ...,  # (1)
    Rules: str = ...,
    Type: RuleGroupTypeType = ...,  # (2)
    Description: str = ...,
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
    SourceMetadata: SourceMetadataTypeDef = ...,  # (4)
    AnalyzeRuleGroup: bool = ...,
    SummaryConfiguration: SummaryConfigurationUnionTypeDef = ...,  # (5)
) -> UpdateRuleGroupResponseTypeDef:  # (6)
    ...- See RuleGroupUnionTypeDef
- See RuleGroupTypeType
- See EncryptionConfigurationTypeDef
- See SourceMetadataTypeDef
- See SummaryConfigurationUnionTypeDef
- See UpdateRuleGroupResponseTypeDef
# update_rule_group method usage example with argument unpacking
kwargs: UpdateRuleGroupRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}
parent.update_rule_group(**kwargs)update_subnet_change_protection#
.
Type annotations and code completion for boto3.client("network-firewall").update_subnet_change_protection method.
 boto3 documentation
# update_subnet_change_protection method definition
def update_subnet_change_protection(
    self,
    *,
    SubnetChangeProtection: bool,
    UpdateToken: str = ...,
    FirewallArn: str = ...,
    FirewallName: str = ...,
) -> UpdateSubnetChangeProtectionResponseTypeDef:  # (1)
    ...# update_subnet_change_protection method usage example with argument unpacking
kwargs: UpdateSubnetChangeProtectionRequestTypeDef = {  # (1)
    "SubnetChangeProtection": ...,
}
parent.update_subnet_change_protection(**kwargs)update_tls_inspection_configuration#
Updates the TLS inspection configuration settings for the specified TLS inspection configuration.
Type annotations and code completion for boto3.client("network-firewall").update_tls_inspection_configuration method.
 boto3 documentation
# update_tls_inspection_configuration method definition
def update_tls_inspection_configuration(
    self,
    *,
    TLSInspectionConfiguration: TLSInspectionConfigurationUnionTypeDef,  # (1)
    UpdateToken: str,
    TLSInspectionConfigurationArn: str = ...,
    TLSInspectionConfigurationName: str = ...,
    Description: str = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
) -> UpdateTLSInspectionConfigurationResponseTypeDef:  # (3)
    ...- See TLSInspectionConfigurationUnionTypeDef
- See EncryptionConfigurationTypeDef
- See UpdateTLSInspectionConfigurationResponseTypeDef
# update_tls_inspection_configuration method usage example with argument unpacking
kwargs: UpdateTLSInspectionConfigurationRequestTypeDef = {  # (1)
    "TLSInspectionConfiguration": ...,
    "UpdateToken": ...,
}
parent.update_tls_inspection_configuration(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("network-firewall").get_paginator method with overloads.
- client.get_paginator("get_analysis_report_results")-> GetAnalysisReportResultsPaginator
- client.get_paginator("list_analysis_reports")-> ListAnalysisReportsPaginator
- client.get_paginator("list_firewall_policies")-> ListFirewallPoliciesPaginator
- client.get_paginator("list_firewalls")-> ListFirewallsPaginator
- client.get_paginator("list_flow_operation_results")-> ListFlowOperationResultsPaginator
- client.get_paginator("list_flow_operations")-> ListFlowOperationsPaginator
- client.get_paginator("list_rule_groups")-> ListRuleGroupsPaginator
- client.get_paginator("list_tls_inspection_configurations")-> ListTLSInspectionConfigurationsPaginator
- client.get_paginator("list_tags_for_resource")-> ListTagsForResourcePaginator
- client.get_paginator("list_vpc_endpoint_associations")-> ListVpcEndpointAssociationsPaginator