AWS SDK for .NET Documentation
RegisterWorkflowTypeRequest Class
AmazonAmazon.SimpleWorkflow.ModelRegisterWorkflowTypeRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the RegisterWorkflowType operation.

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.

IMPORTANT: 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:

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Declaration Syntax
C#
public class RegisterWorkflowTypeRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
RegisterWorkflowTypeRequest()()()()
Initializes a new instance of the RegisterWorkflowTypeRequest class

DefaultChildPolicy
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 StartChildWorkflowExecutionDecision. The supported child policies are:
  • TERMINATE: the child executions will be terminated.
  • REQUEST_CANCEL: a request to cancel will be 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 will be taken. The child executions will continue to run.

Constraints:

Allowed Values
TERMINATE, REQUEST_CANCEL, ABANDON


DefaultExecutionStartToCloseTimeout
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 StartChildWorkflowExecutionDecision. The duration is specified in seconds. The valid values are integers 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 will always cause the workflow execution to time out.

Constraints:

Length
0 - 8


DefaultTaskList
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 is not provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecutionDecision.

DefaultTaskStartToCloseTimeout
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 StartChildWorkflowExecutionDecision. The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:

Length
0 - 8


Description
Textual description of the workflow type.

Constraints:

Length
0 - 1024


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

Constraints:

Length
1 - 256


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Name
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 (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string "arn".

Constraints:

Length
1 - 256


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Version
The version of the workflow type.
Note:
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 (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string "arn".

Constraints:

Length
1 - 64


WithDefaultChildPolicy(String) Obsolete.
Sets the DefaultChildPolicy property

WithDefaultExecutionStartToCloseTimeout(String) Obsolete.
Sets the DefaultExecutionStartToCloseTimeout property

WithDefaultTaskList(TaskList) Obsolete.
Sets the DefaultTaskList property

WithDefaultTaskStartToCloseTimeout(String) Obsolete.
Sets the DefaultTaskStartToCloseTimeout property

WithDescription(String) Obsolete.
Sets the Description property

WithDomain(String) Obsolete.
Sets the Domain property

WithName(String) Obsolete.
Sets the Name property

WithVersion(String) Obsolete.
Sets the Version property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 RegisterWorkflowTypeRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)