Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class RegisterWorkflowTypeCommandProtected

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

  • Use a Resource element with the domain name to limit the action to only specified domains.

  • Use an Action element to allow or deny permission to call this action.

  • Constrain the following parameters by using a Condition element with the appropriate keys.

    • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

    • name: String constraint. The key is swf:name.

    • version: String constraint. The key is swf:version.

If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.


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

import { SWFClient, RegisterWorkflowTypeCommand } from "@aws-sdk/client-swf"; // ES Modules import
// const { SWFClient, RegisterWorkflowTypeCommand } = require("@aws-sdk/client-swf"); // CommonJS import
const client = new SWFClient(config);
const input = { // RegisterWorkflowTypeInput
domain: "STRING_VALUE", // required
name: "STRING_VALUE", // required
version: "STRING_VALUE", // required
description: "STRING_VALUE",
defaultTaskStartToCloseTimeout: "STRING_VALUE",
defaultExecutionStartToCloseTimeout: "STRING_VALUE",
defaultTaskList: { // TaskList
name: "STRING_VALUE", // required
defaultTaskPriority: "STRING_VALUE",
defaultChildPolicy: "TERMINATE" || "REQUEST_CANCEL" || "ABANDON",
defaultLambdaRole: "STRING_VALUE",
const command = new RegisterWorkflowTypeCommand(input);
const response = await client.send(command);
// {};







LimitExceededFault (client fault)

Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.


OperationNotPermittedFault (client fault)

Returned when the caller doesn't have sufficient permissions to invoke the action.


TypeAlreadyExistsFault (client fault)

Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.


UnknownResourceFault (client fault)

Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.



Base exception class for all service exceptions from SWF service.