Smaws_Client_SWF.Typestype nonrec workflow_type = {version : version;The version of the workflow type.
The combination of workflow type name and version must be unique with in a domain.
*)name : name;The name of the workflow type.
The combination of workflow type name and version must be unique with in a domain.
*)}Represents a workflow type.
type nonrec workflow_type_info = {deprecation_date : timestamp option;If the type is in deprecated state, then it is set to the date when the type was deprecated.
*)creation_date : timestamp;The date when this type was registered.
*)description : description option;The description of the type registered through RegisterWorkflowType.
status : registration_status;The current status of the workflow type.
*)workflow_type : workflow_type;The workflow type this information is about.
*)}Contains information about a workflow type.
type nonrec workflow_type_info_list = workflow_type_info listtype nonrec workflow_type_infos = {next_page_token : page_token option;If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
type_infos : workflow_type_info_list;The list of workflow type information.
*)}Contains a paginated list of information structures about workflow types.
type nonrec workflow_type_filter = {version : version_optional option;Version of the workflow type.
*)name : name;Name of the workflow type.
*)}Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.
Represents a task list.
type nonrec workflow_type_configuration = {default_lambda_role : arn option;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 starting 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.
*)default_child_policy : child_policy option;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.default_task_priority : task_priority option;The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.
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.
*)default_task_list : task_list option;The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
default_execution_start_to_close_timeout : duration_in_seconds_optional option;The default maximum duration, specified when registering the workflow type, for executions of 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.
default_task_start_to_close_timeout : duration_in_seconds_optional option;The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. 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.
}The configuration settings of a workflow type.
type nonrec workflow_type_detail = {configuration : workflow_type_configuration;Configuration settings of the workflow type registered through RegisterWorkflowType
type_info : workflow_type_info;General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
REGISTERED – The type is registered and available. Workers supporting this type should be running.DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.}Contains details about a workflow type.
type nonrec workflow_execution_timed_out_event_attributes = {child_policy : child_policy;The policy used for the child workflow executions of this workflow execution.
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.timeout_type : workflow_execution_timeout_type;The type of timeout that caused this event.
*)}Provides the details of the WorkflowExecutionTimedOut event.
type nonrec workflow_execution_terminated_event_attributes = {cause : workflow_execution_terminated_cause option;If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.
*)child_policy : child_policy;The policy used for the child workflow executions of this workflow execution.
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.details : data option;The details provided for the termination.
*)reason : terminate_reason option;The reason provided for the termination.
*)}Provides the details of the WorkflowExecutionTerminated event.
type nonrec tag_list = tag listtype nonrec workflow_execution = {run_id : workflow_run_id;A system-generated unique identifier for the workflow execution.
*)workflow_id : workflow_id;The user defined identifier associated with the workflow execution.
*)}Represents a workflow execution.
type nonrec workflow_execution_started_event_attributes = {lambda_role : arn option;The IAM role attached to the workflow execution.
*)parent_initiated_event_id : event_id option;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
parent_workflow_execution : workflow_execution option;The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.
*)continued_execution_run_id : workflow_run_id_optional option;If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.
tag_list : tag_list option;The list of tags associated with this workflow execution. An execution can have up to 5 tags.
*)workflow_type : workflow_type;The workflow type of this execution.
*)task_priority : task_priority option;The priority of the decision tasks in the workflow execution.
*)task_list : task_list;The name of the task list for scheduling the decision tasks for this workflow execution.
*)child_policy : child_policy;The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
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.task_start_to_close_timeout : duration_in_seconds_optional option;The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
execution_start_to_close_timeout : duration_in_seconds_optional option;The maximum duration for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
input : data option;The input provided to the workflow execution.
*)}Provides details of WorkflowExecutionStarted event.
type nonrec workflow_execution_signaled_event_attributes = {external_initiated_event_id : event_id option;The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.
external_workflow_execution : workflow_execution option;The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
*)input : data option;The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.
*)signal_name : signal_name;The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
*)}Provides the details of the WorkflowExecutionSignaled event.
type nonrec workflow_execution_open_counts = {open_lambda_functions : count option;The count of Lambda tasks whose status is OPEN.
open_child_workflow_executions : count;The count of child workflow executions whose status is OPEN.
open_timers : count;The count of timers started by this workflow execution that have not fired yet.
*)open_decision_tasks : open_decision_tasks_count;The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
*)open_activity_tasks : count;The count of activity tasks whose status is OPEN.
}Contains the counts of open tasks, child workflow executions and timers for a workflow execution.
type nonrec workflow_execution_info = {cancel_requested : canceled option;Set to true if a cancellation is requested for this workflow execution.
*)tag_list : tag_list option;The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.
*)parent : workflow_execution option;If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
*)close_status : close_status option;If the execution status is closed then this specifies how the execution was closed:
COMPLETED – the execution was successfully completed.CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.TERMINATED – the execution was force terminated.FAILED – the execution failed to complete.TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.execution_status : execution_status;The current status of the execution.
*)close_timestamp : timestamp option;The time when the workflow execution was closed. Set only if the execution status is CLOSED.
*)start_timestamp : timestamp;The time when the execution was started.
*)workflow_type : workflow_type;The type of the workflow execution.
*)execution : workflow_execution;The workflow execution this information is about.
*)}Contains information about a workflow execution.
type nonrec workflow_execution_info_list = workflow_execution_info listtype nonrec workflow_execution_infos = {next_page_token : page_token option;If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
execution_infos : workflow_execution_info_list;The list of workflow information structures.
*)}Contains a paginated list of information about workflow executions.
type nonrec workflow_execution_filter = {workflow_id : workflow_id;The workflowId to pass of match the criteria of this filter.
*)}Used to filter the workflow executions in visibility APIs by their workflowId.
type nonrec workflow_execution_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;The details of the failure.
*)reason : failure_reason option;The descriptive reason provided for the failure.
*)}Provides the details of the WorkflowExecutionFailed event.
type nonrec workflow_execution_configuration = {lambda_role : arn option;The IAM role attached to the child workflow execution.
*)child_policy : child_policy;The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
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.task_priority : task_priority option;The priority assigned to decision tasks for this workflow execution. 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.
*)task_list : task_list;The task list used for the decision tasks generated for this workflow execution.
*)execution_start_to_close_timeout : duration_in_seconds;The total duration for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
task_start_to_close_timeout : duration_in_seconds;The maximum duration allowed for decision tasks for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
}The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.
type nonrec workflow_execution_detail = {latest_execution_context : data option;The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.
latest_activity_task_timestamp : timestamp option;The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.
*)open_counts : workflow_execution_open_counts;The number of tasks for this workflow execution. This includes open and closed tasks of all types.
*)execution_configuration : workflow_execution_configuration;The configuration settings for this workflow execution including timeout values, tasklist etc.
*)execution_info : workflow_execution_info;Information about the workflow execution.
*)}Contains details about a workflow execution.
type nonrec workflow_execution_count = {truncated : truncated option;If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
*)count : count;The number of workflow executions.
*)}Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions
type nonrec workflow_execution_continued_as_new_event_attributes = {lambda_role : arn option;The IAM role to attach to the new (continued) workflow execution.
*)workflow_type : workflow_type;The workflow type of this execution.
*)tag_list : tag_list option;The list of tags associated with the new workflow execution.
*)child_policy : child_policy;The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
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.task_start_to_close_timeout : duration_in_seconds_optional option;The maximum duration of decision tasks for the new workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
task_priority : task_priority option;The priority of the task to use for the decisions of the new (continued) workflow execution.
*)task_list : task_list;The task list to use for the decisions of the new (continued) workflow execution.
*)execution_start_to_close_timeout : duration_in_seconds_optional option;The total duration allowed for the new workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
new_execution_run_id : workflow_run_id;The runId of the new workflow execution.
decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
input : data option;The input provided to the new workflow execution.
*)}Provides the details of the WorkflowExecutionContinuedAsNew event.
type nonrec workflow_execution_completed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
result : data option;The result produced by the workflow execution upon successful completion.
*)}Provides the details of the WorkflowExecutionCompleted event.
type nonrec workflow_execution_canceled_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;The details of the cancellation.
*)}Provides the details of the WorkflowExecutionCanceled event.
type nonrec workflow_execution_cancel_requested_event_attributes = {cause : workflow_execution_cancel_requested_cause option;If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.
*)external_initiated_event_id : event_id option;The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
external_workflow_execution : workflow_execution option;The external workflow execution for which the cancellation was requested.
*)}Provides the details of the WorkflowExecutionCancelRequested event.
type nonrec workflow_execution_already_started_fault = {message : error_message option;A description that may help with diagnosing the cause of the fault.
*)}Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
type nonrec resource_tag_key_list = resource_tag_key listtype nonrec untag_resource_input = {tag_keys : resource_tag_key_list;The list of tags to remove from the Amazon SWF domain.
*)resource_arn : arn;The Amazon Resource Name (ARN) for the Amazon SWF domain.
*)}type nonrec unknown_resource_fault = {message : error_message option;A description that may help with diagnosing the cause of the 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.
type nonrec operation_not_permitted_fault = {message : error_message option;A description that may help with diagnosing the cause of the fault.
*)}Returned when the caller doesn't have sufficient permissions to invoke the action.
type nonrec limit_exceeded_fault = {message : error_message option;A description that may help with diagnosing the cause of the 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.
type nonrec undeprecate_workflow_type_input = {workflow_type : workflow_type;The name of the domain of the deprecated workflow type.
*)domain : domain_name;The name of the domain of the deprecated workflow type.
*)}type nonrec type_already_exists_fault = {message : error_message option;A description that may help with diagnosing the cause of the 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.
type nonrec undeprecate_domain_input = {name : domain_name;The name of the domain of the deprecated workflow type.
*)}type nonrec domain_already_exists_fault = {message : error_message option;A description that may help with diagnosing the cause of the fault.
*)}Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.
type nonrec activity_type = {version : version;The version of this activity.
The combination of activity type name and version must be unique with in a domain.
*)name : name;The name of this activity.
The combination of activity type name and version must be unique within a domain.
*)}Represents an activity type.
type nonrec undeprecate_activity_type_input = {activity_type : activity_type;The activity type to undeprecate.
*)domain : domain_name;The name of the domain of the deprecated activity type.
*)}Returned when the resource type has not been deprecated.
type nonrec type_deprecated_fault = {message : error_message option;A description that may help with diagnosing the cause of the fault.
*)}Returned when the specified activity or workflow type was already deprecated.
type nonrec timer_started_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
start_to_fire_timeout : duration_in_seconds;The duration of time after which the timer fires.
The duration is specified in seconds, an integer greater than or equal to 0.
control : data option;Data attached to the event that can be used by the decider in subsequent workflow tasks.
*)timer_id : timer_id;The unique ID of the timer that was started.
*)}Provides the details of the TimerStarted event.
type nonrec timer_fired_event_attributes = {started_event_id : event_id;The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
timer_id : timer_id;The unique ID of the timer that fired.
*)}Provides the details of the TimerFired event.
type nonrec timer_canceled_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
started_event_id : event_id;The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
timer_id : timer_id;The unique ID of the timer that was canceled.
*)}Provides the details of the TimerCanceled event.
type nonrec terminate_workflow_execution_input = {child_policy : child_policy option;If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.
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.A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
*)details : data option;Details for terminating the workflow execution.
*)reason : terminate_reason option;A descriptive reason for terminating the workflow execution.
*)run_id : workflow_run_id_optional option;The runId of the workflow execution to terminate.
*)workflow_id : workflow_id;The workflowId of the workflow execution to terminate.
*)domain : domain_name;The domain of the workflow execution to terminate.
*)}type nonrec resource_tag = {value : resource_tag_value option;The value of a tag.
*)key : resource_tag_key;The key of a tag.
*)}Tags are key-value pairs that can be associated with Amazon SWF state machines and activities.
Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
type nonrec resource_tag_list = resource_tag listtype nonrec tag_resource_input = {resource_arn : arn;The Amazon Resource Name (ARN) for the Amazon SWF domain.
*)}type nonrec tag_filter = {tag : tag;Specifies the tag that must be associated with the execution for it to meet the filter criteria.
Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.
}Used to filter the workflow executions in visibility APIs based on a tag.
type nonrec start_workflow_execution_input = {lambda_role : arn option;The IAM role to attach to this workflow execution.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
child_policy : child_policy option;If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
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.A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
*)task_start_to_close_timeout : duration_in_seconds_optional option;Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
*)tag_list : tag_list option;The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
execution_start_to_close_timeout : duration_in_seconds_optional option;The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
*)input : data option;The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
task_priority : task_priority option;The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type 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.
*)task_list : task_list option;The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
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.
workflow_type : workflow_type;The type of the workflow to start.
*)workflow_id : workflow_id;The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.
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.
domain : domain_name;The name of the domain in which the workflow execution is created.
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.
}The StartWorkflowExecution API action was called without the required parameters set.
Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type.
If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
type nonrec run = {run_id : workflow_run_id option;The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.
}Specifies the runId of a workflow execution.
type nonrec start_timer_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : start_timer_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
timer_id : timer_id;The timerId provided in the StartTimer decision that failed.
}Provides the details of the StartTimerFailed event.
type nonrec start_timer_decision_attributes = {start_to_fire_timeout : duration_in_seconds;The duration to wait before firing the timer.
The duration is specified in seconds, an integer greater than or equal to 0.
control : data option;The data attached to the event that can be used by the decider in subsequent workflow tasks.
*)timer_id : timer_id;The unique ID of the timer.
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.
}Provides the details of the StartTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec start_lambda_function_failed_event_attributes = {message : cause_message option;A description that can help diagnose the cause of the fault.
*)cause : start_lambda_function_failed_cause option;The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.
scheduled_event_id : event_id option;The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
}Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.
type nonrec start_child_workflow_execution_initiated_event_attributes = {lambda_role : arn option;The IAM role to attach to the child workflow execution.
*)tag_list : tag_list option;The list of tags to associated with the child workflow execution.
*)task_start_to_close_timeout : duration_in_seconds_optional option;The maximum duration allowed for the decision tasks for this workflow execution.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
child_policy : child_policy;The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.
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.decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.
task_priority : task_priority option;The priority assigned for the decision tasks for this workflow execution. 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.
*)task_list : task_list;The name of the task list used for the decision tasks of the child workflow execution.
*)execution_start_to_close_timeout : duration_in_seconds_optional option;The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
input : data option;The inputs provided to the child workflow execution.
*)control : data option;Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.
*)workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_id : workflow_id;The workflowId of the child workflow execution.
}Provides the details of the StartChildWorkflowExecutionInitiated event.
type nonrec start_child_workflow_execution_failed_cause = | OPERATION_NOT_PERMITTED| DEFAULT_CHILD_POLICY_UNDEFINED| DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED| DEFAULT_TASK_LIST_UNDEFINED| DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED| WORKFLOW_ALREADY_RUNNING| CHILD_CREATION_RATE_EXCEEDED| OPEN_WORKFLOWS_LIMIT_EXCEEDED| OPEN_CHILDREN_LIMIT_EXCEEDED| WORKFLOW_TYPE_DEPRECATED| WORKFLOW_TYPE_DOES_NOT_EXISTtype nonrec start_child_workflow_execution_failed_event_attributes = {control : data option;The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.
*)decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.
initiated_event_id : event_id;When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.
When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.
workflow_id : workflow_id;The workflowId of the child workflow execution.
cause : start_child_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
workflow_type : workflow_type;The workflow type provided in the StartChildWorkflowExecution Decision that failed.
}Provides the details of the StartChildWorkflowExecutionFailed event.
type nonrec start_child_workflow_execution_decision_attributes = {lambda_role : arn option;The IAM role attached to the child workflow execution.
*)tag_list : tag_list option;The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
child_policy : child_policy option;If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
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.A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
*)task_start_to_close_timeout : duration_in_seconds_optional option;Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
*)task_priority : task_priority option;A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.
*)task_list : task_list option;The name of the task list to be used for decision tasks of the child workflow execution.
A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.
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 be the literal string arn.
execution_start_to_close_timeout : duration_in_seconds_optional option;The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
*)input : data option;The input to be provided to the workflow execution.
*)control : data option;The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.
*)workflow_id : workflow_id;The workflowId of the workflow execution.
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.
workflow_type : workflow_type;The type of the workflow execution to be started.
*)}Provides the details of the StartChildWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Constrain the following parameters by using a Condition element with the appropriate keys.
tagList.member.N – The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive.taskList – String constraint. The key is swf:taskList.name.workflowType.name – String constraint. The key is swf:workflowType.name.workflowType.version – String constraint. The key is swf:workflowType.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.
type nonrec signal_workflow_execution_input = {input : data option;Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
signal_name : signal_name;The name of the signal. This name must be meaningful to the target workflow.
*)run_id : workflow_run_id_optional option;The runId of the workflow execution to signal.
*)workflow_id : workflow_id;The workflowId of the workflow execution to signal.
*)domain : domain_name;The name of the domain containing the workflow execution to signal.
*)}type nonrec decision_type = | ScheduleLambdaFunction| StartChildWorkflowExecution| RequestCancelExternalWorkflowExecution| SignalExternalWorkflowExecution| CancelTimer| StartTimer| RecordMarker| ContinueAsNewWorkflowExecution| CancelWorkflowExecution| FailWorkflowExecution| CompleteWorkflowExecution| RequestCancelActivityTask| ScheduleActivityTasktype nonrec schedule_activity_task_decision_attributes = {heartbeat_timeout : duration_in_seconds_optional option;If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
start_to_close_timeout : duration_in_seconds_optional option;If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.
*)schedule_to_start_timeout : duration_in_seconds_optional option;If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.
*)task_priority : task_priority option;If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. 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.
*)task_list : task_list option;If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.
A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.
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.
schedule_to_close_timeout : duration_in_seconds_optional option;The maximum duration for this activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.
*)input : data option;The input provided to the activity task.
*)control : data option;Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
*)activity_id : activity_id;The activityId of the activity task.
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.
activity_type : activity_type;The type of the activity task to schedule.
*)}Provides the details of the ScheduleActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Constrain the following parameters by using a Condition element with the appropriate keys.
activityType.name – String constraint. The key is swf:activityType.name.activityType.version – String constraint. The key is swf:activityType.version.taskList – String constraint. The key is swf:taskList.name.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.
type nonrec request_cancel_activity_task_decision_attributes = {activity_id : activity_id;The activityId of the activity task to be canceled.
}Provides the details of the RequestCancelActivityTask decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec complete_workflow_execution_decision_attributes = {result : data option;The result of the workflow execution. The form of the result is implementation defined.
*)}Provides the details of the CompleteWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec fail_workflow_execution_decision_attributes = {details : data option;Details of the failure.
*)reason : failure_reason option;A descriptive reason for the failure that may help in diagnostics.
*)}Provides the details of the FailWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec cancel_workflow_execution_decision_attributes = {details : data option;Details of the cancellation.
*)}Provides the details of the CancelWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec continue_as_new_workflow_execution_decision_attributes = {lambda_role : arn option;The IAM role to attach to the new (continued) execution.
*)workflow_type_version : version option;The version of the workflow to start.
*)tag_list : tag_list option;The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.
child_policy : child_policy option;If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
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.A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
*)task_start_to_close_timeout : duration_in_seconds_optional option;Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
*)task_priority : task_priority option;The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. 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.
*)task_list : task_list option;The task list to use for the decisions of the new (continued) workflow execution.
*)execution_start_to_close_timeout : duration_in_seconds_optional option;If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
*)input : data option;The input provided to the new workflow execution.
*)}Provides the details of the ContinueAsNewWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.Constrain the following parameters by using a Condition element with the appropriate keys.
tag – A tag used to identify the workflow executiontaskList – String constraint. The key is swf:taskList.name.workflowType.version – String constraint. The key is swf:workflowType.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.
type nonrec record_marker_decision_attributes = {details : data option;The details of the marker.
*)marker_name : marker_name;The name of the marker.
*)}Provides the details of the RecordMarker decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec cancel_timer_decision_attributes = {timer_id : timer_id;The unique ID of the timer to cancel.
*)}Provides the details of the CancelTimer decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec signal_external_workflow_execution_decision_attributes = {control : data option;The data attached to the event that can be used by the decider in subsequent decision tasks.
*)input : data option;The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.
*)signal_name : signal_name;The name of the signal.The target workflow execution uses the signal name and input to process the signal.
*)run_id : workflow_run_id_optional option;The runId of the workflow execution to be signaled.
workflow_id : workflow_id;The workflowId of the workflow execution to be signaled.
}Provides the details of the SignalExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec request_cancel_external_workflow_execution_decision_attributes = {control : data option;The data attached to the event that can be used by the decider in subsequent workflow tasks.
*)run_id : workflow_run_id_optional option;The runId of the external workflow execution to cancel.
workflow_id : workflow_id;The workflowId of the external workflow execution to cancel.
}Provides the details of the RequestCancelExternalWorkflowExecution decision.
Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
Resource element with the domain name to limit the action to only specified domains.Action element to allow or deny permission to call this action.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.
type nonrec schedule_lambda_function_decision_attributes = {start_to_close_timeout : duration_in_seconds_optional option;The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-900 (1s-15m).
If no value is supplied, then a default value of 900s is assumed.
*)input : function_input option;The optional input data to be supplied to the Lambda function.
*)control : data option;The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
*)name : function_name;The name, or ARN, of the Lambda function to schedule.
*)id : function_id;A string that identifies the Lambda function execution in the event history.
*)}Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.
type nonrec decision = {schedule_lambda_function_decision_attributes : schedule_lambda_function_decision_attributes
option;Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.
start_child_workflow_execution_decision_attributes : start_child_workflow_execution_decision_attributes
option;Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.
request_cancel_external_workflow_execution_decision_attributes : request_cancel_external_workflow_execution_decision_attributes
option;Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.
signal_external_workflow_execution_decision_attributes : signal_external_workflow_execution_decision_attributes
option;Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.
cancel_timer_decision_attributes : cancel_timer_decision_attributes option;Provides the details of the CancelTimer decision. It isn't set for other decision types.
start_timer_decision_attributes : start_timer_decision_attributes option;Provides the details of the StartTimer decision. It isn't set for other decision types.
record_marker_decision_attributes : record_marker_decision_attributes option;Provides the details of the RecordMarker decision. It isn't set for other decision types.
continue_as_new_workflow_execution_decision_attributes : continue_as_new_workflow_execution_decision_attributes
option;Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.
cancel_workflow_execution_decision_attributes : cancel_workflow_execution_decision_attributes
option;Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.
fail_workflow_execution_decision_attributes : fail_workflow_execution_decision_attributes
option;Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.
complete_workflow_execution_decision_attributes : complete_workflow_execution_decision_attributes
option;Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.
request_cancel_activity_task_decision_attributes : request_cancel_activity_task_decision_attributes
option;Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.
schedule_activity_task_decision_attributes : schedule_activity_task_decision_attributes
option;Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.
decision_type : decision_type;Specifies the type of the decision.
*)}Specifies a decision made by the decider. A decision can be one of these types:
CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the history.CancelWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCanceled event in the history.CompleteWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCompleted event in the history .ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed event in the history.RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event.RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.ScheduleActivityTask – Schedules an activity task.SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.StartChildWorkflowExecution – Requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in the history. This timer fires after the specified delay and record a TimerFired event.Access Control
If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
Decision Failure
Decisions can fail for several reasons
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured.RequestCancelActivityTaskFailed – A RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.StartTimerFailed – A StartTimer decision failed. This could happen if there is another open timer with the same timerId.CancelTimerFailed – A CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured.SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.RequestCancelExternalWorkflowExecutionFailed – A RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.ContinueAsNewWorkflowExecutionFailed – A ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault is returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.
How to Code a Decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
[ScheduleActivityTaskDecisionAttributes] [RequestCancelActivityTaskDecisionAttributes] [CompleteWorkflowExecutionDecisionAttributes] [FailWorkflowExecutionDecisionAttributes] [CancelWorkflowExecutionDecisionAttributes] [ContinueAsNewWorkflowExecutionDecisionAttributes] [RecordMarkerDecisionAttributes] [StartTimerDecisionAttributes] [CancelTimerDecisionAttributes] [SignalExternalWorkflowExecutionDecisionAttributes] [RequestCancelExternalWorkflowExecutionDecisionAttributes] [StartChildWorkflowExecutionDecisionAttributes] type nonrec decision_list = decision listtype nonrec respond_decision_task_completed_input = {task_list_schedule_to_start_timeout : duration_in_seconds_optional option;Specifies a timeout (in seconds) for the task list override. When this parameter is missing, the task list override is permanent. This parameter makes it possible to temporarily override the task list. If a decision task scheduled on the override task list is not started within the timeout, the decision task will time out. Amazon SWF will revert the override and schedule a new decision task to the original task list.
If a decision task scheduled on the override task list is started within the timeout, but not completed within the start-to-close timeout, Amazon SWF will also revert the override and schedule a new decision task to the original task list.
*)task_list : task_list option;The task list to use for the future decision tasks of this workflow execution. This list overrides the original task list you specified while starting the workflow execution.
*)execution_context : data option;User defined context to add to workflow execution.
*)decisions : decision_list option;The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.
task_token : task_token;The taskToken from the DecisionTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
}Input data for a TaskCompleted response to a decision task.
type nonrec respond_activity_task_failed_input = {details : data option;Detailed information about the failure.
*)reason : failure_reason option;Description of the error that may assist in diagnostics.
*)task_token : task_token;The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
}type nonrec respond_activity_task_completed_input = {result : data option;The result of the activity task. It is a free form string that is implementation specific.
*)task_token : task_token;The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
}type nonrec respond_activity_task_canceled_input = {details : data option;Information about the cancellation.
*)task_token : task_token;The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
}type nonrec request_cancel_workflow_execution_input = {run_id : workflow_run_id_optional option;The runId of the workflow execution to cancel.
*)workflow_id : workflow_id;The workflowId of the workflow execution to cancel.
*)domain : domain_name;The name of the domain containing the workflow execution to cancel.
*)}type nonrec register_workflow_type_input = {default_lambda_role : arn option;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.
*)default_child_policy : child_policy option;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.default_task_priority : task_priority option;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.
*)default_task_list : task_list option;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.
default_execution_start_to_close_timeout : duration_in_seconds_optional option;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.
default_task_start_to_close_timeout : duration_in_seconds_optional option;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.
description : description option;Textual description of the workflow type.
*)version : version;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.
name : name;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.
domain : domain_name;The name of the domain in which to register the workflow type.
*)}type nonrec register_domain_input = {workflow_execution_retention_period_in_days : duration_in_days;The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.
If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.
The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.
*)description : description option;A text description of the domain.
*)name : domain_name;Name of the domain to register. The name must be unique in the region that the domain is registered in.
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 be the literal string arn.
}type nonrec register_activity_type_input = {default_task_schedule_to_close_timeout : duration_in_seconds_optional option;If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
default_task_schedule_to_start_timeout : duration_in_seconds_optional option;If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
default_task_priority : task_priority option;The default task priority to assign to the activity 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 in the Amazon SWF Developer Guide..
*)default_task_list : task_list option;If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.
default_task_heartbeat_timeout : duration_in_seconds_optional option;If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
default_task_start_to_close_timeout : duration_in_seconds_optional option;If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
description : description option;A textual description of the activity type.
*)version : version;The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique within the domain.
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.
name : name;The name of the activity type within the domain.
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.
domain : domain_name;The name of the domain in which this activity is to be registered.
*)}type nonrec activity_task_status = {cancel_requested : canceled;Set to true if cancellation of the task is requested.
}Status information about an activity task.
type nonrec record_activity_task_heartbeat_input = {details : limited_data option;If specified, contains details about the progress of the task.
*)task_token : task_token;The taskToken of the ActivityTask.
taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
}type nonrec event_type = | StartLambdaFunctionFailed| ScheduleLambdaFunctionFailed| LambdaFunctionTimedOut| LambdaFunctionFailed| LambdaFunctionCompleted| LambdaFunctionStarted| LambdaFunctionScheduled| ExternalWorkflowExecutionCancelRequested| RequestCancelExternalWorkflowExecutionFailed| RequestCancelExternalWorkflowExecutionInitiated| ExternalWorkflowExecutionSignaled| SignalExternalWorkflowExecutionFailed| SignalExternalWorkflowExecutionInitiated| ChildWorkflowExecutionTerminated| ChildWorkflowExecutionCanceled| ChildWorkflowExecutionTimedOut| ChildWorkflowExecutionFailed| ChildWorkflowExecutionCompleted| ChildWorkflowExecutionStarted| StartChildWorkflowExecutionFailed| StartChildWorkflowExecutionInitiated| CancelTimerFailed| TimerCanceled| TimerFired| StartTimerFailed| TimerStarted| RecordMarkerFailed| MarkerRecorded| WorkflowExecutionSignaled| RequestCancelActivityTaskFailed| ActivityTaskCancelRequested| ActivityTaskCanceled| ActivityTaskTimedOut| ActivityTaskFailed| ActivityTaskCompleted| ActivityTaskStarted| ScheduleActivityTaskFailed| ActivityTaskScheduled| DecisionTaskTimedOut| DecisionTaskCompleted| DecisionTaskStarted| DecisionTaskScheduled| WorkflowExecutionTerminated| ContinueAsNewWorkflowExecutionFailed| WorkflowExecutionContinuedAsNew| CancelWorkflowExecutionFailed| WorkflowExecutionCanceled| WorkflowExecutionTimedOut| FailWorkflowExecutionFailed| WorkflowExecutionFailed| CompleteWorkflowExecutionFailed| WorkflowExecutionCompleted| WorkflowExecutionCancelRequested| WorkflowExecutionStartedtype nonrec complete_workflow_execution_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : complete_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
}Provides the details of the CompleteWorkflowExecutionFailed event.
type nonrec fail_workflow_execution_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : fail_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
}Provides the details of the FailWorkflowExecutionFailed event.
type nonrec cancel_workflow_execution_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : cancel_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
}Provides the details of the CancelWorkflowExecutionFailed event.
type nonrec continue_as_new_workflow_execution_failed_cause = | OPERATION_NOT_PERMITTED| CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED| DEFAULT_CHILD_POLICY_UNDEFINED| DEFAULT_TASK_LIST_UNDEFINED| DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED| DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED| WORKFLOW_TYPE_DOES_NOT_EXIST| WORKFLOW_TYPE_DEPRECATED| UNHANDLED_DECISIONtype nonrec continue_as_new_workflow_execution_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : continue_as_new_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
}Provides the details of the ContinueAsNewWorkflowExecutionFailed event.
type nonrec decision_task_scheduled_event_attributes = {schedule_to_start_timeout : duration_in_seconds_optional option;The maximum amount of time the decision task can wait to be assigned to a worker.
*)start_to_close_timeout : duration_in_seconds_optional option;The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
task_priority : task_priority option;A task priority that, if set, specifies the priority for this decision task. 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.
*)task_list : task_list;The name of the task list in which the decision task was scheduled.
*)}Provides details about the DecisionTaskScheduled event.
type nonrec decision_task_started_event_attributes = {scheduled_event_id : event_id;The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
identity : identity option;Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
*)}Provides the details of the DecisionTaskStarted event.
type nonrec decision_task_completed_event_attributes = {task_list_schedule_to_start_timeout : duration_in_seconds_optional option;The maximum amount of time the decision task can wait to be assigned to a worker.
*)task_list : task_list option;started_event_id : event_id;The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
execution_context : data option;User defined context for the workflow execution.
*)}Provides the details of the DecisionTaskCompleted event.
type nonrec decision_task_timed_out_event_attributes = {started_event_id : event_id;The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
timeout_type : decision_task_timeout_type;The type of timeout that expired before the decision task could be completed.
*)}Provides the details of the DecisionTaskTimedOut event.
type nonrec activity_task_scheduled_event_attributes = {heartbeat_timeout : duration_in_seconds_optional option;The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.
decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
task_priority : task_priority option;The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.
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.
*)task_list : task_list;The task list in which the activity task has been scheduled.
*)start_to_close_timeout : duration_in_seconds_optional option;The maximum amount of time a worker may take to process the activity task.
*)schedule_to_close_timeout : duration_in_seconds_optional option;The maximum amount of time for this activity task.
*)schedule_to_start_timeout : duration_in_seconds_optional option;The maximum amount of time the activity task can wait to be assigned to a worker.
*)control : data option;Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.
*)input : data option;The input provided to the activity task.
*)activity_id : activity_id;The unique ID of the activity task.
*)activity_type : activity_type;The type of the activity task.
*)}Provides the details of the ActivityTaskScheduled event.
type nonrec activity_task_started_event_attributes = {scheduled_event_id : event_id;The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
identity : identity option;Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.
*)}Provides the details of the ActivityTaskStarted event.
type nonrec activity_task_completed_event_attributes = {started_event_id : event_id;The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
result : data option;The results of the activity task.
*)}Provides the details of the ActivityTaskCompleted event.
type nonrec activity_task_failed_event_attributes = {started_event_id : event_id;The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;The details of the failure.
*)reason : failure_reason option;The reason provided for the failure.
*)}Provides the details of the ActivityTaskFailed event.
type nonrec activity_task_timed_out_event_attributes = {details : limited_data option;Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.
started_event_id : event_id;The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
timeout_type : activity_task_timeout_type;The type of the timeout that caused this event.
*)}Provides the details of the ActivityTaskTimedOut event.
type nonrec activity_task_canceled_event_attributes = {latest_cancel_requested_event_id : event_id option;If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
started_event_id : event_id;The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;Details of the cancellation.
*)}Provides the details of the ActivityTaskCanceled event.
type nonrec activity_task_cancel_requested_event_attributes = {activity_id : activity_id;The unique ID of the task.
*)decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
}Provides the details of the ActivityTaskCancelRequested event.
type nonrec marker_recorded_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;The details of the marker.
*)marker_name : marker_name;The name of the marker.
*)}Provides the details of the MarkerRecorded event.
type nonrec record_marker_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : record_marker_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
marker_name : marker_name;The marker's name.
*)}Provides the details of the RecordMarkerFailed event.
type nonrec child_workflow_execution_started_event_attributes = {initiated_event_id : event_id;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_execution : workflow_execution;The child workflow execution that was started.
*)}Provides the details of the ChildWorkflowExecutionStarted event.
type nonrec child_workflow_execution_completed_event_attributes = {started_event_id : event_id;The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
result : data option;The result of the child workflow execution.
*)workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_execution : workflow_execution;The child workflow execution that was completed.
*)}Provides the details of the ChildWorkflowExecutionCompleted event.
type nonrec child_workflow_execution_failed_event_attributes = {started_event_id : event_id;The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;The details of the failure (if provided).
*)reason : failure_reason option;The reason for the failure (if provided).
*)workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_execution : workflow_execution;The child workflow execution that failed.
*)}Provides the details of the ChildWorkflowExecutionFailed event.
type nonrec child_workflow_execution_timed_out_event_attributes = {started_event_id : event_id;The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
timeout_type : workflow_execution_timeout_type;The type of the timeout that caused the child workflow execution to time out.
*)workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_execution : workflow_execution;The child workflow execution that timed out.
*)}Provides the details of the ChildWorkflowExecutionTimedOut event.
type nonrec child_workflow_execution_canceled_event_attributes = {started_event_id : event_id;The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
details : data option;Details of the cancellation (if provided).
*)workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_execution : workflow_execution;The child workflow execution that was canceled.
*)}Provide details of the ChildWorkflowExecutionCanceled event.
type nonrec child_workflow_execution_terminated_event_attributes = {started_event_id : event_id;The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
workflow_type : workflow_type;The type of the child workflow execution.
*)workflow_execution : workflow_execution;The child workflow execution that was terminated.
*)}Provides the details of the ChildWorkflowExecutionTerminated event.
type nonrec signal_external_workflow_execution_initiated_event_attributes = {control : data option;Data attached to the event that can be used by the decider in subsequent decision tasks.
*)decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
input : data option;The input provided to the signal.
*)signal_name : signal_name;The name of the signal.
*)run_id : workflow_run_id_optional option;The runId of the external workflow execution to send the signal to.
workflow_id : workflow_id;The workflowId of the external workflow execution.
}Provides the details of the SignalExternalWorkflowExecutionInitiated event.
type nonrec external_workflow_execution_signaled_event_attributes = {initiated_event_id : event_id;The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
workflow_execution : workflow_execution;The external workflow execution that the signal was delivered to.
*)}Provides the details of the ExternalWorkflowExecutionSignaled event.
type nonrec signal_external_workflow_execution_failed_event_attributes = {control : data option;The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
*)decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : signal_external_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
run_id : workflow_run_id_optional option;The runId of the external workflow execution that the signal was being delivered to.
workflow_id : workflow_id;The workflowId of the external workflow execution that the signal was being delivered to.
}Provides the details of the SignalExternalWorkflowExecutionFailed event.
type nonrec external_workflow_execution_cancel_requested_event_attributes = {initiated_event_id : event_id;The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
workflow_execution : workflow_execution;The external workflow execution to which the cancellation request was delivered.
*)}Provides the details of the ExternalWorkflowExecutionCancelRequested event.
type nonrec request_cancel_external_workflow_execution_initiated_event_attributes =
{control : data option;Data attached to the event that can be used by the decider in subsequent workflow tasks.
*)decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
run_id : workflow_run_id_optional option;The runId of the external workflow execution to be canceled.
workflow_id : workflow_id;The workflowId of the external workflow execution to be canceled.
}Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.
type nonrec request_cancel_external_workflow_execution_failed_event_attributes =
{control : data option;The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.
*)decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
initiated_event_id : event_id;The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : request_cancel_external_workflow_execution_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
run_id : workflow_run_id_optional option;The runId of the external workflow execution.
workflow_id : workflow_id;The workflowId of the external workflow to which the cancel request was to be delivered.
}Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.
type nonrec schedule_activity_task_failed_cause = | OPERATION_NOT_PERMITTED| DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED| DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED| DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED| DEFAULT_TASK_LIST_UNDEFINED| DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED| ACTIVITY_CREATION_RATE_EXCEEDED| OPEN_ACTIVITIES_LIMIT_EXCEEDED| ACTIVITY_ID_ALREADY_IN_USE| ACTIVITY_TYPE_DOES_NOT_EXIST| ACTIVITY_TYPE_DEPRECATEDtype nonrec schedule_activity_task_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : schedule_activity_task_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
activity_id : activity_id;The activityId provided in the ScheduleActivityTask decision that failed.
activity_type : activity_type;The activity type provided in the ScheduleActivityTask decision that failed.
}Provides the details of the ScheduleActivityTaskFailed event.
type nonrec request_cancel_activity_task_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : request_cancel_activity_task_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
activity_id : activity_id;The activityId provided in the RequestCancelActivityTask decision that failed.
}Provides the details of the RequestCancelActivityTaskFailed event.
type nonrec cancel_timer_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.
cause : cancel_timer_failed_cause;The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
timer_id : timer_id;The timerId provided in the CancelTimer decision that failed.
}Provides the details of the CancelTimerFailed event.
type nonrec lambda_function_scheduled_event_attributes = {decision_task_completed_event_id : event_id;The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
start_to_close_timeout : duration_in_seconds_optional option;The maximum amount of time a worker can take to process the Lambda task.
*)input : function_input option;The input provided to the Lambda task.
*)control : data option;Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
*)name : function_name;The name of the Lambda function.
*)id : function_id;The unique ID of the Lambda task.
*)}Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.
type nonrec lambda_function_started_event_attributes = {scheduled_event_id : event_id;The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
}Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.
type nonrec lambda_function_completed_event_attributes = {result : data option;The results of the Lambda task.
*)started_event_id : event_id;The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
}Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.
type nonrec lambda_function_failed_event_attributes = {details : data option;The details of the failure.
*)reason : failure_reason option;The reason provided for the failure.
*)started_event_id : event_id;The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
}Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.
type nonrec lambda_function_timed_out_event_attributes = {timeout_type : lambda_function_timeout_type option;The type of the timeout that caused this event.
*)started_event_id : event_id;The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
scheduled_event_id : event_id;The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
}Provides details of the LambdaFunctionTimedOut event.
type nonrec schedule_lambda_function_failed_event_attributes = {decision_task_completed_event_id : event_id;The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
cause : schedule_lambda_function_failed_cause;The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.
If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.
name : function_name;The name of the Lambda function.
*)id : function_id;The ID provided in the ScheduleLambdaFunction decision that failed.
}Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.
type nonrec history_event = {start_lambda_function_failed_event_attributes : start_lambda_function_failed_event_attributes
option;Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.
schedule_lambda_function_failed_event_attributes : schedule_lambda_function_failed_event_attributes
option;Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.
lambda_function_timed_out_event_attributes : lambda_function_timed_out_event_attributes
option;Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.
lambda_function_failed_event_attributes : lambda_function_failed_event_attributes
option;Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.
lambda_function_completed_event_attributes : lambda_function_completed_event_attributes
option;Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.
lambda_function_started_event_attributes : lambda_function_started_event_attributes
option;Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.
lambda_function_scheduled_event_attributes : lambda_function_scheduled_event_attributes
option;Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.
start_child_workflow_execution_failed_event_attributes : start_child_workflow_execution_failed_event_attributes
option;If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
cancel_timer_failed_event_attributes : cancel_timer_failed_event_attributes
option;If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
start_timer_failed_event_attributes : start_timer_failed_event_attributes
option;If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
request_cancel_activity_task_failed_event_attributes : request_cancel_activity_task_failed_event_attributes
option;If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
schedule_activity_task_failed_event_attributes : schedule_activity_task_failed_event_attributes
option;If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
request_cancel_external_workflow_execution_failed_event_attributes :
request_cancel_external_workflow_execution_failed_event_attributes
option;If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
request_cancel_external_workflow_execution_initiated_event_attributes :
request_cancel_external_workflow_execution_initiated_event_attributes
option;If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
external_workflow_execution_cancel_requested_event_attributes : external_workflow_execution_cancel_requested_event_attributes
option;If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
signal_external_workflow_execution_failed_event_attributes : signal_external_workflow_execution_failed_event_attributes
option;If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
external_workflow_execution_signaled_event_attributes : external_workflow_execution_signaled_event_attributes
option;If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.
signal_external_workflow_execution_initiated_event_attributes : signal_external_workflow_execution_initiated_event_attributes
option;If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
child_workflow_execution_terminated_event_attributes : child_workflow_execution_terminated_event_attributes
option;If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.
child_workflow_execution_canceled_event_attributes : child_workflow_execution_canceled_event_attributes
option;If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
child_workflow_execution_timed_out_event_attributes : child_workflow_execution_timed_out_event_attributes
option;If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
child_workflow_execution_failed_event_attributes : child_workflow_execution_failed_event_attributes
option;If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
child_workflow_execution_completed_event_attributes : child_workflow_execution_completed_event_attributes
option;If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
child_workflow_execution_started_event_attributes : child_workflow_execution_started_event_attributes
option;If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
start_child_workflow_execution_initiated_event_attributes : start_child_workflow_execution_initiated_event_attributes
option;If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.
timer_canceled_event_attributes : timer_canceled_event_attributes option;If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
timer_fired_event_attributes : timer_fired_event_attributes option;If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.
timer_started_event_attributes : timer_started_event_attributes option;If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
record_marker_failed_event_attributes : record_marker_failed_event_attributes
option;If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
marker_recorded_event_attributes : marker_recorded_event_attributes option;If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_signaled_event_attributes : workflow_execution_signaled_event_attributes
option;If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_cancel_requested_event_attributes : activity_task_cancel_requested_event_attributes
option;If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_canceled_event_attributes : activity_task_canceled_event_attributes
option;If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_timed_out_event_attributes : activity_task_timed_out_event_attributes
option;If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_failed_event_attributes : activity_task_failed_event_attributes
option;If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_completed_event_attributes : activity_task_completed_event_attributes
option;If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_started_event_attributes : activity_task_started_event_attributes
option;If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
activity_task_scheduled_event_attributes : activity_task_scheduled_event_attributes
option;If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.
decision_task_timed_out_event_attributes : decision_task_timed_out_event_attributes
option;If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
decision_task_completed_event_attributes : decision_task_completed_event_attributes
option;If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
decision_task_started_event_attributes : decision_task_started_event_attributes
option;If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
decision_task_scheduled_event_attributes : decision_task_scheduled_event_attributes
option;If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_cancel_requested_event_attributes : workflow_execution_cancel_requested_event_attributes
option;If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_terminated_event_attributes : workflow_execution_terminated_event_attributes
option;If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.
continue_as_new_workflow_execution_failed_event_attributes : continue_as_new_workflow_execution_failed_event_attributes
option;If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_continued_as_new_event_attributes : workflow_execution_continued_as_new_event_attributes
option;If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.
cancel_workflow_execution_failed_event_attributes : cancel_workflow_execution_failed_event_attributes
option;If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_canceled_event_attributes : workflow_execution_canceled_event_attributes
option;If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_timed_out_event_attributes : workflow_execution_timed_out_event_attributes
option;If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.
fail_workflow_execution_failed_event_attributes : fail_workflow_execution_failed_event_attributes
option;If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_failed_event_attributes : workflow_execution_failed_event_attributes
option;If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
complete_workflow_execution_failed_event_attributes : complete_workflow_execution_failed_event_attributes
option;If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_completed_event_attributes : workflow_execution_completed_event_attributes
option;If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.
workflow_execution_started_event_attributes : workflow_execution_started_event_attributes
option;If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.
event_id : event_id;The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.
*)event_type : event_type;The type of the history event.
*)event_timestamp : timestamp;The date and time when the event occurred.
*)}Event within a workflow execution. A history event can be one of these types:
ActivityTaskCancelRequested – A RequestCancelActivityTask decision was received by the system.ActivityTaskCanceled – The activity task was successfully canceled.ActivityTaskCompleted – An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.ActivityTaskFailed – An activity worker failed an activity task by calling RespondActivityTaskFailed.ActivityTaskScheduled – An activity task was scheduled for execution.ActivityTaskStarted – The scheduled activity task was dispatched to a worker.ActivityTaskTimedOut – The activity task timed out.CancelTimerFailed – Failed to process CancelTimer decision. This happens when the decision isn't configured properly, for example no timer exists with the specified timer Id.CancelWorkflowExecutionFailed – A request to cancel a workflow execution failed.ChildWorkflowExecutionCanceled – A child workflow execution, started by this workflow execution, was canceled and closed.ChildWorkflowExecutionCompleted – A child workflow execution, started by this workflow execution, completed successfully and was closed.ChildWorkflowExecutionFailed – A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.ChildWorkflowExecutionStarted – A child workflow execution was successfully started.ChildWorkflowExecutionTerminated – A child workflow execution, started by this workflow execution, was terminated.ChildWorkflowExecutionTimedOut – A child workflow execution, started by this workflow execution, timed out and was closed.CompleteWorkflowExecutionFailed – The workflow execution failed to complete.ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to complete after being continued as a new workflow execution.DecisionTaskCompleted – The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.DecisionTaskScheduled – A decision task was scheduled for the workflow execution.DecisionTaskStarted – The decision task was dispatched to a decider.DecisionTaskTimedOut – The decision task timed out.ExternalWorkflowExecutionCancelRequested – Request to cancel an external workflow execution was successfully delivered to the target execution.ExternalWorkflowExecutionSignaled – A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.FailWorkflowExecutionFailed – A request to mark a workflow execution as failed, itself failed.MarkerRecorded – A marker was recorded in the workflow history as the result of a RecordMarker decision.RecordMarkerFailed – A RecordMarker decision was returned as failed.RequestCancelActivityTaskFailed – Failed to process RequestCancelActivityTask decision. This happens when the decision isn't configured properly.RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external workflow execution failed.RequestCancelExternalWorkflowExecutionInitiated – A request was made to request the cancellation of an external workflow execution.ScheduleActivityTaskFailed – Failed to process ScheduleActivityTask decision. This happens when the decision isn't configured properly, for example the activity type specified isn't registered.SignalExternalWorkflowExecutionFailed – The request to signal an external workflow execution failed.SignalExternalWorkflowExecutionInitiated – A request to signal an external workflow was made.StartActivityTaskFailed – A scheduled activity task failed to start.StartChildWorkflowExecutionFailed – Failed to process StartChildWorkflowExecution decision. This happens when the decision isn't configured properly, for example the workflow type specified isn't registered.StartChildWorkflowExecutionInitiated – A request was made to start a child workflow execution.StartTimerFailed – Failed to process StartTimer decision. This happens when the decision isn't configured properly, for example a timer already exists with the specified timer Id.TimerCanceled – A timer, previously started for this workflow execution, was successfully canceled.TimerFired – A timer, previously started for this workflow execution, fired.TimerStarted – A timer was started for the workflow execution due to a StartTimer decision.WorkflowExecutionCancelRequested – A request to cancel this workflow execution was made.WorkflowExecutionCanceled – The workflow execution was successfully canceled and closed.WorkflowExecutionCompleted – The workflow execution was closed due to successful completion.WorkflowExecutionContinuedAsNew – The workflow execution was closed and a new execution of the same type was created with the same workflowId.WorkflowExecutionFailed – The workflow execution closed due to a failure.WorkflowExecutionSignaled – An external signal was received for the workflow execution.WorkflowExecutionStarted – The workflow execution was started.WorkflowExecutionTerminated – The workflow execution was terminated.WorkflowExecutionTimedOut – The workflow execution was closed because a time out was exceeded.type nonrec history_event_list = history_event listtype nonrec decision_task = {previous_started_event_id : event_id option;The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.
*)next_page_token : page_token option;If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
events : history_event_list;A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
*)workflow_type : workflow_type;The type of the workflow execution for which this decision task was created.
*)workflow_execution : workflow_execution;The workflow execution for which this decision task was created.
*)started_event_id : event_id;The ID of the DecisionTaskStarted event recorded in the history.
task_token : task_token;The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
*)}A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.
type nonrec poll_for_decision_task_input = {start_at_previous_started_event : start_at_previous_started_event option;When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.
reverse_order : reverse_order option;When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
*)next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.
identity : identity option;Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
*)task_list : task_list;Specifies the task list to poll for decision tasks.
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.
domain : domain_name;The name of the domain containing the task lists to poll.
*)}type nonrec activity_task = {input : data option;The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.
*)activity_type : activity_type;The type of this activity task.
*)workflow_execution : workflow_execution;The workflow execution that started this activity task.
*)started_event_id : event_id;The ID of the ActivityTaskStarted event recorded in the history.
activity_id : activity_id;The unique ID of the task.
*)task_token : task_token;The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.
*)}Unit of work sent to an activity worker.
type nonrec poll_for_activity_task_input = {identity : identity option;Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
task_list : task_list;Specifies the task list to poll for activity tasks.
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 be the literal string arn.
domain : domain_name;The name of the domain that contains the task lists being polled.
*)}type nonrec list_workflow_types_input = {reverse_order : reverse_order option;When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
registration_status : registration_status;Specifies the registration status of the workflow types to list.
*)name : name option;If specified, lists the workflow type with this name.
*)domain : domain_name;The name of the domain in which the workflow types have been registered.
*)}type nonrec execution_time_filter = {latest_date : timestamp option;Specifies the latest start or close date and time to return.
*)oldest_date : timestamp;Specifies the oldest start or close date and time to return.
*)}Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: "oldestDate": 1325376070.
type nonrec list_open_workflow_executions_input = {execution_filter : workflow_execution_filter option;If specified, only workflow executions matching the workflow ID specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
reverse_order : reverse_order option;When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
tag_filter : tag_filter option;If specified, only executions that have the matching tag are listed.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
type_filter : workflow_type_filter option;If specified, only executions of the type specified in the filter are returned.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
start_time_filter : execution_time_filter;Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
*)domain : domain_name;The name of the domain that contains the workflow executions to list.
*)}type nonrec domain_info = {arn : arn option;The ARN of the domain.
*)description : description option;The description of the domain provided through RegisterDomain.
status : registration_status;The status of the domain:
REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.name : domain_name;The name of the domain. This name is unique within the account.
*)}Contains general information about a domain.
type nonrec domain_info_list = domain_info listtype nonrec domain_infos = {next_page_token : page_token option;If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
domain_infos : domain_info_list;A list of DomainInfo structures.
*)}Contains a paginated collection of DomainInfo structures.
type nonrec list_domains_input = {reverse_order : reverse_order option;When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
registration_status : registration_status;Specifies the registration status of the domains to list.
*)next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
}type nonrec close_status_filter = {status : close_status;The close status that must match the close status of an execution for it to meet the criteria of this filter.
*)}Used to filter the closed workflow executions in visibility APIs by their close status.
type nonrec list_closed_workflow_executions_input = {reverse_order : reverse_order option;When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
tag_filter : tag_filter option;If specified, only executions that have the matching tag are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
type_filter : workflow_type_filter option;If specified, only executions of the type specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
close_status_filter : close_status_filter option;If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
execution_filter : workflow_execution_filter option;If specified, only workflow executions matching the workflow ID specified in the filter are returned.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
close_time_filter : execution_time_filter option;If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
start_time_filter : execution_time_filter option;If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
domain : domain_name;The name of the domain that contains the workflow executions to list.
*)}type nonrec activity_type_info = {deprecation_date : timestamp option;If DEPRECATED, the date and time DeprecateActivityType was called.
creation_date : timestamp;The date and time this activity type was created through RegisterActivityType.
description : description option;The description of the activity type provided in RegisterActivityType.
status : registration_status;The current status of the activity type.
*)activity_type : activity_type;The ActivityType type structure representing the activity type.
}Detailed information about an activity type.
type nonrec activity_type_info_list = activity_type_info listtype nonrec activity_type_infos = {next_page_token : page_token option;If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
type_infos : activity_type_info_list;List of activity type information.
*)}Contains a paginated list of activity type information structures.
type nonrec list_activity_types_input = {reverse_order : reverse_order option;When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
registration_status : registration_status;Specifies the registration status of the activity types to list.
*)name : name option;If specified, only lists the activity types that have this name.
*)domain : domain_name;The name of the domain in which the activity types have been registered.
*)}type nonrec history = {next_page_token : page_token option;If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.
The configured maximumPageSize determines how many results can be returned in a single call.
events : history_event_list;The list of history events.
*)}Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.
type nonrec get_workflow_execution_history_input = {reverse_order : reverse_order option;When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
maximum_page_size : page_size option;The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.
next_page_token : page_token option;If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: "Specified token has exceeded its maximum lifetime".
The configured maximumPageSize determines how many results can be returned in a single call.
execution : workflow_execution;Specifies the workflow execution for which to return the history.
*)domain : domain_name;The name of the domain containing the workflow execution.
*)}type nonrec describe_workflow_type_input = {workflow_type : workflow_type;The workflow type to describe.
*)domain : domain_name;The name of the domain in which this workflow type is registered.
*)}type nonrec describe_workflow_execution_input = {execution : workflow_execution;The workflow execution to describe.
*)domain : domain_name;The name of the domain containing the workflow execution.
*)}type nonrec domain_configuration = {workflow_execution_retention_period_in_days : duration_in_days;The retention period for workflow executions in this domain.
*)}Contains the configuration settings of a domain.
type nonrec domain_detail = {configuration : domain_configuration;The domain configuration. Currently, this includes only the domain's retention period.
*)domain_info : domain_info;The basic information about a domain, such as its name, status, and description.
*)}Contains details of a domain.
type nonrec activity_type_configuration = {default_task_schedule_to_close_timeout : duration_in_seconds_optional option;The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
default_task_schedule_to_start_timeout : duration_in_seconds_optional option;The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
default_task_priority : task_priority option;The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task.
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.
*)default_task_list : task_list option;The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.
default_task_heartbeat_timeout : duration_in_seconds_optional option;The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
default_task_start_to_close_timeout : duration_in_seconds_optional option;The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
}Configuration settings registered with the activity type.
type nonrec activity_type_detail = {configuration : activity_type_configuration;The configuration settings registered with the activity type.
*)type_info : activity_type_info;General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
REGISTERED – The type is registered and available. Workers supporting this type should be running.DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.}Detailed information about an activity type.
type nonrec describe_activity_type_input = {activity_type : activity_type;The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.
domain : domain_name;The name of the domain in which the activity type is registered.
*)}type nonrec deprecate_workflow_type_input = {workflow_type : workflow_type;The workflow type to deprecate.
*)domain : domain_name;The name of the domain in which the workflow type is registered.
*)}type nonrec domain_deprecated_fault = {message : error_message option;A description that may help with diagnosing the cause of the fault.
*)}Returned when the specified domain has been deprecated.
type nonrec deprecate_activity_type_input = {activity_type : activity_type;The activity type to deprecate.
*)domain : domain_name;The name of the domain in which the activity type is registered.
*)}type nonrec delete_workflow_type_input = {workflow_type : workflow_type;The workflow type to delete.
*)domain : domain_name;The name of the domain in which the workflow type is registered.
*)}type nonrec delete_activity_type_input = {activity_type : activity_type;The activity type to delete.
*)domain : domain_name;The name of the domain in which the activity type is registered.
*)}type nonrec pending_task_count = {truncated : truncated option;If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.
*)count : count;The number of tasks in the task list.
*)}Contains the count of tasks in a task list.
type nonrec count_pending_decision_tasks_input = {task_list : task_list;The name of the task list.
*)domain : domain_name;The name of the domain that contains the task list.
*)}type nonrec count_pending_activity_tasks_input = {task_list : task_list;The name of the task list.
*)domain : domain_name;The name of the domain that contains the task list.
*)}type nonrec count_open_workflow_executions_input = {execution_filter : workflow_execution_filter option;If specified, only workflow executions matching the WorkflowId in the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
tag_filter : tag_filter option;If specified, only executions that have a tag that matches the filter are counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
type_filter : workflow_type_filter option;Specifies the type of the workflow executions to be counted.
executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
start_time_filter : execution_time_filter;Specifies the start time criteria that workflow executions must meet in order to be counted.
*)domain : domain_name;The name of the domain containing the workflow executions to count.
*)}type nonrec count_closed_workflow_executions_input = {close_status_filter : close_status_filter option;If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
tag_filter : tag_filter option;If specified, only executions that have a tag that matches the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
type_filter : workflow_type_filter option;If specified, indicates the type of the workflow executions to be counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
execution_filter : workflow_execution_filter option;If specified, only workflow executions matching the WorkflowId in the filter are counted.
closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
close_time_filter : execution_time_filter option;If specified, only workflow executions that meet the close time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
start_time_filter : execution_time_filter option;If specified, only workflow executions that meet the start time criteria of the filter are counted.
startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
domain : domain_name;The name of the domain containing the workflow executions to count.
*)}