UpdateScheduleCommand

Modifies the definition of an existing DataBrew schedule.

Example Syntax

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

import { DataBrewClient, UpdateScheduleCommand } from "@aws-sdk/client-databrew"; // ES Modules import
// const { DataBrewClient, UpdateScheduleCommand } = require("@aws-sdk/client-databrew"); // CommonJS import
const client = new DataBrewClient(config);
const input = { // UpdateScheduleRequest
  JobNames: [ // JobNameList
    "STRING_VALUE",
  ],
  CronExpression: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
};
const command = new UpdateScheduleCommand(input);
const response = await client.send(command);
// { // UpdateScheduleResponse
//   Name: "STRING_VALUE", // required
// };

UpdateScheduleCommand Input

See UpdateScheduleCommandInput 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

The name of the schedule to update.

JobNames
string[] | undefined

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

UpdateScheduleCommand Output

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

The name of the schedule that was updated.

Throws

Name
Fault
Details
ResourceNotFoundException
client

One or more resources can't be found.

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.