AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing Lambda

Inheritance Hierarchy

Amazon.Lambda.IAmazonLambda

Namespace: Amazon.Lambda
Assembly: AWSSDK.Lambda.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonLambda
         IAmazonService, IDisposable

The IAmazonLambda type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.Lambda.Model.ILambdaPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method 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.

Public Method 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.

Public Method AddPermission(AddPermissionRequest)

Grants an Amazon Web Services 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 Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services 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.

This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.

Public Method AddPermissionAsync(AddPermissionRequest, CancellationToken)

Grants an Amazon Web Services 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 Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services 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.

This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.

Public Method 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 RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

Public Method 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 RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

Public Method 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).

Public Method 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).

Public Method CreateEventSourceMapping(CreateEventSourceMappingRequest)

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

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 expires

  • MaximumRetryAttempts - 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.

Public Method CreateEventSourceMappingAsync(CreateEventSourceMappingRequest, CancellationToken)

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics. In particular, each of the topics describes the required and optional parameters for the specific event source.

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 expires

  • MaximumRetryAttempts - 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.

Public Method 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.

You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties.

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 Amazon Web Services 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.

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 Functions.

Public Method 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.

You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties.

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 Amazon Web Services 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.

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 Functions.

Public Method DeleteAlias(DeleteAliasRequest)

Deletes a Lambda function alias.

Public Method DeleteAliasAsync(DeleteAliasRequest, CancellationToken)

Deletes a Lambda function alias.

Public Method DeleteCodeSigningConfig(DeleteCodeSigningConfigRequest)

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

Public Method DeleteCodeSigningConfigAsync(DeleteCodeSigningConfigRequest, CancellationToken)

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

Public Method 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 Deleting state and might not be completely deleted for several seconds.

Public Method 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 Deleting state and might not be completely deleted for several seconds.

Public Method DeleteFunction(string)
Public Method DeleteFunction(DeleteFunctionRequest)

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.

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.

Public Method DeleteFunctionAsync(string, CancellationToken)
Public Method DeleteFunctionAsync(DeleteFunctionRequest, CancellationToken)

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.

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.

Public Method DeleteFunctionCodeSigningConfig(DeleteFunctionCodeSigningConfigRequest)

Removes the code signing configuration from the function.

Public Method DeleteFunctionCodeSigningConfigAsync(DeleteFunctionCodeSigningConfigRequest, CancellationToken)

Removes the code signing configuration from the function.

Public Method DeleteFunctionConcurrency(DeleteFunctionConcurrencyRequest)

Removes a concurrent execution limit from a function.

Public Method DeleteFunctionConcurrencyAsync(DeleteFunctionConcurrencyRequest, CancellationToken)

Removes a concurrent execution limit from a function.

Public Method DeleteFunctionEventInvokeConfig(DeleteFunctionEventInvokeConfigRequest)

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method DeleteFunctionEventInvokeConfigAsync(DeleteFunctionEventInvokeConfigRequest, CancellationToken)

Deletes the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method 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.

Public Method 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.

Public Method DeleteProvisionedConcurrencyConfig(DeleteProvisionedConcurrencyConfigRequest)

Deletes the provisioned concurrency configuration for a function.

Public Method DeleteProvisionedConcurrencyConfigAsync(DeleteProvisionedConcurrencyConfigRequest, CancellationToken)

Deletes the provisioned concurrency configuration for a function.

Public Method GetAccountSettings(GetAccountSettingsRequest)

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

Public Method GetAccountSettingsAsync(GetAccountSettingsRequest, CancellationToken)

Retrieves details about your account's limits and usage in an Amazon Web Services Region.

Public Method GetAlias(GetAliasRequest)

Returns details about a Lambda function alias.

Public Method GetAliasAsync(GetAliasRequest, CancellationToken)

Returns details about a Lambda function alias.

Public Method GetCodeSigningConfig(GetCodeSigningConfigRequest)

Returns information about the specified code signing configuration.

Public Method GetCodeSigningConfigAsync(GetCodeSigningConfigRequest, CancellationToken)

Returns information about the specified code signing configuration.

Public Method GetEventSourceMapping(GetEventSourceMappingRequest)

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

Public Method GetEventSourceMappingAsync(GetEventSourceMappingRequest, CancellationToken)

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

Public Method GetFunction(string)
Public Method 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.

Public Method GetFunctionAsync(string, CancellationToken)
Public Method 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.

Public Method GetFunctionCodeSigningConfig(GetFunctionCodeSigningConfigRequest)

Returns the code signing configuration for the specified function.

Public Method GetFunctionCodeSigningConfigAsync(GetFunctionCodeSigningConfigRequest, CancellationToken)

Returns the code signing configuration for the specified function.

Public Method GetFunctionConcurrency(GetFunctionConcurrencyRequest)

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

Public Method GetFunctionConcurrencyAsync(GetFunctionConcurrencyRequest, CancellationToken)

Returns details about the reserved concurrency configuration for a function. To set a concurrency limit for a function, use PutFunctionConcurrency.

Public Method GetFunctionConfiguration(string)
Public Method 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.

Public Method GetFunctionConfigurationAsync(string, CancellationToken)
Public Method 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.

Public Method GetFunctionEventInvokeConfig(GetFunctionEventInvokeConfigRequest)

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method GetFunctionEventInvokeConfigAsync(GetFunctionEventInvokeConfigRequest, CancellationToken)

Retrieves the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method GetLayerVersionPolicy(GetLayerVersionPolicyRequest)

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Public Method GetLayerVersionPolicyAsync(GetLayerVersionPolicyRequest, CancellationToken)

Returns the permission policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Public Method GetPolicy(GetPolicyRequest)

Returns the resource-based IAM policy for a function, version, or alias.

