Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Activity
Task Cancel Requested Event Attributes Provides the details of the
ActivityTaskCancelRequested
event.- Activity
Task Canceled Event Attributes Provides the details of the
ActivityTaskCanceled
event.- Activity
Task Completed Event Attributes Provides the details of the
ActivityTaskCompleted
event.- Activity
Task Failed Event Attributes Provides the details of the
ActivityTaskFailed
event.- Activity
Task Scheduled Event Attributes Provides the details of the
ActivityTaskScheduled
event.- Activity
Task Started Event Attributes Provides the details of the
ActivityTaskStarted
event.- Activity
Task Timed OutEvent Attributes Provides the details of the
ActivityTaskTimedOut
event.- Activity
Type Represents an activity type.
- Activity
Type Configuration Configuration settings registered with the activity type.
- Activity
Type Info Detailed information about an activity type.
- Cancel
Timer Decision Attributes Provides the details of the
CancelTimer
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Cancel
Timer Failed Event Attributes Provides the details of the
CancelTimerFailed
event.- Cancel
Workflow Execution Decision Attributes Provides the details of the
CancelWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Cancel
Workflow Execution Failed Event Attributes Provides the details of the
CancelWorkflowExecutionFailed
event.- Child
Workflow Execution Canceled Event Attributes Provide details of the
ChildWorkflowExecutionCanceled
event.- Child
Workflow Execution Completed Event Attributes Provides the details of the
ChildWorkflowExecutionCompleted
event.- Child
Workflow Execution Failed Event Attributes Provides the details of the
ChildWorkflowExecutionFailed
event.- Child
Workflow Execution Started Event Attributes Provides the details of the
ChildWorkflowExecutionStarted
event.- Child
Workflow Execution Terminated Event Attributes Provides the details of the
ChildWorkflowExecutionTerminated
event.- Child
Workflow Execution Timed OutEvent Attributes Provides the details of the
ChildWorkflowExecutionTimedOut
event.- Close
Status Filter Used to filter the closed workflow executions in visibility APIs by their close status.
- Complete
Workflow Execution Decision Attributes Provides the details of the
CompleteWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Complete
Workflow Execution Failed Event Attributes Provides the details of the
CompleteWorkflowExecutionFailed
event.- Continue
AsNew Workflow Execution Decision Attributes Provides the details of the
ContinueAsNewWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
Constrain the following parameters by using a
Condition
element with the appropriate keys.-
tag
– A tag used to identify the workflow execution -
taskList
– String constraint. The key isswf:taskList.name
. -
workflowType.version
– String constraint. The key isswf:workflowType.version
.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Continue
AsNew Workflow Execution Failed Event Attributes Provides the details of the
ContinueAsNewWorkflowExecutionFailed
event.- Decision
Specifies a decision made by the decider. A decision can be one of these types:
-
CancelTimer
– Cancels a previously started timer and records aTimerCanceled
event in the history. -
CancelWorkflowExecution
– Closes the workflow execution and records aWorkflowExecutionCanceled
event in the history. -
CompleteWorkflowExecution
– Closes the workflow execution and records aWorkflowExecutionCompleted
event in the history . -
ContinueAsNewWorkflowExecution
– Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. AWorkflowExecutionContinuedAsNew
event is recorded in the history. -
FailWorkflowExecution
– Closes the workflow execution and records aWorkflowExecutionFailed
event in the history. -
RecordMarker
– Records aMarkerRecorded
event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event. -
RequestCancelActivityTask
– Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response toRecordActivityTaskHeartbeat
. -
RequestCancelExternalWorkflowExecution
– Requests that a request be made to cancel the specified external workflow execution and records aRequestCancelExternalWorkflowExecutionInitiated
event in the history. -
ScheduleActivityTask
– Schedules an activity task. -
SignalExternalWorkflowExecution
– Requests a signal to be delivered to the specified external workflow execution and records aSignalExternalWorkflowExecutionInitiated
event in the history. -
StartChildWorkflowExecution
– Requests that a child workflow execution be started and records aStartChildWorkflowExecutionInitiated
event in the history. The child workflow execution is a separate workflow execution with its own history. -
StartTimer
– Starts a timer for this workflow execution and records aTimerStarted
event in the history. This timer fires after the specified delay and record aTimerFired
event.
Access Control
If you grant permission to use
RespondDecisionTaskCompleted
, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.Decision Failure
Decisions can fail for several reasons
-
The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.
-
A limit on your account was reached.
-
The decision lacks sufficient permissions.
One of the following events might be added to the history to indicate an error. The event attribute's
cause
parameter indicates the cause. Ifcause
is set toOPERATION_NOT_PERMITTED
, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
ScheduleActivityTaskFailed
– AScheduleActivityTask
decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured. -
RequestCancelActivityTaskFailed
– ARequestCancelActivityTask
decision failed. This could happen if there is no open activity task with the specified activityId. -
StartTimerFailed
– AStartTimer
decision failed. This could happen if there is another open timer with the same timerId. -
CancelTimerFailed
– ACancelTimer
decision failed. This could happen if there is no open timer with the specified timerId. -
StartChildWorkflowExecutionFailed
– AStartChildWorkflowExecution
decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured. -
SignalExternalWorkflowExecutionFailed
– ASignalExternalWorkflowExecution
decision failed. This could happen if theworkflowID
specified in the decision was incorrect. -
RequestCancelExternalWorkflowExecutionFailed
– ARequestCancelExternalWorkflowExecution
decision failed. This could happen if theworkflowID
specified in the decision was incorrect. -
CancelWorkflowExecutionFailed
– ACancelWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution. -
CompleteWorkflowExecutionFailed
– ACompleteWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution. -
ContinueAsNewWorkflowExecutionFailed
– AContinueAsNewWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly. -
FailWorkflowExecutionFailed
– AFailWorkflowExecution
decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.
The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.
A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task:
CompleteWorkflowExecution
,FailWorkflowExecution
,CancelWorkflowExecution
andContinueAsNewWorkflowExecution
. AnUnhandledDecision
fault is returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to callRespondDecisionTaskCompleted
without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.How to Code a Decision
You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
-
ScheduleActivityTaskDecisionAttributes
-
RequestCancelActivityTaskDecisionAttributes
-
CompleteWorkflowExecutionDecisionAttributes
-
FailWorkflowExecutionDecisionAttributes
-
CancelWorkflowExecutionDecisionAttributes
-
ContinueAsNewWorkflowExecutionDecisionAttributes
-
RecordMarkerDecisionAttributes
-
StartTimerDecisionAttributes
-
CancelTimerDecisionAttributes
-
SignalExternalWorkflowExecutionDecisionAttributes
-
RequestCancelExternalWorkflowExecutionDecisionAttributes
-
StartChildWorkflowExecutionDecisionAttributes
-
- Decision
Task Completed Event Attributes Provides the details of the
DecisionTaskCompleted
event.- Decision
Task Scheduled Event Attributes Provides details about the
DecisionTaskScheduled
event.- Decision
Task Started Event Attributes Provides the details of the
DecisionTaskStarted
event.- Decision
Task Timed OutEvent Attributes Provides the details of the
DecisionTaskTimedOut
event.- Domain
Configuration Contains the configuration settings of a domain.
- Domain
Info Contains general information about a domain.
- Execution
Time Filter Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example:
"oldestDate": 1325376070.
- External
Workflow Execution Cancel Requested Event Attributes Provides the details of the
ExternalWorkflowExecutionCancelRequested
event.- External
Workflow Execution Signaled Event Attributes Provides the details of the
ExternalWorkflowExecutionSignaled
event.- Fail
Workflow Execution Decision Attributes Provides the details of the
FailWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Fail
Workflow Execution Failed Event Attributes Provides the details of the
FailWorkflowExecutionFailed
event.- History
Event Event within a workflow execution. A history event can be one of these types:
-
ActivityTaskCancelRequested
– ARequestCancelActivityTask
decision was received by the system. -
ActivityTaskCanceled
– The activity task was successfully canceled. -
ActivityTaskCompleted
– An activity worker successfully completed an activity task by callingRespondActivityTaskCompleted
. -
ActivityTaskFailed
– An activity worker failed an activity task by callingRespondActivityTaskFailed
. -
ActivityTaskScheduled
– An activity task was scheduled for execution. -
ActivityTaskStarted
– The scheduled activity task was dispatched to a worker. -
ActivityTaskTimedOut
– The activity task timed out. -
CancelTimerFailed
– Failed to process CancelTimer decision. This happens when the decision isn't configured properly, for example no timer exists with the specified timer Id. -
CancelWorkflowExecutionFailed
– A request to cancel a workflow execution failed. -
ChildWorkflowExecutionCanceled
– A child workflow execution, started by this workflow execution, was canceled and closed. -
ChildWorkflowExecutionCompleted
– A child workflow execution, started by this workflow execution, completed successfully and was closed. -
ChildWorkflowExecutionFailed
– A child workflow execution, started by this workflow execution, failed to complete successfully and was closed. -
ChildWorkflowExecutionStarted
– A child workflow execution was successfully started. -
ChildWorkflowExecutionTerminated
– A child workflow execution, started by this workflow execution, was terminated. -
ChildWorkflowExecutionTimedOut
– A child workflow execution, started by this workflow execution, timed out and was closed. -
CompleteWorkflowExecutionFailed
– The workflow execution failed to complete. -
ContinueAsNewWorkflowExecutionFailed
– The workflow execution failed to complete after being continued as a new workflow execution. -
DecisionTaskCompleted
– The decider successfully completed a decision task by callingRespondDecisionTaskCompleted
. -
DecisionTaskScheduled
– A decision task was scheduled for the workflow execution. -
DecisionTaskStarted
– The decision task was dispatched to a decider. -
DecisionTaskTimedOut
– The decision task timed out. -
ExternalWorkflowExecutionCancelRequested
– Request to cancel an external workflow execution was successfully delivered to the target execution. -
ExternalWorkflowExecutionSignaled
– A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution. -
FailWorkflowExecutionFailed
– A request to mark a workflow execution as failed, itself failed. -
MarkerRecorded
– A marker was recorded in the workflow history as the result of aRecordMarker
decision. -
RecordMarkerFailed
– ARecordMarker
decision was returned as failed. -
RequestCancelActivityTaskFailed
– Failed to process RequestCancelActivityTask decision. This happens when the decision isn't configured properly. -
RequestCancelExternalWorkflowExecutionFailed
– Request to cancel an external workflow execution failed. -
RequestCancelExternalWorkflowExecutionInitiated
– A request was made to request the cancellation of an external workflow execution. -
ScheduleActivityTaskFailed
– Failed to process ScheduleActivityTask decision. This happens when the decision isn't configured properly, for example the activity type specified isn't registered. -
SignalExternalWorkflowExecutionFailed
– The request to signal an external workflow execution failed. -
SignalExternalWorkflowExecutionInitiated
– A request to signal an external workflow was made. -
StartActivityTaskFailed
– A scheduled activity task failed to start. -
StartChildWorkflowExecutionFailed
– Failed to process StartChildWorkflowExecution decision. This happens when the decision isn't configured properly, for example the workflow type specified isn't registered. -
StartChildWorkflowExecutionInitiated
– A request was made to start a child workflow execution. -
StartTimerFailed
– Failed to process StartTimer decision. This happens when the decision isn't configured properly, for example a timer already exists with the specified timer Id. -
TimerCanceled
– A timer, previously started for this workflow execution, was successfully canceled. -
TimerFired
– A timer, previously started for this workflow execution, fired. -
TimerStarted
– A timer was started for the workflow execution due to aStartTimer
decision. -
WorkflowExecutionCancelRequested
– A request to cancel this workflow execution was made. -
WorkflowExecutionCanceled
– The workflow execution was successfully canceled and closed. -
WorkflowExecutionCompleted
– The workflow execution was closed due to successful completion. -
WorkflowExecutionContinuedAsNew
– The workflow execution was closed and a new execution of the same type was created with the same workflowId. -
WorkflowExecutionFailed
– The workflow execution closed due to a failure. -
WorkflowExecutionSignaled
– An external signal was received for the workflow execution. -
WorkflowExecutionStarted
– The workflow execution was started. -
WorkflowExecutionTerminated
– The workflow execution was terminated. -
WorkflowExecutionTimedOut
– The workflow execution was closed because a time out was exceeded.
-
- Lambda
Function Completed Event Attributes Provides the details of the
LambdaFunctionCompleted
event. It isn't set for other event types.- Lambda
Function Failed Event Attributes Provides the details of the
LambdaFunctionFailed
event. It isn't set for other event types.- Lambda
Function Scheduled Event Attributes Provides the details of the
LambdaFunctionScheduled
event. It isn't set for other event types.- Lambda
Function Started Event Attributes Provides the details of the
LambdaFunctionStarted
event. It isn't set for other event types.- Lambda
Function Timed OutEvent Attributes Provides details of the
LambdaFunctionTimedOut
event.- Marker
Recorded Event Attributes Provides the details of the
MarkerRecorded
event.- Record
Marker Decision Attributes Provides the details of the
RecordMarker
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Record
Marker Failed Event Attributes Provides the details of the
RecordMarkerFailed
event.- Request
Cancel Activity Task Decision Attributes Provides the details of the
RequestCancelActivityTask
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Request
Cancel Activity Task Failed Event Attributes Provides the details of the
RequestCancelActivityTaskFailed
event.- Request
Cancel External Workflow Execution Decision Attributes Provides the details of the
RequestCancelExternalWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Request
Cancel External Workflow Execution Failed Event Attributes Provides the details of the
RequestCancelExternalWorkflowExecutionFailed
event.- Request
Cancel External Workflow Execution Initiated Event Attributes Provides the details of the
RequestCancelExternalWorkflowExecutionInitiated
event.- Resource
Tag Tags are key-value pairs that can be associated with Amazon SWF state machines and activities.
Tags may only contain unicode letters, digits, whitespace, or these symbols:
_ . : / = + - @
.- Schedule
Activity Task Decision Attributes Provides the details of the
ScheduleActivityTask
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
Constrain the following parameters by using a
Condition
element with the appropriate keys.-
activityType.name
– String constraint. The key isswf:activityType.name
. -
activityType.version
– String constraint. The key isswf:activityType.version
. -
taskList
– String constraint. The key isswf:taskList.name
.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Schedule
Activity Task Failed Event Attributes Provides the details of the
ScheduleActivityTaskFailed
event.- Schedule
Lambda Function Decision Attributes Decision attributes specified in
scheduleLambdaFunctionDecisionAttributes
within the list of decisionsdecisions
passed toRespondDecisionTaskCompleted
.- Schedule
Lambda Function Failed Event Attributes Provides the details of the
ScheduleLambdaFunctionFailed
event. It isn't set for other event types.- Signal
External Workflow Execution Decision Attributes Provides the details of the
SignalExternalWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Signal
External Workflow Execution Failed Event Attributes Provides the details of the
SignalExternalWorkflowExecutionFailed
event.- Signal
External Workflow Execution Initiated Event Attributes Provides the details of the
SignalExternalWorkflowExecutionInitiated
event.- Start
Child Workflow Execution Decision Attributes Provides the details of the
StartChildWorkflowExecution
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
Constrain the following parameters by using a
Condition
element with the appropriate keys.-
tagList.member.N
– The key is "swf:tagList.N" where N is the tag number from 0 to 4, inclusive. -
taskList
– String constraint. The key isswf:taskList.name
. -
workflowType.name
– String constraint. The key isswf:workflowType.name
. -
workflowType.version
– String constraint. The key isswf:workflowType.version
.
-
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Start
Child Workflow Execution Failed Event Attributes Provides the details of the
StartChildWorkflowExecutionFailed
event.- Start
Child Workflow Execution Initiated Event Attributes Provides the details of the
StartChildWorkflowExecutionInitiated
event.- Start
Lambda Function Failed Event Attributes Provides the details of the
StartLambdaFunctionFailed
event. It isn't set for other event types.- Start
Timer Decision Attributes Provides the details of the
StartTimer
decision.Access Control
You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
-
Use a
Resource
element with the domain name to limit the action to only specified domains. -
Use an
Action
element to allow or deny permission to call this action. -
You cannot use an IAM policy to constrain this action's parameters.
If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.-
- Start
Timer Failed Event Attributes Provides the details of the
StartTimerFailed
event.- TagFilter
Used to filter the workflow executions in visibility APIs based on a tag.
- Task
List Represents a task list.
- Timer
Canceled Event Attributes Provides the details of the
TimerCanceled
event.- Timer
Fired Event Attributes Provides the details of the
TimerFired
event.- Timer
Started Event Attributes Provides the details of the
TimerStarted
event.- Workflow
Execution Represents a workflow execution.
- Workflow
Execution Cancel Requested Event Attributes Provides the details of the
WorkflowExecutionCancelRequested
event.- Workflow
Execution Canceled Event Attributes Provides the details of the
WorkflowExecutionCanceled
event.- Workflow
Execution Completed Event Attributes Provides the details of the
WorkflowExecutionCompleted
event.- Workflow
Execution Configuration The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.
- Workflow
Execution Continued AsNew Event Attributes Provides the details of the
WorkflowExecutionContinuedAsNew
event.- Workflow
Execution Failed Event Attributes Provides the details of the
WorkflowExecutionFailed
event.- Workflow
Execution Filter Used to filter the workflow executions in visibility APIs by their
workflowId
.- Workflow
Execution Info Contains information about a workflow execution.
- Workflow
Execution Open Counts Contains the counts of open tasks, child workflow executions and timers for a workflow execution.
- Workflow
Execution Signaled Event Attributes Provides the details of the
WorkflowExecutionSignaled
event.- Workflow
Execution Started Event Attributes Provides details of
WorkflowExecutionStarted
event.- Workflow
Execution Terminated Event Attributes Provides the details of the
WorkflowExecutionTerminated
event.- Workflow
Execution Timed OutEvent Attributes Provides the details of the
WorkflowExecutionTimedOut
event.- Workflow
Type Represents a workflow type.
- Workflow
Type Configuration The configuration settings of a workflow type.
- Workflow
Type Filter Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.
- Workflow
Type Info Contains information about a workflow type.
Enums§
- Activity
Task Timeout Type - When writing a match expression against
ActivityTaskTimeoutType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cancel
Timer Failed Cause - When writing a match expression against
CancelTimerFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Cancel
Workflow Execution Failed Cause - When writing a match expression against
CancelWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Child
Policy - When writing a match expression against
ChildPolicy
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Close
Status - When writing a match expression against
CloseStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Complete
Workflow Execution Failed Cause - When writing a match expression against
CompleteWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Continue
AsNew Workflow Execution Failed Cause - When writing a match expression against
ContinueAsNewWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Decision
Task Timeout Type - When writing a match expression against
DecisionTaskTimeoutType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Decision
Type - When writing a match expression against
DecisionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Event
Type - When writing a match expression against
EventType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Execution
Status - When writing a match expression against
ExecutionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Fail
Workflow Execution Failed Cause - When writing a match expression against
FailWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Lambda
Function Timeout Type - When writing a match expression against
LambdaFunctionTimeoutType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Record
Marker Failed Cause - When writing a match expression against
RecordMarkerFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Registration
Status - When writing a match expression against
RegistrationStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Request
Cancel Activity Task Failed Cause - When writing a match expression against
RequestCancelActivityTaskFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Request
Cancel External Workflow Execution Failed Cause - When writing a match expression against
RequestCancelExternalWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schedule
Activity Task Failed Cause - When writing a match expression against
ScheduleActivityTaskFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Schedule
Lambda Function Failed Cause - When writing a match expression against
ScheduleLambdaFunctionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Signal
External Workflow Execution Failed Cause - When writing a match expression against
SignalExternalWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Start
Child Workflow Execution Failed Cause - When writing a match expression against
StartChildWorkflowExecutionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Start
Lambda Function Failed Cause - When writing a match expression against
StartLambdaFunctionFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Start
Timer Failed Cause - When writing a match expression against
StartTimerFailedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Execution Cancel Requested Cause - When writing a match expression against
WorkflowExecutionCancelRequestedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Execution Terminated Cause - When writing a match expression against
WorkflowExecutionTerminatedCause
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Workflow
Execution Timeout Type - When writing a match expression against
WorkflowExecutionTimeoutType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.