Crate rusoto_swf [−] [src]
The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.
Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.
This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide.
If you're using the service, you're probably looking for SwfClient and Swf.
Structs
ActivityTask |
Unit of work sent to an activity worker. |
ActivityTaskCancelRequestedEventAttributes |
Provides details of the |
ActivityTaskCanceledEventAttributes |
Provides details of the |
ActivityTaskCompletedEventAttributes |
Provides details of the |
ActivityTaskFailedEventAttributes |
Provides details of the |
ActivityTaskScheduledEventAttributes |
Provides details of the |
ActivityTaskStartedEventAttributes |
Provides details of the |
ActivityTaskStatus |
Status information about an activity task. |
ActivityTaskTimedOutEventAttributes |
Provides details of the |
ActivityType |
Represents an activity type. |
ActivityTypeConfiguration |
Configuration settings registered with the activity type. |
ActivityTypeDetail |
Detailed information about an activity type. |
ActivityTypeInfo |
Detailed information about an activity type. |
ActivityTypeInfos |
Contains a paginated list of activity type information structures. |
CancelTimerDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
CancelTimerFailedEventAttributes |
Provides details of the |
CancelWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
CancelWorkflowExecutionFailedEventAttributes |
Provides details of the |
ChildWorkflowExecutionCanceledEventAttributes |
Provide details of the |
ChildWorkflowExecutionCompletedEventAttributes |
Provides details of the |
ChildWorkflowExecutionFailedEventAttributes |
Provides details of the |
ChildWorkflowExecutionStartedEventAttributes |
Provides details of the |
ChildWorkflowExecutionTerminatedEventAttributes |
Provides details of the |
ChildWorkflowExecutionTimedOutEventAttributes |
Provides details of the |
CloseStatusFilter |
Used to filter the closed workflow executions in visibility APIs by their close status. |
CompleteWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
CompleteWorkflowExecutionFailedEventAttributes |
Provides details of the |
ContinueAsNewWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
ContinueAsNewWorkflowExecutionFailedEventAttributes |
Provides details of the |
CountClosedWorkflowExecutionsInput | |
CountOpenWorkflowExecutionsInput | |
CountPendingActivityTasksInput | |
CountPendingDecisionTasksInput | |
Decision |
Specifies a decision made by the decider. A decision can be one of these types:
Access Control If you grant permission to use Decision Failure Decisions can fail for several reasons
One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
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. CompleteWorkflowExecution , FailWorkflowExecution , CancelWorkflowExecution and ContinueAsNewWorkflowExecution . An UnhandledDecision fault will be returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.How to code a decision You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:
|
DecisionTask |
A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions. |
DecisionTaskCompletedEventAttributes |
Provides details of the |
DecisionTaskScheduledEventAttributes |
Provides details about the |
DecisionTaskStartedEventAttributes |
Provides details of the |
DecisionTaskTimedOutEventAttributes |
Provides details of the |
DeprecateActivityTypeInput | |
DeprecateDomainInput | |
DeprecateWorkflowTypeInput | |
DescribeActivityTypeInput | |
DescribeDomainInput | |
DescribeWorkflowExecutionInput | |
DescribeWorkflowTypeInput | |
DomainConfiguration |
Contains the configuration settings of a domain. |
DomainDetail |
Contains details of a domain. |
DomainInfo |
Contains general information about a domain. |
DomainInfos |
Contains a paginated collection of DomainInfo structures. |
ExecutionTimeFilter |
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: |
ExternalWorkflowExecutionCancelRequestedEventAttributes |
Provides details of the |
ExternalWorkflowExecutionSignaledEventAttributes |
Provides details of the |
FailWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
FailWorkflowExecutionFailedEventAttributes |
Provides details of the |
GetWorkflowExecutionHistoryInput | |
History |
Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution. |
HistoryEvent |
Event within a workflow execution. A history event can be one of these types:
|
LambdaFunctionCompletedEventAttributes |
Provides details for the |
LambdaFunctionFailedEventAttributes |
Provides details for the |
LambdaFunctionScheduledEventAttributes |
Provides details for the |
LambdaFunctionStartedEventAttributes |
Provides details for the |
LambdaFunctionTimedOutEventAttributes |
Provides details for the |
ListActivityTypesInput | |
ListClosedWorkflowExecutionsInput | |
ListDomainsInput | |
ListOpenWorkflowExecutionsInput | |
ListWorkflowTypesInput | |
MarkerRecordedEventAttributes |
Provides details of the |
PendingTaskCount |
Contains the count of tasks in a task list. |
PollForActivityTaskInput | |
PollForDecisionTaskInput | |
RecordActivityTaskHeartbeatInput | |
RecordMarkerDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
RecordMarkerFailedEventAttributes |
Provides details of the |
RegisterActivityTypeInput | |
RegisterDomainInput | |
RegisterWorkflowTypeInput | |
RequestCancelActivityTaskDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
RequestCancelActivityTaskFailedEventAttributes |
Provides details of the |
RequestCancelExternalWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
RequestCancelExternalWorkflowExecutionFailedEventAttributes |
Provides details of the |
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes |
Provides details of the |
RequestCancelWorkflowExecutionInput | |
RespondActivityTaskCanceledInput | |
RespondActivityTaskCompletedInput | |
RespondActivityTaskFailedInput | |
RespondDecisionTaskCompletedInput | |
Run |
Specifies the |
ScheduleActivityTaskDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
ScheduleActivityTaskFailedEventAttributes |
Provides details of the |
ScheduleLambdaFunctionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
ScheduleLambdaFunctionFailedEventAttributes |
Provides details for the |
SignalExternalWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
SignalExternalWorkflowExecutionFailedEventAttributes |
Provides details of the |
SignalExternalWorkflowExecutionInitiatedEventAttributes |
Provides details of the |
SignalWorkflowExecutionInput | |
StartChildWorkflowExecutionDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
StartChildWorkflowExecutionFailedEventAttributes |
Provides details of the |
StartChildWorkflowExecutionInitiatedEventAttributes |
Provides details of the |
StartLambdaFunctionFailedEventAttributes |
Provides details for the |
StartTimerDecisionAttributes |
Provides details of the Access Control You can use IAM policies to control this decision's access to Amazon SWF resources as follows:
If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows. |
StartTimerFailedEventAttributes |
Provides details of the |
StartWorkflowExecutionInput | |
SwfClient |
A client for the Amazon SWF API. |
TagFilter |
Used to filter the workflow executions in visibility APIs based on a tag. |
TaskList |
Represents a task list. |
TerminateWorkflowExecutionInput | |
TimerCanceledEventAttributes |
Provides details of the |
TimerFiredEventAttributes |
Provides details of the |
TimerStartedEventAttributes |
Provides details of the |
WorkflowExecution |
Represents a workflow execution. |
WorkflowExecutionCancelRequestedEventAttributes |
Provides details of the |
WorkflowExecutionCanceledEventAttributes |
Provides details of the |
WorkflowExecutionCompletedEventAttributes |
Provides details of the |
WorkflowExecutionConfiguration |
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. |
WorkflowExecutionContinuedAsNewEventAttributes |
Provides details of the |
WorkflowExecutionCount |
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions |
WorkflowExecutionDetail |
Contains details about a workflow execution. |
WorkflowExecutionFailedEventAttributes |
Provides details of the |
WorkflowExecutionFilter |
Used to filter the workflow executions in visibility APIs by their |
WorkflowExecutionInfo |
Contains information about a workflow execution. |
WorkflowExecutionInfos |
Contains a paginated list of information about workflow executions. |
WorkflowExecutionOpenCounts |
Contains the counts of open tasks, child workflow executions and timers for a workflow execution. |
WorkflowExecutionSignaledEventAttributes |
Provides details of the |
WorkflowExecutionStartedEventAttributes |
Provides details of |
WorkflowExecutionTerminatedEventAttributes |
Provides details of the |
WorkflowExecutionTimedOutEventAttributes |
Provides details of the |
WorkflowType |
Represents a workflow type. |
WorkflowTypeConfiguration |
The configuration settings of a workflow type. |
WorkflowTypeDetail |
Contains details about a workflow type. |
WorkflowTypeFilter |
Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result. |
WorkflowTypeInfo |
Contains information about a workflow type. |
WorkflowTypeInfos |
Contains a paginated list of information structures about workflow types. |
Enums
CountClosedWorkflowExecutionsError |
Errors returned by CountClosedWorkflowExecutions |
CountOpenWorkflowExecutionsError |
Errors returned by CountOpenWorkflowExecutions |
CountPendingActivityTasksError |
Errors returned by CountPendingActivityTasks |
CountPendingDecisionTasksError |
Errors returned by CountPendingDecisionTasks |
DeprecateActivityTypeError |
Errors returned by DeprecateActivityType |
DeprecateDomainError |
Errors returned by DeprecateDomain |
DeprecateWorkflowTypeError |
Errors returned by DeprecateWorkflowType |
DescribeActivityTypeError |
Errors returned by DescribeActivityType |
DescribeDomainError |
Errors returned by DescribeDomain |
DescribeWorkflowExecutionError |
Errors returned by DescribeWorkflowExecution |
DescribeWorkflowTypeError |
Errors returned by DescribeWorkflowType |
GetWorkflowExecutionHistoryError |
Errors returned by GetWorkflowExecutionHistory |
ListActivityTypesError |
Errors returned by ListActivityTypes |
ListClosedWorkflowExecutionsError |
Errors returned by ListClosedWorkflowExecutions |
ListDomainsError |
Errors returned by ListDomains |
ListOpenWorkflowExecutionsError |
Errors returned by ListOpenWorkflowExecutions |
ListWorkflowTypesError |
Errors returned by ListWorkflowTypes |
PollForActivityTaskError |
Errors returned by PollForActivityTask |
PollForDecisionTaskError |
Errors returned by PollForDecisionTask |
RecordActivityTaskHeartbeatError |
Errors returned by RecordActivityTaskHeartbeat |
RegisterActivityTypeError |
Errors returned by RegisterActivityType |
RegisterDomainError |
Errors returned by RegisterDomain |
RegisterWorkflowTypeError |
Errors returned by RegisterWorkflowType |
RequestCancelWorkflowExecutionError |
Errors returned by RequestCancelWorkflowExecution |
RespondActivityTaskCanceledError |
Errors returned by RespondActivityTaskCanceled |
RespondActivityTaskCompletedError |
Errors returned by RespondActivityTaskCompleted |
RespondActivityTaskFailedError |
Errors returned by RespondActivityTaskFailed |
RespondDecisionTaskCompletedError |
Errors returned by RespondDecisionTaskCompleted |
SignalWorkflowExecutionError |
Errors returned by SignalWorkflowExecution |
StartWorkflowExecutionError |
Errors returned by StartWorkflowExecution |
TerminateWorkflowExecutionError |
Errors returned by TerminateWorkflowExecution |
Traits
Swf |
Trait representing the capabilities of the Amazon SWF API. Amazon SWF clients implement this trait. |