diff options
Diffstat (limited to 'python-mypy-boto3-lambda.spec')
| -rw-r--r-- | python-mypy-boto3-lambda.spec | 2179 |
1 files changed, 2179 insertions, 0 deletions
diff --git a/python-mypy-boto3-lambda.spec b/python-mypy-boto3-lambda.spec new file mode 100644 index 0000000..78712da --- /dev/null +++ b/python-mypy-boto3-lambda.spec @@ -0,0 +1,2179 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-lambda +Version: 1.26.109 +Release: 1 +Summary: Type annotations for boto3.Lambda 1.26.109 service generated with mypy-boto3-builder 7.14.5 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/9a/aa/c75d3be82b37de67fa040be3cebe5f46ebb4eee13e0fde713cbcc6ab3709/mypy-boto3-lambda-1.26.109.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-lambda"></a> + +# mypy-boto3-lambda + +[](https://pypi.org/project/mypy-boto3-lambda) +[](https://pypi.org/project/mypy-boto3-lambda) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lambda/) +[](https://pypistats.org/packages/mypy-boto3-lambda) + + + +Type annotations for +[boto3.Lambda 1.26.109](https://boto3.amazonaws.com/v1/documentation/api/latest/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-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-lambda docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lambda/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-lambda](#mypy-boto3-lambda) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [From conda-forge](#from-conda-forge) + - [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) + - [Waiters annotations](#waiters-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 `Lambda`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Lambda` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[lambda]' + + +# 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[lambda]' + + +# standalone installation +python -m pip install mypy-boto3-lambda +``` + +<a id="from-conda-forge"></a> + +### From conda-forge + +Installing `mypy-boto3-lambda` from the `conda-forge` channel can be achieved +by adding `conda-forge` to your channels with: + +```bash +conda config --add channels conda-forge +conda config --set channel_priority strict +``` + +Once the `conda-forge` channel has been enabled, `mypy-boto3-lambda` can be +installed with: + +```bash +conda install mypy-boto3-lambda +``` + +It is possible to list all of the versions of `mypy-boto3-lambda` available on +your platform with: + +```bash +conda search mypy-boto3-lambda --channel conda-forge +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[lambda]'` +``` + +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[lambda]' +``` + +- 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[lambda]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +- 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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]'` +``` + +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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +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 + +`LambdaClient` provides annotations for `boto3.client("lambda")`. + +```python +from boto3.session import Session + +from mypy_boto3_lambda import LambdaClient + +client: LambdaClient = Session().client("lambda") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_lambda.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_lambda import LambdaClient +from mypy_boto3_lambda.paginator import ( + ListAliasesPaginator, + ListCodeSigningConfigsPaginator, + ListEventSourceMappingsPaginator, + ListFunctionEventInvokeConfigsPaginator, + ListFunctionUrlConfigsPaginator, + ListFunctionsPaginator, + ListFunctionsByCodeSigningConfigPaginator, + ListLayerVersionsPaginator, + ListLayersPaginator, + ListProvisionedConcurrencyConfigsPaginator, + ListVersionsByFunctionPaginator, +) + +client: LambdaClient = Session().client("lambda") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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_function_url_configs_paginator: ListFunctionUrlConfigsPaginator = client.get_paginator( + "list_function_url_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 boto3.session import Session + +from mypy_boto3_lambda import LambdaClient +from mypy_boto3_lambda.waiter import ( + FunctionActiveWaiter, + FunctionActiveV2Waiter, + FunctionExistsWaiter, + FunctionUpdatedWaiter, + FunctionUpdatedV2Waiter, + PublishedVersionActiveWaiter, +) + +client: LambdaClient = Session().client("lambda") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +function_active_waiter: FunctionActiveWaiter = client.get_waiter("function_active") +function_active_v2_waiter: FunctionActiveV2Waiter = client.get_waiter("function_active_v2") +function_exists_waiter: FunctionExistsWaiter = client.get_waiter("function_exists") +function_updated_waiter: FunctionUpdatedWaiter = client.get_waiter("function_updated") +function_updated_v2_waiter: FunctionUpdatedV2Waiter = client.get_waiter("function_updated_v2") +published_version_active_waiter: PublishedVersionActiveWaiter = client.get_waiter( + "published_version_active" +) +``` + +<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 ( + ArchitectureType, + CodeSigningPolicyType, + EndPointTypeType, + EventSourcePositionType, + FullDocumentType, + FunctionActiveV2WaiterName, + FunctionActiveWaiterName, + FunctionExistsWaiterName, + FunctionResponseTypeType, + FunctionUpdatedV2WaiterName, + FunctionUpdatedWaiterName, + FunctionUrlAuthTypeType, + FunctionVersionType, + InvocationTypeType, + InvokeModeType, + LastUpdateStatusReasonCodeType, + LastUpdateStatusType, + ListAliasesPaginatorName, + ListCodeSigningConfigsPaginatorName, + ListEventSourceMappingsPaginatorName, + ListFunctionEventInvokeConfigsPaginatorName, + ListFunctionUrlConfigsPaginatorName, + ListFunctionsByCodeSigningConfigPaginatorName, + ListFunctionsPaginatorName, + ListLayerVersionsPaginatorName, + ListLayersPaginatorName, + ListProvisionedConcurrencyConfigsPaginatorName, + ListVersionsByFunctionPaginatorName, + LogTypeType, + PackageTypeType, + ProvisionedConcurrencyStatusEnumType, + PublishedVersionActiveWaiterName, + ResponseStreamingInvocationTypeType, + RuntimeType, + SnapStartApplyOnType, + SnapStartOptimizationStatusType, + SourceAccessTypeType, + StateReasonCodeType, + StateType, + TracingModeType, + UpdateRuntimeOnType, + LambdaServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + WaiterName, + RegionName, +) + + +def check_value(value: ArchitectureType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_lambda.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_lambda.type_defs import ( + AccountLimitTypeDef, + AccountUsageTypeDef, + AddLayerVersionPermissionRequestRequestTypeDef, + ResponseMetadataTypeDef, + AddPermissionRequestRequestTypeDef, + AliasRoutingConfigurationTypeDef, + AllowedPublishersTypeDef, + AmazonManagedKafkaEventSourceConfigTypeDef, + CodeSigningPoliciesTypeDef, + ConcurrencyTypeDef, + CorsTypeDef, + DocumentDBEventSourceConfigTypeDef, + ScalingConfigTypeDef, + SelfManagedEventSourceTypeDef, + SelfManagedKafkaEventSourceConfigTypeDef, + SourceAccessConfigurationTypeDef, + DeadLetterConfigTypeDef, + EnvironmentTypeDef, + EphemeralStorageTypeDef, + FileSystemConfigTypeDef, + FunctionCodeTypeDef, + ImageConfigTypeDef, + SnapStartTypeDef, + TracingConfigTypeDef, + VpcConfigTypeDef, + DeleteAliasRequestRequestTypeDef, + DeleteCodeSigningConfigRequestRequestTypeDef, + DeleteEventSourceMappingRequestRequestTypeDef, + DeleteFunctionCodeSigningConfigRequestRequestTypeDef, + DeleteFunctionConcurrencyRequestRequestTypeDef, + DeleteFunctionEventInvokeConfigRequestRequestTypeDef, + DeleteFunctionRequestRequestTypeDef, + DeleteFunctionUrlConfigRequestRequestTypeDef, + DeleteLayerVersionRequestRequestTypeDef, + DeleteProvisionedConcurrencyConfigRequestRequestTypeDef, + OnFailureTypeDef, + OnSuccessTypeDef, + EnvironmentErrorTypeDef, + FilterTypeDef, + FunctionCodeLocationTypeDef, + LayerTypeDef, + SnapStartResponseTypeDef, + TracingConfigResponseTypeDef, + VpcConfigResponseTypeDef, + GetAliasRequestRequestTypeDef, + GetCodeSigningConfigRequestRequestTypeDef, + GetEventSourceMappingRequestRequestTypeDef, + GetFunctionCodeSigningConfigRequestRequestTypeDef, + GetFunctionConcurrencyRequestRequestTypeDef, + WaiterConfigTypeDef, + GetFunctionConfigurationRequestRequestTypeDef, + GetFunctionEventInvokeConfigRequestRequestTypeDef, + GetFunctionRequestRequestTypeDef, + GetFunctionUrlConfigRequestRequestTypeDef, + GetLayerVersionByArnRequestRequestTypeDef, + GetLayerVersionPolicyRequestRequestTypeDef, + GetLayerVersionRequestRequestTypeDef, + LayerVersionContentOutputTypeDef, + GetPolicyRequestRequestTypeDef, + GetProvisionedConcurrencyConfigRequestRequestTypeDef, + GetRuntimeManagementConfigRequestRequestTypeDef, + ImageConfigErrorTypeDef, + InvocationRequestRequestTypeDef, + InvokeAsyncRequestRequestTypeDef, + InvokeResponseStreamUpdateTypeDef, + InvokeWithResponseStreamCompleteEventTypeDef, + InvokeWithResponseStreamRequestRequestTypeDef, + LayerVersionContentInputTypeDef, + LayerVersionsListItemTypeDef, + PaginatorConfigTypeDef, + ListAliasesRequestRequestTypeDef, + ListCodeSigningConfigsRequestRequestTypeDef, + ListEventSourceMappingsRequestRequestTypeDef, + ListFunctionEventInvokeConfigsRequestRequestTypeDef, + ListFunctionUrlConfigsRequestRequestTypeDef, + ListFunctionsByCodeSigningConfigRequestRequestTypeDef, + ListFunctionsRequestRequestTypeDef, + ListLayerVersionsRequestRequestTypeDef, + ListLayersRequestRequestTypeDef, + ListProvisionedConcurrencyConfigsRequestRequestTypeDef, + ProvisionedConcurrencyConfigListItemTypeDef, + ListTagsRequestRequestTypeDef, + ListVersionsByFunctionRequestRequestTypeDef, + PublishVersionRequestRequestTypeDef, + PutFunctionCodeSigningConfigRequestRequestTypeDef, + PutFunctionConcurrencyRequestRequestTypeDef, + PutProvisionedConcurrencyConfigRequestRequestTypeDef, + PutRuntimeManagementConfigRequestRequestTypeDef, + RemoveLayerVersionPermissionRequestRequestTypeDef, + RemovePermissionRequestRequestTypeDef, + RuntimeVersionErrorTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateFunctionCodeRequestRequestTypeDef, + AddLayerVersionPermissionResponseTypeDef, + AddPermissionResponseTypeDef, + ConcurrencyResponseMetadataTypeDef, + EmptyResponseMetadataTypeDef, + GetAccountSettingsResponseTypeDef, + GetFunctionCodeSigningConfigResponseTypeDef, + GetFunctionConcurrencyResponseTypeDef, + GetLayerVersionPolicyResponseTypeDef, + GetPolicyResponseTypeDef, + GetProvisionedConcurrencyConfigResponseTypeDef, + GetRuntimeManagementConfigResponseTypeDef, + InvocationResponseTypeDef, + InvokeAsyncResponseTypeDef, + ListFunctionsByCodeSigningConfigResponseTypeDef, + ListTagsResponseTypeDef, + PutFunctionCodeSigningConfigResponseTypeDef, + PutProvisionedConcurrencyConfigResponseTypeDef, + PutRuntimeManagementConfigResponseTypeDef, + AliasConfigurationResponseMetadataTypeDef, + AliasConfigurationTypeDef, + CreateAliasRequestRequestTypeDef, + UpdateAliasRequestRequestTypeDef, + CodeSigningConfigTypeDef, + CreateCodeSigningConfigRequestRequestTypeDef, + UpdateCodeSigningConfigRequestRequestTypeDef, + CreateFunctionUrlConfigRequestRequestTypeDef, + CreateFunctionUrlConfigResponseTypeDef, + FunctionUrlConfigTypeDef, + GetFunctionUrlConfigResponseTypeDef, + UpdateFunctionUrlConfigRequestRequestTypeDef, + UpdateFunctionUrlConfigResponseTypeDef, + CreateFunctionRequestRequestTypeDef, + UpdateFunctionConfigurationRequestRequestTypeDef, + DestinationConfigTypeDef, + EnvironmentResponseTypeDef, + FilterCriteriaTypeDef, + GetFunctionConfigurationRequestFunctionActiveWaitTypeDef, + GetFunctionConfigurationRequestFunctionUpdatedWaitTypeDef, + GetFunctionConfigurationRequestPublishedVersionActiveWaitTypeDef, + GetFunctionRequestFunctionActiveV2WaitTypeDef, + GetFunctionRequestFunctionExistsWaitTypeDef, + GetFunctionRequestFunctionUpdatedV2WaitTypeDef, + GetLayerVersionResponseTypeDef, + PublishLayerVersionResponseTypeDef, + ImageConfigResponseTypeDef, + InvokeWithResponseStreamResponseEventTypeDef, + PublishLayerVersionRequestRequestTypeDef, + LayersListItemTypeDef, + ListLayerVersionsResponseTypeDef, + ListAliasesRequestListAliasesPaginateTypeDef, + ListCodeSigningConfigsRequestListCodeSigningConfigsPaginateTypeDef, + ListEventSourceMappingsRequestListEventSourceMappingsPaginateTypeDef, + ListFunctionEventInvokeConfigsRequestListFunctionEventInvokeConfigsPaginateTypeDef, + ListFunctionUrlConfigsRequestListFunctionUrlConfigsPaginateTypeDef, + ListFunctionsByCodeSigningConfigRequestListFunctionsByCodeSigningConfigPaginateTypeDef, + ListFunctionsRequestListFunctionsPaginateTypeDef, + ListLayerVersionsRequestListLayerVersionsPaginateTypeDef, + ListLayersRequestListLayersPaginateTypeDef, + ListProvisionedConcurrencyConfigsRequestListProvisionedConcurrencyConfigsPaginateTypeDef, + ListVersionsByFunctionRequestListVersionsByFunctionPaginateTypeDef, + ListProvisionedConcurrencyConfigsResponseTypeDef, + RuntimeVersionConfigTypeDef, + ListAliasesResponseTypeDef, + CreateCodeSigningConfigResponseTypeDef, + GetCodeSigningConfigResponseTypeDef, + ListCodeSigningConfigsResponseTypeDef, + UpdateCodeSigningConfigResponseTypeDef, + ListFunctionUrlConfigsResponseTypeDef, + FunctionEventInvokeConfigResponseMetadataTypeDef, + FunctionEventInvokeConfigTypeDef, + PutFunctionEventInvokeConfigRequestRequestTypeDef, + UpdateFunctionEventInvokeConfigRequestRequestTypeDef, + CreateEventSourceMappingRequestRequestTypeDef, + EventSourceMappingConfigurationResponseMetadataTypeDef, + EventSourceMappingConfigurationTypeDef, + UpdateEventSourceMappingRequestRequestTypeDef, + InvokeWithResponseStreamResponseTypeDef, + ListLayersResponseTypeDef, + FunctionConfigurationResponseMetadataTypeDef, + FunctionConfigurationTypeDef, + ListFunctionEventInvokeConfigsResponseTypeDef, + ListEventSourceMappingsResponseTypeDef, + GetFunctionResponseTypeDef, + ListFunctionsResponseTypeDef, + ListVersionsByFunctionResponseTypeDef, +) + + +def get_structure() -> AccountLimitTypeDef: + 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-lambda` 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_lambda/) + +<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. + + +%package -n python3-mypy-boto3-lambda +Summary: Type annotations for boto3.Lambda 1.26.109 service generated with mypy-boto3-builder 7.14.5 +Provides: python-mypy-boto3-lambda +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-lambda +<a id="mypy-boto3-lambda"></a> + +# mypy-boto3-lambda + +[](https://pypi.org/project/mypy-boto3-lambda) +[](https://pypi.org/project/mypy-boto3-lambda) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lambda/) +[](https://pypistats.org/packages/mypy-boto3-lambda) + + + +Type annotations for +[boto3.Lambda 1.26.109](https://boto3.amazonaws.com/v1/documentation/api/latest/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-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-lambda docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lambda/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-lambda](#mypy-boto3-lambda) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [From conda-forge](#from-conda-forge) + - [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) + - [Waiters annotations](#waiters-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 `Lambda`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Lambda` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[lambda]' + + +# 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[lambda]' + + +# standalone installation +python -m pip install mypy-boto3-lambda +``` + +<a id="from-conda-forge"></a> + +### From conda-forge + +Installing `mypy-boto3-lambda` from the `conda-forge` channel can be achieved +by adding `conda-forge` to your channels with: + +```bash +conda config --add channels conda-forge +conda config --set channel_priority strict +``` + +Once the `conda-forge` channel has been enabled, `mypy-boto3-lambda` can be +installed with: + +```bash +conda install mypy-boto3-lambda +``` + +It is possible to list all of the versions of `mypy-boto3-lambda` available on +your platform with: + +```bash +conda search mypy-boto3-lambda --channel conda-forge +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[lambda]'` +``` + +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[lambda]' +``` + +- 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[lambda]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +- 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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]'` +``` + +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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +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 + +`LambdaClient` provides annotations for `boto3.client("lambda")`. + +```python +from boto3.session import Session + +from mypy_boto3_lambda import LambdaClient + +client: LambdaClient = Session().client("lambda") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_lambda.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_lambda import LambdaClient +from mypy_boto3_lambda.paginator import ( + ListAliasesPaginator, + ListCodeSigningConfigsPaginator, + ListEventSourceMappingsPaginator, + ListFunctionEventInvokeConfigsPaginator, + ListFunctionUrlConfigsPaginator, + ListFunctionsPaginator, + ListFunctionsByCodeSigningConfigPaginator, + ListLayerVersionsPaginator, + ListLayersPaginator, + ListProvisionedConcurrencyConfigsPaginator, + ListVersionsByFunctionPaginator, +) + +client: LambdaClient = Session().client("lambda") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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_function_url_configs_paginator: ListFunctionUrlConfigsPaginator = client.get_paginator( + "list_function_url_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 boto3.session import Session + +from mypy_boto3_lambda import LambdaClient +from mypy_boto3_lambda.waiter import ( + FunctionActiveWaiter, + FunctionActiveV2Waiter, + FunctionExistsWaiter, + FunctionUpdatedWaiter, + FunctionUpdatedV2Waiter, + PublishedVersionActiveWaiter, +) + +client: LambdaClient = Session().client("lambda") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +function_active_waiter: FunctionActiveWaiter = client.get_waiter("function_active") +function_active_v2_waiter: FunctionActiveV2Waiter = client.get_waiter("function_active_v2") +function_exists_waiter: FunctionExistsWaiter = client.get_waiter("function_exists") +function_updated_waiter: FunctionUpdatedWaiter = client.get_waiter("function_updated") +function_updated_v2_waiter: FunctionUpdatedV2Waiter = client.get_waiter("function_updated_v2") +published_version_active_waiter: PublishedVersionActiveWaiter = client.get_waiter( + "published_version_active" +) +``` + +<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 ( + ArchitectureType, + CodeSigningPolicyType, + EndPointTypeType, + EventSourcePositionType, + FullDocumentType, + FunctionActiveV2WaiterName, + FunctionActiveWaiterName, + FunctionExistsWaiterName, + FunctionResponseTypeType, + FunctionUpdatedV2WaiterName, + FunctionUpdatedWaiterName, + FunctionUrlAuthTypeType, + FunctionVersionType, + InvocationTypeType, + InvokeModeType, + LastUpdateStatusReasonCodeType, + LastUpdateStatusType, + ListAliasesPaginatorName, + ListCodeSigningConfigsPaginatorName, + ListEventSourceMappingsPaginatorName, + ListFunctionEventInvokeConfigsPaginatorName, + ListFunctionUrlConfigsPaginatorName, + ListFunctionsByCodeSigningConfigPaginatorName, + ListFunctionsPaginatorName, + ListLayerVersionsPaginatorName, + ListLayersPaginatorName, + ListProvisionedConcurrencyConfigsPaginatorName, + ListVersionsByFunctionPaginatorName, + LogTypeType, + PackageTypeType, + ProvisionedConcurrencyStatusEnumType, + PublishedVersionActiveWaiterName, + ResponseStreamingInvocationTypeType, + RuntimeType, + SnapStartApplyOnType, + SnapStartOptimizationStatusType, + SourceAccessTypeType, + StateReasonCodeType, + StateType, + TracingModeType, + UpdateRuntimeOnType, + LambdaServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + WaiterName, + RegionName, +) + + +def check_value(value: ArchitectureType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_lambda.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_lambda.type_defs import ( + AccountLimitTypeDef, + AccountUsageTypeDef, + AddLayerVersionPermissionRequestRequestTypeDef, + ResponseMetadataTypeDef, + AddPermissionRequestRequestTypeDef, + AliasRoutingConfigurationTypeDef, + AllowedPublishersTypeDef, + AmazonManagedKafkaEventSourceConfigTypeDef, + CodeSigningPoliciesTypeDef, + ConcurrencyTypeDef, + CorsTypeDef, + DocumentDBEventSourceConfigTypeDef, + ScalingConfigTypeDef, + SelfManagedEventSourceTypeDef, + SelfManagedKafkaEventSourceConfigTypeDef, + SourceAccessConfigurationTypeDef, + DeadLetterConfigTypeDef, + EnvironmentTypeDef, + EphemeralStorageTypeDef, + FileSystemConfigTypeDef, + FunctionCodeTypeDef, + ImageConfigTypeDef, + SnapStartTypeDef, + TracingConfigTypeDef, + VpcConfigTypeDef, + DeleteAliasRequestRequestTypeDef, + DeleteCodeSigningConfigRequestRequestTypeDef, + DeleteEventSourceMappingRequestRequestTypeDef, + DeleteFunctionCodeSigningConfigRequestRequestTypeDef, + DeleteFunctionConcurrencyRequestRequestTypeDef, + DeleteFunctionEventInvokeConfigRequestRequestTypeDef, + DeleteFunctionRequestRequestTypeDef, + DeleteFunctionUrlConfigRequestRequestTypeDef, + DeleteLayerVersionRequestRequestTypeDef, + DeleteProvisionedConcurrencyConfigRequestRequestTypeDef, + OnFailureTypeDef, + OnSuccessTypeDef, + EnvironmentErrorTypeDef, + FilterTypeDef, + FunctionCodeLocationTypeDef, + LayerTypeDef, + SnapStartResponseTypeDef, + TracingConfigResponseTypeDef, + VpcConfigResponseTypeDef, + GetAliasRequestRequestTypeDef, + GetCodeSigningConfigRequestRequestTypeDef, + GetEventSourceMappingRequestRequestTypeDef, + GetFunctionCodeSigningConfigRequestRequestTypeDef, + GetFunctionConcurrencyRequestRequestTypeDef, + WaiterConfigTypeDef, + GetFunctionConfigurationRequestRequestTypeDef, + GetFunctionEventInvokeConfigRequestRequestTypeDef, + GetFunctionRequestRequestTypeDef, + GetFunctionUrlConfigRequestRequestTypeDef, + GetLayerVersionByArnRequestRequestTypeDef, + GetLayerVersionPolicyRequestRequestTypeDef, + GetLayerVersionRequestRequestTypeDef, + LayerVersionContentOutputTypeDef, + GetPolicyRequestRequestTypeDef, + GetProvisionedConcurrencyConfigRequestRequestTypeDef, + GetRuntimeManagementConfigRequestRequestTypeDef, + ImageConfigErrorTypeDef, + InvocationRequestRequestTypeDef, + InvokeAsyncRequestRequestTypeDef, + InvokeResponseStreamUpdateTypeDef, + InvokeWithResponseStreamCompleteEventTypeDef, + InvokeWithResponseStreamRequestRequestTypeDef, + LayerVersionContentInputTypeDef, + LayerVersionsListItemTypeDef, + PaginatorConfigTypeDef, + ListAliasesRequestRequestTypeDef, + ListCodeSigningConfigsRequestRequestTypeDef, + ListEventSourceMappingsRequestRequestTypeDef, + ListFunctionEventInvokeConfigsRequestRequestTypeDef, + ListFunctionUrlConfigsRequestRequestTypeDef, + ListFunctionsByCodeSigningConfigRequestRequestTypeDef, + ListFunctionsRequestRequestTypeDef, + ListLayerVersionsRequestRequestTypeDef, + ListLayersRequestRequestTypeDef, + ListProvisionedConcurrencyConfigsRequestRequestTypeDef, + ProvisionedConcurrencyConfigListItemTypeDef, + ListTagsRequestRequestTypeDef, + ListVersionsByFunctionRequestRequestTypeDef, + PublishVersionRequestRequestTypeDef, + PutFunctionCodeSigningConfigRequestRequestTypeDef, + PutFunctionConcurrencyRequestRequestTypeDef, + PutProvisionedConcurrencyConfigRequestRequestTypeDef, + PutRuntimeManagementConfigRequestRequestTypeDef, + RemoveLayerVersionPermissionRequestRequestTypeDef, + RemovePermissionRequestRequestTypeDef, + RuntimeVersionErrorTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateFunctionCodeRequestRequestTypeDef, + AddLayerVersionPermissionResponseTypeDef, + AddPermissionResponseTypeDef, + ConcurrencyResponseMetadataTypeDef, + EmptyResponseMetadataTypeDef, + GetAccountSettingsResponseTypeDef, + GetFunctionCodeSigningConfigResponseTypeDef, + GetFunctionConcurrencyResponseTypeDef, + GetLayerVersionPolicyResponseTypeDef, + GetPolicyResponseTypeDef, + GetProvisionedConcurrencyConfigResponseTypeDef, + GetRuntimeManagementConfigResponseTypeDef, + InvocationResponseTypeDef, + InvokeAsyncResponseTypeDef, + ListFunctionsByCodeSigningConfigResponseTypeDef, + ListTagsResponseTypeDef, + PutFunctionCodeSigningConfigResponseTypeDef, + PutProvisionedConcurrencyConfigResponseTypeDef, + PutRuntimeManagementConfigResponseTypeDef, + AliasConfigurationResponseMetadataTypeDef, + AliasConfigurationTypeDef, + CreateAliasRequestRequestTypeDef, + UpdateAliasRequestRequestTypeDef, + CodeSigningConfigTypeDef, + CreateCodeSigningConfigRequestRequestTypeDef, + UpdateCodeSigningConfigRequestRequestTypeDef, + CreateFunctionUrlConfigRequestRequestTypeDef, + CreateFunctionUrlConfigResponseTypeDef, + FunctionUrlConfigTypeDef, + GetFunctionUrlConfigResponseTypeDef, + UpdateFunctionUrlConfigRequestRequestTypeDef, + UpdateFunctionUrlConfigResponseTypeDef, + CreateFunctionRequestRequestTypeDef, + UpdateFunctionConfigurationRequestRequestTypeDef, + DestinationConfigTypeDef, + EnvironmentResponseTypeDef, + FilterCriteriaTypeDef, + GetFunctionConfigurationRequestFunctionActiveWaitTypeDef, + GetFunctionConfigurationRequestFunctionUpdatedWaitTypeDef, + GetFunctionConfigurationRequestPublishedVersionActiveWaitTypeDef, + GetFunctionRequestFunctionActiveV2WaitTypeDef, + GetFunctionRequestFunctionExistsWaitTypeDef, + GetFunctionRequestFunctionUpdatedV2WaitTypeDef, + GetLayerVersionResponseTypeDef, + PublishLayerVersionResponseTypeDef, + ImageConfigResponseTypeDef, + InvokeWithResponseStreamResponseEventTypeDef, + PublishLayerVersionRequestRequestTypeDef, + LayersListItemTypeDef, + ListLayerVersionsResponseTypeDef, + ListAliasesRequestListAliasesPaginateTypeDef, + ListCodeSigningConfigsRequestListCodeSigningConfigsPaginateTypeDef, + ListEventSourceMappingsRequestListEventSourceMappingsPaginateTypeDef, + ListFunctionEventInvokeConfigsRequestListFunctionEventInvokeConfigsPaginateTypeDef, + ListFunctionUrlConfigsRequestListFunctionUrlConfigsPaginateTypeDef, + ListFunctionsByCodeSigningConfigRequestListFunctionsByCodeSigningConfigPaginateTypeDef, + ListFunctionsRequestListFunctionsPaginateTypeDef, + ListLayerVersionsRequestListLayerVersionsPaginateTypeDef, + ListLayersRequestListLayersPaginateTypeDef, + ListProvisionedConcurrencyConfigsRequestListProvisionedConcurrencyConfigsPaginateTypeDef, + ListVersionsByFunctionRequestListVersionsByFunctionPaginateTypeDef, + ListProvisionedConcurrencyConfigsResponseTypeDef, + RuntimeVersionConfigTypeDef, + ListAliasesResponseTypeDef, + CreateCodeSigningConfigResponseTypeDef, + GetCodeSigningConfigResponseTypeDef, + ListCodeSigningConfigsResponseTypeDef, + UpdateCodeSigningConfigResponseTypeDef, + ListFunctionUrlConfigsResponseTypeDef, + FunctionEventInvokeConfigResponseMetadataTypeDef, + FunctionEventInvokeConfigTypeDef, + PutFunctionEventInvokeConfigRequestRequestTypeDef, + UpdateFunctionEventInvokeConfigRequestRequestTypeDef, + CreateEventSourceMappingRequestRequestTypeDef, + EventSourceMappingConfigurationResponseMetadataTypeDef, + EventSourceMappingConfigurationTypeDef, + UpdateEventSourceMappingRequestRequestTypeDef, + InvokeWithResponseStreamResponseTypeDef, + ListLayersResponseTypeDef, + FunctionConfigurationResponseMetadataTypeDef, + FunctionConfigurationTypeDef, + ListFunctionEventInvokeConfigsResponseTypeDef, + ListEventSourceMappingsResponseTypeDef, + GetFunctionResponseTypeDef, + ListFunctionsResponseTypeDef, + ListVersionsByFunctionResponseTypeDef, +) + + +def get_structure() -> AccountLimitTypeDef: + 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-lambda` 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_lambda/) + +<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. + + +%package help +Summary: Development documents and examples for mypy-boto3-lambda +Provides: python3-mypy-boto3-lambda-doc +%description help +<a id="mypy-boto3-lambda"></a> + +# mypy-boto3-lambda + +[](https://pypi.org/project/mypy-boto3-lambda) +[](https://pypi.org/project/mypy-boto3-lambda) +[](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lambda/) +[](https://pypistats.org/packages/mypy-boto3-lambda) + + + +Type annotations for +[boto3.Lambda 1.26.109](https://boto3.amazonaws.com/v1/documentation/api/latest/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-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-lambda docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_lambda/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-lambda](#mypy-boto3-lambda) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [From conda-forge](#from-conda-forge) + - [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) + - [Waiters annotations](#waiters-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 `Lambda`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Lambda` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[lambda]' + + +# 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[lambda]' + + +# standalone installation +python -m pip install mypy-boto3-lambda +``` + +<a id="from-conda-forge"></a> + +### From conda-forge + +Installing `mypy-boto3-lambda` from the `conda-forge` channel can be achieved +by adding `conda-forge` to your channels with: + +```bash +conda config --add channels conda-forge +conda config --set channel_priority strict +``` + +Once the `conda-forge` channel has been enabled, `mypy-boto3-lambda` can be +installed with: + +```bash +conda install mypy-boto3-lambda +``` + +It is possible to list all of the versions of `mypy-boto3-lambda` available on +your platform with: + +```bash +conda search mypy-boto3-lambda --channel conda-forge +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-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 `boto3-stubs[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[lambda]'` +``` + +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[lambda]' +``` + +- 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[lambda]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +- 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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]'` +``` + +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[lambda]` in your environment: + +```bash +python -m pip install 'boto3-stubs[lambda]' +``` + +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 + +`LambdaClient` provides annotations for `boto3.client("lambda")`. + +```python +from boto3.session import Session + +from mypy_boto3_lambda import LambdaClient + +client: LambdaClient = Session().client("lambda") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_lambda.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_lambda import LambdaClient +from mypy_boto3_lambda.paginator import ( + ListAliasesPaginator, + ListCodeSigningConfigsPaginator, + ListEventSourceMappingsPaginator, + ListFunctionEventInvokeConfigsPaginator, + ListFunctionUrlConfigsPaginator, + ListFunctionsPaginator, + ListFunctionsByCodeSigningConfigPaginator, + ListLayerVersionsPaginator, + ListLayersPaginator, + ListProvisionedConcurrencyConfigsPaginator, + ListVersionsByFunctionPaginator, +) + +client: LambdaClient = Session().client("lambda") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +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_function_url_configs_paginator: ListFunctionUrlConfigsPaginator = client.get_paginator( + "list_function_url_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 boto3.session import Session + +from mypy_boto3_lambda import LambdaClient +from mypy_boto3_lambda.waiter import ( + FunctionActiveWaiter, + FunctionActiveV2Waiter, + FunctionExistsWaiter, + FunctionUpdatedWaiter, + FunctionUpdatedV2Waiter, + PublishedVersionActiveWaiter, +) + +client: LambdaClient = Session().client("lambda") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +function_active_waiter: FunctionActiveWaiter = client.get_waiter("function_active") +function_active_v2_waiter: FunctionActiveV2Waiter = client.get_waiter("function_active_v2") +function_exists_waiter: FunctionExistsWaiter = client.get_waiter("function_exists") +function_updated_waiter: FunctionUpdatedWaiter = client.get_waiter("function_updated") +function_updated_v2_waiter: FunctionUpdatedV2Waiter = client.get_waiter("function_updated_v2") +published_version_active_waiter: PublishedVersionActiveWaiter = client.get_waiter( + "published_version_active" +) +``` + +<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 ( + ArchitectureType, + CodeSigningPolicyType, + EndPointTypeType, + EventSourcePositionType, + FullDocumentType, + FunctionActiveV2WaiterName, + FunctionActiveWaiterName, + FunctionExistsWaiterName, + FunctionResponseTypeType, + FunctionUpdatedV2WaiterName, + FunctionUpdatedWaiterName, + FunctionUrlAuthTypeType, + FunctionVersionType, + InvocationTypeType, + InvokeModeType, + LastUpdateStatusReasonCodeType, + LastUpdateStatusType, + ListAliasesPaginatorName, + ListCodeSigningConfigsPaginatorName, + ListEventSourceMappingsPaginatorName, + ListFunctionEventInvokeConfigsPaginatorName, + ListFunctionUrlConfigsPaginatorName, + ListFunctionsByCodeSigningConfigPaginatorName, + ListFunctionsPaginatorName, + ListLayerVersionsPaginatorName, + ListLayersPaginatorName, + ListProvisionedConcurrencyConfigsPaginatorName, + ListVersionsByFunctionPaginatorName, + LogTypeType, + PackageTypeType, + ProvisionedConcurrencyStatusEnumType, + PublishedVersionActiveWaiterName, + ResponseStreamingInvocationTypeType, + RuntimeType, + SnapStartApplyOnType, + SnapStartOptimizationStatusType, + SourceAccessTypeType, + StateReasonCodeType, + StateType, + TracingModeType, + UpdateRuntimeOnType, + LambdaServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + WaiterName, + RegionName, +) + + +def check_value(value: ArchitectureType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_lambda.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_lambda.type_defs import ( + AccountLimitTypeDef, + AccountUsageTypeDef, + AddLayerVersionPermissionRequestRequestTypeDef, + ResponseMetadataTypeDef, + AddPermissionRequestRequestTypeDef, + AliasRoutingConfigurationTypeDef, + AllowedPublishersTypeDef, + AmazonManagedKafkaEventSourceConfigTypeDef, + CodeSigningPoliciesTypeDef, + ConcurrencyTypeDef, + CorsTypeDef, + DocumentDBEventSourceConfigTypeDef, + ScalingConfigTypeDef, + SelfManagedEventSourceTypeDef, + SelfManagedKafkaEventSourceConfigTypeDef, + SourceAccessConfigurationTypeDef, + DeadLetterConfigTypeDef, + EnvironmentTypeDef, + EphemeralStorageTypeDef, + FileSystemConfigTypeDef, + FunctionCodeTypeDef, + ImageConfigTypeDef, + SnapStartTypeDef, + TracingConfigTypeDef, + VpcConfigTypeDef, + DeleteAliasRequestRequestTypeDef, + DeleteCodeSigningConfigRequestRequestTypeDef, + DeleteEventSourceMappingRequestRequestTypeDef, + DeleteFunctionCodeSigningConfigRequestRequestTypeDef, + DeleteFunctionConcurrencyRequestRequestTypeDef, + DeleteFunctionEventInvokeConfigRequestRequestTypeDef, + DeleteFunctionRequestRequestTypeDef, + DeleteFunctionUrlConfigRequestRequestTypeDef, + DeleteLayerVersionRequestRequestTypeDef, + DeleteProvisionedConcurrencyConfigRequestRequestTypeDef, + OnFailureTypeDef, + OnSuccessTypeDef, + EnvironmentErrorTypeDef, + FilterTypeDef, + FunctionCodeLocationTypeDef, + LayerTypeDef, + SnapStartResponseTypeDef, + TracingConfigResponseTypeDef, + VpcConfigResponseTypeDef, + GetAliasRequestRequestTypeDef, + GetCodeSigningConfigRequestRequestTypeDef, + GetEventSourceMappingRequestRequestTypeDef, + GetFunctionCodeSigningConfigRequestRequestTypeDef, + GetFunctionConcurrencyRequestRequestTypeDef, + WaiterConfigTypeDef, + GetFunctionConfigurationRequestRequestTypeDef, + GetFunctionEventInvokeConfigRequestRequestTypeDef, + GetFunctionRequestRequestTypeDef, + GetFunctionUrlConfigRequestRequestTypeDef, + GetLayerVersionByArnRequestRequestTypeDef, + GetLayerVersionPolicyRequestRequestTypeDef, + GetLayerVersionRequestRequestTypeDef, + LayerVersionContentOutputTypeDef, + GetPolicyRequestRequestTypeDef, + GetProvisionedConcurrencyConfigRequestRequestTypeDef, + GetRuntimeManagementConfigRequestRequestTypeDef, + ImageConfigErrorTypeDef, + InvocationRequestRequestTypeDef, + InvokeAsyncRequestRequestTypeDef, + InvokeResponseStreamUpdateTypeDef, + InvokeWithResponseStreamCompleteEventTypeDef, + InvokeWithResponseStreamRequestRequestTypeDef, + LayerVersionContentInputTypeDef, + LayerVersionsListItemTypeDef, + PaginatorConfigTypeDef, + ListAliasesRequestRequestTypeDef, + ListCodeSigningConfigsRequestRequestTypeDef, + ListEventSourceMappingsRequestRequestTypeDef, + ListFunctionEventInvokeConfigsRequestRequestTypeDef, + ListFunctionUrlConfigsRequestRequestTypeDef, + ListFunctionsByCodeSigningConfigRequestRequestTypeDef, + ListFunctionsRequestRequestTypeDef, + ListLayerVersionsRequestRequestTypeDef, + ListLayersRequestRequestTypeDef, + ListProvisionedConcurrencyConfigsRequestRequestTypeDef, + ProvisionedConcurrencyConfigListItemTypeDef, + ListTagsRequestRequestTypeDef, + ListVersionsByFunctionRequestRequestTypeDef, + PublishVersionRequestRequestTypeDef, + PutFunctionCodeSigningConfigRequestRequestTypeDef, + PutFunctionConcurrencyRequestRequestTypeDef, + PutProvisionedConcurrencyConfigRequestRequestTypeDef, + PutRuntimeManagementConfigRequestRequestTypeDef, + RemoveLayerVersionPermissionRequestRequestTypeDef, + RemovePermissionRequestRequestTypeDef, + RuntimeVersionErrorTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateFunctionCodeRequestRequestTypeDef, + AddLayerVersionPermissionResponseTypeDef, + AddPermissionResponseTypeDef, + ConcurrencyResponseMetadataTypeDef, + EmptyResponseMetadataTypeDef, + GetAccountSettingsResponseTypeDef, + GetFunctionCodeSigningConfigResponseTypeDef, + GetFunctionConcurrencyResponseTypeDef, + GetLayerVersionPolicyResponseTypeDef, + GetPolicyResponseTypeDef, + GetProvisionedConcurrencyConfigResponseTypeDef, + GetRuntimeManagementConfigResponseTypeDef, + InvocationResponseTypeDef, + InvokeAsyncResponseTypeDef, + ListFunctionsByCodeSigningConfigResponseTypeDef, + ListTagsResponseTypeDef, + PutFunctionCodeSigningConfigResponseTypeDef, + PutProvisionedConcurrencyConfigResponseTypeDef, + PutRuntimeManagementConfigResponseTypeDef, + AliasConfigurationResponseMetadataTypeDef, + AliasConfigurationTypeDef, + CreateAliasRequestRequestTypeDef, + UpdateAliasRequestRequestTypeDef, + CodeSigningConfigTypeDef, + CreateCodeSigningConfigRequestRequestTypeDef, + UpdateCodeSigningConfigRequestRequestTypeDef, + CreateFunctionUrlConfigRequestRequestTypeDef, + CreateFunctionUrlConfigResponseTypeDef, + FunctionUrlConfigTypeDef, + GetFunctionUrlConfigResponseTypeDef, + UpdateFunctionUrlConfigRequestRequestTypeDef, + UpdateFunctionUrlConfigResponseTypeDef, + CreateFunctionRequestRequestTypeDef, + UpdateFunctionConfigurationRequestRequestTypeDef, + DestinationConfigTypeDef, + EnvironmentResponseTypeDef, + FilterCriteriaTypeDef, + GetFunctionConfigurationRequestFunctionActiveWaitTypeDef, + GetFunctionConfigurationRequestFunctionUpdatedWaitTypeDef, + GetFunctionConfigurationRequestPublishedVersionActiveWaitTypeDef, + GetFunctionRequestFunctionActiveV2WaitTypeDef, + GetFunctionRequestFunctionExistsWaitTypeDef, + GetFunctionRequestFunctionUpdatedV2WaitTypeDef, + GetLayerVersionResponseTypeDef, + PublishLayerVersionResponseTypeDef, + ImageConfigResponseTypeDef, + InvokeWithResponseStreamResponseEventTypeDef, + PublishLayerVersionRequestRequestTypeDef, + LayersListItemTypeDef, + ListLayerVersionsResponseTypeDef, + ListAliasesRequestListAliasesPaginateTypeDef, + ListCodeSigningConfigsRequestListCodeSigningConfigsPaginateTypeDef, + ListEventSourceMappingsRequestListEventSourceMappingsPaginateTypeDef, + ListFunctionEventInvokeConfigsRequestListFunctionEventInvokeConfigsPaginateTypeDef, + ListFunctionUrlConfigsRequestListFunctionUrlConfigsPaginateTypeDef, + ListFunctionsByCodeSigningConfigRequestListFunctionsByCodeSigningConfigPaginateTypeDef, + ListFunctionsRequestListFunctionsPaginateTypeDef, + ListLayerVersionsRequestListLayerVersionsPaginateTypeDef, + ListLayersRequestListLayersPaginateTypeDef, + ListProvisionedConcurrencyConfigsRequestListProvisionedConcurrencyConfigsPaginateTypeDef, + ListVersionsByFunctionRequestListVersionsByFunctionPaginateTypeDef, + ListProvisionedConcurrencyConfigsResponseTypeDef, + RuntimeVersionConfigTypeDef, + ListAliasesResponseTypeDef, + CreateCodeSigningConfigResponseTypeDef, + GetCodeSigningConfigResponseTypeDef, + ListCodeSigningConfigsResponseTypeDef, + UpdateCodeSigningConfigResponseTypeDef, + ListFunctionUrlConfigsResponseTypeDef, + FunctionEventInvokeConfigResponseMetadataTypeDef, + FunctionEventInvokeConfigTypeDef, + PutFunctionEventInvokeConfigRequestRequestTypeDef, + UpdateFunctionEventInvokeConfigRequestRequestTypeDef, + CreateEventSourceMappingRequestRequestTypeDef, + EventSourceMappingConfigurationResponseMetadataTypeDef, + EventSourceMappingConfigurationTypeDef, + UpdateEventSourceMappingRequestRequestTypeDef, + InvokeWithResponseStreamResponseTypeDef, + ListLayersResponseTypeDef, + FunctionConfigurationResponseMetadataTypeDef, + FunctionConfigurationTypeDef, + ListFunctionEventInvokeConfigsResponseTypeDef, + ListEventSourceMappingsResponseTypeDef, + GetFunctionResponseTypeDef, + ListFunctionsResponseTypeDef, + ListVersionsByFunctionResponseTypeDef, +) + + +def get_structure() -> AccountLimitTypeDef: + 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-lambda` 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_lambda/) + +<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. + + +%prep +%autosetup -n mypy-boto3-lambda-1.26.109 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-lambda -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Mon Apr 10 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.109-1 +- Package Spec generated |