Metadata-Version: 2.1
Name: mypy-boto3-networkmanager
Version: 1.17.87
Summary: Type annotations for boto3.NetworkManager 1.17.87 service, generated by mypy-boto3-buider 4.14.1
Home-page: https://github.com/vemel/mypy_boto3_builder
Author: Vlad Emelianov
Author-email: vlad.emelianov.nz@gmail.com
License: MIT License
Project-URL: Documentation, https://mypy-boto3-builder.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/vemel/mypy_boto3_builder
Project-URL: Tracker, https://github.com/vemel/mypy_boto3_builder/issues
Description: # mypy-boto3-networkmanager<a id="mypy-boto3-networkmanager"></a>
        
        [![PyPI - mypy-boto3-networkmanager](https://img.shields.io/pypi/v/mypy-boto3-networkmanager.svg?color=blue)](https://pypi.org/project/mypy-boto3-networkmanager)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-networkmanager.svg?color=blue)](https://pypi.org/project/mypy-boto3-networkmanager)
        [![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
        [![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-networkmanager?color=blue)](https://pypistats.org/packages/mypy-boto3-networkmanager)
        
        ![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
        
        Type annotations for
        [boto3.NetworkManager 1.17.87](https://boto3.amazonaws.com/v1/documentation/api/1.17.87/reference/services/networkmanager.html#NetworkManager)
        service compatible with [VSCode](https://code.visualstudio.com/),
        [PyCharm](https://www.jetbrains.com/pycharm/),
        [Emacs](https://www.gnu.org/software/emacs/),
        [Sublime Text](https://www.sublimetext.com/),
        [mypy](https://github.com/python/mypy),
        [pyright](https://github.com/microsoft/pyright) and other tools.
        
        Generated by
        [mypy-boto3-buider 4.14.1](https://github.com/vemel/mypy_boto3_builder).
        
        More information can be found on
        [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
        [mypy-boto3-networkmanager docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/)
        
        See how it helps to find and fix potential bugs:
        
        ![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
        
        - [mypy-boto3-networkmanager](#mypy-boto3-networkmanager)
          - [How to install](#how-to-install)
          - [Usage](#usage)
            - [VSCode](#vscode)
            - [PyCharm](#pycharm)
            - [Other IDEs](#other-ides)
            - [mypy](#mypy)
            - [pyright](#pyright)
          - [Explicit type annotations](#explicit-type-annotations)
            - [Client annotations](#client-annotations)
            - [Paginators annotations](#paginators-annotations)
            - [Literals](#literals)
            - [Typed dictionaries](#typed-dictionaries)
          - [Versioning](#versioning)
          - [Documentation](#documentation)
          - [Support and contributing](#support-and-contributing)
        
        ## How to install<a id="how-to-install"></a>
        
        Install `boto3-stubs` for `NetworkManager` service.
        
        ```bash
        python -m pip install boto3-stubs[networkmanager]
        ```
        
        ## Usage<a id="usage"></a>
        
        ### VSCode<a id="vscode"></a>
        
        - Install
          [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
        - Install
          [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
        - Set `Pylance` as your Python Language Server
        - Install `boto-stubs[networkmanager]` in your environment:
          `python -m pip install 'boto3-stubs[networkmanager]'`
        
        Both type checking and auto-complete should work for `NetworkManager` service.
        No explicit type annotations required, write your `boto3` code as usual.
        
        ### PyCharm<a id="pycharm"></a>
        
        - Install `boto-stubs[networkmanager]` in your environment:
          `python -m pip install 'boto3-stubs[networkmanager]'`
        
        Both type checking and auto-complete should work for `NetworkManager` 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<a id="other-ides"></a>
        
        Not tested, but as long as your IDE support `mypy` or `pyright`, everything
        should work.
        
        ### mypy<a id="mypy"></a>
        
        - Install `mypy`: `python -m pip install mypy`
        - Install `boto-stubs[networkmanager]` in your environment:
          `python -m pip install 'boto3-stubs[networkmanager]'`
        - Run `mypy` as usual
        
        Type checking should work for `NetworkManager` service. No explicit type
        annotations required, write your `boto3` code as usual.
        
        ### pyright<a id="pyright"></a>
        
        - Install `pyright`: `yarn global add pyright`
        - Install `boto-stubs[networkmanager]` in your environment:
          `python -m pip install 'boto3-stubs[networkmanager]'`
        - Optionally, you can install `boto3-stubs` to `typings` folder.
        
        Type checking should work for `NetworkManager` service. No explicit type
        annotations required, write your `boto3` code as usual.
        
        ## Explicit type annotations<a id="explicit-type-annotations"></a>
        
        ### Client annotations<a id="client-annotations"></a>
        
        `NetworkManagerClient` provides annotations for
        `boto3.client("networkmanager")`.
        
        ```python
        import boto3
        
        from mypy_boto3_networkmanager import NetworkManagerClient
        
        client: NetworkManagerClient = boto3.client("networkmanager")
        
        # 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: NetworkManagerClient = session.client("networkmanager")
        ```
        
        ### Paginators annotations<a id="paginators-annotations"></a>
        
        `mypy_boto3_networkmanager.paginator` module contains type annotations for all
        paginators.
        
        ```python
        from mypy_boto3_networkmanager import NetworkManagerClient
        from mypy_boto3_networkmanager.paginator import (
            DescribeGlobalNetworksPaginator,
            GetConnectionsPaginator,
            GetCustomerGatewayAssociationsPaginator,
            GetDevicesPaginator,
            GetLinkAssociationsPaginator,
            GetLinksPaginator,
            GetSitesPaginator,
            GetTransitGatewayConnectPeerAssociationsPaginator,
            GetTransitGatewayRegistrationsPaginator,
        )
        
        client: NetworkManagerClient = boto3.client("networkmanager")
        
        # Explicit type annotations are optional here
        # Type should be correctly discovered by mypy and IDEs
        # VSCode requires explicit type annotations
        describe_global_networks_paginator: DescribeGlobalNetworksPaginator = client.get_paginator("describe_global_networks")
        get_connections_paginator: GetConnectionsPaginator = client.get_paginator("get_connections")
        get_customer_gateway_associations_paginator: GetCustomerGatewayAssociationsPaginator = client.get_paginator("get_customer_gateway_associations")
        get_devices_paginator: GetDevicesPaginator = client.get_paginator("get_devices")
        get_link_associations_paginator: GetLinkAssociationsPaginator = client.get_paginator("get_link_associations")
        get_links_paginator: GetLinksPaginator = client.get_paginator("get_links")
        get_sites_paginator: GetSitesPaginator = client.get_paginator("get_sites")
        get_transit_gateway_connect_peer_associations_paginator: GetTransitGatewayConnectPeerAssociationsPaginator = client.get_paginator("get_transit_gateway_connect_peer_associations")
        get_transit_gateway_registrations_paginator: GetTransitGatewayRegistrationsPaginator = client.get_paginator("get_transit_gateway_registrations")
        ```
        
        ### Literals<a id="literals"></a>
        
        `mypy_boto3_networkmanager.literals` module contains literals extracted from
        shapes that can be used in user code for type checking.
        
        ```python
        from mypy_boto3_networkmanager.literals import (
            ConnectionStateType,
            CustomerGatewayAssociationStateType,
            DescribeGlobalNetworksPaginatorName,
            DeviceStateType,
            GetConnectionsPaginatorName,
            GetCustomerGatewayAssociationsPaginatorName,
            GetDevicesPaginatorName,
            GetLinkAssociationsPaginatorName,
            GetLinksPaginatorName,
            GetSitesPaginatorName,
            GetTransitGatewayConnectPeerAssociationsPaginatorName,
            GetTransitGatewayRegistrationsPaginatorName,
            GlobalNetworkStateType,
            LinkAssociationStateType,
            LinkStateType,
            SiteStateType,
            TransitGatewayConnectPeerAssociationStateType,
            TransitGatewayRegistrationStateType,
        )
        
        def check_value(value: ConnectionStateType) -> bool:
            ...
        ```
        
        ### Typed dictionaries<a id="typed-dictionaries"></a>
        
        `mypy_boto3_networkmanager.type_defs` module contains structures and shapes
        assembled to typed dictionaries for additional type checking.
        
        ```python
        from mypy_boto3_networkmanager.type_defs import (
            AWSLocationTypeDef,
            AssociateCustomerGatewayResponseTypeDef,
            AssociateLinkResponseTypeDef,
            AssociateTransitGatewayConnectPeerResponseTypeDef,
            BandwidthTypeDef,
            ConnectionTypeDef,
            CreateConnectionResponseTypeDef,
            CreateDeviceResponseTypeDef,
            CreateGlobalNetworkResponseTypeDef,
            CreateLinkResponseTypeDef,
            CreateSiteResponseTypeDef,
            CustomerGatewayAssociationTypeDef,
            DeleteConnectionResponseTypeDef,
            DeleteDeviceResponseTypeDef,
            DeleteGlobalNetworkResponseTypeDef,
            DeleteLinkResponseTypeDef,
            DeleteSiteResponseTypeDef,
            DeregisterTransitGatewayResponseTypeDef,
            DescribeGlobalNetworksResponseTypeDef,
            DeviceTypeDef,
            DisassociateCustomerGatewayResponseTypeDef,
            DisassociateLinkResponseTypeDef,
            DisassociateTransitGatewayConnectPeerResponseTypeDef,
            GetConnectionsResponseTypeDef,
            GetCustomerGatewayAssociationsResponseTypeDef,
            GetDevicesResponseTypeDef,
            GetLinkAssociationsResponseTypeDef,
            GetLinksResponseTypeDef,
            GetSitesResponseTypeDef,
            GetTransitGatewayConnectPeerAssociationsResponseTypeDef,
            GetTransitGatewayRegistrationsResponseTypeDef,
            GlobalNetworkTypeDef,
            LinkAssociationTypeDef,
            LinkTypeDef,
            ListTagsForResourceResponseTypeDef,
            LocationTypeDef,
            PaginatorConfigTypeDef,
            RegisterTransitGatewayResponseTypeDef,
            SiteTypeDef,
            TagTypeDef,
            TransitGatewayConnectPeerAssociationTypeDef,
            TransitGatewayRegistrationStateReasonTypeDef,
            TransitGatewayRegistrationTypeDef,
            UpdateConnectionResponseTypeDef,
            UpdateDeviceResponseTypeDef,
            UpdateGlobalNetworkResponseTypeDef,
            UpdateLinkResponseTypeDef,
            UpdateSiteResponseTypeDef,
        )
        
        def get_structure() -> AWSLocationTypeDef:
            return {
              ...
            }
        ```
        
        ## Versioning<a id="versioning"></a>
        
        `mypy-boto3-networkmanager` version is the same as related `boto3` version and
        follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
        
        ## Documentation<a id="documentation"></a>
        
        All type annotations can be found in
        [mypy-boto3-networkmanager docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/)
        
        ## Support and contributing<a id="support-and-contributing"></a>
        
        This package is auto-generated. Please reports any bugs or request new features
        in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/)
        repository.
        
Keywords: boto3 networkmanager type-annotations boto3-stubs mypy typeshed autocomplete auto-generated
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
