Examples
Auto-generated documentation for Lambda type annotations stubs module mypy-boto3-lambda.
Client
Implicit type annotations
Can be used with boto3-stubs[lambda]
package installed.
Write your Lambda
code as usual,
type checking and code completion should work out of the box.
Client usage example
from boto3.session import Session
session = Session()
client = session.client("lambda") # (1)
result = client.add_layer_version_permission() # (2)
- client: LambdaClient
- result: AddLayerVersionPermissionResponseTypeDef
Paginator usage example
from boto3.session import Session
session = Session()
client = session.client("lambda") # (1)
paginator = client.get_paginator("list_aliases") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: LambdaClient
- paginator: ListAliasesPaginator
- item: ListAliasesResponseTypeDef
Waiter usage example
from boto3.session import Session
session = Session()
client = session.client("lambda") # (1)
waiter = client.get_waiter("function_active") # (2)
waiter.wait()
- client: LambdaClient
- waiter: FunctionActiveWaiter
Explicit type annotations
With boto3-stubs-lite[lambda]
or a standalone mypy_boto3_lambda
package, you have to explicitly specify client: LambdaClient
type annotation.
All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.
Client usage example
from boto3.session import Session
from mypy_boto3_lambda.client import LambdaClient
from mypy_boto3_lambda.type_defs import AddLayerVersionPermissionResponseTypeDef
from mypy_boto3_lambda.type_defs import AddLayerVersionPermissionRequestRequestTypeDef
session = Session()
client: LambdaClient = session.client("lambda")
kwargs: AddLayerVersionPermissionRequestRequestTypeDef = {...}
result: AddLayerVersionPermissionResponseTypeDef = client.add_layer_version_permission(**kwargs)
Paginator usage example
from boto3.session import Session
from mypy_boto3_lambda.client import LambdaClient
from mypy_boto3_lambda.paginator import ListAliasesPaginator
from mypy_boto3_lambda.type_defs import ListAliasesResponseTypeDef
session = Session()
client: LambdaClient = session.client("lambda")
paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
for item in paginator.paginate(...):
item: ListAliasesResponseTypeDef
print(item)
Waiter usage example
from boto3.session import Session
from mypy_boto3_lambda.client import LambdaClient
from mypy_boto3_lambda.waiter import FunctionActiveWaiter
session = Session()
client: LambdaClient = session.client("lambda")
waiter: FunctionActiveWaiter = client.get_waiter("function_active")
waiter.wait()