Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RegisterWorkflowTypeCommand

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.

example

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 command = new RegisterWorkflowTypeCommand(input);
const response = await client.send(command);
see

RegisterWorkflowTypeCommandInput for command's input shape.

see

RegisterWorkflowTypeCommandOutput for command's response shape.

see

config for SWFClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: RegisterWorkflowTypeCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions