@aws-sdk/client-lambda
Advanced tools
AWS SDK for JavaScript Lambda Client for Node.js, Browser and React Native
The @aws-sdk/client-lambda package is a client library for AWS Lambda that allows developers to interact with the AWS Lambda service programmatically. It provides methods to create, update, delete, and invoke Lambda functions, as well as manage function configurations, aliases, and versions.
Invoke a Lambda function
This feature allows you to invoke an AWS Lambda function with optional payload. The response includes the result of the function execution.
{"const { LambdaClient, InvokeCommand } = require('@aws-sdk/client-lambda');
const client = new LambdaClient({ region: 'us-west-2' });
const params = {
FunctionName: 'my-lambda-function',
Payload: Buffer.from(JSON.stringify({ key: 'value' }))
};
const command = new InvokeCommand(params);
client.send(command).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
});"}Create a Lambda function
This feature allows you to create a new AWS Lambda function by specifying the code, function name, handler, role, and runtime.
{"const { LambdaClient, CreateFunctionCommand } = require('@aws-sdk/client-lambda');
const client = new LambdaClient({ region: 'us-west-2' });
const params = {
Code: { /* code properties */ },
FunctionName: 'my-new-function',
Handler: 'index.handler',
Role: 'arn:aws:iam::123456789012:role/lambda-role',
Runtime: 'nodejs12.x'
};
const command = new CreateFunctionCommand(params);
client.send(command).then((response) => {
console.log(response);
}).catch((error) => {
console.error(error);
});"}List Lambda functions
This feature allows you to list all of your AWS Lambda functions in a specific region.
{"const { LambdaClient, ListFunctionsCommand } = require('@aws-sdk/client-lambda');
const client = new LambdaClient({ region: 'us-west-2' });
const command = new ListFunctionsCommand({});
client.send(command).then((response) => {
console.log(response.Functions);
}).catch((error) => {
console.error(error);
});"}The 'aws-sdk' package is the previous version of the AWS SDK for JavaScript. It provides similar functionalities to interact with AWS Lambda and other AWS services. However, @aws-sdk/client-lambda is part of the modular AWS SDK for JavaScript (v3), which allows for importing only the specific clients needed, potentially reducing bundle sizes and improving load times.
The 'serverless' package is a framework for building serverless applications using AWS Lambda and other cloud providers. It provides a higher-level abstraction for deploying and managing serverless functions, whereas @aws-sdk/client-lambda is a lower-level client for direct interaction with the AWS Lambda service API.
The 'claudia' package is a deployment tool for AWS Lambda and API Gateway. It simplifies the process of deploying Node.js projects to AWS Lambda. While Claudia focuses on the deployment aspect, @aws-sdk/client-lambda provides a programmatic interface for managing and invoking Lambda functions.
AWS SDK for JavaScript Lambda Client for Node.js, Browser and React Native.
Lambda
Overview
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.
To install the this package, simply type add or install @aws-sdk/client-lambda using your favorite package manager:
npm install @aws-sdk/client-lambdayarn add @aws-sdk/client-lambdapnpm add @aws-sdk/client-lambdaThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the LambdaClient and
the commands you need, for example ListLayersCommand:
// ES5 example
const { LambdaClient, ListLayersCommand } = require("@aws-sdk/client-lambda");
// ES6+ example
import { LambdaClient, ListLayersCommand } from "@aws-sdk/client-lambda";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new LambdaClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListLayersCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-lambda";
const client = new AWS.Lambda({ region: "REGION" });
// async/await.
try {
const data = await client.listLayers(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listLayers(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listLayers(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-lambda package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
3.629.0 (2024-08-12)
FAQs
AWS SDK for JavaScript Lambda Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-lambda receives a total of 2,611,093 weekly downloads. As such, @aws-sdk/client-lambda popularity was classified as popular.
We found that @aws-sdk/client-lambda demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.