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

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

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

1. See RuleGroupTypeType
2. See DescribeRuleGroupMetadataResponseTypeDef

# describe_rule_group_metadata method usage example with argument unpacking

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

parent.describe_rule_group_metadata(**kwargs)

1. See DescribeRuleGroupMetadataRequestRequestTypeDef

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

1. See DescribeTLSInspectionConfigurationResponseTypeDef

# describe_tls_inspection_configuration method usage example with argument unpacking

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

parent.describe_tls_inspection_configuration(**kwargs)

1. See DescribeTLSInspectionConfigurationRequestRequestTypeDef

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

1. See DisassociateSubnetsResponseTypeDef

# disassociate_subnets method usage example with argument unpacking

kwargs: DisassociateSubnetsRequestRequestTypeDef = {  # (1)
    "SubnetIds": ...,
}

parent.disassociate_subnets(**kwargs)

1. See DisassociateSubnetsRequestRequestTypeDef

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

1. See ListFirewallPoliciesResponseTypeDef

# list_firewall_policies method usage example with argument unpacking

kwargs: ListFirewallPoliciesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_firewall_policies(**kwargs)

1. See ListFirewallPoliciesRequestRequestTypeDef

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

1. See ListFirewallsResponseTypeDef

# list_firewalls method usage example with argument unpacking

kwargs: ListFirewallsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_firewalls(**kwargs)

1. See ListFirewallsRequestRequestTypeDef

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

1. See ResourceManagedStatusType
2. See ResourceManagedTypeType
3. See RuleGroupTypeType
4. See ListRuleGroupsResponseTypeDef

# list_rule_groups method usage example with argument unpacking

kwargs: ListRuleGroupsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_rule_groups(**kwargs)

1. See ListRuleGroupsRequestRequestTypeDef

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

1. See ListTLSInspectionConfigurationsResponseTypeDef

# list_tls_inspection_configurations method usage example with argument unpacking

kwargs: ListTLSInspectionConfigurationsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_tls_inspection_configurations(**kwargs)

1. See ListTLSInspectionConfigurationsRequestRequestTypeDef

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

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

put_resource_policy

Creates or updates an IAM policy for your rule group or firewall policy.

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

parent.put_resource_policy(**kwargs)

1. See PutResourcePolicyRequestRequestTypeDef

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

1. See TagTypeDef

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

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

1. See UpdateFirewallDeleteProtectionResponseTypeDef

# update_firewall_delete_protection method usage example with argument unpacking

kwargs: UpdateFirewallDeleteProtectionRequestRequestTypeDef = {  # (1)
    "DeleteProtection": ...,
}

parent.update_firewall_delete_protection(**kwargs)

1. See UpdateFirewallDeleteProtectionRequestRequestTypeDef

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

1. See UpdateFirewallDescriptionResponseTypeDef

# update_firewall_description method usage example with argument unpacking

kwargs: UpdateFirewallDescriptionRequestRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}

parent.update_firewall_description(**kwargs)

1. See UpdateFirewallDescriptionRequestRequestTypeDef

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

1. See EncryptionConfigurationTypeDef
2. See UpdateFirewallEncryptionConfigurationResponseTypeDef

# update_firewall_encryption_configuration method usage example with argument unpacking

kwargs: UpdateFirewallEncryptionConfigurationRequestRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}

parent.update_firewall_encryption_configuration(**kwargs)

1. See UpdateFirewallEncryptionConfigurationRequestRequestTypeDef

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: FirewallPolicyTypeDef,  # (1)
    FirewallPolicyArn: str = ...,
    FirewallPolicyName: str = ...,
    Description: str = ...,
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
) -> UpdateFirewallPolicyResponseTypeDef:  # (3)
    ...

1. See FirewallPolicyTypeDef
2. See EncryptionConfigurationTypeDef
3. See UpdateFirewallPolicyResponseTypeDef

# update_firewall_policy method usage example with argument unpacking

kwargs: UpdateFirewallPolicyRequestRequestTypeDef = {  # (1)
    "UpdateToken": ...,
    "FirewallPolicy": ...,
}

parent.update_firewall_policy(**kwargs)

1. See UpdateFirewallPolicyRequestRequestTypeDef

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

1. See UpdateFirewallPolicyChangeProtectionResponseTypeDef

# update_firewall_policy_change_protection method usage example with argument unpacking

kwargs: UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef = {  # (1)
    "FirewallPolicyChangeProtection": ...,
}

parent.update_firewall_policy_change_protection(**kwargs)

1. See UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef

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: LoggingConfigurationTypeDef = ...,  # (1)
) -> UpdateLoggingConfigurationResponseTypeDef:  # (2)
    ...

1. See LoggingConfigurationTypeDef
2. See UpdateLoggingConfigurationResponseTypeDef

# update_logging_configuration method usage example with argument unpacking

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

parent.update_logging_configuration(**kwargs)

1. See UpdateLoggingConfigurationRequestRequestTypeDef

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: RuleGroupTypeDef = ...,  # (1)
    Rules: str = ...,
    Type: RuleGroupTypeType = ...,  # (2)
    Description: str = ...,
    DryRun: bool = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (3)
    SourceMetadata: SourceMetadataTypeDef = ...,  # (4)
    AnalyzeRuleGroup: bool = ...,
) -> UpdateRuleGroupResponseTypeDef:  # (5)
    ...

1. See RuleGroupTypeDef
2. See RuleGroupTypeType
3. See EncryptionConfigurationTypeDef
4. See SourceMetadataTypeDef
5. See UpdateRuleGroupResponseTypeDef

# update_rule_group method usage example with argument unpacking

kwargs: UpdateRuleGroupRequestRequestTypeDef = {  # (1)
    "UpdateToken": ...,
}

parent.update_rule_group(**kwargs)

1. See UpdateRuleGroupRequestRequestTypeDef

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

1. See UpdateSubnetChangeProtectionResponseTypeDef

# update_subnet_change_protection method usage example with argument unpacking

kwargs: UpdateSubnetChangeProtectionRequestRequestTypeDef = {  # (1)
    "SubnetChangeProtection": ...,
}

parent.update_subnet_change_protection(**kwargs)

1. See UpdateSubnetChangeProtectionRequestRequestTypeDef

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: TLSInspectionConfigurationTypeDef,  # (1)
    UpdateToken: str,
    TLSInspectionConfigurationArn: str = ...,
    TLSInspectionConfigurationName: str = ...,
    Description: str = ...,
    EncryptionConfiguration: EncryptionConfigurationTypeDef = ...,  # (2)
) -> UpdateTLSInspectionConfigurationResponseTypeDef:  # (3)
    ...

1. See TLSInspectionConfigurationTypeDef
2. See EncryptionConfigurationTypeDef
3. See UpdateTLSInspectionConfigurationResponseTypeDef

# update_tls_inspection_configuration method usage example with argument unpacking

kwargs: UpdateTLSInspectionConfigurationRequestRequestTypeDef = {  # (1)
    "TLSInspectionConfiguration": ...,
    "UpdateToken": ...,
}

parent.update_tls_inspection_configuration(**kwargs)

1. See UpdateTLSInspectionConfigurationRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("network-firewall").get_paginator method with overloads.

• client.get_paginator("list_firewall_policies") -> ListFirewallPoliciesPaginator
• client.get_paginator("list_firewalls") -> ListFirewallsPaginator
• client.get_paginator("list_rule_groups") -> ListRuleGroupsPaginator
• client.get_paginator("list_tls_inspection_configurations") -> ListTLSInspectionConfigurationsPaginator
• client.get_paginator("list_tags_for_resource") -> ListTagsForResourcePaginator