- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SchedulerClient
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.
Installation
npm install @aws-sdk/client-scheduler
yarn add @aws-sdk/client-scheduler
pnpm add @aws-sdk/client-scheduler
SchedulerClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateScheduleCommand | Creates the specified schedule. |
CreateScheduleGroupCommand | Creates the specified schedule group. |
DeleteScheduleCommand | Deletes the specified schedule. |
DeleteScheduleGroupCommand | Deletes the specified schedule group. Deleting a schedule group results in EventBridge Scheduler deleting all schedules associated with the group. When you delete a group, it remains in a This operation is eventually consistent. |
GetScheduleCommand | Retrieves the specified schedule. |
GetScheduleGroupCommand | Retrieves the specified schedule group. |
ListScheduleGroupsCommand | Returns a paginated list of your schedule groups. |
ListSchedulesCommand | Returns a paginated list of your EventBridge Scheduler schedules. |
ListTagsForResourceCommand | Lists the tags associated with the Scheduler resource. |
TagResourceCommand | Assigns one or more tags (key-value pairs) to the specified EventBridge Scheduler resource. You can only assign tags to schedule groups. |
UntagResourceCommand | Removes one or more tags from the specified EventBridge Scheduler schedule group. |
UpdateScheduleCommand | Updates the specified schedule. When you call Before calling this operation, we recommend that you call the |
SchedulerClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SchedulerClientConfig