mypy-boto3-privatenetworks


Namemypy-boto3-privatenetworks JSON
Version 1.27.0 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for boto3.Private5G 1.27.0 service generated with mypy-boto3-builder 7.14.5
upload_time2023-07-03 20:01:57
maintainer
docs_urlNone
authorVlad Emelianov
requires_python>=3.7
licenseMIT License
keywords boto3 privatenetworks type-annotations boto3-stubs mypy typeshed autocomplete
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <a id="mypy-boto3-privatenetworks"></a>

# mypy-boto3-privatenetworks

[![PyPI - mypy-boto3-privatenetworks](https://img.shields.io/pypi/v/mypy-boto3-privatenetworks.svg?color=blue)](https://pypi.org/project/mypy-boto3-privatenetworks)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-privatenetworks.svg?color=blue)](https://pypi.org/project/mypy-boto3-privatenetworks)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-privatenetworks?color=blue)](https://pypistats.org/packages/mypy-boto3-privatenetworks)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[boto3.Private5G 1.27.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/privatenetworks.html#Private5G)
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-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-privatenetworks docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/).

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [mypy-boto3-privatenetworks](#mypy-boto3-privatenetworks)
  - [How to install](#how-to-install)
    - [VSCode extension](#vscode-extension)
    - [From PyPI with pip](#from-pypi-with-pip)
  - [How to uninstall](#how-to-uninstall)
  - [Usage](#usage)
    - [VSCode](#vscode)
    - [PyCharm](#pycharm)
    - [Emacs](#emacs)
    - [Sublime Text](#sublime-text)
    - [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)
  - [How it works](#how-it-works)
  - [What's new](#what's-new)
    - [Implemented features](#implemented-features)
    - [Latest changes](#latest-changes)
  - [Versioning](#versioning)
  - [Thank you](#thank-you)
  - [Documentation](#documentation)
  - [Support and contributing](#support-and-contributing)

<a id="how-to-install"></a>

## How to install

<a id="vscode-extension"></a>

### VSCode extension

Add
[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.

Click `Modify` and select `boto3 common` and `Private5G`.

<a id="from-pypi-with-pip"></a>

### From PyPI with pip

Install `boto3-stubs` for `Private5G` service.

```bash
# install with boto3 type annotations
python -m pip install 'boto3-stubs[privatenetworks]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[privatenetworks]'


# standalone installation
python -m pip install mypy-boto3-privatenetworks
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y mypy-boto3-privatenetworks
```

<a id="usage"></a>

## Usage

<a id="vscode"></a>

### VSCode

- 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 `boto3-stubs[privatenetworks]` in your environment:

```bash
python -m pip install 'boto3-stubs[privatenetworks]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `boto3` code as usual.

<a id="pycharm"></a>

### PyCharm

Install `boto3-stubs-lite[privatenetworks]` in your environment:

```bash
python -m pip install 'boto3-stubs-lite[privatenetworks]'`
```

Both type checking and code completion should now work. Explicit type
annotations **are required**.

Use `boto3-stubs` package instead for implicit type discovery.

<a id="emacs"></a>

### Emacs

- Install `boto3-stubs` with services you use in your environment:

```bash
python -m pip install 'boto3-stubs[privatenetworks]'
```

- Install [use-package](https://github.com/jwiegley/use-package),
  [lsp](https://github.com/emacs-lsp/lsp-mode/),
  [company](https://github.com/company-mode/company-mode) and
  [flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

```elisp
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
```

- Make sure emacs uses the environment where you have installed `boto3-stubs`

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `boto3-stubs[privatenetworks]` with services you use in your
  environment:

```bash
python -m pip install 'boto3-stubs[privatenetworks]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="other-ides"></a>

### Other IDEs

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

<a id="mypy"></a>

### mypy

- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs[privatenetworks]` in your environment:

```bash
python -m pip install 'boto3-stubs[privatenetworks]'`
```

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `boto3-stubs[privatenetworks]` in your environment:

```bash
python -m pip install 'boto3-stubs[privatenetworks]'
```

Optionally, you can install `boto3-stubs` to `typings` folder.

Type checking should now work. No explicit type annotations required, write
your `boto3` code as usual.

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`Private5GClient` provides annotations for `boto3.client("privatenetworks")`.

```python
from boto3.session import Session

from mypy_boto3_privatenetworks import Private5GClient

client: Private5GClient = Session().client("privatenetworks")

# now client usage is checked by mypy and IDE should provide code completion
```

<a id="paginators-annotations"></a>

### Paginators annotations

`mypy_boto3_privatenetworks.paginator` module contains type annotations for all
paginators.

```python
from boto3.session import Session

from mypy_boto3_privatenetworks import Private5GClient
from mypy_boto3_privatenetworks.paginator import (
    ListDeviceIdentifiersPaginator,
    ListNetworkResourcesPaginator,
    ListNetworkSitesPaginator,
    ListNetworksPaginator,
    ListOrdersPaginator,
)

client: Private5GClient = Session().client("privatenetworks")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_device_identifiers_paginator: ListDeviceIdentifiersPaginator = client.get_paginator(
    "list_device_identifiers"
)
list_network_resources_paginator: ListNetworkResourcesPaginator = client.get_paginator(
    "list_network_resources"
)
list_network_sites_paginator: ListNetworkSitesPaginator = client.get_paginator("list_network_sites")
list_networks_paginator: ListNetworksPaginator = client.get_paginator("list_networks")
list_orders_paginator: ListOrdersPaginator = client.get_paginator("list_orders")
```

<a id="literals"></a>

### Literals

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

```python
from mypy_boto3_privatenetworks.literals import (
    AcknowledgmentStatusType,
    CommitmentLengthType,
    DeviceIdentifierFilterKeysType,
    DeviceIdentifierStatusType,
    ElevationReferenceType,
    ElevationUnitType,
    HealthStatusType,
    ListDeviceIdentifiersPaginatorName,
    ListNetworkResourcesPaginatorName,
    ListNetworkSitesPaginatorName,
    ListNetworksPaginatorName,
    ListOrdersPaginatorName,
    NetworkFilterKeysType,
    NetworkResourceDefinitionTypeType,
    NetworkResourceFilterKeysType,
    NetworkResourceStatusType,
    NetworkResourceTypeType,
    NetworkSiteFilterKeysType,
    NetworkSiteStatusType,
    NetworkStatusType,
    OrderFilterKeysType,
    UpdateTypeType,
    Private5GServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
)


def check_value(value: AcknowledgmentStatusType) -> bool:
    ...
```

<a id="typed-dictionaries"></a>

### Typed dictionaries

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

```python
from mypy_boto3_privatenetworks.type_defs import (
    AcknowledgeOrderReceiptRequestRequestTypeDef,
    ActivateDeviceIdentifierRequestRequestTypeDef,
    DeviceIdentifierTypeDef,
    AddressTypeDef,
    CommitmentConfigurationTypeDef,
    PositionTypeDef,
    CreateNetworkRequestRequestTypeDef,
    NetworkTypeDef,
    DeactivateDeviceIdentifierRequestRequestTypeDef,
    DeleteNetworkRequestRequestTypeDef,
    DeleteNetworkSiteRequestRequestTypeDef,
    GetDeviceIdentifierRequestRequestTypeDef,
    GetNetworkRequestRequestTypeDef,
    GetNetworkResourceRequestRequestTypeDef,
    GetNetworkSiteRequestRequestTypeDef,
    GetOrderRequestRequestTypeDef,
    ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef,
    ListDeviceIdentifiersRequestRequestTypeDef,
    ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef,
    ListNetworkResourcesRequestRequestTypeDef,
    ListNetworkSitesRequestListNetworkSitesPaginateTypeDef,
    ListNetworkSitesRequestRequestTypeDef,
    ListNetworksRequestListNetworksPaginateTypeDef,
    ListNetworksRequestRequestTypeDef,
    ListOrdersRequestListOrdersPaginateTypeDef,
    ListOrdersRequestRequestTypeDef,
    ListTagsForResourceRequestRequestTypeDef,
    ListTagsForResourceResponseTypeDef,
    NameValuePairTypeDef,
    TrackingInformationTypeDef,
    PaginatorConfigTypeDef,
    PingResponseTypeDef,
    ResponseMetadataTypeDef,
    TagResourceRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateNetworkSiteRequestRequestTypeDef,
    ActivateDeviceIdentifierResponseTypeDef,
    DeactivateDeviceIdentifierResponseTypeDef,
    GetDeviceIdentifierResponseTypeDef,
    ListDeviceIdentifiersResponseTypeDef,
    ReturnInformationTypeDef,
    ActivateNetworkSiteRequestRequestTypeDef,
    CommitmentInformationTypeDef,
    OrderedResourceDefinitionTypeDef,
    StartNetworkResourceUpdateRequestRequestTypeDef,
    ConfigureAccessPointRequestRequestTypeDef,
    CreateNetworkResponseTypeDef,
    DeleteNetworkResponseTypeDef,
    GetNetworkResponseTypeDef,
    ListNetworksResponseTypeDef,
    NetworkResourceDefinitionTypeDef,
    NetworkResourceTypeDef,
    OrderTypeDef,
    SitePlanTypeDef,
    ConfigureAccessPointResponseTypeDef,
    GetNetworkResourceResponseTypeDef,
    ListNetworkResourcesResponseTypeDef,
    StartNetworkResourceUpdateResponseTypeDef,
    AcknowledgeOrderReceiptResponseTypeDef,
    GetOrderResponseTypeDef,
    ListOrdersResponseTypeDef,
    CreateNetworkSiteRequestRequestTypeDef,
    NetworkSiteTypeDef,
    UpdateNetworkSitePlanRequestRequestTypeDef,
    ActivateNetworkSiteResponseTypeDef,
    CreateNetworkSiteResponseTypeDef,
    DeleteNetworkSiteResponseTypeDef,
    GetNetworkSiteResponseTypeDef,
    ListNetworkSitesResponseTypeDef,
    UpdateNetworkSiteResponseTypeDef,
)


def get_structure() -> AcknowledgeOrderReceiptRequestRequestTypeDef:
    return {...}
```

<a id="how-it-works"></a>

## How it works

Fully automated
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully
generates type annotations for each service, patiently waiting for `boto3`
updates. It delivers drop-in type annotations for you and makes sure that:

- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type
  annotations extracted from `botocore` schemas.
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black) and
  [isort](https://github.com/PyCQA/isort) for readability.

<a id="what's-new"></a>

## What's new

<a id="implemented-features"></a>

### Implemented features

- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`
  libraries
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`
  compatibility
- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type
  annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.resource` calls
- Auto discovery of types for `session.client` and `session.resource` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator`
  calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
- Auto discovery of types for `aiobotocore.Session.create_client` calls

<a id="latest-changes"></a>

### Latest changes

Builder changelog can be found in
[Releases](https://github.com/youtype/mypy_boto3_builder/releases).

<a id="versioning"></a>

## Versioning

`mypy-boto3-privatenetworks` version is the same as related `boto3` version and
follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.

<a id="thank-you"></a>

## Thank you

- [Allie Fitter](https://github.com/alliefitter) for
  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
  this package is based on top of his work
- [black](https://github.com/psf/black) developers for an awesome formatting
  tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
  [isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work
  for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed
  Python

<a id="documentation"></a>

## Documentation

All services type annotations can be found in
[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/)

<a id="support-and-contributing"></a>

## Support and contributing

This package is auto-generated. Please reports any bugs or request new features
in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)
repository.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/youtype/mypy_boto3_builder",
    "name": "mypy-boto3-privatenetworks",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "boto3 privatenetworks type-annotations boto3-stubs mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e4/71/6e7e8da7c316ceaa12ac782d4d2215266e12a101a8f54f900dc13725820d/mypy-boto3-privatenetworks-1.27.0.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3-privatenetworks\"></a>\n\n# mypy-boto3-privatenetworks\n\n[![PyPI - mypy-boto3-privatenetworks](https://img.shields.io/pypi/v/mypy-boto3-privatenetworks.svg?color=blue)](https://pypi.org/project/mypy-boto3-privatenetworks)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-privatenetworks.svg?color=blue)](https://pypi.org/project/mypy-boto3-privatenetworks)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-privatenetworks?color=blue)](https://pypistats.org/packages/mypy-boto3-privatenetworks)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3.Private5G 1.27.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/privatenetworks.html#Private5G)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 7.14.5](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in\n[mypy-boto3-privatenetworks docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [mypy-boto3-privatenetworks](#mypy-boto3-privatenetworks)\n  - [How to install](#how-to-install)\n    - [VSCode extension](#vscode-extension)\n    - [From PyPI with pip](#from-pypi-with-pip)\n  - [How to uninstall](#how-to-uninstall)\n  - [Usage](#usage)\n    - [VSCode](#vscode)\n    - [PyCharm](#pycharm)\n    - [Emacs](#emacs)\n    - [Sublime Text](#sublime-text)\n    - [Other IDEs](#other-ides)\n    - [mypy](#mypy)\n    - [pyright](#pyright)\n  - [Explicit type annotations](#explicit-type-annotations)\n    - [Client annotations](#client-annotations)\n    - [Paginators annotations](#paginators-annotations)\n    - [Literals](#literals)\n    - [Typed dictionaries](#typed-dictionaries)\n  - [How it works](#how-it-works)\n  - [What's new](#what's-new)\n    - [Implemented features](#implemented-features)\n    - [Latest changes](#latest-changes)\n  - [Versioning](#versioning)\n  - [Thank you](#thank-you)\n  - [Documentation](#documentation)\n  - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"vscode-extension\"></a>\n\n### VSCode extension\n\nAdd\n[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nClick `Modify` and select `boto3 common` and `Private5G`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `Private5G` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[privatenetworks]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[privatenetworks]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-privatenetworks\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-privatenetworks\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs[privatenetworks]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[privatenetworks]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `boto3` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `boto3-stubs-lite[privatenetworks]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[privatenetworks]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `boto3-stubs` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[privatenetworks]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n  [lsp](https://github.com/emacs-lsp/lsp-mode/),\n  [company](https://github.com/company-mode/company-mode) and\n  [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n  :ensure t\n  :hook (python-mode . (lambda ()\n                          (require 'lsp-pyright)\n                          (lsp)))  ; or lsp-deferred\n  :init (when (executable-find \"python3\")\n          (setq lsp-pyright-python-executable-cmd \"python3\"))\n  )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `boto3-stubs[privatenetworks]` with services you use in your\n  environment:\n\n```bash\npython -m pip install 'boto3-stubs[privatenetworks]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs[privatenetworks]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[privatenetworks]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `boto3-stubs[privatenetworks]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[privatenetworks]'\n```\n\nOptionally, you can install `boto3-stubs` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `boto3` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`Private5GClient` provides annotations for `boto3.client(\"privatenetworks\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_privatenetworks import Private5GClient\n\nclient: Private5GClient = Session().client(\"privatenetworks\")\n\n# now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`mypy_boto3_privatenetworks.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_privatenetworks import Private5GClient\nfrom mypy_boto3_privatenetworks.paginator import (\n    ListDeviceIdentifiersPaginator,\n    ListNetworkResourcesPaginator,\n    ListNetworkSitesPaginator,\n    ListNetworksPaginator,\n    ListOrdersPaginator,\n)\n\nclient: Private5GClient = Session().client(\"privatenetworks\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\nlist_device_identifiers_paginator: ListDeviceIdentifiersPaginator = client.get_paginator(\n    \"list_device_identifiers\"\n)\nlist_network_resources_paginator: ListNetworkResourcesPaginator = client.get_paginator(\n    \"list_network_resources\"\n)\nlist_network_sites_paginator: ListNetworkSitesPaginator = client.get_paginator(\"list_network_sites\")\nlist_networks_paginator: ListNetworksPaginator = client.get_paginator(\"list_networks\")\nlist_orders_paginator: ListOrdersPaginator = client.get_paginator(\"list_orders\")\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_privatenetworks.literals` module contains literals extracted from\nshapes that can be used in user code for type checking.\n\n```python\nfrom mypy_boto3_privatenetworks.literals import (\n    AcknowledgmentStatusType,\n    CommitmentLengthType,\n    DeviceIdentifierFilterKeysType,\n    DeviceIdentifierStatusType,\n    ElevationReferenceType,\n    ElevationUnitType,\n    HealthStatusType,\n    ListDeviceIdentifiersPaginatorName,\n    ListNetworkResourcesPaginatorName,\n    ListNetworkSitesPaginatorName,\n    ListNetworksPaginatorName,\n    ListOrdersPaginatorName,\n    NetworkFilterKeysType,\n    NetworkResourceDefinitionTypeType,\n    NetworkResourceFilterKeysType,\n    NetworkResourceStatusType,\n    NetworkResourceTypeType,\n    NetworkSiteFilterKeysType,\n    NetworkSiteStatusType,\n    NetworkStatusType,\n    OrderFilterKeysType,\n    UpdateTypeType,\n    Private5GServiceName,\n    ServiceName,\n    ResourceServiceName,\n    PaginatorName,\n)\n\n\ndef check_value(value: AcknowledgmentStatusType) -> bool:\n    ...\n```\n\n<a id=\"typed-dictionaries\"></a>\n\n### Typed dictionaries\n\n`mypy_boto3_privatenetworks.type_defs` module contains structures and shapes\nassembled to typed dictionaries for additional type checking.\n\n```python\nfrom mypy_boto3_privatenetworks.type_defs import (\n    AcknowledgeOrderReceiptRequestRequestTypeDef,\n    ActivateDeviceIdentifierRequestRequestTypeDef,\n    DeviceIdentifierTypeDef,\n    AddressTypeDef,\n    CommitmentConfigurationTypeDef,\n    PositionTypeDef,\n    CreateNetworkRequestRequestTypeDef,\n    NetworkTypeDef,\n    DeactivateDeviceIdentifierRequestRequestTypeDef,\n    DeleteNetworkRequestRequestTypeDef,\n    DeleteNetworkSiteRequestRequestTypeDef,\n    GetDeviceIdentifierRequestRequestTypeDef,\n    GetNetworkRequestRequestTypeDef,\n    GetNetworkResourceRequestRequestTypeDef,\n    GetNetworkSiteRequestRequestTypeDef,\n    GetOrderRequestRequestTypeDef,\n    ListDeviceIdentifiersRequestListDeviceIdentifiersPaginateTypeDef,\n    ListDeviceIdentifiersRequestRequestTypeDef,\n    ListNetworkResourcesRequestListNetworkResourcesPaginateTypeDef,\n    ListNetworkResourcesRequestRequestTypeDef,\n    ListNetworkSitesRequestListNetworkSitesPaginateTypeDef,\n    ListNetworkSitesRequestRequestTypeDef,\n    ListNetworksRequestListNetworksPaginateTypeDef,\n    ListNetworksRequestRequestTypeDef,\n    ListOrdersRequestListOrdersPaginateTypeDef,\n    ListOrdersRequestRequestTypeDef,\n    ListTagsForResourceRequestRequestTypeDef,\n    ListTagsForResourceResponseTypeDef,\n    NameValuePairTypeDef,\n    TrackingInformationTypeDef,\n    PaginatorConfigTypeDef,\n    PingResponseTypeDef,\n    ResponseMetadataTypeDef,\n    TagResourceRequestRequestTypeDef,\n    UntagResourceRequestRequestTypeDef,\n    UpdateNetworkSiteRequestRequestTypeDef,\n    ActivateDeviceIdentifierResponseTypeDef,\n    DeactivateDeviceIdentifierResponseTypeDef,\n    GetDeviceIdentifierResponseTypeDef,\n    ListDeviceIdentifiersResponseTypeDef,\n    ReturnInformationTypeDef,\n    ActivateNetworkSiteRequestRequestTypeDef,\n    CommitmentInformationTypeDef,\n    OrderedResourceDefinitionTypeDef,\n    StartNetworkResourceUpdateRequestRequestTypeDef,\n    ConfigureAccessPointRequestRequestTypeDef,\n    CreateNetworkResponseTypeDef,\n    DeleteNetworkResponseTypeDef,\n    GetNetworkResponseTypeDef,\n    ListNetworksResponseTypeDef,\n    NetworkResourceDefinitionTypeDef,\n    NetworkResourceTypeDef,\n    OrderTypeDef,\n    SitePlanTypeDef,\n    ConfigureAccessPointResponseTypeDef,\n    GetNetworkResourceResponseTypeDef,\n    ListNetworkResourcesResponseTypeDef,\n    StartNetworkResourceUpdateResponseTypeDef,\n    AcknowledgeOrderReceiptResponseTypeDef,\n    GetOrderResponseTypeDef,\n    ListOrdersResponseTypeDef,\n    CreateNetworkSiteRequestRequestTypeDef,\n    NetworkSiteTypeDef,\n    UpdateNetworkSitePlanRequestRequestTypeDef,\n    ActivateNetworkSiteResponseTypeDef,\n    CreateNetworkSiteResponseTypeDef,\n    DeleteNetworkSiteResponseTypeDef,\n    GetNetworkSiteResponseTypeDef,\n    ListNetworkSitesResponseTypeDef,\n    UpdateNetworkSiteResponseTypeDef,\n)\n\n\ndef get_structure() -> AcknowledgeOrderReceiptRequestRequestTypeDef:\n    return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for `boto3`\nupdates. It delivers drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type\n  annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black) and\n  [isort](https://github.com/PyCQA/isort) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n  libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n  compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n  annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n  calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`mypy-boto3-privatenetworks` version is the same as related `boto3` version and\nfollows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n  this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n  tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n  [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n  for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n  Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Type annotations for boto3.Private5G 1.27.0 service generated with mypy-boto3-builder 7.14.5",
    "version": "1.27.0",
    "project_urls": {
        "Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_privatenetworks/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Source": "https://github.com/youtype/mypy_boto3_builder",
        "Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
    },
    "split_keywords": [
        "boto3",
        "privatenetworks",
        "type-annotations",
        "boto3-stubs",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e677130d8c552c5b26d86a403fb82951c4d7f3183aa79042d2b34c7e498cbd61",
                "md5": "1d507dfaec3d85c1dea14658c54968aa",
                "sha256": "bdba43b1bf94cf73ab927cb29de0a6e1560b3f634ef216913f6cf2325608fe08"
            },
            "downloads": -1,
            "filename": "mypy_boto3_privatenetworks-1.27.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1d507dfaec3d85c1dea14658c54968aa",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 29208,
            "upload_time": "2023-07-03T20:01:41",
            "upload_time_iso_8601": "2023-07-03T20:01:41.499422Z",
            "url": "https://files.pythonhosted.org/packages/e6/77/130d8c552c5b26d86a403fb82951c4d7f3183aa79042d2b34c7e498cbd61/mypy_boto3_privatenetworks-1.27.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e4716e7e8da7c316ceaa12ac782d4d2215266e12a101a8f54f900dc13725820d",
                "md5": "c1613df70436767feba940430a455f98",
                "sha256": "9e6a1843948ccf94111c7f2753524d5113c46ed5e788825c128aa5bd595af970"
            },
            "downloads": -1,
            "filename": "mypy-boto3-privatenetworks-1.27.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c1613df70436767feba940430a455f98",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 20863,
            "upload_time": "2023-07-03T20:01:57",
            "upload_time_iso_8601": "2023-07-03T20:01:57.066175Z",
            "url": "https://files.pythonhosted.org/packages/e4/71/6e7e8da7c316ceaa12ac782d4d2215266e12a101a8f54f900dc13725820d/mypy-boto3-privatenetworks-1.27.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-03 20:01:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mypy-boto3-privatenetworks"
}
Vlad Emelianov
Elapsed time: 0.09131s