aws_lambda
AWS Lambda
Overview
This is the AWS Lambda API Reference.
The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.Summary
Functions
-
add_layer_version_permission(Client, LayerName, VersionNumber, Input)
Adds permissions to the resource-based policy of a version of an AWS Lambda layer.
- add_layer_version_permission(Client, LayerName, VersionNumber, Input0, Options0)
-
add_permission(Client, FunctionName, Input)
Grants an AWS service or another account permission to use a function.
- add_permission(Client, FunctionName, Input0, Options0)
-
create_alias(Client, FunctionName, Input)
Creates an alias for a Lambda function version.
- create_alias(Client, FunctionName, Input0, Options0)
-
create_code_signing_config(Client, Input)
Creates a code signing configuration.
- create_code_signing_config(Client, Input0, Options0)
-
create_event_source_mapping(Client, Input)
Creates a mapping between an event source and an AWS Lambda function.
- create_event_source_mapping(Client, Input0, Options0)
-
create_function(Client, Input)
Creates a Lambda function.
- create_function(Client, Input0, Options0)
-
delete_alias(Client, FunctionName, Name, Input)
Deletes a Lambda function alias.
- delete_alias(Client, FunctionName, Name, Input0, Options0)
-
delete_code_signing_config(Client, CodeSigningConfigArn, Input)
Deletes the code signing configuration.
- delete_code_signing_config(Client, CodeSigningConfigArn, Input0, Options0)
-
delete_event_source_mapping(Client, UUID, Input)
Deletes an event source mapping.
- delete_event_source_mapping(Client, UUID, Input0, Options0)
-
delete_function(Client, FunctionName, Input)
Deletes a Lambda function.
- delete_function(Client, FunctionName, Input0, Options0)
-
delete_function_code_signing_config(Client, FunctionName, Input)
Removes the code signing configuration from the function.
- delete_function_code_signing_config(Client, FunctionName, Input0, Options0)
-
delete_function_concurrency(Client, FunctionName, Input)
Removes a concurrent execution limit from a function.
- delete_function_concurrency(Client, FunctionName, Input0, Options0)
-
delete_function_event_invoke_config(Client, FunctionName, Input)
Deletes the configuration for asynchronous invocation for a function, version, or alias.
- delete_function_event_invoke_config(Client, FunctionName, Input0, Options0)
-
delete_layer_version(Client, LayerName, VersionNumber, Input)
Deletes a version of an AWS Lambda layer.
- delete_layer_version(Client, LayerName, VersionNumber, Input0, Options0)
-
delete_provisioned_concurrency_config(Client, FunctionName, Input)
Deletes the provisioned concurrency configuration for a function.
- delete_provisioned_concurrency_config(Client, FunctionName, Input0, Options0)
-
get_account_settings(Client)
Retrieves details about your account's limits and usage in an AWS Region.
- get_account_settings(Client, QueryMap, HeadersMap)
- get_account_settings(Client, QueryMap, HeadersMap, Options0)
-
get_alias(Client, FunctionName, Name)
Returns details about a Lambda function alias.
- get_alias(Client, FunctionName, Name, QueryMap, HeadersMap)
- get_alias(Client, FunctionName, Name, QueryMap, HeadersMap, Options0)
-
get_code_signing_config(Client, CodeSigningConfigArn)
Returns information about the specified code signing configuration.
- get_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap)
- get_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap, Options0)
-
get_event_source_mapping(Client, UUID)
Returns details about an event source mapping.
- get_event_source_mapping(Client, UUID, QueryMap, HeadersMap)
- get_event_source_mapping(Client, UUID, QueryMap, HeadersMap, Options0)
-
get_function(Client, FunctionName)
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes.
- get_function(Client, FunctionName, QueryMap, HeadersMap)
- get_function(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
get_function_code_signing_config(Client, FunctionName)
Returns the code signing configuration for the specified function.
- get_function_code_signing_config(Client, FunctionName, QueryMap, HeadersMap)
- get_function_code_signing_config(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
get_function_concurrency(Client, FunctionName)
Returns details about the reserved concurrency configuration for a function.
- get_function_concurrency(Client, FunctionName, QueryMap, HeadersMap)
- get_function_concurrency(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
get_function_configuration(Client, FunctionName)
Returns the version-specific settings of a Lambda function or version.
- get_function_configuration(Client, FunctionName, QueryMap, HeadersMap)
- get_function_configuration(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
get_function_event_invoke_config(Client, FunctionName)
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
- get_function_event_invoke_config(Client, FunctionName, QueryMap, HeadersMap)
- get_function_event_invoke_config(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
get_layer_version(Client, LayerName, VersionNumber)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
- get_layer_version(Client, LayerName, VersionNumber, QueryMap, HeadersMap)
- get_layer_version(Client, LayerName, VersionNumber, QueryMap, HeadersMap, Options0)
-
get_layer_version_by_arn(Client, Arn)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
- get_layer_version_by_arn(Client, Arn, QueryMap, HeadersMap)
- get_layer_version_by_arn(Client, Arn, QueryMap, HeadersMap, Options0)
-
get_layer_version_policy(Client, LayerName, VersionNumber)
Returns the permission policy for a version of an AWS Lambda layer.
- get_layer_version_policy(Client, LayerName, VersionNumber, QueryMap, HeadersMap)
- get_layer_version_policy(Client, LayerName, VersionNumber, QueryMap, HeadersMap, Options0)
-
get_policy(Client, FunctionName)
Returns the resource-based IAM policy for a function, version, or alias.
- get_policy(Client, FunctionName, QueryMap, HeadersMap)
- get_policy(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
get_provisioned_concurrency_config(Client, FunctionName, Qualifier)
Retrieves the provisioned concurrency configuration for a function's alias or version.
- get_provisioned_concurrency_config(Client, FunctionName, Qualifier, QueryMap, HeadersMap)
- get_provisioned_concurrency_config(Client, FunctionName, Qualifier, QueryMap, HeadersMap, Options0)
-
invoke(Client, FunctionName, Input)
Invokes a Lambda function.
- invoke(Client, FunctionName, Input0, Options0)
-
invoke_async(Client, FunctionName, Input)
For asynchronous function invocation, use
Invoke
. - invoke_async(Client, FunctionName, Input0, Options0)
-
list_aliases(Client, FunctionName)
Returns a list of aliases for a Lambda function.
- list_aliases(Client, FunctionName, QueryMap, HeadersMap)
- list_aliases(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
list_code_signing_configs(Client)
Returns a list of code signing configurations.
- list_code_signing_configs(Client, QueryMap, HeadersMap)
- list_code_signing_configs(Client, QueryMap, HeadersMap, Options0)
-
list_event_source_mappings(Client)
Lists event source mappings.
- list_event_source_mappings(Client, QueryMap, HeadersMap)
- list_event_source_mappings(Client, QueryMap, HeadersMap, Options0)
-
list_function_event_invoke_configs(Client, FunctionName)
Retrieves a list of configurations for asynchronous invocation for a function.
- list_function_event_invoke_configs(Client, FunctionName, QueryMap, HeadersMap)
- list_function_event_invoke_configs(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
list_functions(Client)
Returns a list of Lambda functions, with the version-specific configuration of each.
- list_functions(Client, QueryMap, HeadersMap)
- list_functions(Client, QueryMap, HeadersMap, Options0)
-
list_functions_by_code_signing_config(Client, CodeSigningConfigArn)
List the functions that use the specified code signing configuration.
- list_functions_by_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap)
- list_functions_by_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap, Options0)
-
list_layer_versions(Client, LayerName)
Lists the versions of an AWS Lambda layer.
- list_layer_versions(Client, LayerName, QueryMap, HeadersMap)
- list_layer_versions(Client, LayerName, QueryMap, HeadersMap, Options0)
-
list_layers(Client)
Lists AWS Lambda layers and shows information about the latest version of each.
- list_layers(Client, QueryMap, HeadersMap)
- list_layers(Client, QueryMap, HeadersMap, Options0)
-
list_provisioned_concurrency_configs(Client, FunctionName)
Retrieves a list of provisioned concurrency configurations for a function.
- list_provisioned_concurrency_configs(Client, FunctionName, QueryMap, HeadersMap)
- list_provisioned_concurrency_configs(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
list_tags(Client, Resource)
Returns a function's tags.
- list_tags(Client, Resource, QueryMap, HeadersMap)
- list_tags(Client, Resource, QueryMap, HeadersMap, Options0)
-
list_versions_by_function(Client, FunctionName)
Returns a list of versions, with the version-specific configuration of each.
- list_versions_by_function(Client, FunctionName, QueryMap, HeadersMap)
- list_versions_by_function(Client, FunctionName, QueryMap, HeadersMap, Options0)
-
publish_layer_version(Client, LayerName, Input)
Creates an AWS Lambda layer from a ZIP archive.
- publish_layer_version(Client, LayerName, Input0, Options0)
-
publish_version(Client, FunctionName, Input)
Creates a version from the current code and configuration of a function.
- publish_version(Client, FunctionName, Input0, Options0)
-
put_function_code_signing_config(Client, FunctionName, Input)
Update the code signing configuration for the function.
- put_function_code_signing_config(Client, FunctionName, Input0, Options0)
-
put_function_concurrency(Client, FunctionName, Input)
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
- put_function_concurrency(Client, FunctionName, Input0, Options0)
-
put_function_event_invoke_config(Client, FunctionName, Input)
Configures options for asynchronous invocation on a function, version, or alias.
- put_function_event_invoke_config(Client, FunctionName, Input0, Options0)
-
put_provisioned_concurrency_config(Client, FunctionName, Input)
Adds a provisioned concurrency configuration to a function's alias or version.
- put_provisioned_concurrency_config(Client, FunctionName, Input0, Options0)
-
remove_layer_version_permission(Client, LayerName, StatementId, VersionNumber, Input)
Removes a statement from the permissions policy for a version of an AWS Lambda layer.
- remove_layer_version_permission(Client, LayerName, StatementId, VersionNumber, Input0, Options0)
-
remove_permission(Client, FunctionName, StatementId, Input)
Revokes function-use permission from an AWS service or another account.
- remove_permission(Client, FunctionName, StatementId, Input0, Options0)
-
tag_resource(Client, Resource, Input)
Adds tags to a function.
- tag_resource(Client, Resource, Input0, Options0)
-
untag_resource(Client, Resource, Input)
Removes tags from a function.
- untag_resource(Client, Resource, Input0, Options0)
-
update_alias(Client, FunctionName, Name, Input)
Updates the configuration of a Lambda function alias.
- update_alias(Client, FunctionName, Name, Input0, Options0)
-
update_code_signing_config(Client, CodeSigningConfigArn, Input)
Update the code signing configuration.
- update_code_signing_config(Client, CodeSigningConfigArn, Input0, Options0)
-
update_event_source_mapping(Client, UUID, Input)
Updates an event source mapping.
- update_event_source_mapping(Client, UUID, Input0, Options0)
-
update_function_code(Client, FunctionName, Input)
Updates a Lambda function's code.
- update_function_code(Client, FunctionName, Input0, Options0)
-
update_function_configuration(Client, FunctionName, Input)
Modify the version-specific settings of a Lambda function.
- update_function_configuration(Client, FunctionName, Input0, Options0)
-
update_function_event_invoke_config(Client, FunctionName, Input)
Updates the configuration for asynchronous invocation for a function, version, or alias.
- update_function_event_invoke_config(Client, FunctionName, Input0, Options0)
Functions
add_layer_version_permission(Client, LayerName, VersionNumber, Input)
Adds permissions to the resource-based policy of a version of an AWS Lambda layer.
Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.
To revoke permission, callRemoveLayerVersionPermission
with the
statement ID that you specified when you added it.
add_layer_version_permission(Client, LayerName, VersionNumber, Input0, Options0)
add_permission(Client, FunctionName, Input)
Grants an AWS service or another account permission to use a function.
You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.
To grant permission to another account, specify the account ID as the
Principal
. For AWS services, the principal is a domain-style identifier
defined by the service, like s3.amazonaws.com
or sns.amazonaws.com
.
For AWS services, you can also specify the ARN of the associated resource
as the SourceArn
. If you grant permission to a service principal without
specifying the source, other accounts could potentially configure
resources in their account to invoke your Lambda function.
add_permission(Client, FunctionName, Input0, Options0)
create_alias(Client, FunctionName, Input)
Creates an alias for a Lambda function version.
Use aliases to provide clients with a function identifier that you can update to invoke a different version.
You can also map an alias to split invocation requests between two versions. Use theRoutingConfig
parameter to specify a second version
and the percentage of invocation requests that it receives.
create_alias(Client, FunctionName, Input0, Options0)
create_code_signing_config(Client, Input)
Creates a code signing configuration.
A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).create_code_signing_config(Client, Input0, Options0)
create_event_source_mapping(Client, Input)
Creates a mapping between an event source and an AWS Lambda function.
Lambda reads items from the event source and triggers the function.
For details about each event source type, see the following topics.
Using AWS Lambda with Amazon DynamoDB
Using AWS Lambda with Amazon Kinesis
Using AWS Lambda with Amazon SQS
Using AWS Lambda with Amazon MQ
Using AWS Lambda with Amazon MSK
Using AWS Lambda with Self-Managed Apache Kafka
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError
- If the function returns an error, split the batch in two and retry.DestinationConfig
- Send discarded records to an Amazon SQS queue or Amazon SNS topic.MaximumRecordAgeInSeconds
- Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expiresMaximumRetryAttempts
- Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.ParallelizationFactor
- Process multiple batches from each shard concurrently.
create_event_source_mapping(Client, Input0, Options0)
create_function(Client, Input)
Creates a Lambda function.
To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.
When you create a function, Lambda provisions an instance of the function
and its supporting resources. If your function connects to a VPC, this
process can take a minute or so. During this time, you can't invoke or
modify the function. The State
, StateReason
, and StateReasonCode
fields in the response from GetFunctionConfiguration
indicate when the
function is ready to invoke. For more information, see Function States.
A function has an unpublished version, and can have published versions and
aliases. The unpublished version changes when you update your function's
code and configuration. A published version is a snapshot of your function
code and configuration that can't be changed. An alias is a named resource
that maps to a version, and can be changed to map to a different version.
Use the Publish
parameter to create version 1
of your function from
its initial configuration.
The other parameters let you configure version-specific and function-level
settings. You can modify version-specific settings later with
UpdateFunctionConfiguration
. Function-level settings apply to both the
unpublished and published versions of the function, and include tags
(TagResource
) and per-function concurrency limits
(PutFunctionConcurrency
).
You can use code signing if your deployment package is a .zip file
archive. To enable code signing for this function, specify the ARN of a
code-signing configuration. When a user attempts to deploy a code package
with UpdateFunctionCode
, Lambda checks that the code package has a valid
signature from a trusted publisher. The code-signing configuration
includes set set of signing profiles, which define the trusted publishers
for this function.
If another account or an AWS service invokes your function, use
AddPermission
to grant permission by creating a resource-based IAM
policy. You can grant permissions at the function level, on a version, or
on an alias.
Invoke
. To invoke your function in
response to events in other AWS services, create an event source mapping
(CreateEventSourceMapping
), or configure a function trigger in the other
service. For more information, see Invoking Functions.
create_function(Client, Input0, Options0)
delete_alias(Client, FunctionName, Name, Input)
Deletes a Lambda function alias.
delete_alias(Client, FunctionName, Name, Input0, Options0)
delete_code_signing_config(Client, CodeSigningConfigArn, Input)
Deletes the code signing configuration.
You can delete the code signing configuration only if no function is using it.delete_code_signing_config(Client, CodeSigningConfigArn, Input0, Options0)
delete_event_source_mapping(Client, UUID, Input)
Deletes an event source mapping.
You can get the identifier of a mapping from the output of
ListEventSourceMappings
.
Deleting
state and
might not be completely deleted for several seconds.
delete_event_source_mapping(Client, UUID, Input0, Options0)
delete_function(Client, FunctionName, Input)
Deletes a Lambda function.
To delete a specific function version, use the Qualifier
parameter.
Otherwise, all versions and aliases are deleted.
DeleteEventSourceMapping
. For AWS services and resources that invoke
your function directly, delete the trigger in the service where you
originally configured it.
delete_function(Client, FunctionName, Input0, Options0)
delete_function_code_signing_config(Client, FunctionName, Input)
Removes the code signing configuration from the function.
delete_function_code_signing_config(Client, FunctionName, Input0, Options0)
delete_function_concurrency(Client, FunctionName, Input)
Removes a concurrent execution limit from a function.
delete_function_concurrency(Client, FunctionName, Input0, Options0)
delete_function_event_invoke_config(Client, FunctionName, Input)
Deletes the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, usePutFunctionEventInvokeConfig
.
delete_function_event_invoke_config(Client, FunctionName, Input0, Options0)
delete_layer_version(Client, LayerName, VersionNumber, Input)
Deletes a version of an AWS Lambda layer.
Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.delete_layer_version(Client, LayerName, VersionNumber, Input0, Options0)
delete_provisioned_concurrency_config(Client, FunctionName, Input)
Deletes the provisioned concurrency configuration for a function.
delete_provisioned_concurrency_config(Client, FunctionName, Input0, Options0)
get_account_settings(Client)
Retrieves details about your account's limits and usage in an AWS Region.
get_account_settings(Client, QueryMap, HeadersMap)
get_account_settings(Client, QueryMap, HeadersMap, Options0)
get_alias(Client, FunctionName, Name)
Returns details about a Lambda function alias.
get_alias(Client, FunctionName, Name, QueryMap, HeadersMap)
get_alias(Client, FunctionName, Name, QueryMap, HeadersMap, Options0)
get_code_signing_config(Client, CodeSigningConfigArn)
Returns information about the specified code signing configuration.
get_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap)
get_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap, Options0)
get_event_source_mapping(Client, UUID)
Returns details about an event source mapping.
You can get the identifier of a mapping from the output ofListEventSourceMappings
.
get_event_source_mapping(Client, UUID, QueryMap, HeadersMap)
get_event_source_mapping(Client, UUID, QueryMap, HeadersMap, Options0)
get_function(Client, FunctionName)
Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes.
If you specify a function version, only details that are specific to that version are returned.get_function(Client, FunctionName, QueryMap, HeadersMap)
get_function(Client, FunctionName, QueryMap, HeadersMap, Options0)
get_function_code_signing_config(Client, FunctionName)
Returns the code signing configuration for the specified function.
get_function_code_signing_config(Client, FunctionName, QueryMap, HeadersMap)
get_function_code_signing_config(Client, FunctionName, QueryMap, HeadersMap, Options0)
get_function_concurrency(Client, FunctionName)
Returns details about the reserved concurrency configuration for a function.
To set a concurrency limit for a function, usePutFunctionConcurrency
.
get_function_concurrency(Client, FunctionName, QueryMap, HeadersMap)
get_function_concurrency(Client, FunctionName, QueryMap, HeadersMap, Options0)
get_function_configuration(Client, FunctionName)
Returns the version-specific settings of a Lambda function or version.
The output includes only options that can vary between versions of a
function. To modify these settings, use UpdateFunctionConfiguration
.
GetFunction
.
get_function_configuration(Client, FunctionName, QueryMap, HeadersMap)
get_function_configuration(Client, FunctionName, QueryMap, HeadersMap, Options0)
get_function_event_invoke_config(Client, FunctionName)
Retrieves the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, usePutFunctionEventInvokeConfig
.
get_function_event_invoke_config(Client, FunctionName, QueryMap, HeadersMap)
get_function_event_invoke_config(Client, FunctionName, QueryMap, HeadersMap, Options0)
get_layer_version(Client, LayerName, VersionNumber)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
get_layer_version(Client, LayerName, VersionNumber, QueryMap, HeadersMap)
get_layer_version(Client, LayerName, VersionNumber, QueryMap, HeadersMap, Options0)
get_layer_version_by_arn(Client, Arn)
Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.
get_layer_version_by_arn(Client, Arn, QueryMap, HeadersMap)
get_layer_version_by_arn(Client, Arn, QueryMap, HeadersMap, Options0)
get_layer_version_policy(Client, LayerName, VersionNumber)
Returns the permission policy for a version of an AWS Lambda layer.
For more information, seeAddLayerVersionPermission
.
get_layer_version_policy(Client, LayerName, VersionNumber, QueryMap, HeadersMap)
get_layer_version_policy(Client, LayerName, VersionNumber, QueryMap, HeadersMap, Options0)
get_policy(Client, FunctionName)
Returns the resource-based IAM policy for a function, version, or alias.
get_policy(Client, FunctionName, QueryMap, HeadersMap)
get_policy(Client, FunctionName, QueryMap, HeadersMap, Options0)
get_provisioned_concurrency_config(Client, FunctionName, Qualifier)
Retrieves the provisioned concurrency configuration for a function's alias or version.
get_provisioned_concurrency_config(Client, FunctionName, Qualifier, QueryMap, HeadersMap)
get_provisioned_concurrency_config(Client, FunctionName, Qualifier, QueryMap, HeadersMap, Options0)
invoke(Client, FunctionName, Input)
Invokes a Lambda function.
You can invoke a function synchronously (and wait for the response), or
asynchronously. To invoke a function asynchronously, set InvocationType
to Event
.
For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace.
When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior.
For asynchronous invocation, Lambda adds events to a queue before sending them to your function. If your function does not have enough capacity to keep up with the queue, events may be lost. Occasionally, your function may receive the same event multiple times, even if no error occurs. To retain events that were not processed, configure your function with a dead-letter queue.
The status code in the API response doesn't reflect function errors. Error
codes are reserved for errors that prevent your function from executing,
such as permissions errors, limit errors, or issues with your function's
code and configuration. For example, Lambda returns
TooManyRequestsException
if executing the function would cause you to
exceed a concurrency limit at either the account level
(ConcurrentInvocationLimitExceeded
) or function level
(ReservedFunctionConcurrentInvocationLimitExceeded
).
For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.
This operation requires permission for the lambda:InvokeFunction action.invoke(Client, FunctionName, Input0, Options0)
invoke_async(Client, FunctionName, Input)
For asynchronous function invocation, use Invoke
.
invoke_async(Client, FunctionName, Input0, Options0)
list_aliases(Client, FunctionName)
Returns a list of aliases for a Lambda function.
list_aliases(Client, FunctionName, QueryMap, HeadersMap)
list_aliases(Client, FunctionName, QueryMap, HeadersMap, Options0)
list_code_signing_configs(Client)
Returns a list of code signing configurations.
A request returns up to 10,000 configurations per call. You can use theMaxItems
parameter to return fewer configurations per call.
list_code_signing_configs(Client, QueryMap, HeadersMap)
list_code_signing_configs(Client, QueryMap, HeadersMap, Options0)
list_event_source_mappings(Client)
Lists event source mappings.
Specify anEventSourceArn
to only show event source mappings for a
single event source.
list_event_source_mappings(Client, QueryMap, HeadersMap)
list_event_source_mappings(Client, QueryMap, HeadersMap, Options0)
list_function_event_invoke_configs(Client, FunctionName)
Retrieves a list of configurations for asynchronous invocation for a function.
To configure options for asynchronous invocation, usePutFunctionEventInvokeConfig
.
list_function_event_invoke_configs(Client, FunctionName, QueryMap, HeadersMap)
list_function_event_invoke_configs(Client, FunctionName, QueryMap, HeadersMap, Options0)
list_functions(Client)
Returns a list of Lambda functions, with the version-specific configuration of each.
Lambda returns up to 50 functions per call.
SetFunctionVersion
to ALL
to include all published versions of each
function in addition to the unpublished version. To get more information
about a function or version, use GetFunction
.
list_functions(Client, QueryMap, HeadersMap)
list_functions(Client, QueryMap, HeadersMap, Options0)
list_functions_by_code_signing_config(Client, CodeSigningConfigArn)
List the functions that use the specified code signing configuration.
You can use this method prior to deleting a code signing configuration, to verify that no functions are using it.list_functions_by_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap)
list_functions_by_code_signing_config(Client, CodeSigningConfigArn, QueryMap, HeadersMap, Options0)
list_layer_versions(Client, LayerName)
Lists the versions of an AWS Lambda layer.
Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.list_layer_versions(Client, LayerName, QueryMap, HeadersMap)
list_layer_versions(Client, LayerName, QueryMap, HeadersMap, Options0)
list_layers(Client)
Lists AWS Lambda layers and shows information about the latest version of each.
Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.list_layers(Client, QueryMap, HeadersMap)
list_layers(Client, QueryMap, HeadersMap, Options0)
list_provisioned_concurrency_configs(Client, FunctionName)
Retrieves a list of provisioned concurrency configurations for a function.
list_provisioned_concurrency_configs(Client, FunctionName, QueryMap, HeadersMap)
list_provisioned_concurrency_configs(Client, FunctionName, QueryMap, HeadersMap, Options0)
list_tags(Client, Resource)
Returns a function's tags.
You can also view tags withGetFunction
.
list_tags(Client, Resource, QueryMap, HeadersMap)
list_tags(Client, Resource, QueryMap, HeadersMap, Options0)
list_versions_by_function(Client, FunctionName)
Returns a list of versions, with the version-specific configuration of each.
Lambda returns up to 50 versions per call.list_versions_by_function(Client, FunctionName, QueryMap, HeadersMap)
list_versions_by_function(Client, FunctionName, QueryMap, HeadersMap, Options0)
publish_layer_version(Client, LayerName, Input)
Creates an AWS Lambda layer from a ZIP archive.
Each time you call PublishLayerVersion
with the same layer name, a new
version is created.
CreateFunction
or
UpdateFunctionConfiguration
.
publish_layer_version(Client, LayerName, Input0, Options0)
publish_version(Client, FunctionName, Input)
Creates a version from the current code and configuration of a function.
Use versions to create a snapshot of your function code and configuration that doesn't change.
AWS Lambda doesn't publish a version if the function's configuration and
code haven't changed since the last version. Use UpdateFunctionCode
or
UpdateFunctionConfiguration
to update the function before publishing a
version.
CreateAlias
.
publish_version(Client, FunctionName, Input0, Options0)
put_function_code_signing_config(Client, FunctionName, Input)
Update the code signing configuration for the function.
Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.put_function_code_signing_config(Client, FunctionName, Input0, Options0)
put_function_concurrency(Client, FunctionName, Input)
Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.
Concurrency settings apply to the function as a whole, including all
published versions and the unpublished version. Reserving concurrency both
ensures that your function has capacity to process the specified number of
events simultaneously, and prevents it from scaling beyond that level. Use
GetFunction
to see the current setting for a function.
GetAccountSettings
to see your Regional concurrency limit. You can
reserve concurrency for as many functions as you like, as long as you
leave at least 100 simultaneous executions unreserved for functions that
aren't configured with a per-function limit. For more information, see
Managing Concurrency.
put_function_concurrency(Client, FunctionName, Input0, Options0)
put_function_event_invoke_config(Client, FunctionName, Input)
Configures options for asynchronous invocation on a function, version, or alias.
If a configuration already exists for a function, version, or alias, this
operation overwrites it. If you exclude any settings, they are removed. To
set one option without affecting existing settings for other options, use
UpdateFunctionEventInvokeConfig
.
By default, Lambda retries an asynchronous invocation twice if the
function returns an error. It retains events in a queue for up to six
hours. When an event fails all processing attempts or stays in the
asynchronous invocation queue for too long, Lambda discards it. To retain
discarded events, configure a dead-letter queue with
UpdateFunctionConfiguration
.
put_function_event_invoke_config(Client, FunctionName, Input0, Options0)
put_provisioned_concurrency_config(Client, FunctionName, Input)
Adds a provisioned concurrency configuration to a function's alias or version.
put_provisioned_concurrency_config(Client, FunctionName, Input0, Options0)
remove_layer_version_permission(Client, LayerName, StatementId, VersionNumber, Input)
Removes a statement from the permissions policy for a version of an AWS Lambda layer.
For more information, seeAddLayerVersionPermission
.
remove_layer_version_permission(Client, LayerName, StatementId, VersionNumber, Input0, Options0)
remove_permission(Client, FunctionName, StatementId, Input)
Revokes function-use permission from an AWS service or another account.
You can get the ID of the statement from the output ofGetPolicy
.
remove_permission(Client, FunctionName, StatementId, Input0, Options0)
tag_resource(Client, Resource, Input)
Adds tags to a function.
tag_resource(Client, Resource, Input0, Options0)
untag_resource(Client, Resource, Input)
Removes tags from a function.
untag_resource(Client, Resource, Input0, Options0)
update_alias(Client, FunctionName, Name, Input)
Updates the configuration of a Lambda function alias.
update_alias(Client, FunctionName, Name, Input0, Options0)
update_code_signing_config(Client, CodeSigningConfigArn, Input)
Update the code signing configuration.
Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.update_code_signing_config(Client, CodeSigningConfigArn, Input0, Options0)
update_event_source_mapping(Client, UUID, Input)
Updates an event source mapping.
You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.
The following error handling options are only available for stream sources (DynamoDB and Kinesis):
BisectBatchOnFunctionError
- If the function returns an error, split the batch in two and retry.DestinationConfig
- Send discarded records to an Amazon SQS queue or Amazon SNS topic.MaximumRecordAgeInSeconds
- Discard records older than the specified age. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expiresMaximumRetryAttempts
- Discard records after the specified number of retries. The default value is infinite (-1). When set to infinite (-1), failed records are retried until the record expires.ParallelizationFactor
- Process multiple batches from each shard concurrently.
update_event_source_mapping(Client, UUID, Input0, Options0)
update_function_code(Client, FunctionName, Input)
Updates a Lambda function's code.
If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing.
The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.
For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.update_function_code(Client, FunctionName, Input0, Options0)
update_function_configuration(Client, FunctionName, Input)
Modify the version-specific settings of a Lambda function.
When you update a function, Lambda provisions an instance of the function
and its supporting resources. If your function connects to a VPC, this
process can take a minute. During this time, you can't modify the
function, but you can still invoke it. The LastUpdateStatus
,
LastUpdateStatusReason
, and LastUpdateStatusReasonCode
fields in the
response from GetFunctionConfiguration
indicate when the update is
complete and the function is processing events with the new configuration.
For more information, see Function States.
These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.
To configure function concurrency, usePutFunctionConcurrency
. To grant
invoke permissions to an account or AWS service, use AddPermission
.
update_function_configuration(Client, FunctionName, Input0, Options0)
update_function_event_invoke_config(Client, FunctionName, Input)
Updates the configuration for asynchronous invocation for a function, version, or alias.
To configure options for asynchronous invocation, usePutFunctionEventInvokeConfig
.