CreateScheduleCommand

Suggest an Edit

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataBrewClient, CreateScheduleCommand } from "@aws-sdk/client-databrew"; // ES Modules import
// const { DataBrewClient, CreateScheduleCommand } = require("@aws-sdk/client-databrew"); // CommonJS import
const client = new DataBrewClient(config);
const input = { // CreateScheduleRequest
  JobNames: [ // JobNameList
    "STRING_VALUE",
  ],
  CronExpression: "STRING_VALUE", // required
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
  Name: "STRING_VALUE", // required
};
const command = new CreateScheduleCommand(input);
const response = await client.send(command);
// { // CreateScheduleResponse
//   Name: "STRING_VALUE", // required
// };

CreateScheduleCommand Input

See CreateScheduleCommandInput for more details

Parameter
Type
Description
CronExpression
Required
string | undefined

The date or dates and time or times when the jobs are to be run. For more information, see Cron expressions  in the Glue DataBrew Developer Guide.

Name
Required
string | undefined

A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

JobNames
string[] | undefined

The name or names of one or more jobs to be run.

Tags
Record<string, string> | undefined

Metadata tags to apply to this schedule.

CreateScheduleCommand Output

See CreateScheduleCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Name
Required
string | undefined

The name of the schedule that was created.

Throws

Name
Fault
Details
ConflictException
client

Updating or deleting a resource can cause an inconsistent state.

ServiceQuotaExceededException
client

A service quota is exceeded.

ValidationException
client

The input parameters for this request failed validation.

DataBrewServiceException
Base exception class for all service exceptions from DataBrew service.