Public Method GetPolicyAsync(GetPolicyRequest, CancellationToken)

Returns the resource-based IAM policy for a function, version, or alias.

Public Method GetProvisionedConcurrencyConfig(GetProvisionedConcurrencyConfigRequest)

Retrieves the provisioned concurrency configuration for a function's alias or version.

Public Method GetProvisionedConcurrencyConfigAsync(GetProvisionedConcurrencyConfigRequest, CancellationToken)

Retrieves the provisioned concurrency configuration for a function's alias or version.

Public Method Invoke(InvokeRequest)

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.

Public Method 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 lambda:InvokeAsync action.

The InvokeArgs will be set to an empty json document.

Public Method 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 lambda:InvokeAsync action.

Public Method InvokeAsync(InvokeRequest, CancellationToken)

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.

Public Method InvokeAsync(InvokeAsyncRequest)

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

Public Method InvokeAsyncAsync(InvokeAsyncRequest, CancellationToken)

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

Public Method ListAliases(ListAliasesRequest)

Returns a list of aliases for a Lambda function.

Public Method ListAliasesAsync(ListAliasesRequest, CancellationToken)

Returns a list of aliases for a Lambda function.

Public Method ListCodeSigningConfigs(ListCodeSigningConfigsRequest)

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.

Public Method ListCodeSigningConfigsAsync(ListCodeSigningConfigsRequest, CancellationToken)

Returns a list of code signing configurations. A request returns up to 10,000 configurations per call. You can use the MaxItems parameter to return fewer configurations per call.

Public Method ListEventSourceMappings(ListEventSourceMappingsRequest)

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.

Public Method ListEventSourceMappingsAsync(ListEventSourceMappingsRequest, CancellationToken)

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.

Public Method ListFunctionEventInvokeConfigs(ListFunctionEventInvokeConfigsRequest)

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method ListFunctionEventInvokeConfigsAsync(ListFunctionEventInvokeConfigsRequest, CancellationToken)

Retrieves a list of configurations for asynchronous invocation for a function.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method ListFunctions()

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction.

Public Method ListFunctions(ListFunctionsRequest)

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction.

Public Method ListFunctionsAsync(CancellationToken)

Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction.

Public Method 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 FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version.

The ListFunctions action returns a subset of the FunctionConfiguration fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use GetFunction.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method ListProvisionedConcurrencyConfigs(ListProvisionedConcurrencyConfigsRequest)

Retrieves a list of provisioned concurrency configurations for a function.

Public Method ListProvisionedConcurrencyConfigsAsync(ListProvisionedConcurrencyConfigsRequest, CancellationToken)

Retrieves a list of provisioned concurrency configurations for a function.

Public Method ListTags(ListTagsRequest)

Returns a function's tags. You can also view tags with GetFunction.

Public Method ListTagsAsync(ListTagsRequest, CancellationToken)

Returns a function's tags. You can also view tags with GetFunction.

Public Method ListVersionsByFunction(ListVersionsByFunctionRequest)

Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.

Public Method ListVersionsByFunctionAsync(ListVersionsByFunctionRequest, CancellationToken)

Returns a list of versions, with the version-specific configuration of each. Lambda returns up to 50 versions per call.

Public Method PublishLayerVersion(PublishLayerVersionRequest)

Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

Public Method PublishLayerVersionAsync(PublishLayerVersionRequest, CancellationToken)

Creates an Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same layer name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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.

Public Method 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 Managing Concurrency.

Public Method 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 Managing Concurrency.

Public Method 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, 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.

Public Method 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, 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.

Public Method PutProvisionedConcurrencyConfig(PutProvisionedConcurrencyConfigRequest)

Adds a provisioned concurrency configuration to a function's alias or version.

Public Method PutProvisionedConcurrencyConfigAsync(PutProvisionedConcurrencyConfigRequest, CancellationToken)

Adds a provisioned concurrency configuration to a function's alias or version.

Public Method RemoveLayerVersionPermission(RemoveLayerVersionPermissionRequest)

Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Public Method RemoveLayerVersionPermissionAsync(RemoveLayerVersionPermissionRequest, CancellationToken)

Removes a statement from the permissions policy for a version of an Lambda layer. For more information, see AddLayerVersionPermission.

Public Method RemovePermission(RemovePermissionRequest)

Revokes function-use permission from an Amazon Web Services service or another account. You can get the ID of the statement from the output of GetPolicy.

Public Method RemovePermissionAsync(RemovePermissionRequest, CancellationToken)

Revokes function-use permission from an Amazon Web Services service or another account. You can get the ID of the statement from the output of GetPolicy.

Public Method TagResource(TagResourceRequest)

Adds tags to a function.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds tags to a function.

Public Method UntagResource(UntagResourceRequest)

Removes tags from a function.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from a function.

Public Method UpdateAlias(UpdateAliasRequest)

Updates the configuration of a Lambda function alias.

Public Method UpdateAliasAsync(UpdateAliasRequest, CancellationToken)

Updates the configuration of a Lambda function alias.

Public Method 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.

Public Method 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.

Public Method 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.

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 expires

  • MaximumRetryAttempts - 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.

Public Method 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.

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 expires

  • MaximumRetryAttempts - 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.

Public Method 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.

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.

Public Method 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.

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.

Public Method 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 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, use PutFunctionConcurrency. To grant invoke permissions to an account or Amazon Web Services service, use AddPermission.

Public Method 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 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, use PutFunctionConcurrency. To grant invoke permissions to an account or Amazon Web Services service, use AddPermission.

Public Method UpdateFunctionEventInvokeConfig(UpdateFunctionEventInvokeConfigRequest)

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Public Method UpdateFunctionEventInvokeConfigAsync(UpdateFunctionEventInvokeConfigRequest, CancellationToken)

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5