<a id="mypy-boto3-worklink"></a>
# mypy-boto3-worklink
[![PyPI - mypy-boto3-worklink](https://img.shields.io/pypi/v/mypy-boto3-worklink.svg?color=blue)](https://pypi.org/project/mypy-boto3-worklink)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-worklink.svg?color=blue)](https://pypi.org/project/mypy-boto3-worklink)
[![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-worklink?color=blue)](https://pypistats.org/packages/mypy-boto3-worklink)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.WorkLink 1.18.11](https://boto3.amazonaws.com/v1/documentation/api/1.18.11/reference/services/worklink.html#WorkLink)
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 5.1.0](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-worklink docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_worklink/)
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-worklink](#mypy-boto3-worklink)
- [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)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `WorkLink` service.
```bash
python -m pip install boto3-stubs[worklink]
```
<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 `boto-stubs[worklink]` in your environment:
`python -m pip install 'boto3-stubs[worklink]'`
Both type checking and auto-complete should work for `WorkLink` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[worklink]` in your environment:
`python -m pip install 'boto3-stubs[worklink]'`
Both type checking and auto-complete should work for `WorkLink` 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.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[worklink]` in your environment:
`python -m pip install 'boto3-stubs[worklink]'`
- Run `mypy` as usual
Type checking should work for `WorkLink` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[worklink]` in your environment:
`python -m pip install 'boto3-stubs[worklink]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `WorkLink` service. 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
`WorkLinkClient` provides annotations for `boto3.client("worklink")`.
```python
import boto3
from mypy_boto3_worklink import WorkLinkClient
client: WorkLinkClient = boto3.client("worklink")
# 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: WorkLinkClient = session.client("worklink")
```
<a id="literals"></a>
### Literals
`mypy_boto3_worklink.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_worklink.literals import (
AuthorizationProviderTypeType,
DeviceStatusType,
DomainStatusType,
FleetStatusType,
IdentityProviderTypeType,
)
def check_value(value: AuthorizationProviderTypeType) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_worklink.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_worklink.type_defs import (
AssociateDomainRequestRequestTypeDef,
AssociateWebsiteAuthorizationProviderRequestRequestTypeDef,
AssociateWebsiteAuthorizationProviderResponseTypeDef,
AssociateWebsiteCertificateAuthorityRequestRequestTypeDef,
AssociateWebsiteCertificateAuthorityResponseTypeDef,
CreateFleetRequestRequestTypeDef,
CreateFleetResponseTypeDef,
DeleteFleetRequestRequestTypeDef,
DescribeAuditStreamConfigurationRequestRequestTypeDef,
DescribeAuditStreamConfigurationResponseTypeDef,
DescribeCompanyNetworkConfigurationRequestRequestTypeDef,
DescribeCompanyNetworkConfigurationResponseTypeDef,
DescribeDevicePolicyConfigurationRequestRequestTypeDef,
DescribeDevicePolicyConfigurationResponseTypeDef,
DescribeDeviceRequestRequestTypeDef,
DescribeDeviceResponseTypeDef,
DescribeDomainRequestRequestTypeDef,
DescribeDomainResponseTypeDef,
DescribeFleetMetadataRequestRequestTypeDef,
DescribeFleetMetadataResponseTypeDef,
DescribeIdentityProviderConfigurationRequestRequestTypeDef,
DescribeIdentityProviderConfigurationResponseTypeDef,
DescribeWebsiteCertificateAuthorityRequestRequestTypeDef,
DescribeWebsiteCertificateAuthorityResponseTypeDef,
DeviceSummaryTypeDef,
DisassociateDomainRequestRequestTypeDef,
DisassociateWebsiteAuthorizationProviderRequestRequestTypeDef,
DisassociateWebsiteCertificateAuthorityRequestRequestTypeDef,
DomainSummaryTypeDef,
FleetSummaryTypeDef,
ListDevicesRequestRequestTypeDef,
ListDevicesResponseTypeDef,
ListDomainsRequestRequestTypeDef,
ListDomainsResponseTypeDef,
ListFleetsRequestRequestTypeDef,
ListFleetsResponseTypeDef,
ListTagsForResourceRequestRequestTypeDef,
ListTagsForResourceResponseTypeDef,
ListWebsiteAuthorizationProvidersRequestRequestTypeDef,
ListWebsiteAuthorizationProvidersResponseTypeDef,
ListWebsiteCertificateAuthoritiesRequestRequestTypeDef,
ListWebsiteCertificateAuthoritiesResponseTypeDef,
ResponseMetadataTypeDef,
RestoreDomainAccessRequestRequestTypeDef,
RevokeDomainAccessRequestRequestTypeDef,
SignOutUserRequestRequestTypeDef,
TagResourceRequestRequestTypeDef,
UntagResourceRequestRequestTypeDef,
UpdateAuditStreamConfigurationRequestRequestTypeDef,
UpdateCompanyNetworkConfigurationRequestRequestTypeDef,
UpdateDevicePolicyConfigurationRequestRequestTypeDef,
UpdateDomainMetadataRequestRequestTypeDef,
UpdateFleetMetadataRequestRequestTypeDef,
UpdateIdentityProviderConfigurationRequestRequestTypeDef,
WebsiteAuthorizationProviderSummaryTypeDef,
WebsiteCaSummaryTypeDef,
)
def get_structure() -> AssociateDomainRequestRequestTypeDef:
return {
...
}
``
PyPI 官网下载 | mypy-boto3-worklink-1.18.11.tar.gz
版权申诉
64 浏览量
2022-02-10
17:21:52
上传
评论
收藏 12KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- python-leetcode面试题解之第198题打家劫舍-题解.zip
- python-leetcode面试题解之第191题位1的个数-题解.zip
- python-leetcode面试题解之第186题反转字符串中的单词II-题解.zip
- 一个基于python的web后端高性能开发框架,下载可用
- python-leetcode面试题解之第179题最大数-题解.zip
- python-leetcode面试题解之第170题两数之和III数据结构设计-题解.zip
- python-leetcode面试题解之第168题Excel表列名称-题解.zip
- python-leetcode面试题解之第167题两数之和II输入有序数组-题解.zip
- python-leetcode面试题解之第166题分数到小数-题解.zip
- python-leetcode面试题解之第165比较版本号-题解.zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