StopWorkflowRunCommand

Stops the execution of the specified workflow run.

Example Syntax

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

import { GlueClient, StopWorkflowRunCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, StopWorkflowRunCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // StopWorkflowRunRequest
  Name: "STRING_VALUE", // required
  RunId: "STRING_VALUE", // required
};
const command = new StopWorkflowRunCommand(input);
const response = await client.send(command);
// {};

StopWorkflowRunCommand Input

See StopWorkflowRunCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the workflow to stop.

RunId
Required
string | undefined

The ID of the workflow run to stop.

StopWorkflowRunCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
EntityNotFoundException
client

A specified entity does not exist

IllegalWorkflowStateException
client

The workflow is in an invalid state to perform a requested operation.

InternalServiceException
server

An internal service error occurred.

InvalidInputException
client

The input provided was not valid.

OperationTimeoutException
client

The operation timed out.

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