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
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.
client = boto3.client("network-firewall")
try:
do_something(client)
except (
client.ClientError,
client.InsufficientCapacityException,
client.InternalServerError,
client.InvalidOperationException,
client.InvalidRequestException,
client.InvalidResourcePolicyException,
client.InvalidTokenException,
client.LimitExceededException,
client.LogDestinationPermissionException,
client.ResourceNotFoundException,
client.ResourceOwnerCheckException,
client.ThrottlingException,
client.UnsupportedOperationException,
) as e:
print(e)
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
def associate_firewall_policy(
self,
*,
FirewallPolicyArn: str,
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> AssociateFirewallPolicyResponseTypeDef: # (1)
...
kwargs: AssociateFirewallPolicyRequestRequestTypeDef = { # (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
def associate_subnets(
self,
*,
SubnetMappings: Sequence[SubnetMappingTypeDef], # (1)
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> AssociateSubnetsResponseTypeDef: # (2)
...
kwargs: AssociateSubnetsRequestRequestTypeDef = { # (1)
"SubnetMappings": ...,
}
parent.associate_subnets(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("network-firewall").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("network-firewall").close
method.
boto3 documentation
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
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)
...
- See SubnetMappingTypeDef
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See CreateFirewallResponseTypeDef
kwargs: CreateFirewallRequestRequestTypeDef = { # (1)
"FirewallName": ...,
"FirewallPolicyArn": ...,
"VpcId": ...,
"SubnetMappings": ...,
}
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
def create_firewall_policy(
self,
*,
FirewallPolicyName: str,
FirewallPolicy: FirewallPolicyTypeDef, # (1)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
DryRun: bool = ...,
EncryptionConfiguration: EncryptionConfigurationTypeDef = ..., # (3)
) -> CreateFirewallPolicyResponseTypeDef: # (4)
...
- See FirewallPolicyTypeDef
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See CreateFirewallPolicyResponseTypeDef
kwargs: CreateFirewallPolicyRequestRequestTypeDef = { # (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
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)
) -> CreateRuleGroupResponseTypeDef: # (6)
...
- See RuleGroupTypeType
- See RuleGroupTypeDef
- See TagTypeDef
- See EncryptionConfigurationTypeDef
- See SourceMetadataTypeDef
- See CreateRuleGroupResponseTypeDef
kwargs: CreateRuleGroupRequestRequestTypeDef = { # (1)
"RuleGroupName": ...,
"Type": ...,
"Capacity": ...,
}
parent.create_rule_group(**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
def delete_firewall(
self,
*,
FirewallName: str = ...,
FirewallArn: str = ...,
) -> DeleteFirewallResponseTypeDef: # (1)
...
kwargs: DeleteFirewallRequestRequestTypeDef = { # (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
def delete_firewall_policy(
self,
*,
FirewallPolicyName: str = ...,
FirewallPolicyArn: str = ...,
) -> DeleteFirewallPolicyResponseTypeDef: # (1)
...
kwargs: DeleteFirewallPolicyRequestRequestTypeDef = { # (1)
"FirewallPolicyName": ...,
}
parent.delete_firewall_policy(**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
kwargs: DeleteResourcePolicyRequestRequestTypeDef = { # (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
def delete_rule_group(
self,
*,
RuleGroupName: str = ...,
RuleGroupArn: str = ...,
Type: RuleGroupTypeType = ..., # (1)
) -> DeleteRuleGroupResponseTypeDef: # (2)
...
kwargs: DeleteRuleGroupRequestRequestTypeDef = { # (1)
"RuleGroupName": ...,
}
parent.delete_rule_group(**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
def describe_firewall(
self,
*,
FirewallName: str = ...,
FirewallArn: str = ...,
) -> DescribeFirewallResponseTypeDef: # (1)
...
kwargs: DescribeFirewallRequestRequestTypeDef = { # (1)
"FirewallName": ...,
}
parent.describe_firewall(**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
def describe_firewall_policy(
self,
*,
FirewallPolicyName: str = ...,
FirewallPolicyArn: str = ...,
) -> DescribeFirewallPolicyResponseTypeDef: # (1)
...
kwargs: DescribeFirewallPolicyRequestRequestTypeDef = { # (1)
"FirewallPolicyName": ...,
}
parent.describe_firewall_policy(**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
def describe_logging_configuration(
self,
*,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> DescribeLoggingConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeLoggingConfigurationRequestRequestTypeDef = { # (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
def describe_resource_policy(
self,
*,
ResourceArn: str,
) -> DescribeResourcePolicyResponseTypeDef: # (1)
...
kwargs: DescribeResourcePolicyRequestRequestTypeDef = { # (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
def describe_rule_group(
self,
*,
RuleGroupName: str = ...,
RuleGroupArn: str = ...,
Type: RuleGroupTypeType = ..., # (1)
) -> DescribeRuleGroupResponseTypeDef: # (2)
...
kwargs: DescribeRuleGroupRequestRequestTypeDef = { # (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
def describe_rule_group_metadata(
self,
*,
RuleGroupName: str = ...,
RuleGroupArn: str = ...,
Type: RuleGroupTypeType = ..., # (1)
) -> DescribeRuleGroupMetadataResponseTypeDef: # (2)
...
kwargs: DescribeRuleGroupMetadataRequestRequestTypeDef = { # (1)
"RuleGroupName": ...,
}
parent.describe_rule_group_metadata(**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
def disassociate_subnets(
self,
*,
SubnetIds: Sequence[str],
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> DisassociateSubnetsResponseTypeDef: # (1)
...
kwargs: DisassociateSubnetsRequestRequestTypeDef = { # (1)
"SubnetIds": ...,
}
parent.disassociate_subnets(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("network-firewall").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
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
def list_firewall_policies(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFirewallPoliciesResponseTypeDef: # (1)
...
kwargs: ListFirewallPoliciesRequestRequestTypeDef = { # (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
def list_firewalls(
self,
*,
NextToken: str = ...,
VpcIds: Sequence[str] = ...,
MaxResults: int = ...,
) -> ListFirewallsResponseTypeDef: # (1)
...
kwargs: ListFirewallsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_firewalls(**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
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
kwargs: ListRuleGroupsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_rule_groups(**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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def put_resource_policy(
self,
*,
ResourceArn: str,
Policy: str,
) -> Dict[str, Any]:
...
kwargs: PutResourcePolicyRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Policy": ...,
}
parent.put_resource_policy(**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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (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
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**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
def update_firewall_delete_protection(
self,
*,
DeleteProtection: bool,
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> UpdateFirewallDeleteProtectionResponseTypeDef: # (1)
...
kwargs: UpdateFirewallDeleteProtectionRequestRequestTypeDef = { # (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
def update_firewall_description(
self,
*,
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
Description: str = ...,
) -> UpdateFirewallDescriptionResponseTypeDef: # (1)
...
kwargs: UpdateFirewallDescriptionRequestRequestTypeDef = { # (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
def update_firewall_encryption_configuration(
self,
*,
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
EncryptionConfiguration: EncryptionConfigurationTypeDef = ..., # (1)
) -> UpdateFirewallEncryptionConfigurationResponseTypeDef: # (2)
...
kwargs: UpdateFirewallEncryptionConfigurationRequestRequestTypeDef = { # (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
def update_firewall_policy(
self,
*,
UpdateToken: str,
FirewallPolicy: FirewallPolicyTypeDef, # (1)
FirewallPolicyArn: str = ...,
FirewallPolicyName: str = ...,
Description: str = ...,
DryRun: bool = ...,
EncryptionConfiguration: EncryptionConfigurationTypeDef = ..., # (2)
) -> UpdateFirewallPolicyResponseTypeDef: # (3)
...
- See FirewallPolicyTypeDef
- See EncryptionConfigurationTypeDef
- See UpdateFirewallPolicyResponseTypeDef
kwargs: UpdateFirewallPolicyRequestRequestTypeDef = { # (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
def update_firewall_policy_change_protection(
self,
*,
FirewallPolicyChangeProtection: bool,
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> UpdateFirewallPolicyChangeProtectionResponseTypeDef: # (1)
...
kwargs: UpdateFirewallPolicyChangeProtectionRequestRequestTypeDef = { # (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
def update_logging_configuration(
self,
*,
FirewallArn: str = ...,
FirewallName: str = ...,
LoggingConfiguration: LoggingConfigurationTypeDef = ..., # (1)
) -> UpdateLoggingConfigurationResponseTypeDef: # (2)
...
kwargs: UpdateLoggingConfigurationRequestRequestTypeDef = { # (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
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)
) -> UpdateRuleGroupResponseTypeDef: # (5)
...
- See RuleGroupTypeDef
- See RuleGroupTypeType
- See EncryptionConfigurationTypeDef
- See SourceMetadataTypeDef
- See UpdateRuleGroupResponseTypeDef
kwargs: UpdateRuleGroupRequestRequestTypeDef = { # (1)
"UpdateToken": ...,
}
parent.update_rule_group(**kwargs)
update_subnet_change_protection
See also: AWS API Documentation.
Type annotations and code completion for boto3.client("network-firewall").update_subnet_change_protection
method.
boto3 documentation
def update_subnet_change_protection(
self,
*,
SubnetChangeProtection: bool,
UpdateToken: str = ...,
FirewallArn: str = ...,
FirewallName: str = ...,
) -> UpdateSubnetChangeProtectionResponseTypeDef: # (1)
...
kwargs: UpdateSubnetChangeProtectionRequestRequestTypeDef = { # (1)
"SubnetChangeProtection": ...,
}
parent.update_subnet_change_protection(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("network-firewall").get_paginator
method with overloads.
client.get_paginator("list_firewall_policies")
-> ListFirewallPoliciesPaginatorclient.get_paginator("list_firewalls")
-> ListFirewallsPaginatorclient.get_paginator("list_rule_groups")
-> ListRuleGroupsPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginator