Skip to content

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#

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)
    ...
  1. See AssociateFirewallPolicyResponseTypeDef 
# associate_firewall_policy method usage example with argument unpacking

kwargs: AssociateFirewallPolicyRequestRequestTypeDef = {  # (1)
    "FirewallPolicyArn": ...,
}

parent.associate_firewall_policy(**kwargs)
  1. See AssociateFirewallPolicyRequestRequestTypeDef

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)
    ...
  1. See SubnetMappingTypeDef
  2. See AssociateSubnetsResponseTypeDef 
# associate_subnets method usage example with argument unpacking

kwargs: AssociateSubnetsRequestRequestTypeDef = {  # (1)
    "SubnetMappings": ...,
}

parent.associate_subnets(**kwargs)
  1. See AssociateSubnetsRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

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)
) -> CreateFirewallResponseTypeDef:  # (4)
    ...
  1. See SubnetMappingTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef
  4. See CreateFirewallResponseTypeDef 
# create_firewall method usage example with argument unpacking

kwargs: CreateFirewallRequestRequestTypeDef = {  # (1)
    "FirewallName": ...,
    "FirewallPolicyArn": ...,
    "VpcId": ...,
    "SubnetMappings": ...,
}

parent.create_firewall(**kwargs)
  1. See CreateFirewallRequestRequestTypeDef

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: FirewallPolicyTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
) -> CreateFirewallPolicyResponseTypeDef:  # (4)
    ...
  1. See FirewallPolicyTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef
  4. See CreateFirewallPolicyResponseTypeDef 
# create_firewall_policy method usage example with argument unpacking

kwargs: CreateFirewallPolicyRequestRequestTypeDef = {  # (1)
    "FirewallPolicyName": ...,
    "FirewallPolicy": ...,
}

parent.create_firewall_policy(**kwargs)
  1. See CreateFirewallPolicyRequestRequestTypeDef

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: RuleGroupTypeDef = ...,  # (2)
    Rules: str = ...,
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (4)
    SourceMetadata: SourceMetadataTypeDef = ...,  # (5)
    AnalyzeRuleGroup: bool = ...,
) -> CreateRuleGroupResponseTypeDef:  # (6)
    ...
  1. See RuleGroupTypeType
  2. See RuleGroupTypeDef
  3. See TagTypeDef
  4. See EncryptionConfigurationTypeDef
  5. See SourceMetadataTypeDef
  6. See CreateRuleGroupResponseTypeDef 
# create_rule_group method usage example with argument unpacking

kwargs: CreateRuleGroupRequestRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
    "Type": ...,
    "Capacity": ...,
}

parent.create_rule_group(**kwargs)
  1. See CreateRuleGroupRequestRequestTypeDef

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: TLSInspectionConfigurationTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
) -> CreateTLSInspectionConfigurationResponseTypeDef:  # (4)
    ...
  1. See TLSInspectionConfigurationTypeDef
  2. See TagTypeDef
  3. See EncryptionConfigurationTypeDef
  4. See CreateTLSInspectionConfigurationResponseTypeDef 
# create_tls_inspection_configuration method usage example with argument unpacking

kwargs: CreateTLSInspectionConfigurationRequestRequestTypeDef = {  # (1)
    "TLSInspectionConfigurationName": ...,
    "TLSInspectionConfiguration": ...,
}

parent.create_tls_inspection_configuration(**kwargs)
  1. See CreateTLSInspectionConfigurationRequestRequestTypeDef

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)
    ...
  1. See DeleteFirewallResponseTypeDef 
# delete_firewall method usage example with argument unpacking

kwargs: DeleteFirewallRequestRequestTypeDef = {  # (1)
    "FirewallName": ...,
}

parent.delete_firewall(**kwargs)
  1. See DeleteFirewallRequestRequestTypeDef

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)
    ...
  1. See DeleteFirewallPolicyResponseTypeDef 
# delete_firewall_policy method usage example with argument unpacking

kwargs: DeleteFirewallPolicyRequestRequestTypeDef = {  # (1)
    "FirewallPolicyName": ...,
}

parent.delete_firewall_policy(**kwargs)
  1. See DeleteFirewallPolicyRequestRequestTypeDef

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: DeleteResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.delete_resource_policy(**kwargs)
  1. See DeleteResourcePolicyRequestRequestTypeDef

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)
    ...
  1. See RuleGroupTypeType
  2. See DeleteRuleGroupResponseTypeDef 
# delete_rule_group method usage example with argument unpacking

kwargs: DeleteRuleGroupRequestRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
}

parent.delete_rule_group(**kwargs)
  1. See DeleteRuleGroupRequestRequestTypeDef

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)
    ...
  1. See DeleteTLSInspectionConfigurationResponseTypeDef 
# delete_tls_inspection_configuration method usage example with argument unpacking

kwargs: DeleteTLSInspectionConfigurationRequestRequestTypeDef = {  # (1)
    "TLSInspectionConfigurationArn": ...,
}

parent.delete_tls_inspection_configuration(**kwargs)
  1. See DeleteTLSInspectionConfigurationRequestRequestTypeDef

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)
    ...
  1. See DescribeFirewallResponseTypeDef 
# describe_firewall method usage example with argument unpacking

kwargs: DescribeFirewallRequestRequestTypeDef = {  # (1)
    "FirewallName": ...,
}

parent.describe_firewall(**kwargs)
  1. See DescribeFirewallRequestRequestTypeDef

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)
    ...
  1. See DescribeFirewallPolicyResponseTypeDef 
# describe_firewall_policy method usage example with argument unpacking

kwargs: DescribeFirewallPolicyRequestRequestTypeDef = {  # (1)
    "FirewallPolicyName": ...,
}

parent.describe_firewall_policy(**kwargs)
  1. See DescribeFirewallPolicyRequestRequestTypeDef

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)
    ...
  1. See DescribeLoggingConfigurationResponseTypeDef 
# describe_logging_configuration method usage example with argument unpacking

kwargs: DescribeLoggingConfigurationRequestRequestTypeDef = {  # (1)
    "FirewallArn": ...,
}

parent.describe_logging_configuration(**kwargs)
  1. See DescribeLoggingConfigurationRequestRequestTypeDef

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)
    ...
  1. See DescribeResourcePolicyResponseTypeDef 
# describe_resource_policy method usage example with argument unpacking

kwargs: DescribeResourcePolicyRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.describe_resource_policy(**kwargs)
  1. See DescribeResourcePolicyRequestRequestTypeDef

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)
    ...
  1. See RuleGroupTypeType
  2. See DescribeRuleGroupResponseTypeDef 
# describe_rule_group method usage example with argument unpacking

kwargs: DescribeRuleGroupRequestRequestTypeDef = {  # (1)
    "RuleGroupName": ...,
}

parent.describe_rule_group(**kwargs)
  1. See DescribeRuleGroupRequestRequestTypeDef

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)
    ...