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.42.2' mypy-boto3-builder - Select
boto3-stubsAWS SDK. - Add
Lambdaservice. - 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("...").
# GetDurableExecutionHistoryPaginator usage example
from boto3.session import Session
from mypy_boto3_lambda.paginator import GetDurableExecutionHistoryPaginator
def get_get_durable_execution_history_paginator() -> GetDurableExecutionHistoryPaginator:
return Session().client("lambda").get_paginator("get_durable_execution_history"))
- GetDurableExecutionHistoryPaginator
- GetDurableExecutionStatePaginator
- ListAliasesPaginator
- ListCapacityProvidersPaginator
- ListCodeSigningConfigsPaginator
- ListDurableExecutionsByFunctionPaginator
- ListEventSourceMappingsPaginator
- ListFunctionEventInvokeConfigsPaginator
- ListFunctionUrlConfigsPaginator
- ListFunctionVersionsByCapacityProviderPaginator
- 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
- CapacityProviderPredefinedMetricTypeType
- CapacityProviderScalingModeType
- CapacityProviderStateType
- CodeSigningPolicyType
- EndPointTypeType
- EventSourceMappingMetricType
- EventSourcePositionType
- EventTypeType
- ExecutionStatusType
- FullDocumentType
- FunctionActiveV2WaiterName
- FunctionActiveWaiterName
- FunctionExistsWaiterName
- FunctionResponseTypeType
- FunctionUpdatedV2WaiterName
- FunctionUpdatedWaiterName
- FunctionUrlAuthTypeType
- FunctionVersionLatestPublishedType
- FunctionVersionType
- GetDurableExecutionHistoryPaginatorName
- GetDurableExecutionStatePaginatorName
- InvocationTypeType
- InvokeModeType
- KafkaSchemaRegistryAuthTypeType
- KafkaSchemaValidationAttributeType
- LastUpdateStatusReasonCodeType
- LastUpdateStatusType
- ListAliasesPaginatorName
- ListCapacityProvidersPaginatorName
- ListCodeSigningConfigsPaginatorName
- ListDurableExecutionsByFunctionPaginatorName
- ListEventSourceMappingsPaginatorName
- ListFunctionEventInvokeConfigsPaginatorName
- ListFunctionUrlConfigsPaginatorName
- ListFunctionVersionsByCapacityProviderPaginatorName
- ListFunctionsByCodeSigningConfigPaginatorName
- ListFunctionsPaginatorName
- ListLayerVersionsPaginatorName
- ListLayersPaginatorName
- ListProvisionedConcurrencyConfigsPaginatorName
- ListVersionsByFunctionPaginatorName
- LogFormatType
- LogTypeType
- OperationActionType
- OperationStatusType
- OperationTypeType
- PackageTypeType
- ProvisionedConcurrencyStatusEnumType
- PublishedVersionActiveWaiterName
- RecursiveLoopType
- ResponseStreamingInvocationTypeType
- RuntimeType
- SchemaRegistryEventRecordFormatType
- SnapStartApplyOnType
- SnapStartOptimizationStatusType
- SourceAccessTypeType
- StateReasonCodeType
- StateType
- SystemLogLevelType
- TenantIsolationModeType
- TracingModeType
- UpdateRuntimeOnType
- LambdaServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountLimitTypeDef
- AccountUsageTypeDef
- AddLayerVersionPermissionRequestTypeDef
- ResponseMetadataTypeDef
- AddPermissionRequestTypeDef
- AliasRoutingConfigurationOutputTypeDef
- AliasRoutingConfigurationTypeDef
- AllowedPublishersOutputTypeDef
- AllowedPublishersTypeDef
- BlobTypeDef
- ErrorObjectOutputTypeDef
- CallbackOptionsTypeDef
- CallbackStartedDetailsTypeDef
- EventResultTypeDef
- LambdaManagedInstancesCapacityProviderConfigTypeDef
- CapacityProviderPermissionsConfigTypeDef
- TargetTrackingScalingPolicyTypeDef
- CapacityProviderVpcConfigOutputTypeDef
- InstanceRequirementsOutputTypeDef
- CapacityProviderVpcConfigTypeDef
- ChainedInvokeOptionsTypeDef
- EventInputTypeDef
- CodeSigningPoliciesTypeDef
- ConcurrencyTypeDef
- ContextOptionsTypeDef
- CorsOutputTypeDef
- CorsTypeDef
- DocumentDBEventSourceConfigTypeDef
- ProvisionedPollerConfigTypeDef
- ScalingConfigTypeDef
- SourceAccessConfigurationTypeDef
- TimestampTypeDef
- DeadLetterConfigTypeDef
- DurableConfigTypeDef
- EnvironmentTypeDef
- EphemeralStorageTypeDef
- FileSystemConfigTypeDef
- LoggingConfigTypeDef
- SnapStartTypeDef
- TenancyConfigTypeDef
- TracingConfigTypeDef
- VpcConfigTypeDef
- DeleteAliasRequestTypeDef
- DeleteCapacityProviderRequestTypeDef
- DeleteCodeSigningConfigRequestTypeDef
- DeleteEventSourceMappingRequestTypeDef
- DeleteFunctionCodeSigningConfigRequestTypeDef
- DeleteFunctionConcurrencyRequestTypeDef
- DeleteFunctionEventInvokeConfigRequestTypeDef
- DeleteFunctionRequestTypeDef
- DeleteFunctionUrlConfigRequestTypeDef
- DeleteLayerVersionRequestTypeDef
- DeleteProvisionedConcurrencyConfigRequestTypeDef
- OnFailureTypeDef
- OnSuccessTypeDef
- EnvironmentErrorTypeDef
- ErrorObjectTypeDef
- EventSourceMappingMetricsConfigOutputTypeDef
- FilterCriteriaErrorTypeDef
- SelfManagedEventSourceOutputTypeDef
- EventSourceMappingMetricsConfigTypeDef
- WaitStartedDetailsTypeDef
- WaitSucceededDetailsTypeDef
- ExecutionDetailsTypeDef
- ExecutionTypeDef
- FilterTypeDef
- FunctionCodeLocationTypeDef
- LayerTypeDef
- SnapStartResponseTypeDef
- TracingConfigResponseTypeDef
- VpcConfigResponseTypeDef
- FunctionScalingConfigTypeDef
- FunctionVersionsByCapacityProviderListItemTypeDef
- GetAliasRequestTypeDef
- GetCapacityProviderRequestTypeDef
- GetCodeSigningConfigRequestTypeDef
- PaginatorConfigTypeDef
- GetDurableExecutionHistoryRequestTypeDef
- GetDurableExecutionRequestTypeDef
- TraceHeaderTypeDef
- GetDurableExecutionStateRequestTypeDef
- GetEventSourceMappingRequestTypeDef
- GetFunctionCodeSigningConfigRequestTypeDef
- GetFunctionConcurrencyRequestTypeDef
- GetFunctionConfigurationRequestTypeDef
- WaiterConfigTypeDef
- GetFunctionEventInvokeConfigRequestTypeDef
- GetFunctionRecursionConfigRequestTypeDef
- GetFunctionRequestTypeDef
- TagsErrorTypeDef
- GetFunctionScalingConfigRequestTypeDef
- GetFunctionUrlConfigRequestTypeDef
- GetLayerVersionByArnRequestTypeDef
- GetLayerVersionPolicyRequestTypeDef
- GetLayerVersionRequestTypeDef
- LayerVersionContentOutputTypeDef
- GetPolicyRequestTypeDef
- GetProvisionedConcurrencyConfigRequestTypeDef
- GetRuntimeManagementConfigRequestTypeDef
- ImageConfigErrorTypeDef
- ImageConfigOutputTypeDef
- ImageConfigTypeDef
- InstanceRequirementsTypeDef
- InvokeResponseStreamUpdateTypeDef
- InvokeWithResponseStreamCompleteEventTypeDef
- KafkaSchemaRegistryAccessConfigTypeDef
- KafkaSchemaValidationConfigTypeDef
- LayerVersionsListItemTypeDef
- ListAliasesRequestTypeDef
- ListCapacityProvidersRequestTypeDef
- ListCodeSigningConfigsRequestTypeDef
- ListEventSourceMappingsRequestTypeDef
- ListFunctionEventInvokeConfigsRequestTypeDef
- ListFunctionUrlConfigsRequestTypeDef
- ListFunctionVersionsByCapacityProviderRequestTypeDef
- ListFunctionsByCodeSigningConfigRequestTypeDef
- ListFunctionsRequestTypeDef
- ListLayerVersionsRequestTypeDef
- ListLayersRequestTypeDef
- ListProvisionedConcurrencyConfigsRequestTypeDef
- ProvisionedConcurrencyConfigListItemTypeDef
- ListTagsRequestTypeDef
- ListVersionsByFunctionRequestTypeDef
- WaitDetailsTypeDef
- StepOptionsTypeDef
- WaitOptionsTypeDef
- PublishVersionRequestTypeDef
- PutFunctionCodeSigningConfigRequestTypeDef
- PutFunctionConcurrencyRequestTypeDef
- PutFunctionRecursionConfigRequestTypeDef
- PutProvisionedConcurrencyConfigRequestTypeDef
- PutRuntimeManagementConfigRequestTypeDef
- RemoveLayerVersionPermissionRequestTypeDef
- RemovePermissionRequestTypeDef
- RetryDetailsTypeDef
- RuntimeVersionErrorTypeDef
- SelfManagedEventSourceTypeDef
- SendDurableExecutionCallbackHeartbeatRequestTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- AddLayerVersionPermissionResponseTypeDef
- AddPermissionResponseTypeDef
- ConcurrencyResponseTypeDef
- DeleteFunctionResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetAccountSettingsResponseTypeDef
- GetFunctionCodeSigningConfigResponseTypeDef
- GetFunctionConcurrencyResponseTypeDef
- GetFunctionRecursionConfigResponseTypeDef
- GetLayerVersionPolicyResponseTypeDef
- GetPolicyResponseTypeDef
- GetProvisionedConcurrencyConfigResponseTypeDef
- GetRuntimeManagementConfigResponseTypeDef
- InvocationResponseTypeDef
- InvokeAsyncResponseTypeDef
- ListFunctionsByCodeSigningConfigResponseTypeDef
- ListTagsResponseTypeDef
- PutFunctionCodeSigningConfigResponseTypeDef
- PutFunctionRecursionConfigResponseTypeDef
- PutFunctionScalingConfigResponseTypeDef
- PutProvisionedConcurrencyConfigResponseTypeDef
- PutRuntimeManagementConfigResponseTypeDef
- StopDurableExecutionResponseTypeDef
- AliasConfigurationResponseTypeDef
- AliasConfigurationTypeDef
- AliasRoutingConfigurationUnionTypeDef
- AllowedPublishersUnionTypeDef
- FunctionCodeTypeDef
- InvocationRequestTypeDef
- InvokeAsyncRequestTypeDef
- InvokeWithResponseStreamRequestTypeDef
- LayerVersionContentInputTypeDef
- SendDurableExecutionCallbackSuccessRequestTypeDef
- UpdateFunctionCodeRequestTypeDef
- CallbackDetailsTypeDef
- ChainedInvokeDetailsTypeDef
- ContextDetailsTypeDef
- EventErrorTypeDef
- StepDetailsTypeDef
- CallbackSucceededDetailsTypeDef
- ChainedInvokeSucceededDetailsTypeDef
- ContextSucceededDetailsTypeDef
- ExecutionSucceededDetailsTypeDef
- CapacityProviderConfigTypeDef
- CapacityProviderScalingConfigOutputTypeDef
- CapacityProviderScalingConfigTypeDef
- CapacityProviderVpcConfigUnionTypeDef
- ChainedInvokeStartedDetailsTypeDef
- ExecutionStartedDetailsTypeDef
- CodeSigningConfigTypeDef
- CreateFunctionUrlConfigResponseTypeDef
- FunctionUrlConfigTypeDef
- GetFunctionUrlConfigResponseTypeDef
- UpdateFunctionUrlConfigResponseTypeDef
- CorsUnionTypeDef
- ListDurableExecutionsByFunctionRequestTypeDef
- DestinationConfigTypeDef
- EnvironmentResponseTypeDef
- ErrorObjectUnionTypeDef
- EventSourceMappingMetricsConfigUnionTypeDef
- ListDurableExecutionsByFunctionResponseTypeDef
- FilterCriteriaOutputTypeDef
- FilterCriteriaTypeDef
- GetFunctionScalingConfigResponseTypeDef
- PutFunctionScalingConfigRequestTypeDef
- ListFunctionVersionsByCapacityProviderResponseTypeDef
- GetDurableExecutionHistoryRequestPaginateTypeDef
- GetDurableExecutionStateRequestPaginateTypeDef
- ListAliasesRequestPaginateTypeDef
- ListCapacityProvidersRequestPaginateTypeDef
- ListCodeSigningConfigsRequestPaginateTypeDef
- ListDurableExecutionsByFunctionRequestPaginateTypeDef
- ListEventSourceMappingsRequestPaginateTypeDef
- ListFunctionEventInvokeConfigsRequestPaginateTypeDef
- ListFunctionUrlConfigsRequestPaginateTypeDef
- ListFunctionVersionsByCapacityProviderRequestPaginateTypeDef
- ListFunctionsByCodeSigningConfigRequestPaginateTypeDef
- ListFunctionsRequestPaginateTypeDef
- ListLayerVersionsRequestPaginateTypeDef
- ListLayersRequestPaginateTypeDef
- ListProvisionedConcurrencyConfigsRequestPaginateTypeDef
- ListVersionsByFunctionRequestPaginateTypeDef
- GetDurableExecutionResponseTypeDef
- GetFunctionConfigurationRequestWaitExtraExtraTypeDef
- GetFunctionConfigurationRequestWaitExtraTypeDef
- GetFunctionConfigurationRequestWaitTypeDef
- GetFunctionRequestWaitExtraExtraTypeDef
- GetFunctionRequestWaitExtraTypeDef
- GetFunctionRequestWaitTypeDef
- GetLayerVersionResponseTypeDef
- PublishLayerVersionResponseTypeDef
- ImageConfigResponseTypeDef
- ImageConfigUnionTypeDef
- InstanceRequirementsUnionTypeDef
- InvokeWithResponseStreamResponseEventTypeDef
- KafkaSchemaRegistryConfigOutputTypeDef
- KafkaSchemaRegistryConfigTypeDef
- LayersListItemTypeDef
- ListLayerVersionsResponseTypeDef
- ListProvisionedConcurrencyConfigsResponseTypeDef
- StepSucceededDetailsTypeDef
- RuntimeVersionConfigTypeDef
- SelfManagedEventSourceUnionTypeDef
- ListAliasesResponseTypeDef
- CreateAliasRequestTypeDef
- UpdateAliasRequestTypeDef
- CreateCodeSigningConfigRequestTypeDef
- UpdateCodeSigningConfigRequestTypeDef
- PublishLayerVersionRequestTypeDef
- CallbackFailedDetailsTypeDef
- CallbackTimedOutDetailsTypeDef
- ChainedInvokeFailedDetailsTypeDef
- ChainedInvokeStoppedDetailsTypeDef
- ChainedInvokeTimedOutDetailsTypeDef
- ContextFailedDetailsTypeDef
- ExecutionFailedDetailsTypeDef
- ExecutionStoppedDetailsTypeDef
- ExecutionTimedOutDetailsTypeDef
- InvocationCompletedDetailsTypeDef
- StepFailedDetailsTypeDef
- WaitCancelledDetailsTypeDef
- OperationTypeDef
- CapacityProviderTypeDef
- CapacityProviderScalingConfigUnionTypeDef
- CreateCodeSigningConfigResponseTypeDef
- GetCodeSigningConfigResponseTypeDef
- ListCodeSigningConfigsResponseTypeDef
- UpdateCodeSigningConfigResponseTypeDef
- ListFunctionUrlConfigsResponseTypeDef
- CreateFunctionUrlConfigRequestTypeDef
- UpdateFunctionUrlConfigRequestTypeDef
- FunctionEventInvokeConfigResponseTypeDef
- FunctionEventInvokeConfigTypeDef
- PutFunctionEventInvokeConfigRequestTypeDef
- UpdateFunctionEventInvokeConfigRequestTypeDef
- OperationUpdateTypeDef
- SendDurableExecutionCallbackFailureRequestTypeDef
- StopDurableExecutionRequestTypeDef
- FilterCriteriaUnionTypeDef
- CreateFunctionRequestTypeDef
- UpdateFunctionConfigurationRequestTypeDef
- InvokeWithResponseStreamResponseTypeDef
- AmazonManagedKafkaEventSourceConfigOutputTypeDef
- SelfManagedKafkaEventSourceConfigOutputTypeDef
- AmazonManagedKafkaEventSourceConfigTypeDef
- SelfManagedKafkaEventSourceConfigTypeDef
- ListLayersResponseTypeDef
- FunctionConfigurationResponseTypeDef
- FunctionConfigurationTypeDef
- EventTypeDef
- CheckpointUpdatedExecutionStateTypeDef
- GetDurableExecutionStateResponseTypeDef
- CreateCapacityProviderResponseTypeDef
- DeleteCapacityProviderResponseTypeDef
- GetCapacityProviderResponseTypeDef
- ListCapacityProvidersResponseTypeDef
- UpdateCapacityProviderResponseTypeDef
- CreateCapacityProviderRequestTypeDef
- UpdateCapacityProviderRequestTypeDef
- ListFunctionEventInvokeConfigsResponseTypeDef
- CheckpointDurableExecutionRequestTypeDef
- EventSourceMappingConfigurationResponseTypeDef
- EventSourceMappingConfigurationTypeDef
- AmazonManagedKafkaEventSourceConfigUnionTypeDef
- SelfManagedKafkaEventSourceConfigUnionTypeDef
- GetFunctionResponseTypeDef
- ListFunctionsResponseTypeDef
- ListVersionsByFunctionResponseTypeDef
- GetDurableExecutionHistoryResponseTypeDef
- CheckpointDurableExecutionResponseTypeDef
- ListEventSourceMappingsResponseTypeDef
- CreateEventSourceMappingRequestTypeDef
- UpdateEventSourceMappingRequestTypeDef