Implementation for accessing Lambda
LambdaOverview
Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.
The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.
You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.
For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..
When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..
CA certificates
Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:
Microsoft Windows versions that have updates from January 2005 or later installed contain at least one of the required CAs in their trust list.
Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), Mac OS X 10.5 (October 2007), and later versions contain at least one of the required CAs in their trust list.
Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and 7 all contain at least one of the required CAs in their default trusted CA list.
Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, including Java 6 (December 2006), 7, and 8, contain at least one of the required CAs in their default trusted CA list.
When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:
Amazon Root CA 1
Starfield Services Root Certificate Authority - G2
Starfield Class 2 Certification Authority
Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.
Inheritance Hierarchy
Namespace: Amazon.Lambda
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z
Syntax
public class AmazonLambdaClient : AmazonServiceClient IAmazonLambda, IAmazonService, IDisposable
The AmazonLambdaClient type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
AmazonLambdaClient() |
Constructs AmazonLambdaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonLambdaClient(RegionEndpoint) |
Constructs AmazonLambdaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonLambdaClient(AmazonLambdaConfig) |
Constructs AmazonLambdaClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</appSettings>
</configuration>
|
|
|
AmazonLambdaClient(AWSCredentials) |
Constructs AmazonLambdaClient with AWS Credentials |
|
|
AmazonLambdaClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonLambdaClient with AWS Credentials |
|
|
AmazonLambdaClient(AWSCredentials, AmazonLambdaConfig) |
Constructs AmazonLambdaClient with AWS Credentials and an AmazonLambdaClient Configuration object. |
|
|
AmazonLambdaClient(string, string) |
Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonLambdaClient(string, string, RegionEndpoint) |
Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonLambdaClient(string, string, AmazonLambdaConfig) |
Constructs AmazonLambdaClient with AWS Access Key ID, AWS Secret Key and an AmazonLambdaClient Configuration object. |
|
|
AmazonLambdaClient(string, string, string) |
Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonLambdaClient(string, string, string, RegionEndpoint) |
Constructs AmazonLambdaClient with AWS Access Key ID and AWS Secret Key |
|
|
AmazonLambdaClient(string, string, string, AmazonLambdaConfig) |
Constructs AmazonLambdaClient with AWS Access Key ID, AWS Secret Key and an AmazonLambdaClient Configuration object. |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
Paginators | Amazon.Lambda.Model.ILambdaPaginatorFactory |
Paginators for the service |
Methods
| Name | Description | |
|---|---|---|
|
|
AddLayerVersionPermission(AddLayerVersionPermissionRequest) |
Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it. |
|
|
AddLayerVersionPermissionAsync(AddLayerVersionPermissionRequest, CancellationToken) |
Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts. To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it. |
|
|
AddPermission(AddPermissionRequest) |
Grants a principal 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. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda. |
|
|
AddPermissionAsync(AddPermissionRequest, CancellationToken) |
Grants a principal 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. Note: Lambda does not support adding policies to version $LATEST.
To grant permission to another account, specify the account ID as the This operation adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Using resource-based policies for Lambda. |
|
|
CreateAlias(CreateAliasRequest) |
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 the
|
|
|
CreateAliasAsync(CreateAliasRequest, CancellationToken) |
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 the
|
|
|
CreateCodeSigningConfig(CreateCodeSigningConfigRequest) |
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). |
|
|
CreateCodeSigningConfigAsync(CreateCodeSigningConfigRequest, CancellationToken) |
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). |
|
|
CreateEventSourceMapping(CreateEventSourceMappingRequest) |
Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function. For details about how to configure different event sources, see the following topics. The following error handling options are available only for DynamoDB and Kinesis event sources:
For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:
For information about which configuration parameters apply to each event source, see the following topics. |
|
|
CreateEventSourceMappingAsync(CreateEventSourceMappingRequest, CancellationToken) |
Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and invokes the function. For details about how to configure different event sources, see the following topics. The following error handling options are available only for DynamoDB and Kinesis event sources:
For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:
For information about which configuration parameters apply to each event source, see the following topics. |
|
|
CreateFunction(CreateFunctionRequest) |
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 Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container
image, then you set the package type to
If the deployment package is a .zip
file archive, then you set the package type to
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
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 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 of signing profiles, which define the trusted publishers for this function. If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions. |
|
|
CreateFunctionAsync(CreateFunctionRequest, CancellationToken) |
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 Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.
If the deployment package is a container
image, then you set the package type to
If the deployment package is a .zip
file archive, then you set the package type to
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
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 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 of signing profiles, which define the trusted publishers for this function. If another Amazon Web Services account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based Identity and Access Management (IAM) policy. You can grant permissions at the function level, on a version, or on an alias. To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions. |
|
|
CreateFunctionUrlConfig(CreateFunctionUrlConfigRequest) |
Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function. |
|
|
CreateFunctionUrlConfigAsync(CreateFunctionUrlConfigRequest, CancellationToken) |
Creates a Lambda function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function. |
|
|
DeleteAlias(DeleteAliasRequest) |
Deletes a Lambda function alias. |
|
|
DeleteAliasAsync(DeleteAliasRequest, CancellationToken) |
Deletes a Lambda function alias. |
|
|
DeleteCodeSigningConfig(DeleteCodeSigningConfigRequest) |
Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it. |
|
|
DeleteCodeSigningConfigAsync(DeleteCodeSigningConfigRequest, CancellationToken) |
Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it. |
|
|
DeleteEventSourceMapping(DeleteEventSourceMappingRequest) |
Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
When you delete an event source mapping, it enters a |
|
|
DeleteEventSourceMappingAsync(DeleteEventSourceMappingRequest, CancellationToken) |
Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.
When you delete an event source mapping, it enters a |
|
|
DeleteFunction(string) | |
|
|
DeleteFunction(DeleteFunctionRequest) |
Deletes a Lambda function. To delete a specific function version, use the To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it. |
|
|
DeleteFunctionAsync(string, CancellationToken) | |
|
|
DeleteFunctionAsync(DeleteFunctionRequest, CancellationToken) |
Deletes a Lambda function. To delete a specific function version, use the To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Services services and resources that invoke your function directly, delete the trigger in the service where you originally configured it. |
|
|
DeleteFunctionCodeSigningConfig(DeleteFunctionCodeSigningConfigRequest) |
Removes the code signing configuration from the function. |
|
|
DeleteFunctionCodeSigningConfigAsync(DeleteFunctionCodeSigningConfigRequest, CancellationToken) |
Removes the code signing configuration from the function. |
|
|
DeleteFunctionConcurrency(DeleteFunctionConcurrencyRequest) |
Removes a concurrent execution limit from a function. |
|
|
DeleteFunctionConcurrencyAsync(DeleteFunctionConcurrencyRequest, CancellationToken) |
Removes a concurrent execution limit from a function. |
|
|
DeleteFunctionEventInvokeConfig(DeleteFunctionEventInvokeConfigRequest) |
Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
DeleteFunctionEventInvokeConfigAsync(DeleteFunctionEventInvokeConfigRequest, CancellationToken) |
Deletes the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
DeleteFunctionUrlConfig(DeleteFunctionUrlConfigRequest) |
Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address. |
|
|
DeleteFunctionUrlConfigAsync(DeleteFunctionUrlConfigRequest, CancellationToken) |
Deletes a Lambda function URL. When you delete a function URL, you can't recover it. Creating a new function URL results in a different URL address. |
|
|
DeleteLayerVersion(DeleteLayerVersionRequest) |
Deletes a version of an 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. |
|
|
DeleteLayerVersionAsync(DeleteLayerVersionRequest, CancellationToken) |
Deletes a version of an 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. |
|
|
DeleteProvisionedConcurrencyConfig(DeleteProvisionedConcurrencyConfigRequest) |
Deletes the provisioned concurrency configuration for a function. |
|
|
DeleteProvisionedConcurrencyConfigAsync(DeleteProvisionedConcurrencyConfigRequest, CancellationToken) |
Deletes the provisioned concurrency configuration for a function. |
|
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
GetAccountSettings(GetAccountSettingsRequest) |
Retrieves details about your account's limits and usage in an Amazon Web Services Region. |
|
|
GetAccountSettingsAsync(GetAccountSettingsRequest, CancellationToken) |
Retrieves details about your account's limits and usage in an Amazon Web Services Region. |
|
|
GetAlias(GetAliasRequest) |
Returns details about a Lambda function alias. |
|
|
GetAliasAsync(GetAliasRequest, CancellationToken) |
Returns details about a Lambda function alias. |
|
|
GetCodeSigningConfig(GetCodeSigningConfigRequest) |
Returns information about the specified code signing configuration. |
|
|
GetCodeSigningConfigAsync(GetCodeSigningConfigRequest, CancellationToken) |
Returns information about the specified code signing configuration. |
|
|
GetEventSourceMapping(GetEventSourceMappingRequest) |
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. |
|
|
GetEventSourceMappingAsync(GetEventSourceMappingRequest, CancellationToken) |
Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings. |
|
|
GetFunction(string) | |
|
|
GetFunction(GetFunctionRequest) |
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. |
|
|
GetFunctionAsync(string, CancellationToken) | |
|
|
GetFunctionAsync(GetFunctionRequest, CancellationToken) |
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. |
|
|
GetFunctionCodeSigningConfig(GetFunctionCodeSigningConfigRequest) |
Returns the code signing configuration for the specified function. |
|
|
GetFunctionCodeSigningConfigAsync(GetFunctionCodeSigningConfigRequest, CancellationToken) |
Returns the code signing configuration for the specified function. |
|
|
GetFunctionConcurrency(GetFunctionConcurrencyRequest) |
Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency. |
|
|
GetFunctionConcurrencyAsync(GetFunctionConcurrencyRequest, CancellationToken) |
Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency. |
|
|
GetFunctionConfiguration(string) | |
|
|
GetFunctionConfiguration(GetFunctionConfigurationRequest) |
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. To get all of a function's details, including function-level settings, use GetFunction. |
|
|
GetFunctionConfigurationAsync(string, CancellationToken) | |
|
|
GetFunctionConfigurationAsync(GetFunctionConfigurationRequest, CancellationToken) |
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. To get all of a function's details, including function-level settings, use GetFunction. |
|
|
GetFunctionEventInvokeConfig(GetFunctionEventInvokeConfigRequest) |
Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
GetFunctionEventInvokeConfigAsync(GetFunctionEventInvokeConfigRequest, CancellationToken) |
Retrieves the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
GetFunctionRecursionConfig(GetFunctionRecursionConfigRequest) |
Returns your function's recursive loop detection configuration. |
|
|
GetFunctionRecursionConfigAsync(GetFunctionRecursionConfigRequest, CancellationToken) |
Returns your function's recursive loop detection configuration. |
|
|
GetFunctionUrlConfig(GetFunctionUrlConfigRequest) |
Returns details about a Lambda function URL. |
|
|
GetFunctionUrlConfigAsync(GetFunctionUrlConfigRequest, CancellationToken) |
Returns details about a Lambda function URL. |
|
|
GetLayerVersion(GetLayerVersionRequest) |
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. |
|
|
GetLayerVersionAsync(GetLayerVersionRequest, CancellationToken) |
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. |
|
|
GetLayerVersionByArn(GetLayerVersionByArnRequest) |
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. |
|
|
GetLayerVersionByArnAsync(GetLayerVersionByArnRequest, CancellationToken) |
Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes. |
|
|
GetLayerVersionPolicy(GetLayerVersionPolicyRequest) |
Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. |
|
|
GetLayerVersionPolicyAsync(GetLayerVersionPolicyRequest, CancellationToken) |
Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. |
|
|
GetPolicy(GetPolicyRequest) |
Returns the resource-based IAM policy for a function, version, or alias. |
|
|
GetPolicyAsync(GetPolicyRequest, CancellationToken) |
Returns the resource-based IAM policy for a function, version, or alias. |
|
|
GetProvisionedConcurrencyConfig(GetProvisionedConcurrencyConfigRequest) |
Retrieves the provisioned concurrency configuration for a function's alias or version. |
|
|
GetProvisionedConcurrencyConfigAsync(GetProvisionedConcurrencyConfigRequest, CancellationToken) |
Retrieves the provisioned concurrency configuration for a function's alias or version. |
|
|
GetRuntimeManagementConfig(GetRuntimeManagementConfigRequest) |
Retrieves the runtime management configuration for a function's version. If the runtime
update mode is Manual, this includes the ARN of the runtime version and the
runtime update mode. If the runtime update mode is Auto or Function update,
this includes the runtime update mode and |
|
|
GetRuntimeManagementConfigAsync(GetRuntimeManagementConfigRequest, CancellationToken) |
Retrieves the runtime management configuration for a function's version. If the runtime
update mode is Manual, this includes the ARN of the runtime version and the
runtime update mode. If the runtime update mode is Auto or Function update,
this includes the runtime update mode and |
|
|
Invoke(InvokeRequest) |
Invokes a Lambda function. You can invoke a function synchronously (and wait for the
response), or asynchronously. By default, Lambda invokes your function synchronously
(i.e. the 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 Error handling and automatic retries in Lambda. 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, quota
errors, or issues with your function's code and configuration. For example, Lambda
returns For functions with a long timeout, your client might disconnect 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. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts. |
|
|
InvokeAsync(string) |
Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console.
This operation requires permission for the The InvokeArgs will be set to an empty json document. |
|
|
InvokeAsync(string, string) |
Submits an invocation request to Lambda. Upon receiving the request, Lambda executes the specified cloud function asynchronously. To see the logs generated by the cloud function execution, see the CloudWatch logs console.
This operation requires permission for the |
|
|
InvokeAsync(InvokeRequest, CancellationToken) |
Invokes a Lambda function. You can invoke a function synchronously (and wait for the
response), or asynchronously. By default, Lambda invokes your function synchronously
(i.e. the 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 Error handling and automatic retries in Lambda. 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, quota
errors, or issues with your function's code and configuration. For example, Lambda
returns For functions with a long timeout, your client might disconnect 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. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts. |
|
|
InvokeAsync(InvokeAsyncRequest) |
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously. If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on. |
|
|
InvokeAsyncAsync(InvokeAsyncRequest, CancellationToken) |
For asynchronous function invocation, use Invoke.
Invokes a function asynchronously. If you do use the InvokeAsync action, note that it doesn't support the use of X-Ray active tracing. Trace ID is not propagated to the function, even if X-Ray active tracing is turned on. |
|
|
InvokeWithResponseStream(InvokeWithResponseStreamRequest) |
Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses. This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts. |
|
|
InvokeWithResponseStreamAsync(InvokeWithResponseStreamRequest, CancellationToken) |
Configure your Lambda functions to stream response payloads back to clients. For more information, see Configuring a Lambda function to stream responses. This operation requires permission for the lambda:InvokeFunction action. For details on how to set up permissions for cross-account invocations, see Granting function access to other accounts. |
|
|
ListAliases(ListAliasesRequest) |
Returns a list of aliases for a Lambda function. |
|
|
ListAliasesAsync(ListAliasesRequest, CancellationToken) |
Returns a list of aliases for a Lambda function. |
|
|
ListCodeSigningConfigs(ListCodeSigningConfigsRequest) |
Returns a list of code
signing configurations. A request returns up to 10,000 configurations per call.
You can use the |
|
|
ListCodeSigningConfigsAsync(ListCodeSigningConfigsRequest, CancellationToken) |
Returns a list of code
signing configurations. A request returns up to 10,000 configurations per call.
You can use the |
|
|
ListEventSourceMappings(ListEventSourceMappingsRequest) |
Lists event source mappings. Specify an |
|
|
ListEventSourceMappingsAsync(ListEventSourceMappingsRequest, CancellationToken) |
Lists event source mappings. Specify an |
|
|
ListFunctionEventInvokeConfigs(ListFunctionEventInvokeConfigsRequest) |
Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
ListFunctionEventInvokeConfigsAsync(ListFunctionEventInvokeConfigsRequest, CancellationToken) |
Retrieves a list of configurations for asynchronous invocation for a function. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
ListFunctions() |
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set
The |
|
|
ListFunctions(ListFunctionsRequest) |
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set
The |
|
|
ListFunctionsAsync(CancellationToken) |
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set
The |
|
|
ListFunctionsAsync(ListFunctionsRequest, CancellationToken) |
Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.
Set
The |
|
|
ListFunctionsByCodeSigningConfig(ListFunctionsByCodeSigningConfigRequest) |
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. |
|
|
ListFunctionsByCodeSigningConfigAsync(ListFunctionsByCodeSigningConfigRequest, CancellationToken) |
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. |
|
|
ListFunctionUrlConfigs(ListFunctionUrlConfigsRequest) |
Returns a list of Lambda function URLs for the specified function. |
|
|
ListFunctionUrlConfigsAsync(ListFunctionUrlConfigsRequest, CancellationToken) |
Returns a list of Lambda function URLs for the specified function. |
|
|
ListLayers(ListLayersRequest) |
Lists 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. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture. |
|
|
ListLayersAsync(ListLayersRequest, CancellationToken) |
Lists 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. Specify a compatible architecture to include only layers that are compatible with that instruction set architecture. |
|
|
ListLayerVersions(ListLayerVersionsRequest) |
Lists the versions of an 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. Specify a compatible architecture to include only layer versions that are compatible with that architecture. |
|
|
ListLayerVersionsAsync(ListLayerVersionsRequest, CancellationToken) |
Lists the versions of an 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. Specify a compatible architecture to include only layer versions that are compatible with that architecture. |
|
|
ListProvisionedConcurrencyConfigs(ListProvisionedConcurrencyConfigsRequest) |
Retrieves a list of provisioned concurrency configurations for a function. |
|
|
ListProvisionedConcurrencyConfigsAsync(ListProvisionedConcurrencyConfigsRequest, CancellationToken) |
Retrieves a list of provisioned concurrency configurations for a function. |
|
|
ListTags(ListTagsRequest) |
Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction. |
|
|
ListTagsAsync(ListTagsRequest, CancellationToken) |
Returns a function, event source mapping, or code signing configuration's tags. You can also view function tags with GetFunction. |
|
|
ListVersionsByFunction(ListVersionsByFunctionRequest) |
Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call. |
|
|
ListVersionsByFunctionAsync(ListVersionsByFunctionRequest, CancellationToken) |
Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call. |
|
|
PublishLayerVersion(PublishLayerVersionRequest) |
Creates an Lambda
layer from a ZIP archive. Each time you call Add layers to your function with CreateFunction or UpdateFunctionConfiguration. |
|
|
PublishLayerVersionAsync(PublishLayerVersionRequest, CancellationToken) |
Creates an Lambda
layer from a ZIP archive. Each time you call Add layers to your function with CreateFunction or UpdateFunctionConfiguration. |
|
|
PublishVersion(PublishVersionRequest) |
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. 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. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias. |
|
|
PublishVersionAsync(PublishVersionRequest, CancellationToken) |
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. 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. Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias. |
|
|
PutFunctionCodeSigningConfig(PutFunctionCodeSigningConfigRequest) |
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. |
|
|
PutFunctionCodeSigningConfigAsync(PutFunctionCodeSigningConfigRequest, CancellationToken) |
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. |
|
|
PutFunctionConcurrency(PutFunctionConcurrencyRequest) |
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. Use 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 Lambda function scaling. |
|
|
PutFunctionConcurrencyAsync(PutFunctionConcurrencyRequest, CancellationToken) |
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. Use 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 Lambda function scaling. |
|
|
PutFunctionEventInvokeConfig(PutFunctionEventInvokeConfigRequest) |
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. To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue. S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type. |
|
|
PutFunctionEventInvokeConfigAsync(PutFunctionEventInvokeConfigRequest, CancellationToken) |
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. To send an invocation record to a queue, topic, S3 bucket, function, or event bus, specify a destination. You can configure separate destinations for successful invocations (on-success) and events that fail all processing attempts (on-failure). You can configure destinations in addition to or instead of a dead-letter queue. S3 buckets are supported only for on-failure destinations. To retain records of successful invocations, use another destination type. |
|
|
PutFunctionRecursionConfig(PutFunctionRecursionConfigRequest) |
Sets your function's recursive loop detection configuration. When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.
Lambda can detect certain types of recursive loops shortly after they occur. When
Lambda detects a recursive loop and your function's recursive loop detection configuration
is set to |
|
|
PutFunctionRecursionConfigAsync(PutFunctionRecursionConfigRequest, CancellationToken) |
Sets your function's recursive loop detection configuration. When you configure a Lambda function to output to the same service or resource that invokes the function, it's possible to create an infinite recursive loop. For example, a Lambda function might write a message to an Amazon Simple Queue Service (Amazon SQS) queue, which then invokes the same function. This invocation causes the function to write another message to the queue, which in turn invokes the function again.
Lambda can detect certain types of recursive loops shortly after they occur. When
Lambda detects a recursive loop and your function's recursive loop detection configuration
is set to |
|
|
PutProvisionedConcurrencyConfig(PutProvisionedConcurrencyConfigRequest) |
Adds a provisioned concurrency configuration to a function's alias or version. |
|
|
PutProvisionedConcurrencyConfigAsync(PutProvisionedConcurrencyConfigRequest, CancellationToken) |
Adds a provisioned concurrency configuration to a function's alias or version. |
|
|
PutRuntimeManagementConfig(PutRuntimeManagementConfigRequest) |
Sets the runtime management configuration for a function's version. For more information, see Runtime updates. |
|
|
PutRuntimeManagementConfigAsync(PutRuntimeManagementConfigRequest, CancellationToken) |
Sets the runtime management configuration for a function's version. For more information, see Runtime updates. |
|
|
RemoveLayerVersionPermission(RemoveLayerVersionPermissionRequest) |
Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. |
|
|
RemoveLayerVersionPermissionAsync(RemoveLayerVersionPermissionRequest, CancellationToken) |
Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission. |
|
|
RemovePermission(RemovePermissionRequest) |
Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy. |
|
|
RemovePermissionAsync(RemovePermissionRequest, CancellationToken) |
Revokes function-use permission from an Amazon Web Services service or another Amazon Web Services account. You can get the ID of the statement from the output of GetPolicy. |
|
|
TagResource(TagResourceRequest) |
Adds tags to a function, event source mapping, or code signing configuration. |
|
|
TagResourceAsync(TagResourceRequest, CancellationToken) |
Adds tags to a function, event source mapping, or code signing configuration. |
|
|
UntagResource(UntagResourceRequest) |
Removes tags from a function, event source mapping, or code signing configuration. |
|
|
UntagResourceAsync(UntagResourceRequest, CancellationToken) |
Removes tags from a function, event source mapping, or code signing configuration. |
|
|
UpdateAlias(UpdateAliasRequest) |
Updates the configuration of a Lambda function alias. |
|
|
UpdateAliasAsync(UpdateAliasRequest, CancellationToken) |
Updates the configuration of a Lambda function alias. |
|
|
UpdateCodeSigningConfig(UpdateCodeSigningConfigRequest) |
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. |
|
|
UpdateCodeSigningConfigAsync(UpdateCodeSigningConfigRequest, CancellationToken) |
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. |
|
|
UpdateEventSourceMapping(UpdateEventSourceMappingRequest) |
Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location. For details about how to configure different event sources, see the following topics. The following error handling options are available only for DynamoDB and Kinesis event sources:
For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:
For information about which configuration parameters apply to each event source, see the following topics. |
|
|
UpdateEventSourceMappingAsync(UpdateEventSourceMappingRequest, CancellationToken) |
Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location. For details about how to configure different event sources, see the following topics. The following error handling options are available only for DynamoDB and Kinesis event sources:
For stream sources (DynamoDB, Kinesis, Amazon MSK, and self-managed Apache Kafka), the following option is also available:
For information about which configuration parameters apply to each event source, see the following topics. |
|
|
UpdateFunctionCode(UpdateFunctionCodeRequest) |
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 for Lambda.
If the function's package type is
If the function's package type is
The code in the deployment package must be compatible with the target instruction
set architecture of the function ( 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. |
|
|
UpdateFunctionCodeAsync(UpdateFunctionCodeRequest, CancellationToken) |
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 for Lambda.
If the function's package type is
If the function's package type is
The code in the deployment package must be compatible with the target instruction
set architecture of the function ( 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. |
|
|
UpdateFunctionConfiguration(UpdateFunctionConfigurationRequest) |
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 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, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission. |
|
|
UpdateFunctionConfigurationAsync(UpdateFunctionConfigurationRequest, CancellationToken) |
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 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, use PutFunctionConcurrency. To grant invoke permissions to an Amazon Web Services account or Amazon Web Services service, use AddPermission. |
|
|
UpdateFunctionEventInvokeConfig(UpdateFunctionEventInvokeConfigRequest) |
Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
UpdateFunctionEventInvokeConfigAsync(UpdateFunctionEventInvokeConfigRequest, CancellationToken) |
Updates the configuration for asynchronous invocation for a function, version, or alias. To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig. |
|
|
UpdateFunctionUrlConfig(UpdateFunctionUrlConfigRequest) |
Updates the configuration for a Lambda function URL. |
|
|
UpdateFunctionUrlConfigAsync(UpdateFunctionUrlConfigRequest, CancellationToken) |
Updates the configuration for a Lambda function URL. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5