mypy-boto3-directconnect


Namemypy-boto3-directconnect JSON
Version 1.28.16 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for boto3.DirectConnect 1.28.16 service generated with mypy-boto3-builder 7.17.1
upload_time2023-08-01 11:41:04
maintainer
docs_urlNone
authorVlad Emelianov
requires_python>=3.7
licenseMIT License
keywords boto3 directconnect type-annotations botocore mypy typeshed autocomplete
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            <a id="mypy-boto3-directconnect"></a>

# mypy-boto3-directconnect

[![PyPI - mypy-boto3-directconnect](https://img.shields.io/pypi/v/mypy-boto3-directconnect.svg?color=blue)](https://pypi.org/project/mypy-boto3-directconnect)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-directconnect.svg?color=blue)](https://pypi.org/project/mypy-boto3-directconnect)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_directconnect/)
[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-directconnect)](https://pepy.tech/project/mypy-boto3-directconnect)

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

Type annotations for
[boto3.DirectConnect 1.28.16](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/directconnect.html#DirectConnect)
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.17.1](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-directconnect docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_directconnect/).

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-directconnect](#mypy-boto3-directconnect)
  - [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)
    - [Type definitions](#type-definitions)
  - [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 `DirectConnect`.

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

### From PyPI with pip

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

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


# 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[directconnect]'


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

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

## How to uninstall

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

<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[directconnect]` in your environment:

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

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[directconnect]` in your environment:

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

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[directconnect]'
```

- 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[directconnect]` with services you use in your
  environment:

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

- 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[directconnect]` in your environment:

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

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[directconnect]` in your environment:

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

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

`DirectConnectClient` provides annotations for `boto3.client("directconnect")`.

```python
from boto3.session import Session

from mypy_boto3_directconnect import DirectConnectClient

client: DirectConnectClient = Session().client("directconnect")

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

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

### Paginators annotations

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

```python
from boto3.session import Session

from mypy_boto3_directconnect import DirectConnectClient
from mypy_boto3_directconnect.paginator import (
    DescribeDirectConnectGatewayAssociationsPaginator,
    DescribeDirectConnectGatewayAttachmentsPaginator,
    DescribeDirectConnectGatewaysPaginator,
)

client: DirectConnectClient = Session().client("directconnect")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
describe_direct_connect_gateway_associations_paginator: DescribeDirectConnectGatewayAssociationsPaginator = client.get_paginator(
    "describe_direct_connect_gateway_associations"
)
describe_direct_connect_gateway_attachments_paginator: DescribeDirectConnectGatewayAttachmentsPaginator = client.get_paginator(
    "describe_direct_connect_gateway_attachments"
)
describe_direct_connect_gateways_paginator: DescribeDirectConnectGatewaysPaginator = (
    client.get_paginator("describe_direct_connect_gateways")
)
```

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

### Literals

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

```python
from mypy_boto3_directconnect.literals import (
    AddressFamilyType,
    BGPPeerStateType,
    BGPStatusType,
    ConnectionStateType,
    DescribeDirectConnectGatewayAssociationsPaginatorName,
    DescribeDirectConnectGatewayAttachmentsPaginatorName,
    DescribeDirectConnectGatewaysPaginatorName,
    DirectConnectGatewayAssociationProposalStateType,
    DirectConnectGatewayAssociationStateType,
    DirectConnectGatewayAttachmentStateType,
    DirectConnectGatewayAttachmentTypeType,
    DirectConnectGatewayStateType,
    GatewayTypeType,
    HasLogicalRedundancyType,
    InterconnectStateType,
    LagStateType,
    LoaContentTypeType,
    NniPartnerTypeType,
    VirtualInterfaceStateType,
    DirectConnectServiceName,
    ServiceName,
    ResourceServiceName,
    PaginatorName,
    RegionName,
)


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

<a id="type-definitions"></a>

### Type definitions

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

```python
from mypy_boto3_directconnect.type_defs import (
    RouteFilterPrefixTypeDef,
    ResponseMetadataTypeDef,
    AllocateConnectionOnInterconnectRequestRequestTypeDef,
    TagTypeDef,
    AssociateConnectionWithLagRequestRequestTypeDef,
    AssociateHostedConnectionRequestRequestTypeDef,
    AssociateMacSecKeyRequestRequestTypeDef,
    MacSecKeyTypeDef,
    AssociateVirtualInterfaceRequestRequestTypeDef,
    AssociatedGatewayTypeDef,
    BGPPeerTypeDef,
    ConfirmConnectionRequestRequestTypeDef,
    ConfirmCustomerAgreementRequestRequestTypeDef,
    ConfirmPrivateVirtualInterfaceRequestRequestTypeDef,
    ConfirmPublicVirtualInterfaceRequestRequestTypeDef,
    ConfirmTransitVirtualInterfaceRequestRequestTypeDef,
    NewBGPPeerTypeDef,
    CreateDirectConnectGatewayRequestRequestTypeDef,
    DirectConnectGatewayTypeDef,
    CustomerAgreementTypeDef,
    DeleteBGPPeerRequestRequestTypeDef,
    DeleteConnectionRequestRequestTypeDef,
    DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef,
    DeleteDirectConnectGatewayAssociationRequestRequestTypeDef,
    DeleteDirectConnectGatewayRequestRequestTypeDef,
    DeleteInterconnectRequestRequestTypeDef,
    DeleteLagRequestRequestTypeDef,
    DeleteVirtualInterfaceRequestRequestTypeDef,
    DescribeConnectionLoaRequestRequestTypeDef,
    LoaTypeDef,
    DescribeConnectionsOnInterconnectRequestRequestTypeDef,
    DescribeConnectionsRequestRequestTypeDef,
    DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef,
    PaginatorConfigTypeDef,
    DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef,
    DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef,
    DirectConnectGatewayAttachmentTypeDef,
    DescribeDirectConnectGatewaysRequestRequestTypeDef,
    DescribeHostedConnectionsRequestRequestTypeDef,
    DescribeInterconnectLoaRequestRequestTypeDef,
    DescribeInterconnectsRequestRequestTypeDef,
    DescribeLagsRequestRequestTypeDef,
    DescribeLoaRequestRequestTypeDef,
    DescribeRouterConfigurationRequestRequestTypeDef,
    RouterTypeTypeDef,
    DescribeTagsRequestRequestTypeDef,
    DescribeVirtualInterfacesRequestRequestTypeDef,
    DisassociateConnectionFromLagRequestRequestTypeDef,
    DisassociateMacSecKeyRequestRequestTypeDef,
    ListVirtualInterfaceTestHistoryRequestRequestTypeDef,
    VirtualInterfaceTestHistoryTypeDef,
    LocationTypeDef,
    StartBgpFailoverTestRequestRequestTypeDef,
    StopBgpFailoverTestRequestRequestTypeDef,
    UntagResourceRequestRequestTypeDef,
    UpdateConnectionRequestRequestTypeDef,
    UpdateDirectConnectGatewayRequestRequestTypeDef,
    UpdateLagRequestRequestTypeDef,
    UpdateVirtualInterfaceAttributesRequestRequestTypeDef,
    VirtualGatewayTypeDef,
    AcceptDirectConnectGatewayAssociationProposalRequestRequestTypeDef,
    CreateDirectConnectGatewayAssociationProposalRequestRequestTypeDef,
    CreateDirectConnectGatewayAssociationRequestRequestTypeDef,
    UpdateDirectConnectGatewayAssociationRequestRequestTypeDef,
    ConfirmConnectionResponseTypeDef,
    ConfirmCustomerAgreementResponseTypeDef,
    ConfirmPrivateVirtualInterfaceResponseTypeDef,
    ConfirmPublicVirtualInterfaceResponseTypeDef,
    ConfirmTransitVirtualInterfaceResponseTypeDef,
    DeleteInterconnectResponseTypeDef,
    DeleteVirtualInterfaceResponseTypeDef,
    LoaResponseTypeDef,
    AllocateHostedConnectionRequestRequestTypeDef,
    CreateConnectionRequestRequestTypeDef,
    CreateInterconnectRequestRequestTypeDef,
    CreateLagRequestRequestTypeDef,
    InterconnectResponseTypeDef,
    InterconnectTypeDef,
    NewPrivateVirtualInterfaceAllocationTypeDef,
    NewPrivateVirtualInterfaceTypeDef,
    NewPublicVirtualInterfaceAllocationTypeDef,
    NewPublicVirtualInterfaceTypeDef,
    NewTransitVirtualInterfaceAllocationTypeDef,
    NewTransitVirtualInterfaceTypeDef,
    ResourceTagTypeDef,
    TagResourceRequestRequestTypeDef,
    AssociateMacSecKeyResponseTypeDef,
    ConnectionResponseTypeDef,
    ConnectionTypeDef,
    DisassociateMacSecKeyResponseTypeDef,
    DirectConnectGatewayAssociationProposalTypeDef,
    DirectConnectGatewayAssociationTypeDef,
    VirtualInterfaceResponseTypeDef,
    VirtualInterfaceTypeDef,
    CreateBGPPeerRequestRequestTypeDef,
    CreateDirectConnectGatewayResultTypeDef,
    DeleteDirectConnectGatewayResultTypeDef,
    DescribeDirectConnectGatewaysResultTypeDef,
    UpdateDirectConnectGatewayResponseTypeDef,
    DescribeCustomerMetadataResponseTypeDef,
    DescribeConnectionLoaResponseTypeDef,
    DescribeInterconnectLoaResponseTypeDef,
    DescribeDirectConnectGatewayAssociationsRequestDescribeDirectConnectGatewayAssociationsPaginateTypeDef,
    DescribeDirectConnectGatewayAttachmentsRequestDescribeDirectConnectGatewayAttachmentsPaginateTypeDef,
    DescribeDirectConnectGatewaysRequestDescribeDirectConnectGatewaysPaginateTypeDef,
    DescribeDirectConnectGatewayAttachmentsResultTypeDef,
    DescribeRouterConfigurationResponseTypeDef,
    ListVirtualInterfaceTestHistoryResponseTypeDef,
    StartBgpFailoverTestResponseTypeDef,
    StopBgpFailoverTestResponseTypeDef,
    LocationsTypeDef,
    VirtualGatewaysTypeDef,
    InterconnectsTypeDef,
    AllocatePrivateVirtualInterfaceRequestRequestTypeDef,
    CreatePrivateVirtualInterfaceRequestRequestTypeDef,
    AllocatePublicVirtualInterfaceRequestRequestTypeDef,
    CreatePublicVirtualInterfaceRequestRequestTypeDef,
    AllocateTransitVirtualInterfaceRequestRequestTypeDef,
    CreateTransitVirtualInterfaceRequestRequestTypeDef,
    DescribeTagsResponseTypeDef,
    ConnectionsTypeDef,
    LagResponseTypeDef,
    LagTypeDef,
    CreateDirectConnectGatewayAssociationProposalResultTypeDef,
    DeleteDirectConnectGatewayAssociationProposalResultTypeDef,
    DescribeDirectConnectGatewayAssociationProposalsResultTypeDef,
    AcceptDirectConnectGatewayAssociationProposalResultTypeDef,
    CreateDirectConnectGatewayAssociationResultTypeDef,
    DeleteDirectConnectGatewayAssociationResultTypeDef,
    DescribeDirectConnectGatewayAssociationsResultTypeDef,
    UpdateDirectConnectGatewayAssociationResultTypeDef,
    AllocateTransitVirtualInterfaceResultTypeDef,
    CreateBGPPeerResponseTypeDef,
    CreateTransitVirtualInterfaceResultTypeDef,
    DeleteBGPPeerResponseTypeDef,
    VirtualInterfacesTypeDef,
    LagsTypeDef,
)


def get_value() -> RouteFilterPrefixTypeDef:
    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-directconnect` 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_directconnect/)

<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-directconnect",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "boto3 directconnect type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/9d/f9/dc43bbf3460c371636b2444c5c418c2964167e11f43d9d8ab544fefb8533/mypy-boto3-directconnect-1.28.16.tar.gz",
    "platform": null,
    "description": "<a id=\"mypy-boto3-directconnect\"></a>\n\n# mypy-boto3-directconnect\n\n[![PyPI - mypy-boto3-directconnect](https://img.shields.io/pypi/v/mypy-boto3-directconnect.svg?color=blue)](https://pypi.org/project/mypy-boto3-directconnect)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-directconnect.svg?color=blue)](https://pypi.org/project/mypy-boto3-directconnect)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_directconnect/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/mypy-boto3-directconnect)](https://pepy.tech/project/mypy-boto3-directconnect)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[boto3.DirectConnect 1.28.16](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/directconnect.html#DirectConnect)\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.17.1](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-directconnect docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_directconnect/).\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-directconnect](#mypy-boto3-directconnect)\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    - [Type definitions](#type-definitions)\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 `DirectConnect`.\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `boto3-stubs` for `DirectConnect` service.\n\n```bash\n# install with boto3 type annotations\npython -m pip install 'boto3-stubs[directconnect]'\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[directconnect]'\n\n\n# standalone installation\npython -m pip install mypy-boto3-directconnect\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y mypy-boto3-directconnect\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[directconnect]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[directconnect]'\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[directconnect]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[directconnect]'`\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[directconnect]'\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[directconnect]` with services you use in your\n  environment:\n\n```bash\npython -m pip install 'boto3-stubs[directconnect]'\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[directconnect]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[directconnect]'`\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[directconnect]` in your environment:\n\n```bash\npython -m pip install 'boto3-stubs[directconnect]'\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`DirectConnectClient` provides annotations for `boto3.client(\"directconnect\")`.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_directconnect import DirectConnectClient\n\nclient: DirectConnectClient = Session().client(\"directconnect\")\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_directconnect.paginator` module contains type annotations for all\npaginators.\n\n```python\nfrom boto3.session import Session\n\nfrom mypy_boto3_directconnect import DirectConnectClient\nfrom mypy_boto3_directconnect.paginator import (\n    DescribeDirectConnectGatewayAssociationsPaginator,\n    DescribeDirectConnectGatewayAttachmentsPaginator,\n    DescribeDirectConnectGatewaysPaginator,\n)\n\nclient: DirectConnectClient = Session().client(\"directconnect\")\n\n# Explicit type annotations are optional here\n# Types should be correctly discovered by mypy and IDEs\ndescribe_direct_connect_gateway_associations_paginator: DescribeDirectConnectGatewayAssociationsPaginator = client.get_paginator(\n    \"describe_direct_connect_gateway_associations\"\n)\ndescribe_direct_connect_gateway_attachments_paginator: DescribeDirectConnectGatewayAttachmentsPaginator = client.get_paginator(\n    \"describe_direct_connect_gateway_attachments\"\n)\ndescribe_direct_connect_gateways_paginator: DescribeDirectConnectGatewaysPaginator = (\n    client.get_paginator(\"describe_direct_connect_gateways\")\n)\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`mypy_boto3_directconnect.literals` module contains literals extracted from\nshapes that can be used in user code for type checking.\n\n```python\nfrom mypy_boto3_directconnect.literals import (\n    AddressFamilyType,\n    BGPPeerStateType,\n    BGPStatusType,\n    ConnectionStateType,\n    DescribeDirectConnectGatewayAssociationsPaginatorName,\n    DescribeDirectConnectGatewayAttachmentsPaginatorName,\n    DescribeDirectConnectGatewaysPaginatorName,\n    DirectConnectGatewayAssociationProposalStateType,\n    DirectConnectGatewayAssociationStateType,\n    DirectConnectGatewayAttachmentStateType,\n    DirectConnectGatewayAttachmentTypeType,\n    DirectConnectGatewayStateType,\n    GatewayTypeType,\n    HasLogicalRedundancyType,\n    InterconnectStateType,\n    LagStateType,\n    LoaContentTypeType,\n    NniPartnerTypeType,\n    VirtualInterfaceStateType,\n    DirectConnectServiceName,\n    ServiceName,\n    ResourceServiceName,\n    PaginatorName,\n    RegionName,\n)\n\n\ndef check_value(value: AddressFamilyType) -> bool:\n    ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`mypy_boto3_directconnect.type_defs` module contains structures and shapes\nassembled to typed dictionaries and unions for additional type checking.\n\n```python\nfrom mypy_boto3_directconnect.type_defs import (\n    RouteFilterPrefixTypeDef,\n    ResponseMetadataTypeDef,\n    AllocateConnectionOnInterconnectRequestRequestTypeDef,\n    TagTypeDef,\n    AssociateConnectionWithLagRequestRequestTypeDef,\n    AssociateHostedConnectionRequestRequestTypeDef,\n    AssociateMacSecKeyRequestRequestTypeDef,\n    MacSecKeyTypeDef,\n    AssociateVirtualInterfaceRequestRequestTypeDef,\n    AssociatedGatewayTypeDef,\n    BGPPeerTypeDef,\n    ConfirmConnectionRequestRequestTypeDef,\n    ConfirmCustomerAgreementRequestRequestTypeDef,\n    ConfirmPrivateVirtualInterfaceRequestRequestTypeDef,\n    ConfirmPublicVirtualInterfaceRequestRequestTypeDef,\n    ConfirmTransitVirtualInterfaceRequestRequestTypeDef,\n    NewBGPPeerTypeDef,\n    CreateDirectConnectGatewayRequestRequestTypeDef,\n    DirectConnectGatewayTypeDef,\n    CustomerAgreementTypeDef,\n    DeleteBGPPeerRequestRequestTypeDef,\n    DeleteConnectionRequestRequestTypeDef,\n    DeleteDirectConnectGatewayAssociationProposalRequestRequestTypeDef,\n    DeleteDirectConnectGatewayAssociationRequestRequestTypeDef,\n    DeleteDirectConnectGatewayRequestRequestTypeDef,\n    DeleteInterconnectRequestRequestTypeDef,\n    DeleteLagRequestRequestTypeDef,\n    DeleteVirtualInterfaceRequestRequestTypeDef,\n    DescribeConnectionLoaRequestRequestTypeDef,\n    LoaTypeDef,\n    DescribeConnectionsOnInterconnectRequestRequestTypeDef,\n    DescribeConnectionsRequestRequestTypeDef,\n    DescribeDirectConnectGatewayAssociationProposalsRequestRequestTypeDef,\n    PaginatorConfigTypeDef,\n    DescribeDirectConnectGatewayAssociationsRequestRequestTypeDef,\n    DescribeDirectConnectGatewayAttachmentsRequestRequestTypeDef,\n    DirectConnectGatewayAttachmentTypeDef,\n    DescribeDirectConnectGatewaysRequestRequestTypeDef,\n    DescribeHostedConnectionsRequestRequestTypeDef,\n    DescribeInterconnectLoaRequestRequestTypeDef,\n    DescribeInterconnectsRequestRequestTypeDef,\n    DescribeLagsRequestRequestTypeDef,\n    DescribeLoaRequestRequestTypeDef,\n    DescribeRouterConfigurationRequestRequestTypeDef,\n    RouterTypeTypeDef,\n    DescribeTagsRequestRequestTypeDef,\n    DescribeVirtualInterfacesRequestRequestTypeDef,\n    DisassociateConnectionFromLagRequestRequestTypeDef,\n    DisassociateMacSecKeyRequestRequestTypeDef,\n    ListVirtualInterfaceTestHistoryRequestRequestTypeDef,\n    VirtualInterfaceTestHistoryTypeDef,\n    LocationTypeDef,\n    StartBgpFailoverTestRequestRequestTypeDef,\n    StopBgpFailoverTestRequestRequestTypeDef,\n    UntagResourceRequestRequestTypeDef,\n    UpdateConnectionRequestRequestTypeDef,\n    UpdateDirectConnectGatewayRequestRequestTypeDef,\n    UpdateLagRequestRequestTypeDef,\n    UpdateVirtualInterfaceAttributesRequestRequestTypeDef,\n    VirtualGatewayTypeDef,\n    AcceptDirectConnectGatewayAssociationProposalRequestRequestTypeDef,\n    CreateDirectConnectGatewayAssociationProposalRequestRequestTypeDef,\n    CreateDirectConnectGatewayAssociationRequestRequestTypeDef,\n    UpdateDirectConnectGatewayAssociationRequestRequestTypeDef,\n    ConfirmConnectionResponseTypeDef,\n    ConfirmCustomerAgreementResponseTypeDef,\n    ConfirmPrivateVirtualInterfaceResponseTypeDef,\n    ConfirmPublicVirtualInterfaceResponseTypeDef,\n    ConfirmTransitVirtualInterfaceResponseTypeDef,\n    DeleteInterconnectResponseTypeDef,\n    DeleteVirtualInterfaceResponseTypeDef,\n    LoaResponseTypeDef,\n    AllocateHostedConnectionRequestRequestTypeDef,\n    CreateConnectionRequestRequestTypeDef,\n    CreateInterconnectRequestRequestTypeDef,\n    CreateLagRequestRequestTypeDef,\n    InterconnectResponseTypeDef,\n    InterconnectTypeDef,\n    NewPrivateVirtualInterfaceAllocationTypeDef,\n    NewPrivateVirtualInterfaceTypeDef,\n    NewPublicVirtualInterfaceAllocationTypeDef,\n    NewPublicVirtualInterfaceTypeDef,\n    NewTransitVirtualInterfaceAllocationTypeDef,\n    NewTransitVirtualInterfaceTypeDef,\n    ResourceTagTypeDef,\n    TagResourceRequestRequestTypeDef,\n    AssociateMacSecKeyResponseTypeDef,\n    ConnectionResponseTypeDef,\n    ConnectionTypeDef,\n    DisassociateMacSecKeyResponseTypeDef,\n    DirectConnectGatewayAssociationProposalTypeDef,\n    DirectConnectGatewayAssociationTypeDef,\n    VirtualInterfaceResponseTypeDef,\n    VirtualInterfaceTypeDef,\n    CreateBGPPeerRequestRequestTypeDef,\n    CreateDirectConnectGatewayResultTypeDef,\n    DeleteDirectConnectGatewayResultTypeDef,\n    DescribeDirectConnectGatewaysResultTypeDef,\n    UpdateDirectConnectGatewayResponseTypeDef,\n    DescribeCustomerMetadataResponseTypeDef,\n    DescribeConnectionLoaResponseTypeDef,\n    DescribeInterconnectLoaResponseTypeDef,\n    DescribeDirectConnectGatewayAssociationsRequestDescribeDirectConnectGatewayAssociationsPaginateTypeDef,\n    DescribeDirectConnectGatewayAttachmentsRequestDescribeDirectConnectGatewayAttachmentsPaginateTypeDef,\n    DescribeDirectConnectGatewaysRequestDescribeDirectConnectGatewaysPaginateTypeDef,\n    DescribeDirectConnectGatewayAttachmentsResultTypeDef,\n    DescribeRouterConfigurationResponseTypeDef,\n    ListVirtualInterfaceTestHistoryResponseTypeDef,\n    StartBgpFailoverTestResponseTypeDef,\n    StopBgpFailoverTestResponseTypeDef,\n    LocationsTypeDef,\n    VirtualGatewaysTypeDef,\n    InterconnectsTypeDef,\n    AllocatePrivateVirtualInterfaceRequestRequestTypeDef,\n    CreatePrivateVirtualInterfaceRequestRequestTypeDef,\n    AllocatePublicVirtualInterfaceRequestRequestTypeDef,\n    CreatePublicVirtualInterfaceRequestRequestTypeDef,\n    AllocateTransitVirtualInterfaceRequestRequestTypeDef,\n    CreateTransitVirtualInterfaceRequestRequestTypeDef,\n    DescribeTagsResponseTypeDef,\n    ConnectionsTypeDef,\n    LagResponseTypeDef,\n    LagTypeDef,\n    CreateDirectConnectGatewayAssociationProposalResultTypeDef,\n    DeleteDirectConnectGatewayAssociationProposalResultTypeDef,\n    DescribeDirectConnectGatewayAssociationProposalsResultTypeDef,\n    AcceptDirectConnectGatewayAssociationProposalResultTypeDef,\n    CreateDirectConnectGatewayAssociationResultTypeDef,\n    DeleteDirectConnectGatewayAssociationResultTypeDef,\n    DescribeDirectConnectGatewayAssociationsResultTypeDef,\n    UpdateDirectConnectGatewayAssociationResultTypeDef,\n    AllocateTransitVirtualInterfaceResultTypeDef,\n    CreateBGPPeerResponseTypeDef,\n    CreateTransitVirtualInterfaceResultTypeDef,\n    DeleteBGPPeerResponseTypeDef,\n    VirtualInterfacesTypeDef,\n    LagsTypeDef,\n)\n\n\ndef get_value() -> RouteFilterPrefixTypeDef:\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-directconnect` 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_directconnect/)\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.DirectConnect 1.28.16 service generated with mypy-boto3-builder 7.17.1",
    "version": "1.28.16",
    "project_urls": {
        "Documentation": "https://youtype.github.io/boto3_stubs_docs/mypy_boto3_directconnect/",
        "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",
        "directconnect",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b4ef4e565c49813211e74a06d208204ce42eaf3713252f1b3bbf1bd41c88d07f",
                "md5": "63c716da979e66dfd1331bc550903c15",
                "sha256": "82373c8cd8c5b2b864b346865fcd4629d1b788160edd428c8e557f39d0ceebb4"
            },
            "downloads": -1,
            "filename": "mypy_boto3_directconnect-1.28.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "63c716da979e66dfd1331bc550903c15",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 37123,
            "upload_time": "2023-08-01T11:40:59",
            "upload_time_iso_8601": "2023-08-01T11:40:59.409699Z",
            "url": "https://files.pythonhosted.org/packages/b4/ef/4e565c49813211e74a06d208204ce42eaf3713252f1b3bbf1bd41c88d07f/mypy_boto3_directconnect-1.28.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9df9dc43bbf3460c371636b2444c5c418c2964167e11f43d9d8ab544fefb8533",
                "md5": "40736b19faf2a21f530bf63222b29ed6",
                "sha256": "988edda352940a2cf5da4f7cd94a4eeb888f552ca3018ee0f15799704c8f82db"
            },
            "downloads": -1,
            "filename": "mypy-boto3-directconnect-1.28.16.tar.gz",
            "has_sig": false,
            "md5_digest": "40736b19faf2a21f530bf63222b29ed6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 33992,
            "upload_time": "2023-08-01T11:41:04",
            "upload_time_iso_8601": "2023-08-01T11:41:04.907979Z",
            "url": "https://files.pythonhosted.org/packages/9d/f9/dc43bbf3460c371636b2444c5c418c2964167e11f43d9d8ab544fefb8533/mypy-boto3-directconnect-1.28.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-01 11:41:04",
    "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-directconnect"
}
Vlad Emelianov
Elapsed time: 0.14854s