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.
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.
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.
String details
The details of the failure.
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
Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't 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
The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.
Valid values are integers that range from Java's Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
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 is 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
The default maximum duration for tasks of an activity type specified when registering the activity type. You can
override this default when scheduling a task through the ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
String defaultTaskHeartbeatTimeout
The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be
overridden when you schedule a task through the ScheduleActivityTask
Decision. If the
activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an
UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task to be valid;
the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
TaskList defaultTaskList
The default task list specified for this activity type at registration. This default is used if a task list isn't
provided when a task is scheduled through the ScheduleActivityTask
Decision. You can override
the default registered task list when scheduling a task through the ScheduleActivityTask
Decision.
String defaultTaskPriority
The default task priority for tasks of this activity type, specified at registration. If not set, then
0
is used as the default priority. This default can be overridden when scheduling an activity task.
Valid values are integers that range from Java's Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
String defaultTaskScheduleToStartTimeout
The default maximum duration, specified when registering the activity type, that a task of an activity type can
wait before being assigned to a worker. You can override this default when scheduling a task through the
ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
String defaultTaskScheduleToCloseTimeout
The default maximum duration, specified when registering the activity type, for tasks of this activity type. You
can override this default when scheduling a task through the ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
ActivityTypeInfo typeInfo
General information about the activity type.
The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.
REGISTERED
– The type is registered and available. Workers supporting this type should be running.
DEPRECATED
– The type was deprecated using DeprecateActivityType, but is still in use. You
should keep workers supporting this type running. You cannot create new tasks of this type.
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
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.
If cause
is set to OPERATION_NOT_PERMITTED
, the decision failed because it lacked
sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to
Amazon SWF Workflows in the Amazon SWF Developer Guide.
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
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.
If cause
is set to OPERATION_NOT_PERMITTED
, the decision failed because it lacked
sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to
Amazon SWF Workflows in the Amazon SWF Developer Guide.
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.
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
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.
If cause
is set to OPERATION_NOT_PERMITTED
, the decision failed because it lacked
sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to
Amazon SWF Workflows in the Amazon SWF Developer Guide.
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
. You can use
NONE
to specify unlimited duration.
An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.
TaskList taskList
The task list to use for the decisions of the new (continued) workflow execution.
String taskPriority
The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This
overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that
range from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647).
Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
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
. You can use
NONE
to specify unlimited duration.
A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.
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:
TERMINATE
– The child executions are terminated.
REQUEST_CANCEL
– A request to cancel is attempted for each child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate
actions when it receives an execution history with this event.
ABANDON
– No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.
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
The version of the workflow to start.
String lambdaRole
The IAM role to attach to the new (continued) execution.
String cause
The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.
If cause
is set to OPERATION_NOT_PERMITTED
, the decision failed because it lacked
sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to
Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 the details of the ScheduleActivityTask
decision. It isn't set for other decision types.
RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes
Provides the details of the RequestCancelActivityTask
decision. It isn't set for other decision
types.
CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes
Provides the details of the CompleteWorkflowExecution
decision. It isn't set for other decision
types.
FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes
Provides the details of the FailWorkflowExecution
decision. It isn't set for other decision types.
CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes
Provides the details of the CancelWorkflowExecution
decision. It isn't set for other decision types.
ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes
Provides the details of the ContinueAsNewWorkflowExecution
decision. It isn't set for other decision
types.
RecordMarkerDecisionAttributes recordMarkerDecisionAttributes
Provides the details of the RecordMarker
decision. It isn't set for other decision types.
StartTimerDecisionAttributes startTimerDecisionAttributes
Provides the details of the StartTimer
decision. It isn't set for other decision types.
CancelTimerDecisionAttributes cancelTimerDecisionAttributes
Provides the details of the CancelTimer
decision. It isn't set for other decision types.
SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes
Provides the details of the SignalExternalWorkflowExecution
decision. It isn't set for other
decision types.
RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes
Provides the details of the RequestCancelExternalWorkflowExecution
decision. It isn't set for other
decision types.
StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes
Provides the details of the StartChildWorkflowExecution
decision. It isn't set for other decision
types.
ScheduleLambdaFunctionDecisionAttributes scheduleLambdaFunctionDecisionAttributes
Provides the details of the ScheduleLambdaFunction
decision. It isn't set for other decision types.
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
A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range
from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
(2147483647). Higher
numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
String startToCloseTimeout
The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
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
The basic information about a domain, such as its name, status, and description.
DomainConfiguration configuration
The domain configuration. Currently, this includes only the domain's retention period.
String name
The name of the domain. This name is unique within the account.
String status
The status of the domain:
REGISTERED
– The domain is properly registered and available. You can use this domain for
registering types and creating new workflow executions.
DEPRECATED
– The domain was deprecated using DeprecateDomain, but is still in use. You should
not create new workflow executions in this domain.
String description
The description of the domain provided through RegisterDomain.
String arn
The ARN of the domain.
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.
If cause
is set to OPERATION_NOT_PERMITTED
, the decision failed because it lacked
sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to
Amazon SWF Workflows in the Amazon SWF Developer Guide.
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 NextPageToken
is returned there are more results available. The value of
NextPageToken
is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60
seconds. Using an expired pagination token will return a 400
error: "
Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
Integer maximumPageSize
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages
of results.
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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't 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 isn't set for other event types.
LambdaFunctionScheduledEventAttributes lambdaFunctionScheduledEventAttributes
Provides the details of the LambdaFunctionScheduled
event. It isn't set for other event types.
LambdaFunctionStartedEventAttributes lambdaFunctionStartedEventAttributes
Provides the details of the LambdaFunctionStarted
event. It isn't set for other event types.
LambdaFunctionCompletedEventAttributes lambdaFunctionCompletedEventAttributes
Provides the details of the LambdaFunctionCompleted
event. It isn't set for other event types.
LambdaFunctionFailedEventAttributes lambdaFunctionFailedEventAttributes
Provides the details of the LambdaFunctionFailed
event. It isn't set for other event types.
LambdaFunctionTimedOutEventAttributes lambdaFunctionTimedOutEventAttributes
Provides the details of the LambdaFunctionTimedOut
event. It isn't set for other event types.
ScheduleLambdaFunctionFailedEventAttributes scheduleLambdaFunctionFailedEventAttributes
Provides the details of the ScheduleLambdaFunctionFailed
event. It isn't set for other event types.
StartLambdaFunctionFailedEventAttributes startLambdaFunctionFailedEventAttributes
Provides the details of the StartLambdaFunctionFailed
event. It isn't set for other event types.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was recorded when this Lambda task was scheduled.
To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Long startedEventId
The ID of the LambdaFunctionStarted
event recorded when this activity task started. To help diagnose
issues, use this information to trace back the chain of events leading up to this event.
String result
The results of the Lambda task.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was recorded when this activity task was scheduled.
To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Long startedEventId
The ID of the LambdaFunctionStarted
event recorded when this activity task started. To help diagnose
issues, use this information to trace back the chain of events leading up to this event.
String reason
The reason provided for the failure.
String details
The details of the failure.
String id
The unique ID of the Lambda task.
String name
The name of the Lambda function.
String control
Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.
String input
The input provided to the Lambda task.
String startToCloseTimeout
The maximum amount of time a worker can take to process the Lambda task.
Long decisionTaskCompletedEventId
The ID of the LambdaFunctionCompleted
event corresponding to the decision that resulted in
scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events
leading up to this event.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was recorded when this activity task was scheduled.
To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Long scheduledEventId
The ID of the LambdaFunctionScheduled
event that was recorded when this activity task was scheduled.
To help diagnose issues, use this information to trace back the chain of events leading up to this event.
Long startedEventId
The ID of the ActivityTaskStarted
event that was recorded when this activity task started. To help
diagnose issues, use this information to trace back the chain of events leading up to this event.
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 NextPageToken
is returned there are more results available. The value of
NextPageToken
is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60
seconds. Using an expired pagination token will return a 400
error: "
Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
Integer maximumPageSize
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages
of results.
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 NextPageToken
is returned there are more results available. The value of
NextPageToken
is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60
seconds. Using an expired pagination token will return a 400
error: "
Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
Integer maximumPageSize
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages
of results.
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 NextPageToken
is returned there are more results available. The value of
NextPageToken
is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60
seconds. Using an expired pagination token will return a 400
error: "
Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
String registrationStatus
Specifies the registration status of the domains to list.
Integer maximumPageSize
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages
of results.
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 NextPageToken
is returned there are more results available. The value of
NextPageToken
is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60
seconds. Using an expired pagination token will return a 400
error: "
Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
Integer maximumPageSize
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages
of results.
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 resourceArn
The Amazon Resource Name (ARN) for the Amazon SWF domain.
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 NextPageToken
is returned there are more results available. The value of
NextPageToken
is a unique pagination token for each page. Make the call again using the returned
token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60
seconds. Using an expired pagination token will return a 400
error: "
Specified token has exceeded its maximum lifetime
".
The configured maximumPageSize
determines how many results can be returned in a single call.
Integer maximumPageSize
The maximum number of results that are returned per call. Use nextPageToken
to obtain further pages
of results.
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
The details of the marker.
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 (