<a id="mypy-boto3-lambda"></a>
# mypy-boto3-lambda
[![PyPI - mypy-boto3-lambda](https://img.shields.io/pypi/v/mypy-boto3-lambda.svg?color=blue)](https://pypi.org/project/mypy-boto3-lambda)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-lambda.svg?color=blue)](https://pypi.org/project/mypy-boto3-lambda)
[![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-lambda?color=blue)](https://pypistats.org/packages/mypy-boto3-lambda)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.Lambda 1.17.104](https://boto3.amazonaws.com/v1/documentation/api/1.17.104/reference/services/lambda.html#Lambda)
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.22.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-lambda docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_lambda/)
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-lambda](#mypy-boto3-lambda)
- [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)
- [Waiters annotations](#waiters-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 `Lambda` service.
```bash
python -m pip install boto3-stubs[lambda]
```
<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[lambda]` in your environment:
`python -m pip install 'boto3-stubs[lambda]'`
Both type checking and auto-complete should work for `Lambda` service. No
explicit type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[lambda]` in your environment:
`python -m pip install 'boto3-stubs[lambda]'`
Both type checking and auto-complete should work for `Lambda` 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[lambda]` in your environment:
`python -m pip install 'boto3-stubs[lambda]'`
- Run `mypy` as usual
Type checking should work for `Lambda` 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[lambda]` in your environment:
`python -m pip install 'boto3-stubs[lambda]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `Lambda` 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
`LambdaClient` provides annotations for `boto3.client("lambda")`.
```python
import boto3
from mypy_boto3_lambda import LambdaClient
client: LambdaClient = boto3.client("lambda")
# 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: LambdaClient = session.client("lambda")
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_lambda.paginator` module contains type annotations for all
paginators.
```python
from mypy_boto3_lambda import LambdaClient
from mypy_boto3_lambda.paginator import (
ListAliasesPaginator,
ListCodeSigningConfigsPaginator,
ListEventSourceMappingsPaginator,
ListFunctionEventInvokeConfigsPaginator,
ListFunctionsPaginator,
ListFunctionsByCodeSigningConfigPaginator,
ListLayerVersionsPaginator,
ListLayersPaginator,
ListProvisionedConcurrencyConfigsPaginator,
ListVersionsByFunctionPaginator,
)
client: LambdaClient = boto3.client("lambda")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
list_code_signing_configs_paginator: ListCodeSigningConfigsPaginator = client.get_paginator("list_code_signing_configs")
list_event_source_mappings_paginator: ListEventSourceMappingsPaginator = client.get_paginator("list_event_source_mappings")
list_function_event_invoke_configs_paginator: ListFunctionEventInvokeConfigsPaginator = client.get_paginator("list_function_event_invoke_configs")
list_functions_paginator: ListFunctionsPaginator = client.get_paginator("list_functions")
list_functions_by_code_signing_config_paginator: ListFunctionsByCodeSigningConfigPaginator = client.get_paginator("list_functions_by_code_signing_config")
list_layer_versions_paginator: ListLayerVersionsPaginator = client.get_paginator("list_layer_versions")
list_layers_paginator: ListLayersPaginator = client.get_paginator("list_layers")
list_provisioned_concurrency_configs_paginator: ListProvisionedConcurrencyConfigsPaginator = client.get_paginator("list_provisioned_concurrency_configs")
list_versions_by_function_paginator: ListVersionsByFunctionPaginator = client.get_paginator("list_versions_by_function")
```
<a id="waiters-annotations"></a>
### Waiters annotations
`mypy_boto3_lambda.waiter` module contains type annotations for all waiters.
```python
from mypy_boto3_lambda import LambdaClient
from mypy_boto3_lambda.waiter import (
FunctionActiveWaiter,
FunctionExistsWaiter,
FunctionUpdatedWaiter,
)
client: LambdaClient = boto3.client("lambda")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
function_active_waiter: FunctionActiveWaiter = client.get_waiter("function_active")
function_exists_waiter: FunctionExistsWaiter = client.get_waiter("function_exists")
function_updated_waiter: FunctionUpdatedWaiter = client.get_waiter("function_updated")
```
<a id="literals"></a>
### Literals
`mypy_boto3_lambda.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_lambda.literals import (
CodeSigningPolicyType,
EndPointTypeType,
EventSourcePositionType,
FunctionActiveWaiterName,
FunctionExistsWaiterName,
FunctionResponseTypeType,
FunctionUpdatedWaiterName,
FunctionVersionType,
InvocationTypeType,
LastUpdateStatusReasonCodeType,
LastUpdateStatusType,
ListAliasesPaginatorName,
ListCodeSigningConfigsPaginatorName,
ListEventSourceMapping
挣扎的蓝藻
- 粉丝: 14w+
- 资源: 15万+
最新资源
- MATLAB(GUI)的人脸门禁【ORL人脸库,库外预警,可增删查】.zip
- 智能驾驶ADAS基础知识(一)
- MATLAB(GUI)的手写字符识别[数字,字母,符号].zip
- MATLAB(GUI)的小波变换dwt数字水印[彩色,评价指标,GUI框架].zip
- MATLAB(GUI)的水果识别分类(分类器,Matlab版运行).zip
- MATLAB(GUI)的语音滤波(FIR,多方法,GUI界面).zip
- Matlab Simulink模型代搭 七自由度整车动力学模型 魔术轮胎模型 轮毂电机模型 软件使用:Matlab Simulink 适用场景:整车动力学建模,Carsim与Simulink联合仿真验
- MATLAB(GUI)的运动行为检测(某行为预警).zip
- MATLAB(GUI)购物系统,无人自助购物(自动计费,历史购物清单查询,GUI框架).zip
- MATLAB(GUI)汉字识别(写字板,GUI界面).zip
- MATLAB(GUI)汉字语音识别(语音转汉字,GUI界面).zip
- MATLAB(GUI)火焰识别[创新点:Bp神经网络].zip
- Delphi 12 控件之GExperts-RS12-1.3.25-2024-08-24.exe
- MATLAB(GUI)火焰识别系统(创新点:面积增长率,面积高度).zip
- MATLAB(GUI)基于DWT+SVD结合傅里叶变换的数字图像水印水印系统(嵌入+攻击+提取).zip
- MATLAB(GUI)火焰烟雾检测(视频,有火焰则预警,GUI).zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
评论0