CreateWorkflowCommand

Suggest an Edit

Creates a new workflow.

Example Syntax

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

import { GlueClient, CreateWorkflowCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, CreateWorkflowCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // CreateWorkflowRequest
  Name: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  DefaultRunProperties: { // WorkflowRunProperties
    "<keys>": "STRING_VALUE",
  },
  Tags: { // TagsMap
    "<keys>": "STRING_VALUE",
  },
  MaxConcurrentRuns: Number("int"),
};
const command = new CreateWorkflowCommand(input);
const response = await client.send(command);
// { // CreateWorkflowResponse
//   Name: "STRING_VALUE",
// };

CreateWorkflowCommand Input

See CreateWorkflowCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name to be assigned to the workflow. It should be unique within your account.

DefaultRunProperties
Record<string, string> | undefined

A collection of properties to be used as part of each execution of the workflow.

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.

Description
string | undefined

A description of the workflow.

MaxConcurrentRuns
number | undefined

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.

Tags
Record<string, string> | undefined

The tags to be used with this workflow.

CreateWorkflowCommand Output

See CreateWorkflowCommandOutput for details

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

The name of the workflow which was provided as part of the request.

Throws

Name
Fault
Details
AlreadyExistsException
client

A resource to be created or added already exists.

ConcurrentModificationException
client

Two processes are trying to modify a resource simultaneously.

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.