Skip to main content

Type annotations for boto3.NetworkFirewall 1.17.93 service, generated by mypy-boto3-buider 4.18.2

Project description

mypy-boto3-network-firewall

PyPI - mypy-boto3-network-firewall PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3.NetworkFirewall 1.17.93 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-buider 4.18.2.

More information can be found on boto3-stubs page and in mypy-boto3-network-firewall docs

See how it helps to find and fix potential bugs:

boto3-stubs demo

How to install

Install boto3-stubs for NetworkFirewall service.

python -m pip install boto3-stubs[network-firewall]

Usage

VSCode

  • Install Python extension
  • Install Pylance extension
  • Set Pylance as your Python Language Server
  • Install boto-stubs[network-firewall] in your environment: python -m pip install 'boto3-stubs[network-firewall]'

Both type checking and auto-complete should work for NetworkFirewall service. No explicit type annotations required, write your boto3 code as usual.

PyCharm

  • Install boto-stubs[network-firewall] in your environment: python -m pip install 'boto3-stubs[network-firewall]'

Both type checking and auto-complete should work for NetworkFirewall service. No explicit type annotations required, write your boto3 code as usual. Auto-complete can be slow on big projects or if you have a lot of installed boto3-stubs submodules.

Other IDEs

Not tested, but as long as your IDE support mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install boto-stubs[network-firewall] in your environment: python -m pip install 'boto3-stubs[network-firewall]'
  • Run mypy as usual

Type checking should work for NetworkFirewall service. No explicit type annotations required, write your boto3 code as usual.

pyright

  • Install pyright: yarn global add pyright
  • Install boto-stubs[network-firewall] in your environment: python -m pip install 'boto3-stubs[network-firewall]'
  • Optionally, you can install boto3-stubs to typings folder.

Type checking should work for NetworkFirewall service. No explicit type annotations required, write your boto3 code as usual.

Explicit type annotations

Client annotations

NetworkFirewallClient provides annotations for boto3.client("network-firewall").

import boto3

from mypy_boto3_network_firewall import NetworkFirewallClient

client: NetworkFirewallClient = boto3.client("network-firewall")

# now client usage is checked by mypy and IDE should provide code auto-complete

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: NetworkFirewallClient = session.client("network-firewall")

Paginators annotations

mypy_boto3_network_firewall.paginator module contains type annotations for all paginators.

from mypy_boto3_network_firewall import NetworkFirewallClient
from mypy_boto3_network_firewall.paginator import (
    ListFirewallPoliciesPaginator,
    ListFirewallsPaginator,
    ListRuleGroupsPaginator,
    ListTagsForResourcePaginator,
)

client: NetworkFirewallClient = boto3.client("network-firewall")

# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_firewall_policies_paginator: ListFirewallPoliciesPaginator = client.get_paginator("list_firewall_policies")
list_firewalls_paginator: ListFirewallsPaginator = client.get_paginator("list_firewalls")
list_rule_groups_paginator: ListRuleGroupsPaginator = client.get_paginator("list_rule_groups")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")

Literals

mypy_boto3_network_firewall.literals module contains literals extracted from shapes that can be used in user code for type checking.

from mypy_boto3_network_firewall.literals import (
    AttachmentStatusType,
    ConfigurationSyncStateType,
    FirewallStatusValueType,
    GeneratedRulesTypeType,
    ListFirewallPoliciesPaginatorName,
    ListFirewallsPaginatorName,
    ListRuleGroupsPaginatorName,
    ListTagsForResourcePaginatorName,
    LogDestinationTypeType,
    LogTypeType,
    PerObjectSyncStatusType,
    ResourceStatusType,
    RuleGroupTypeType,
    StatefulActionType,
    StatefulRuleDirectionType,
    StatefulRuleProtocolType,
    TCPFlagType,
    TargetTypeType,
)

def check_value(value: AttachmentStatusType) -> bool:
    ...

Typed dictionaries

mypy_boto3_network_firewall.type_defs module contains structures and shapes assembled to typed dictionaries for additional type checking.

