AWS.Lambda — AWS SDK for JavaScript (original) (raw)

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

addLayerVersionPermission(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Grants an Amazon Web Servicesservice, Amazon Web Services account, or Amazon Web Services organization 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 Principal. To grant permission to an organization defined in Organizations, specify the organization ID as the PrincipalOrgID. For Amazon Web Servicesservices, the principal is a domain-style identifier that the service defines, such as s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Servicesservices, 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 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(params = {}, callback) ⇒ AWS.Request

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.

createCodeSigningConfig(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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 stream sources (DynamoDB and Kinesis):

For information about which configuration parameters apply to each event source, see the following topics.

createFunction(params = {}, callback) ⇒ AWS.Request

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 Servicesservices, 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 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.

If the deployment package is a .zip file archive, then you set the package type to Zip. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, then the default value is x86-64.

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 Lambda 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 of signing profiles, which define the trusted publishers for this function.

If another Amazon Web Services account or an Amazon Web Servicesservice 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 Servicesservices, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Lambda functions.

createFunctionUrlConfig(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Deletes a Lambda function alias.

deleteCodeSigningConfig(params = {}, callback) ⇒ AWS.Request

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

deleteEventSourceMapping(params = {}, callback) ⇒ AWS.Request

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.

deleteFunction(params = {}, callback) ⇒ AWS.Request

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted. This doesn't require the user to have explicit permissions for DeleteAlias.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For Amazon Web Servicesservices and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

deleteFunctionCodeSigningConfig(params = {}, callback) ⇒ AWS.Request

Removes the code signing configuration from the function.

deleteFunctionConcurrency(params = {}, callback) ⇒ AWS.Request

Removes a concurrent execution limit from a function.

deleteFunctionEventInvokeConfig(params = {}, callback) ⇒ AWS.Request

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

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

deleteFunctionUrlConfig(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Deletes the provisioned concurrency configuration for a function.

getAccountSettings(params = {}, callback) ⇒ AWS.Request

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

getAlias(params = {}, callback) ⇒ AWS.Request

Returns details about a Lambda function alias.

getCodeSigningConfig(params = {}, callback) ⇒ AWS.Request

Returns information about the specified code signing configuration.

getEventSourceMapping(params = {}, callback) ⇒ AWS.Request

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

getFunction(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Returns the code signing configuration for the specified function.

getFunctionConcurrency(params = {}, callback) ⇒ AWS.Request

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

getFunctionConfiguration(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

getFunctionRecursionConfig(params = {}, callback) ⇒ AWS.Request

getFunctionUrlConfig(params = {}, callback) ⇒ AWS.Request

Returns details about a Lambda function URL.

getLayerVersion(params = {}, callback) ⇒ AWS.Request

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

getLayerVersionByArn(params = {}, callback) ⇒ AWS.Request

Returns information about a version of an Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

getLayerVersionPolicy(params = {}, callback) ⇒ AWS.Request

getProvisionedConcurrencyConfig(params = {}, callback) ⇒ AWS.Request

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

getRuntimeManagementConfig(params = {}, callback) ⇒ AWS.Request

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 null is returned for the ARN. For more information, see Runtime updates.

invoke(params = {}, callback) ⇒ AWS.Request

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. theInvocationType is RequestResponse). To invoke a function asynchronously, set InvocationType to Event. Lambda passes the ClientContext object to your function for synchronous invocations only.

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 TooManyRequestsException if running 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 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(params = {}, callback) ⇒ AWS.Request

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

Note: 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(params = {}, callback) ⇒ AWS.Request

listAliases(params = {}, callback) ⇒ AWS.Request

Returns a list of aliases for a Lambda function.

listCodeSigningConfigs(params = {}, callback) ⇒ AWS.Request

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.

listEventSourceMappings(params = {}, callback) ⇒ AWS.Request

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

listFunctionEventInvokeConfigs(params = {}, callback) ⇒ AWS.Request

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

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

listFunctions(params = {}, callback) ⇒ AWS.Request

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.

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

listFunctionsByCodeSigningConfig(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Returns a list of Lambda function URLs for the specified function.

listLayers(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

Retrieves a list of provisioned concurrency configurations for a function.

listVersionsByFunction(params = {}, callback) ⇒ AWS.Request

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

publishLayerVersion(params = {}, callback) ⇒ AWS.Request

publishVersion(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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.

putFunctionRecursionConfig(params = {}, callback) ⇒ AWS.Request

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 Terminate, it stops your function being invoked and notifies you.

putProvisionedConcurrencyConfig(params = {}, callback) ⇒ AWS.Request

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

putRuntimeManagementConfig(params = {}, callback) ⇒ AWS.Request

Sets the runtime management configuration for a function's version. For more information, see Runtime updates.

removeLayerVersionPermission(params = {}, callback) ⇒ AWS.Request

removePermission(params = {}, callback) ⇒ AWS.Request

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

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a function.

updateAlias(params = {}, callback) ⇒ AWS.Request

Updates the configuration of a Lambda function alias.

updateCodeSigningConfig(params = {}, callback) ⇒ AWS.Request

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(params = {}, callback) ⇒ AWS.Request

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 stream sources (DynamoDB and Kinesis):

For information about which configuration parameters apply to each event source, see the following topics.

updateFunctionCode(params = {}, callback) ⇒ AWS.Request

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 Image, then you must specify the code package in ImageUri as the URI of a container image in the Amazon ECR registry.

If the function's package type is Zip, then you must specify the deployment package as a .zip file archive. Enter the Amazon S3 bucket and key of the code .zip file location. You can also provide the function code inline using the ZipFile field.

The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64).

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.

Note: 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(params = {}, callback) ⇒ AWS.Request

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 Lambda 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 Amazon Web Services account or Amazon Web Servicesservice, use AddPermission.

updateFunctionEventInvokeConfig(params = {}, callback) ⇒ AWS.Request

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

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

updateFunctionUrlConfig(params = {}, callback) ⇒ AWS.Request

Updates the configuration for a Lambda function URL.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Lambda resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.