StartWorkflowRunCommand

Starts a new run of the specified workflow.

Example Syntax

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

import { GlueClient, StartWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, StartWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // StartWorkflowRunRequest
  Name: "STRING_VALUE", // required
  RunProperties: { // WorkflowRunProperties
    "<keys>": "STRING_VALUE",
  },
};
const command = new StartWorkflowRunCommand(input);
const response = await client.send(command);
// { // StartWorkflowRunResponse
//   RunId: "STRING_VALUE",
// };

StartWorkflowRunCommand Input

See StartWorkflowRunCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the workflow to start.

RunProperties
Record<string, string> | undefined

The workflow run properties for the new workflow run.

Run properties may be logged. Do not pass plaintext secrets as properties. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to use them within the workflow run.

StartWorkflowRunCommand Output

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

An Id for the new run.

Throws

Name
Fault
Details
ConcurrentRunsExceededException
client

Too many jobs are being run concurrently.

EntityNotFoundException
client

A specified entity does not exist

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

ResourceNumberLimitExceededException
client

A resource numerical limit was exceeded.

GlueServiceException
Base exception class for all service exceptions from Glue service.