@aws-sdk/client-scheduler
Advanced tools
AWS SDK for JavaScript Scheduler Client for Node.js, Browser and React Native
@aws-sdk/client-scheduler is an AWS SDK client that allows you to interact with the Amazon EventBridge Scheduler service. This service enables you to create, manage, and execute scheduled tasks and events in AWS. You can use it to automate tasks, trigger events at specific times, and manage schedules programmatically.
Create a Schedule
This code sample demonstrates how to create a new schedule using the @aws-sdk/client-scheduler package. The schedule triggers a Lambda function every 5 minutes.
const { SchedulerClient, CreateScheduleCommand } = require('@aws-sdk/client-scheduler');
const client = new SchedulerClient({ region: 'us-west-2' });
const params = {
Name: 'MySchedule',
ScheduleExpression: 'rate(5 minutes)',
Target: {
Arn: 'arn:aws:lambda:us-west-2:123456789012:function:MyFunction',
RoleArn: 'arn:aws:iam::123456789012:role/MyRole'
}
};
const command = new CreateScheduleCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);List Schedules
This code sample demonstrates how to list all existing schedules using the @aws-sdk/client-scheduler package.
const { SchedulerClient, ListSchedulesCommand } = require('@aws-sdk/client-scheduler');
const client = new SchedulerClient({ region: 'us-west-2' });
const command = new ListSchedulesCommand({});
client.send(command).then(
(data) => console.log(data.Schedules),
(error) => console.error(error)
);Delete a Schedule
This code sample demonstrates how to delete an existing schedule using the @aws-sdk/client-scheduler package.
const { SchedulerClient, DeleteScheduleCommand } = require('@aws-sdk/client-scheduler');
const client = new SchedulerClient({ region: 'us-west-2' });
const params = { Name: 'MySchedule' };
const command = new DeleteScheduleCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);node-cron is a lightweight npm package for scheduling tasks in Node.js using cron syntax. Unlike @aws-sdk/client-scheduler, which integrates with AWS services, node-cron is a standalone package that runs scheduled tasks locally within your Node.js application.
Agenda is a job scheduling package for Node.js that uses MongoDB for persistence. It provides more advanced scheduling features compared to @aws-sdk/client-scheduler, such as job prioritization and concurrency control. However, it does not integrate directly with AWS services.
Bree is a job scheduler for Node.js that uses worker threads to run jobs. It supports cron syntax and provides features like graceful shutdown and job retries. Unlike @aws-sdk/client-scheduler, Bree is designed to run within your Node.js application and does not integrate with AWS services.
AWS SDK for JavaScript Scheduler Client for Node.js, Browser and React Native.
Amazon EventBridge Scheduler is a serverless scheduler that allows you to create, run, and manage tasks from one central, managed service. EventBridge Scheduler delivers your tasks reliably, with built-in mechanisms that adjust your schedules based on the availability of downstream targets. The following reference lists the available API actions, and data types for EventBridge Scheduler.
To install this package, simply type add or install @aws-sdk/client-scheduler using your favorite package manager:
npm install @aws-sdk/client-scheduleryarn add @aws-sdk/client-schedulerpnpm add @aws-sdk/client-schedulerThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the SchedulerClient and
the commands you need, for example ListSchedulesCommand:
// ES5 example
const { SchedulerClient, ListSchedulesCommand } = require("@aws-sdk/client-scheduler");
// ES6+ example
import { SchedulerClient, ListSchedulesCommand } from "@aws-sdk/client-scheduler";
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 SchedulerClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListSchedulesCommand(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-scheduler";
const client = new AWS.Scheduler({ region: "REGION" });
// async/await.
try {
const data = await client.listSchedules(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listSchedules(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listSchedules(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-scheduler 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.
FAQs
AWS SDK for JavaScript Scheduler Client for Node.js, Browser and React Native
The npm package @aws-sdk/client-scheduler receives a total of 401,934 weekly downloads. As such, @aws-sdk/client-scheduler popularity was classified as popular.
We found that @aws-sdk/client-scheduler 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
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.