from mypy_boto3_network_firewall.type_defs import (
    ActionDefinitionTypeDef,
    AddressTypeDef,
    AssociateFirewallPolicyResponseTypeDef,
    AssociateSubnetsResponseTypeDef,
    AttachmentTypeDef,
    CreateFirewallPolicyResponseTypeDef,
    CreateFirewallResponseTypeDef,
    CreateRuleGroupResponseTypeDef,
    CustomActionTypeDef,
    DeleteFirewallPolicyResponseTypeDef,
    DeleteFirewallResponseTypeDef,
    DeleteRuleGroupResponseTypeDef,
    DescribeFirewallPolicyResponseTypeDef,
    DescribeFirewallResponseTypeDef,
    DescribeLoggingConfigurationResponseTypeDef,
    DescribeResourcePolicyResponseTypeDef,
    DescribeRuleGroupResponseTypeDef,
    DimensionTypeDef,
    DisassociateSubnetsResponseTypeDef,
    FirewallMetadataTypeDef,
    FirewallPolicyMetadataTypeDef,
    FirewallPolicyResponseTypeDef,
    FirewallPolicyTypeDef,
    FirewallStatusTypeDef,
    FirewallTypeDef,
    HeaderTypeDef,
    IPSetTypeDef,
    ListFirewallPoliciesResponseTypeDef,
    ListFirewallsResponseTypeDef,
    ListRuleGroupsResponseTypeDef,
    ListTagsForResourceResponseTypeDef,
    LogDestinationConfigTypeDef,
    LoggingConfigurationTypeDef,
    MatchAttributesTypeDef,
    PaginatorConfigTypeDef,
    PerObjectStatusTypeDef,
    PortRangeTypeDef,
    PortSetTypeDef,
    PublishMetricActionTypeDef,
    RuleDefinitionTypeDef,
    RuleGroupMetadataTypeDef,
    RuleGroupResponseTypeDef,
    RuleGroupTypeDef,
    RuleOptionTypeDef,
    RuleVariablesTypeDef,
    RulesSourceListTypeDef,
    RulesSourceTypeDef,
    StatefulRuleGroupReferenceTypeDef,
    StatefulRuleTypeDef,
    StatelessRuleGroupReferenceTypeDef,
    StatelessRuleTypeDef,
    StatelessRulesAndCustomActionsTypeDef,
    SubnetMappingTypeDef,
    SyncStateTypeDef,
    TCPFlagFieldTypeDef,
    TagTypeDef,
    UpdateFirewallDeleteProtectionResponseTypeDef,
    UpdateFirewallDescriptionResponseTypeDef,
    UpdateFirewallPolicyChangeProtectionResponseTypeDef,
    UpdateFirewallPolicyResponseTypeDef,
    UpdateLoggingConfigurationResponseTypeDef,
    UpdateRuleGroupResponseTypeDef,
    UpdateSubnetChangeProtectionResponseTypeDef,
)

def get_structure() -> ActionDefinitionTypeDef:
    return {
      ...
    }

Versioning

mypy-boto3-network-firewall version is the same as related boto3 version and follows PEP 440 format.

Documentation

All type annotations can be found in mypy-boto3-network-firewall docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mypy-boto3-network-firewall-1.17.93.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_network_firewall-1.17.93-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file mypy-boto3-network-firewall-1.17.93.tar.gz.

File metadata

  • Download URL: mypy-boto3-network-firewall-1.17.93.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for mypy-boto3-network-firewall-1.17.93.tar.gz
Algorithm Hash digest
SHA256 ddec903025d0bdb2f387bb966213f823eb9d52707b7d84555658a7fa8fcfaedf
MD5 6279d978ce89af4795e7b6354448cb86
BLAKE2b-256 55ce2818c7247ef322993c5b809f15a0dbf5a4799cd9d8ce7f4da3f246170ff5

See more details on using hashes here.

File details

Details for the file mypy_boto3_network_firewall-1.17.93-py3-none-any.whl.

File metadata

  • Download URL: mypy_boto3_network_firewall-1.17.93-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5

File hashes

Hashes for mypy_boto3_network_firewall-1.17.93-py3-none-any.whl
Algorithm Hash digest
SHA256 798490824547d3505cdaca9b416856b0bb27672bda6733c7f52aa8227e47c5a6
MD5 b11a6c3c53aa745a18518234f4611dd1
BLAKE2b-256 e7f2aece40e02cf4b4878754d102c6e4a3865ae99739e0ac9eb9ffc608d8a495

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page