Lambda module#
Index > Lambda
Auto-generated documentation for Lambda type annotations stubs module mypy-boto3-lambda.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
Lambda
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and Lambda
.
From PyPI with pip#
Install boto3-stubs
for Lambda
service.
# 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
From conda-forge#
Add conda-forge
to your channels with:
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:
conda install mypy-boto3-lambda
List all available versions of mypy-boto3-lambda
available on your platform with:
conda search mypy-boto3-lambda --channel conda-forge
How to uninstall#
python -m pip uninstall -y mypy-boto3-lambda
Usage#
Code samples can be found in Examples.
LambdaClient#
Type annotations and code completion for boto3.client("lambda")
as LambdaClient
boto3 documentation
# LambdaClient usage example
from boto3.session import Session
from mypy_boto3_lambda.client import LambdaClient
def get_client() -> LambdaClient:
return Session().client("lambda")
Paginators#
Type annotations and code completion for paginators
from boto3.client("lambda").get_paginator("...")
.
# ListAliasesPaginator usage example
from boto3.session import Session
from mypy_boto3_lambda.paginator import ListAliasesPaginator
def get_list_aliases_paginator() -> ListAliasesPaginator:
return Session().client("lambda").get_paginator("list_aliases"))
- ListAliasesPaginator
- ListCodeSigningConfigsPaginator
- ListEventSourceMappingsPaginator
- ListFunctionEventInvokeConfigsPaginator
- ListFunctionUrlConfigsPaginator
- ListFunctionsByCodeSigningConfigPaginator
- ListFunctionsPaginator
- ListLayerVersionsPaginator
- ListLayersPaginator
- ListProvisionedConcurrencyConfigsPaginator
- ListVersionsByFunctionPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("lambda").get_waiter("...")
.
# FunctionActiveV2Waiter usage example
from boto3.session import Session
from mypy_boto3_lambda.waiter import FunctionActiveV2Waiter
def get_function_active_v2_waiter() -> FunctionActiveV2Waiter:
return Session().client("lambda").get_waiter("function_active_v2")
- FunctionActiveV2Waiter
- FunctionActiveWaiter
- FunctionExistsWaiter
- FunctionUpdatedV2Waiter
- FunctionUpdatedWaiter
- PublishedVersionActiveWaiter
Literals#
Type annotations for literals used in methods and schema.
# ApplicationLogLevelType usage example
from mypy_boto3_lambda.literals import ApplicationLogLevelType
def get_value() -> ApplicationLogLevelType:
return "DEBUG"
- ApplicationLogLevelType
- ArchitectureType
- CodeSigningPolicyType
- EndPointTypeType
- EventSourceMappingMetricType
- 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
- LogFormatType
- LogTypeType
- PackageTypeType
- ProvisionedConcurrencyStatusEnumType
- PublishedVersionActiveWaiterName
- RecursiveLoopType
- ResponseStreamingInvocationTypeType
- RuntimeType
- SnapStartApplyOnType
- SnapStartOptimizationStatusType
- SourceAccessTypeType
- StateReasonCodeType
- StateType
- SystemLogLevelType
- TracingModeType
- UpdateRuntimeOnType
- LambdaServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountLimitTypeDef
- AccountUsageTypeDef
- AddLayerVersionPermissionRequestRequestTypeDef
- ResponseMetadataTypeDef
- AddPermissionRequestRequestTypeDef
- AliasRoutingConfigurationOutputTypeDef
- AliasRoutingConfigurationTypeDef
- AllowedPublishersOutputTypeDef
- AllowedPublishersTypeDef
- AmazonManagedKafkaEventSourceConfigTypeDef
- BlobTypeDef
- CodeSigningPoliciesTypeDef
- ConcurrencyTypeDef
- CorsOutputTypeDef
- CorsTypeDef
- DocumentDBEventSourceConfigTypeDef
- EventSourceMappingMetricsConfigTypeDef
- ProvisionedPollerConfigTypeDef
- ScalingConfigTypeDef
- SelfManagedEventSourceTypeDef
- SelfManagedKafkaEventSourceConfigTypeDef
- SourceAccessConfigurationTypeDef
- TimestampTypeDef
- DeadLetterConfigTypeDef
- EnvironmentTypeDef
- EphemeralStorageTypeDef
- FileSystemConfigTypeDef
- ImageConfigTypeDef
- LoggingConfigTypeDef
- SnapStartTypeDef
- TracingConfigTypeDef
- VpcConfigTypeDef
- DeleteAliasRequestRequestTypeDef
- DeleteCodeSigningConfigRequestRequestTypeDef
- DeleteEventSourceMappingRequestRequestTypeDef
- DeleteFunctionCodeSigningConfigRequestRequestTypeDef
- DeleteFunctionConcurrencyRequestRequestTypeDef
- DeleteFunctionEventInvokeConfigRequestRequestTypeDef
- DeleteFunctionRequestRequestTypeDef
- DeleteFunctionUrlConfigRequestRequestTypeDef
- DeleteLayerVersionRequestRequestTypeDef
- DeleteProvisionedConcurrencyConfigRequestRequestTypeDef
- OnFailureTypeDef
- OnSuccessTypeDef
- EnvironmentErrorTypeDef
- EventSourceMappingMetricsConfigOutputTypeDef
- FilterCriteriaErrorTypeDef
- SelfManagedEventSourceOutputTypeDef
- FilterTypeDef
- FunctionCodeLocationTypeDef
- LayerTypeDef
- SnapStartResponseTypeDef
- TracingConfigResponseTypeDef
- VpcConfigResponseTypeDef
- GetAliasRequestRequestTypeDef
- GetCodeSigningConfigRequestRequestTypeDef
- GetEventSourceMappingRequestRequestTypeDef
- GetFunctionCodeSigningConfigRequestRequestTypeDef
- GetFunctionConcurrencyRequestRequestTypeDef
- GetFunctionConfigurationRequestRequestTypeDef
- WaiterConfigTypeDef
- GetFunctionEventInvokeConfigRequestRequestTypeDef
- GetFunctionRecursionConfigRequestRequestTypeDef
- GetFunctionRequestRequestTypeDef
- TagsErrorTypeDef
- GetFunctionUrlConfigRequestRequestTypeDef
- GetLayerVersionByArnRequestRequestTypeDef
- GetLayerVersionPolicyRequestRequestTypeDef
- GetLayerVersionRequestRequestTypeDef
- LayerVersionContentOutputTypeDef
- GetPolicyRequestRequestTypeDef
- GetProvisionedConcurrencyConfigRequestRequestTypeDef
- GetRuntimeManagementConfigRequestRequestTypeDef
- ImageConfigErrorTypeDef
- ImageConfigOutputTypeDef
- InvokeResponseStreamUpdateTypeDef
- InvokeWithResponseStreamCompleteEventTypeDef
- LayerVersionsListItemTypeDef
- PaginatorConfigTypeDef
- ListAliasesRequestRequestTypeDef
- ListCodeSigningConfigsRequestRequestTypeDef
- ListEventSourceMappingsRequestRequestTypeDef
- ListFunctionEventInvokeConfigsRequestRequestTypeDef
- ListFunctionUrlConfigsRequestRequestTypeDef
- ListFunctionsByCodeSigningConfigRequestRequestTypeDef
- ListFunctionsRequestRequestTypeDef
- ListLayerVersionsRequestRequestTypeDef
- ListLayersRequestRequestTypeDef
- ListProvisionedConcurrencyConfigsRequestRequestTypeDef
- ProvisionedConcurrencyConfigListItemTypeDef
- ListTagsRequestRequestTypeDef
- ListVersionsByFunctionRequestRequestTypeDef
- PublishVersionRequestRequestTypeDef
- PutFunctionCodeSigningConfigRequestRequestTypeDef
- PutFunctionConcurrencyRequestRequestTypeDef
- PutFunctionRecursionConfigRequestRequestTypeDef
- PutProvisionedConcurrencyConfigRequestRequestTypeDef
- PutRuntimeManagementConfigRequestRequestTypeDef
- RemoveLayerVersionPermissionRequestRequestTypeDef
- RemovePermissionRequestRequestTypeDef
- RuntimeVersionErrorTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- AddLayerVersionPermissionResponseTypeDef
- AddPermissionResponseTypeDef
- ConcurrencyResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetAccountSettingsResponseTypeDef
- GetFunctionCodeSigningConfigResponseTypeDef
- GetFunctionConcurrencyResponseTypeDef
- GetFunctionRecursionConfigResponseTypeDef
- GetLayerVersionPolicyResponseTypeDef
- GetPolicyResponseTypeDef
- GetProvisionedConcurrencyConfigResponseTypeDef
- GetRuntimeManagementConfigResponseTypeDef
- InvocationResponseTypeDef
- InvokeAsyncResponseTypeDef
- ListFunctionsByCodeSigningConfigResponseTypeDef
- ListTagsResponseTypeDef
- PutFunctionCodeSigningConfigResponseTypeDef
- PutFunctionRecursionConfigResponseTypeDef
- PutProvisionedConcurrencyConfigResponseTypeDef
- PutRuntimeManagementConfigResponseTypeDef
- AliasConfigurationResponseTypeDef
- AliasConfigurationTypeDef
- CreateAliasRequestRequestTypeDef
- UpdateAliasRequestRequestTypeDef
- FunctionCodeTypeDef
- InvocationRequestRequestTypeDef
- InvokeAsyncRequestRequestTypeDef
- InvokeWithResponseStreamRequestRequestTypeDef
- LayerVersionContentInputTypeDef
- UpdateFunctionCodeRequestRequestTypeDef
- CodeSigningConfigTypeDef
- CreateCodeSigningConfigRequestRequestTypeDef
- UpdateCodeSigningConfigRequestRequestTypeDef
- CreateFunctionUrlConfigResponseTypeDef
- FunctionUrlConfigTypeDef
- GetFunctionUrlConfigResponseTypeDef
- UpdateFunctionUrlConfigResponseTypeDef
- CreateFunctionUrlConfigRequestRequestTypeDef
- UpdateFunctionUrlConfigRequestRequestTypeDef
- UpdateFunctionConfigurationRequestRequestTypeDef
- DestinationConfigTypeDef
- EnvironmentResponseTypeDef
- FilterCriteriaOutputTypeDef
- FilterCriteriaTypeDef
- GetFunctionConfigurationRequestWaitTypeDef
- GetFunctionRequestWaitTypeDef
- GetLayerVersionResponseTypeDef
- PublishLayerVersionResponseTypeDef
- ImageConfigResponseTypeDef
- InvokeWithResponseStreamResponseEventTypeDef
- LayersListItemTypeDef
- ListLayerVersionsResponseTypeDef
- ListAliasesRequestPaginateTypeDef
- ListCodeSigningConfigsRequestPaginateTypeDef
- ListEventSourceMappingsRequestPaginateTypeDef
- ListFunctionEventInvokeConfigsRequestPaginateTypeDef
- ListFunctionUrlConfigsRequestPaginateTypeDef
- ListFunctionsByCodeSigningConfigRequestPaginateTypeDef
- ListFunctionsRequestPaginateTypeDef
- ListLayerVersionsRequestPaginateTypeDef
- ListLayersRequestPaginateTypeDef
- ListProvisionedConcurrencyConfigsRequestPaginateTypeDef
- ListVersionsByFunctionRequestPaginateTypeDef
- ListProvisionedConcurrencyConfigsResponseTypeDef
- RuntimeVersionConfigTypeDef
- ListAliasesResponseTypeDef
- CreateFunctionRequestRequestTypeDef
- PublishLayerVersionRequestRequestTypeDef
- CreateCodeSigningConfigResponseTypeDef
- GetCodeSigningConfigResponseTypeDef
- ListCodeSigningConfigsResponseTypeDef
- UpdateCodeSigningConfigResponseTypeDef
- ListFunctionUrlConfigsResponseTypeDef
- FunctionEventInvokeConfigResponseTypeDef
- FunctionEventInvokeConfigTypeDef
- PutFunctionEventInvokeConfigRequestRequestTypeDef
- UpdateFunctionEventInvokeConfigRequestRequestTypeDef
- EventSourceMappingConfigurationResponseTypeDef
- EventSourceMappingConfigurationTypeDef
- CreateEventSourceMappingRequestRequestTypeDef
- UpdateEventSourceMappingRequestRequestTypeDef
- InvokeWithResponseStreamResponseTypeDef
- ListLayersResponseTypeDef
- FunctionConfigurationResponseTypeDef
- FunctionConfigurationTypeDef
- ListFunctionEventInvokeConfigsResponseTypeDef
- ListEventSourceMappingsResponseTypeDef
- GetFunctionResponseTypeDef
- ListFunctionsResponseTypeDef
- ListVersionsByFunctionResponseTypeDef