String taskToken
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.
String activityId
The unique ID of the task.
Long startedEventId
The ID of the ActivityTaskStarted
event recorded in the
history.
WorkflowExecution workflowExecution
The workflow execution that started this activity task.
ActivityType activityType
The type of this activity task.
String input
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.
String details
Details of the cancellation (if any).
Long scheduledEventId
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.
Long startedEventId
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.
Long latestCancelRequestedEventId
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.
Long decisionTaskCompletedEventId
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.
String activityId
The unique ID of the task.
String result
The results of the activity task (if any).
Long scheduledEventId
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.
Long startedEventId
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.
String reason
The reason provided for the failure (if any).
String details
The details of the failure (if any).
Long scheduledEventId
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.
Long startedEventId
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.
ActivityType activityType
The type of the activity task.
String activityId
The unique ID of the activity task.
String input
The input provided to the activity task.
String control
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
String scheduleToStartTimeout
The maximum amount of time the activity task can wait to be assigned to a worker.
String scheduleToCloseTimeout
The maximum amount of time for this activity task.
String startToCloseTimeout
The maximum amount of time a worker may take to process the activity task.
TaskList taskList
The task list in which the activity task has been scheduled.
String taskPriority
Optional. The priority to assign to the scheduled activity task. If set, this will override 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 Simple Workflow Developer Guide.
Long decisionTaskCompletedEventId
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.
String heartbeatTimeout
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 will be ignored.
String identity
Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.
Long scheduledEventId
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.
Boolean cancelRequested
Set to true
if cancellation of the task is requested.
String timeoutType
The type of the timeout that caused this event.
Long scheduledEventId
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.
Long startedEventId
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.
String details
Contains the content of the details
parameter for the last
call made by the activity to RecordActivityTaskHeartbeat
.
String defaultTaskStartToCloseTimeout
Optional. 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. The value "NONE" can be used to specify unlimited duration.
String defaultTaskHeartbeatTimeout
Optional. 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. The value "NONE" can be used to specify unlimited duration.
TaskList defaultTaskList
Optional. The default task list specified for this activity type
at registration. This default is used if a task list is not 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.
String defaultTaskPriority
Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be 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 Simple Workflow Developer Guide.
String defaultTaskScheduleToStartTimeout
Optional. 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. The value "NONE" can be used to specify unlimited duration.
String defaultTaskScheduleToCloseTimeout
Optional. 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. The value "NONE" can be used to specify unlimited duration.
ActivityTypeInfo typeInfo
General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
ActivityTypeConfiguration configuration
The configuration settings registered with the activity type.
ActivityType activityType
The ActivityType type structure representing the activity type.
String status
The current status of the activity type.
String description
The description of the activity type provided in RegisterActivityType.
Date creationDate
The date and time this activity type was created through RegisterActivityType.
Date deprecationDate
If DEPRECATED, the date and time DeprecateActivityType was called.
List<E> typeInfos
List of activity type information.
String nextPageToken
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.
String timerId
Required. The unique ID of the timer to cancel.
String timerId
The timerId provided in the CancelTimer
decision that
failed.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String details
Optional. details of the cancellation.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
WorkflowExecution workflowExecution
The child workflow execution that was canceled.
WorkflowType workflowType
The type of the child workflow execution.
String details
Details of the cancellation (if provided).
Long initiatedEventId
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.
Long startedEventId
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.
WorkflowExecution workflowExecution
The child workflow execution that was completed.
WorkflowType workflowType
The type of the child workflow execution.
String result
The result of the child workflow execution (if any).
Long initiatedEventId
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.
Long startedEventId
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.
WorkflowExecution workflowExecution
The child workflow execution that failed.
WorkflowType workflowType
The type of the child workflow execution.
String reason
The reason for the failure (if provided).
String details
The details of the failure (if provided).
Long initiatedEventId
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.
Long startedEventId
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.
WorkflowExecution workflowExecution
The child workflow execution that was started.
WorkflowType workflowType
The type of the child workflow execution.
Long initiatedEventId
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.
WorkflowExecution workflowExecution
The child workflow execution that was terminated.
WorkflowType workflowType
The type of the child workflow execution.
Long initiatedEventId
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.
Long startedEventId
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.
WorkflowExecution workflowExecution
The child workflow execution that timed out.
WorkflowType workflowType
The type of the child workflow execution.
String timeoutType
The type of the timeout that caused the child workflow execution to time out.
Long initiatedEventId
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.
Long startedEventId
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.
String status
Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.
String result
The result of the workflow execution. The form of the result is implementation defined.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String input
The input provided to the new workflow execution.
String executionStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
TaskList taskList
String taskPriority
Optional. 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 Simple Workflow Developer Guide.
String taskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.List<E> tagList
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.
String workflowTypeVersion
String lambdaRole
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String domain
The name of the domain containing the workflow executions to count.
ExecutionTimeFilter startTimeFilter
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.ExecutionTimeFilter closeTimeFilter
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.WorkflowExecutionFilter executionFilter
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.WorkflowTypeFilter typeFilter
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.TagFilter tagFilter
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.CloseStatusFilter closeStatusFilter
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.String domain
The name of the domain containing the workflow executions to count.
ExecutionTimeFilter startTimeFilter
Specifies the start time criteria that workflow executions must meet in order to be counted.
WorkflowTypeFilter typeFilter
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.TagFilter tagFilter
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.WorkflowExecutionFilter executionFilter
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.String decisionType
Specifies the type of the decision.
ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes
Provides details of the ScheduleActivityTask
decision. It is
not set for other decision types.
RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes
Provides details of the RequestCancelActivityTask
decision.
It is not set for other decision types.
CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes
Provides details of the CompleteWorkflowExecution
decision.
It is not set for other decision types.
FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes
Provides details of the FailWorkflowExecution
decision. It
is not set for other decision types.
CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes
Provides details of the CancelWorkflowExecution
decision. It
is not set for other decision types.
ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes
Provides details of the ContinueAsNewWorkflowExecution
decision. It is not set for other decision types.
RecordMarkerDecisionAttributes recordMarkerDecisionAttributes
Provides details of the RecordMarker
decision. It is not set
for other decision types.
StartTimerDecisionAttributes startTimerDecisionAttributes
Provides details of the StartTimer
decision. It is not set
for other decision types.
CancelTimerDecisionAttributes cancelTimerDecisionAttributes
Provides details of the CancelTimer
decision. It is not set
for other decision types.
SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes
Provides details of the SignalExternalWorkflowExecution
decision. It is not set for other decision types.
RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes
Provides details of the
RequestCancelExternalWorkflowExecution
decision. It is not
set for other decision types.
StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes
Provides details of the StartChildWorkflowExecution
decision. It is not set for other decision types.
ScheduleLambdaFunctionDecisionAttributes scheduleLambdaFunctionDecisionAttributes
String taskToken
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.
Long startedEventId
The ID of the DecisionTaskStarted
event recorded in the
history.
WorkflowExecution workflowExecution
The workflow execution for which this decision task was created.
WorkflowType workflowType
The type of the workflow execution for which this decision task was created.
List<E> events
A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.
String nextPageToken
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.
Long previousStartedEventId
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.
String executionContext
User defined context for the workflow execution.
Long scheduledEventId
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.
Long startedEventId
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.
TaskList taskList
The name of the task list in which the decision task was scheduled.
String taskPriority
Optional. 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 Simple Workflow Developer Guide.
String startToCloseTimeout
The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
String identity
Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.
Long scheduledEventId
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.
String timeoutType
The type of timeout that expired before the decision task could be completed.
Long scheduledEventId
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.
Long startedEventId
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.
String domain
The name of the domain in which the activity type is registered.
ActivityType activityType
The activity type to deprecate.
String name
The name of the domain to deprecate.
String domain
The name of the domain in which the workflow type is registered.
WorkflowType workflowType
The workflow type to deprecate.
String domain
The name of the domain in which the activity type is registered.
ActivityType activityType
The activity type to get information about. Activity types are identified
by the name
and version
that were supplied when
the activity was registered.
String name
The name of the domain to describe.
String domain
The name of the domain containing the workflow execution.
WorkflowExecution execution
The workflow execution to describe.
String domain
The name of the domain in which this workflow type is registered.
WorkflowType workflowType
The workflow type to describe.
String workflowExecutionRetentionPeriodInDays
The retention period for workflow executions in this domain.
DomainInfo domainInfo
DomainConfiguration configuration
String name
The name of the domain. This name is unique within the account.
String status
The status of the domain:
String description
The description of the domain provided through RegisterDomain.
List<E> domainInfos
A list of DomainInfo structures.
String nextPageToken
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.
WorkflowExecution workflowExecution
The external workflow execution to which the cancellation request was delivered.
Long initiatedEventId
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.
WorkflowExecution workflowExecution
The external workflow execution that the signal was delivered to.
Long initiatedEventId
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.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String domain
The name of the domain containing the workflow execution.
WorkflowExecution execution
Specifies the workflow execution for which to return the history.
String nextPageToken
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.
Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
List<E> events
The list of history events.
String nextPageToken
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.
Date eventTimestamp
The date and time when the event occurred.
String eventType
The type of the history event.
Long eventId
The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.
WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes
If the event is of type WorkflowExecutionStarted
then this
member is set and provides detailed information about the event. It is
not set for other event types.
WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes
If the event is of type WorkflowExecutionCompleted
then this
member is set and provides detailed information about the event. It is
not set for other event types.
CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes
If the event is of type CompleteWorkflowExecutionFailed
then
this member is set and provides detailed information about the event. It
is not set for other event types.
WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes
If the event is of type WorkflowExecutionFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.
FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes
If the event is of type FailWorkflowExecutionFailed
then
this member is set and provides detailed information about the event. It
is not set for other event types.
WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes
If the event is of type WorkflowExecutionTimedOut
then this
member is set and provides detailed information about the event. It is
not set for other event types.
WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes
If the event is of type WorkflowExecutionCanceled
then this
member is set and provides detailed information about the event. It is
not set for other event types.
CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes
If the event is of type CancelWorkflowExecutionFailed
then
this member is set and provides detailed information about the event. It
is not set for other event types.
WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes
If the event is of type WorkflowExecutionContinuedAsNew
then
this member is set and provides detailed information about the event. It
is not set for other event types.
ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes
If the event is of type ContinueAsNewWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.
WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes
If the event is of type WorkflowExecutionTerminated
then
this member is set and provides detailed information about the event. It
is not set for other event types.
WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes
If the event is of type WorkflowExecutionCancelRequested
then this member is set and provides detailed information about the
event. It is not set for other event types.
DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes
If the event is of type DecisionTaskScheduled
then this
member is set and provides detailed information about the event. It is
not set for other event types.
DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes
If the event is of type DecisionTaskStarted
then this member
is set and provides detailed information about the event. It is not set
for other event types.
DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes
If the event is of type DecisionTaskCompleted
then this
member is set and provides detailed information about the event. It is
not set for other event types.
DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes
If the event is of type DecisionTaskTimedOut
then this
member is set and provides detailed information about the event. It is
not set for other event types.
ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes
If the event is of type ActivityTaskScheduled
then this
member is set and provides detailed information about the event. It is
not set for other event types.
ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes
If the event is of type ActivityTaskStarted
then this member
is set and provides detailed information about the event. It is not set
for other event types.
ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes
If the event is of type ActivityTaskCompleted
then this
member is set and provides detailed information about the event. It is
not set for other event types.
ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes
If the event is of type ActivityTaskFailed
then this member
is set and provides detailed information about the event. It is not set
for other event types.
ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes
If the event is of type ActivityTaskTimedOut
then this
member is set and provides detailed information about the event. It is
not set for other event types.
ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes
If the event is of type ActivityTaskCanceled
then this
member is set and provides detailed information about the event. It is
not set for other event types.
ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes
If the event is of type ActivityTaskcancelRequested
then
this member is set and provides detailed information about the event. It
is not set for other event types.
WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes
If the event is of type WorkflowExecutionSignaled
then this
member is set and provides detailed information about the event. It is
not set for other event types.
MarkerRecordedEventAttributes markerRecordedEventAttributes
If the event is of type MarkerRecorded
then this member is
set and provides detailed information about the event. It is not set for
other event types.
RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes
If the event is of type DecisionTaskFailed
then this member
is set and provides detailed information about the event. It is not set
for other event types.
TimerStartedEventAttributes timerStartedEventAttributes
If the event is of type TimerStarted
then this member is set
and provides detailed information about the event. It is not set for
other event types.
TimerFiredEventAttributes timerFiredEventAttributes
If the event is of type TimerFired
then this member is set
and provides detailed information about the event. It is not set for
other event types.
TimerCanceledEventAttributes timerCanceledEventAttributes
If the event is of type TimerCanceled
then this member is
set and provides detailed information about the event. It is not set for
other event types.
StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes
If the event is of type StartChildWorkflowExecutionInitiated
then this member is set and provides detailed information about the
event. It is not set for other event types.
ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes
If the event is of type ChildWorkflowExecutionStarted
then
this member is set and provides detailed information about the event. It
is not set for other event types.
ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes
If the event is of type ChildWorkflowExecutionCompleted
then
this member is set and provides detailed information about the event. It
is not set for other event types.
ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes
If the event is of type ChildWorkflowExecutionFailed
then
this member is set and provides detailed information about the event. It
is not set for other event types.
ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes
If the event is of type ChildWorkflowExecutionTimedOut
then
this member is set and provides detailed information about the event. It
is not set for other event types.
ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes
If the event is of type ChildWorkflowExecutionCanceled
then
this member is set and provides detailed information about the event. It
is not set for other event types.
ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes
If the event is of type ChildWorkflowExecutionTerminated
then this member is set and provides detailed information about the
event. It is not set for other event types.
SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes
If the event is of type
SignalExternalWorkflowExecutionInitiated
then this member is
set and provides detailed information about the event. It is not set for
other event types.
ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes
If the event is of type ExternalWorkflowExecutionSignaled
then this member is set and provides detailed information about the
event. It is not set for other event types.
SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes
If the event is of type
SignalExternalWorkflowExecutionFailed
then this member is
set and provides detailed information about the event. It is not set for
other event types.
ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes
If the event is of type
ExternalWorkflowExecutionCancelRequested
then this member is
set and provides detailed information about the event. It is not set for
other event types.
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes
If the event is of type
RequestCancelExternalWorkflowExecutionInitiated
then this
member is set and provides detailed information about the event. It is
not set for other event types.
RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes
If the event is of type
RequestCancelExternalWorkflowExecutionFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.
ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes
If the event is of type ScheduleActivityTaskFailed
then this
member is set and provides detailed information about the event. It is
not set for other event types.
RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes
If the event is of type RequestCancelActivityTaskFailed
then
this member is set and provides detailed information about the event. It
is not set for other event types.
StartTimerFailedEventAttributes startTimerFailedEventAttributes
If the event is of type StartTimerFailed
then this member is
set and provides detailed information about the event. It is not set for
other event types.
CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes
If the event is of type CancelTimerFailed
then this member
is set and provides detailed information about the event. It is not set
for other event types.
StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes
If the event is of type StartChildWorkflowExecutionFailed
then this member is set and provides detailed information about the
event. It is not set for other event types.
LambdaFunctionScheduledEventAttributes lambdaFunctionScheduledEventAttributes
LambdaFunctionStartedEventAttributes lambdaFunctionStartedEventAttributes
LambdaFunctionCompletedEventAttributes lambdaFunctionCompletedEventAttributes
LambdaFunctionFailedEventAttributes lambdaFunctionFailedEventAttributes
LambdaFunctionTimedOutEventAttributes lambdaFunctionTimedOutEventAttributes
ScheduleLambdaFunctionFailedEventAttributes scheduleLambdaFunctionFailedEventAttributes
StartLambdaFunctionFailedEventAttributes startLambdaFunctionFailedEventAttributes
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of events
leading up to this event.
Long startedEventId
The ID of the LambdaFunctionStarted
event recorded in the
history.
String result
The result of the function execution (if any).
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of events
leading up to this event.
Long startedEventId
The ID of the LambdaFunctionStarted
event recorded in the
history.
String reason
The reason provided for the failure (if any).
String details
The details of the failure (if any).
String id
The unique Amazon SWF ID for the AWS Lambda task.
String name
The name of the scheduled AWS Lambda function.
String input
Input provided to the AWS Lambda function.
String startToCloseTimeout
The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.
Long decisionTaskCompletedEventId
The ID of the DecisionTaskCompleted
event for the decision
that resulted in the scheduling of this AWS Lambda function. This
information can be useful for diagnosing problems by tracing back the
chain of events leading up to this event.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of events
leading up to this event.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of events
leading up to this event.
Long startedEventId
The ID of the LambdaFunctionStarted
event recorded in the
history.
String timeoutType
The type of the timeout that caused this event.
String domain
The name of the domain in which the activity types have been registered.
String name
If specified, only lists the activity types that have this name.
String registrationStatus
Specifies the registration status of the activity types to list.
String nextPageToken
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.
Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
String domain
The name of the domain that contains the workflow executions to list.
ExecutionTimeFilter startTimeFilter
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.ExecutionTimeFilter closeTimeFilter
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.WorkflowExecutionFilter executionFilter
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.CloseStatusFilter closeStatusFilter
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.WorkflowTypeFilter typeFilter
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.TagFilter tagFilter
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.String nextPageToken
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.
Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
String nextPageToken
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.
String registrationStatus
Specifies the registration status of the domains to list.
Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
String domain
The name of the domain that contains the workflow executions to list.
ExecutionTimeFilter startTimeFilter
Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.
WorkflowTypeFilter typeFilter
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.TagFilter tagFilter
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.String nextPageToken
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.
Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
WorkflowExecutionFilter executionFilter
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.String domain
The name of the domain in which the workflow types have been registered.
String name
If specified, lists the workflow type with this name.
String registrationStatus
Specifies the registration status of the workflow types to list.
String nextPageToken
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.
Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
String markerName
The name of the marker.
String details
Details of the marker (if any).
Long decisionTaskCompletedEventId
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.
String domain
The name of the domain that contains the task lists being polled.
TaskList taskList
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 ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String identity
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.
String domain
The name of the domain containing the task lists to poll.
TaskList taskList
Specifies the task list to poll for decision tasks.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String identity
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.
String nextPageToken
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.
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
will
not return a new decision task.Integer maximumPageSize
The maximum number of results that will be returned per call.
nextPageToken
can be used to obtain futher pages of results.
The default is 1000, which is the maximum allowed page size. You can,
however, specify a page size smaller than the maximum.
This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
Boolean reverseOrder
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.
String taskToken
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. String details
If specified, contains details about the progress of the task.
String markerName
The marker's name.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String domain
The name of the domain in which this activity is to be registered.
String name
The name of the activity type within the domain.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String version
The version of the activity type.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String description
A textual description of the activity type.
String defaultTaskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String defaultTaskHeartbeatTimeout
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. The value "NONE" can be used to specify unlimited duration.
TaskList defaultTaskList
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 is not
provided when a task is scheduled through the
ScheduleActivityTask
decision.
String defaultTaskPriority
The default task priority to assign to the activity type. If not
assigned, then "0" will be 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 Simple Workflow Developer Guide.
String defaultTaskScheduleToStartTimeout
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. The value "NONE" can be used to specify unlimited duration.
String defaultTaskScheduleToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String 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 ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String description
A text description of the domain.
String workflowExecutionRetentionPeriodInDays
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 is not available in the results of visibility calls.
If you pass the value NONE
or 0
(zero), then
the workflow execution history will not be 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.
String domain
The name of the domain in which to register the workflow type.
String name
The name of the workflow type.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String version
The version of the workflow type.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String description
Textual description of the workflow type.
String defaultTaskStartToCloseTimeout
If set, specifies the default maximum duration of decision tasks for this
workflow type. This default can be overridden when starting a workflow
execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
String defaultExecutionStartToCloseTimeout
If set, specifies the default maximum duration for executions of this
workflow type. You can override this default when starting an execution
through the StartWorkflowExecution action or
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
will always cause the workflow execution to time out.
TaskList defaultTaskList
If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type. This default is used only if
a task list is not provided when starting the execution through the
StartWorkflowExecution action or
StartChildWorkflowExecution
decision.
String defaultTaskPriority
The default task priority to assign to the workflow type. If not
assigned, then "0" will be 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 Simple Workflow Developer Guide.
String defaultChildPolicy
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due to
an expired timeout. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String defaultLambdaRole
The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.
This default can be overridden when starting a workflow execution using
the StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
String activityId
The activityId
of the activity task to be canceled.
String activityId
The activityId provided in the RequestCancelActivityTask
decision that failed.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String workflowId
The workflowId
of the external workflow to which the cancel
request was to be delivered.
String runId
The runId
of the external workflow execution.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long initiatedEventId
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.
Long decisionTaskCompletedEventId
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.
String control
String workflowId
The workflowId
of the external workflow execution to be
canceled.
String runId
The runId
of the external workflow execution to be canceled.
Long decisionTaskCompletedEventId
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.
String control
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
String taskToken
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.String details
Optional. Information about the cancellation.
String taskToken
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.String result
The result of the activity task. It is a free form string that is implementation specific.
String taskToken
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.String reason
Description of the error that may assist in diagnostics.
String details
Optional. Detailed information about the failure.
String taskToken
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.List<E> decisions
The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the decision structure for details.
String executionContext
User defined context to add to workflow execution.
String runId
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.
ActivityType activityType
Required. The type of the activity task to schedule.
String activityId
Required. The activityId
of the activity task.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String control
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.
String input
The input provided to the activity task.
String scheduleToCloseTimeout
The maximum duration for this activity task.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
TaskList taskList
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 will be used.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String taskPriority
Optional. 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 Simple Workflow Developer Guide.
String scheduleToStartTimeout
Optional. 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. The value "NONE" can be used to specify unlimited duration.
String startToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String heartbeatTimeout
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 will be 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. The value "NONE" can be used to specify unlimited duration.
ActivityType activityType
The activity type provided in the ScheduleActivityTask
decision that failed.
String activityId
The activityId provided in the ScheduleActivityTask
decision
that failed.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String id
Required. The SWF id
of the AWS Lambda task.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String name
Required. The name of the AWS Lambda function to invoke.
String input
The input provided to the AWS Lambda function.
String startToCloseTimeout
If set, specifies the maximum duration the function may take to execute.
String id
The unique Amazon SWF ID of the AWS Lambda task.
String name
The name of the scheduled AWS Lambda function.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
The ID of the DecisionTaskCompleted
event corresponding to
the decision that resulted in the scheduling of this AWS Lambda function.
This information can be useful for diagnosing problems by tracing back
the chain of events leading up to this event.
String workflowId
Required. The workflowId
of the workflow execution to
be signaled.
String runId
The runId
of the workflow execution to be signaled.
String signalName
Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.
String input
Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.
String control
Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.
String workflowId
The workflowId
of the external workflow execution that the
signal was being delivered to.
String runId
The runId
of the external workflow execution that the signal
was being delivered to.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long initiatedEventId
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.
Long decisionTaskCompletedEventId
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.
String control
String workflowId
The workflowId
of the external workflow execution.
String runId
The runId
of the external workflow execution to send the
signal to.
String signalName
The name of the signal.
String input
Input provided to the signal (if any).
Long decisionTaskCompletedEventId
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.
String control
Optional. data attached to the event that can be used by the decider in subsequent decision tasks.
String domain
The name of the domain containing the workflow execution to signal.
String workflowId
The workflowId of the workflow execution to signal.
String runId
The runId of the workflow execution to signal.
String signalName
The name of the signal. This name must be meaningful to the target workflow.
String input
Data to attach to the WorkflowExecutionSignaled
event in the
target workflow execution's history.
WorkflowType workflowType
Required. The type of the workflow execution to be started.
String workflowId
Required. The workflowId
of the workflow execution.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String control
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.
String input
The input to be provided to the workflow execution.
String executionStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
TaskList taskList
The name of the task list to be used for decision tasks of the child workflow execution.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String taskPriority
Optional. 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 Simple Workflow Developer Guide.
String taskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String childPolicy
Optional. 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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.List<E> tagList
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.
String lambdaRole
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
WorkflowType workflowType
The workflow type provided in the
StartChildWorkflowExecution
decision that failed.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
String workflowId
The workflowId
of the child workflow execution.
Long initiatedEventId
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.
Long decisionTaskCompletedEventId
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.
String control
String workflowId
The workflowId
of the child workflow execution.
WorkflowType workflowType
The type of the child workflow execution.
String control
Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.
String input
The inputs provided to the child workflow execution (if any).
String executionStartToCloseTimeout
The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
TaskList taskList
The name of the task list used for the decision tasks of the child workflow execution.
String taskPriority
Optional. 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 Simple Workflow Developer Guide.
Long decisionTaskCompletedEventId
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.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String taskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
List<E> tagList
The list of tags to associated with the child workflow execution.
String lambdaRole
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was
recorded when this AWS Lambda function was scheduled. This information
can be useful for diagnosing problems by tracing back the chain of events
leading up to this event.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
String message
The error message (if any).
String timerId
Required. The unique ID of the timer.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String control
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
String startToFireTimeout
Required. The duration to wait before firing the timer.
The duration is specified in seconds; an integer greater than or equal to 0.
String timerId
The timerId provided in the StartTimer
decision that failed.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
Long decisionTaskCompletedEventId
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.
String domain
The name of the domain in which the workflow execution is created.
String workflowId
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.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
WorkflowType workflowType
The type of the workflow to start.
TaskList taskList
The task list to use for the decision tasks generated for this workflow
execution. This overrides the defaultTaskList
specified when
registering the workflow type.
The specified string must not start or end with whitespace. It must not
contain a :
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
Ÿ). Also, it must not contain the literal string quotarnquot.
String taskPriority
The task priority to use for this workflow execution. This will override
any default priority that was assigned when the workflow type was
registered. If not set, then the default task priority for the workflow
type will be 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 Simple Workflow Developer Guide.
String input
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.
String executionStartToCloseTimeout
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 will cause 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.
List<E> tagList
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.
String taskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String lambdaRole
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
String tag
Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.
String name
The name of the task list.
String domain
The domain of the workflow execution to terminate.
String workflowId
The workflowId of the workflow execution to terminate.
String runId
The runId of the workflow execution to terminate.
String reason
Optional. A descriptive reason for terminating the workflow execution.
String details
Optional. Details for terminating the workflow execution.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String timerId
The unique ID of the timer that was canceled.
Long startedEventId
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.
Long decisionTaskCompletedEventId
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.
String timerId
The unique ID of the timer that was started.
String control
Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
String startToFireTimeout
The duration of time after which the timer will fire.
The duration is specified in seconds; an integer greater than or equal to 0.
Long decisionTaskCompletedEventId
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.
String details
Details for the cancellation (if any).
Long decisionTaskCompletedEventId
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.
WorkflowExecution externalWorkflowExecution
The external workflow execution for which the cancellation was requested.
Long externalInitiatedEventId
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.
String cause
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.
String result
The result produced by the workflow execution upon successful completion.
Long decisionTaskCompletedEventId
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.
String taskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String executionStartToCloseTimeout
The total duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
TaskList taskList
The task list used for the decision tasks generated for this workflow execution.
String taskPriority
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 Simple Workflow Developer Guide.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String lambdaRole
The IAM role used by this workflow execution when invoking AWS Lambda functions.
String input
The input provided to the new workflow execution.
Long decisionTaskCompletedEventId
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.
String newExecutionRunId
The runId
of the new workflow execution.
String executionStartToCloseTimeout
The total duration allowed for the new workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
TaskList taskList
String taskPriority
String taskStartToCloseTimeout
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. The value "NONE" can be used to specify unlimited duration.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.List<E> tagList
The list of tags associated with the new workflow execution.
WorkflowType workflowType
String lambdaRole
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
WorkflowExecutionInfo executionInfo
Information about the workflow execution.
WorkflowExecutionConfiguration executionConfiguration
The configuration settings for this workflow execution including timeout values, tasklist etc.
WorkflowExecutionOpenCounts openCounts
The number of tasks for this workflow execution. This includes open and closed tasks of all types.
Date latestActivityTaskTimestamp
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.
String latestExecutionContext
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.
String reason
The descriptive reason provided for the failure (if any).
String details
The details of the failure (if any).
Long decisionTaskCompletedEventId
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.
String workflowId
The workflowId to pass of match the criteria of this filter.
WorkflowExecution execution
The workflow execution this information is about.
WorkflowType workflowType
The type of the workflow execution.
Date startTimestamp
The time when the execution was started.
Date closeTimestamp
The time when the workflow execution was closed. Set only if the execution status is CLOSED.
String executionStatus
The current status of the execution.
String closeStatus
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.WorkflowExecution parent
If this workflow execution is a child of another execution then contains the workflow execution that started this execution.
List<E> tagList
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.
Boolean cancelRequested
Set to true if a cancellation is requested for this workflow execution.
List<E> executionInfos
The list of workflow information structures.
String nextPageToken
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.
Integer openActivityTasks
The count of activity tasks whose status is OPEN.
Integer openDecisionTasks
The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.
Integer openTimers
The count of timers started by this workflow execution that have not fired yet.
Integer openChildWorkflowExecutions
The count of child workflow executions whose status is OPEN.
Integer openLambdaFunctions
The count of AWS Lambda functions that are currently executing.
String signalName
The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.
String input
Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.
WorkflowExecution externalWorkflowExecution
The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.
Long externalInitiatedEventId
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.
String input
The input provided to the workflow execution (if any).
String executionStartToCloseTimeout
The maximum duration for this workflow execution.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
String taskStartToCloseTimeout
The maximum duration of decision tasks for this workflow type.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
String childPolicy
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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.TaskList taskList
The name of the task list for scheduling the decision tasks for this workflow execution.
WorkflowType workflowType
The workflow type of this execution.
List<E> tagList
The list of tags associated with this workflow execution. An execution can have up to 5 tags.
String taskPriority
String continuedExecutionRunId
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.
WorkflowExecution parentWorkflowExecution
The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.
Long parentInitiatedEventId
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.
String lambdaRole
The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.
String reason
The reason provided for the termination (if any).
String details
The details provided for the termination (if any).
String childPolicy
The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String cause
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.
String timeoutType
The type of timeout that caused this event.
String childPolicy
The policy used for the child workflow executions of this workflow execution.
The supported child policies are:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String defaultTaskStartToCloseTimeout
Optional. 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 does
not 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. The value "NONE" can be used to specify unlimited duration.
String defaultExecutionStartToCloseTimeout
Optional. 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. The value "NONE" can be used to specify unlimited duration.
TaskList defaultTaskList
Optional. 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.
String defaultTaskPriority
Optional. 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 Simple Workflow Developer Guide.
String defaultChildPolicy
Optional. 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:
WorkflowExecutionCancelRequested
event in its history. It is
up to the decider to take appropriate actions when it receives an
execution history with this event.String defaultLambdaRole
The default IAM role to use when a workflow execution invokes a AWS Lambda function.
WorkflowTypeInfo typeInfo
General information about the workflow type.
The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.
WorkflowTypeConfiguration configuration
Configuration settings of the workflow type registered through RegisterWorkflowType
WorkflowType workflowType
The workflow type this information is about.
String status
The current status of the workflow type.
String description
The description of the type registered through RegisterWorkflowType.
Date creationDate
The date when this type was registered.
Date deprecationDate
If the type is in deprecated state, then it is set to the date when the type was deprecated.
List<E> typeInfos
The list of workflow type information.
String nextPageToken
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.
Copyright © 2016. All rights reserved.