Registers a new workflow type and its configuration settings in the specified domain.
swf_register_workflow_type(domain, name, version, description,
defaultTaskStartToCloseTimeout, defaultExecutionStartToCloseTimeout,
defaultTaskList, defaultTaskPriority, defaultChildPolicy,
defaultLambdaRole)[required] The name of the domain in which to register the workflow type.
[required] The name of the workflow type.
The specified string must not start or end with whitespace. It must not
contain a : (colon), / (slash), | (vertical bar), or any control
characters (U+0000`-`U+001f \| U+007f`-`U+009f). Also, it must not be
the literal string arn.
[required] The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.
The specified string must not start or end with whitespace. It must not
contain a : (colon), / (slash), | (vertical bar), or any control
characters (U+0000`-`U+001f \| U+007f`-`U+009f). Also, it must not be
the literal string arn.
Textual description of the workflow type.
If set, specifies the default maximum duration of decision tasks for
this workflow type. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution Decision.
The duration is specified in seconds, an integer greater than or equal
to 0. You can use NONE to specify unlimited duration.
If set, specifies the default maximum duration for executions of this
workflow type. You can override this default when starting an execution
through the StartWorkflowExecution Action or
StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal
to 0. Unlike some of the other timeout parameters in Amazon SWF, you
cannot specify a value of "NONE" for
defaultExecutionStartToCloseTimeout; there is a one-year max limit on
the time that a workflow execution can run. Exceeding this limit always
causes the workflow execution to time out.
If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type. This default is used only if
a task list isn't provided when starting the execution through the
StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The default task priority to assign to the workflow type. If not
assigned, then 0 is used. Valid values are integers that range from
Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due to an
expired timeout. This default can be overridden when starting a workflow
execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution Decision.
The supported child policies are:
TERMINATE -- The child executions are terminated.
REQUEST_CANCEL -- A request to cancel is attempted for each child
execution by recording a WorkflowExecutionCancelRequested event in
its history. It is up to the decider to take appropriate actions
when it receives an execution history with this event.
ABANDON -- No action is taken. The child executions continue to
run.
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
svc$register_workflow_type(
domain = "string",
name = "string",
version = "string",
description = "string",
defaultTaskStartToCloseTimeout = "string",
defaultExecutionStartToCloseTimeout = "string",
defaultTaskList = list(
name = "string"
),
defaultTaskPriority = "string",
defaultChildPolicy = "TERMINATE"|"REQUEST_CANCEL"|"ABANDON",
defaultLambdaRole = "string"
)
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.