Skip to content

/AWS1/IF_SWF=>REGISTERWORKFLOWTYPE()

About RegisterWorkflowType

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.

Method Signature

METHODS /AWS1/IF_SWF~REGISTERWORKFLOWTYPE
  IMPORTING
    !IV_DOMAIN TYPE /AWS1/SWFDOMAINNAME OPTIONAL
    !IV_NAME TYPE /AWS1/SWFNAME OPTIONAL
    !IV_VERSION TYPE /AWS1/SWFVERSION OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SWFDESCRIPTION OPTIONAL
    !IV_DEFTASKSTARTTOCLOSETMOUT TYPE /AWS1/SWFDURINSECONDSOPTIONAL OPTIONAL
    !IV_DEFEXECSTARTTOCLOSETMOUT TYPE /AWS1/SWFDURINSECONDSOPTIONAL OPTIONAL
    !IO_DEFAULTTASKLIST TYPE REF TO /AWS1/CL_SWFTASKLIST OPTIONAL
    !IV_DEFAULTTASKPRIORITY TYPE /AWS1/SWFTASKPRIORITY OPTIONAL
    !IV_DEFAULTCHILDPOLICY TYPE /AWS1/SWFCHILDPOLICY OPTIONAL
    !IV_DEFAULTLAMBDAROLE TYPE /AWS1/SWFARN OPTIONAL
  RAISING
    /AWS1/CX_SWFLIMITEXCEEDEDFAULT
    /AWS1/CX_SWFOPNOTPERMITTEDFA00
    /AWS1/CX_SWFTYPEALRDYEXFAULT
    /AWS1/CX_SWFUNKNOWNRESRCFAULT
    /AWS1/CX_SWFCLIENTEXC
    /AWS1/CX_SWFSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domain TYPE /AWS1/SWFDOMAINNAME /AWS1/SWFDOMAINNAME

The name of the domain in which to register the workflow type.

iv_name TYPE /AWS1/SWFNAME /AWS1/SWFNAME

The name of the workflow type.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

iv_version TYPE /AWS1/SWFVERSION /AWS1/SWFVERSION

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Optional arguments:

iv_description TYPE /AWS1/SWFDESCRIPTION /AWS1/SWFDESCRIPTION

Textual description of the workflow type.

iv_deftaskstarttoclosetmout TYPE /AWS1/SWFDURINSECONDSOPTIONAL /AWS1/SWFDURINSECONDSOPTIONAL

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.

iv_defexecstarttoclosetmout TYPE /AWS1/SWFDURINSECONDSOPTIONAL /AWS1/SWFDURINSECONDSOPTIONAL

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.

io_defaulttasklist TYPE REF TO /AWS1/CL_SWFTASKLIST /AWS1/CL_SWFTASKLIST

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.

iv_defaulttaskpriority TYPE /AWS1/SWFTASKPRIORITY /AWS1/SWFTASKPRIORITY

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.

iv_defaultchildpolicy TYPE /AWS1/SWFCHILDPOLICY /AWS1/SWFCHILDPOLICY

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.

iv_defaultlambdarole TYPE /AWS1/SWFARN /AWS1/SWFARN

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.

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->registerworkflowtype(
  io_defaulttasklist = new /aws1/cl_swftasklist( |string| )
  iv_defaultchildpolicy = |string|
  iv_defaultlambdarole = |string|
  iv_defaulttaskpriority = |string|
  iv_defexecstarttoclosetmout = |string|
  iv_deftaskstarttoclosetmout = |string|
  iv_description = |string|
  iv_domain = |string|
  iv_name = |string|
  iv_version = |string|
).