Get all available regions for the Amazon Simple Workflow service.
Return type: | list |
---|---|
Returns: | A list of boto.regioninfo.RegionInfo |
Low-level interface to Simple WorkFlow Service.
The default region name for Simple Workflow.
alias of SWFResponseError
The name of the Service
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, TypeDeprecatedFault, SWFOperationNotPermittedError |
Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
Parameters: | name (string) – The name of the domain to deprecate. |
---|---|
Raises: | UnknownResourceFault, DomainDeprecatedFault, SWFOperationNotPermittedError |
Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, TypeDeprecatedFault, SWFOperationNotPermittedError |
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns information about the specified domain including description and status.
Parameters: | name (string) – The name of the domain to describe. |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns information about the specified workflow execution including its type and some statistics.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
This method wraps around make_request() to normalize and serialize the dictionary with request parameters.
Parameters: |
---|
Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Parameters: |
|
---|---|
Raises: | SWFOperationNotPermittedError, UnknownResourceFault |
Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Parameters: |
|
---|---|
Raises: | SWFOperationNotPermittedError |
Returns the list of open workflow executions within the given domain that meet the specified filtering criteria.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Parameters: |
|
---|---|
Raises: | SWFOperationNotPermittedError, UnknownResourceFault |
Raises: | SWFResponseError if response status is not 200. |
---|
Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Registers a new activity type along with its configuration settings in the specified domain.
Parameters: |
|
---|---|
Raises: | SWFTypeAlreadyExistsError, SWFLimitExceededError, UnknownResourceFault, SWFOperationNotPermittedError |
Registers a new domain.
Parameters: |
|
---|---|
Raises: | SWFDomainAlreadyExistsError, SWFLimitExceededError, SWFOperationNotPermittedError |
Registers a new workflow type and its configuration settings in the specified domain.
Parameters: |
|
---|---|
Raises: | SWFTypeAlreadyExistsError, SWFLimitExceededError, UnknownResourceFault, SWFOperationNotPermittedError |
Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided).
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified).
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
Parameters: |
|
---|
Raises: | UnknownResourceFault, TypeDeprecatedFault, SWFWorkflowExecutionAlreadyStartedError, SWFLimitExceededError, SWFOperationNotPermittedError, DefaultUndefinedFault |
---|
Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Helper class for creating decision responses.
Use this object to build a list of decisions for a decision response. Each method call will add append a new decision. Retrieve the list of decisions from the _data attribute.
Cancels a previously started timer and records a TimerCanceled event in the history.
Closes the workflow execution and records a WorkflowExecutionCanceled event in the history.
Closes the workflow execution and records a WorkflowExecutionCompleted event in the history
Closes the workflow execution and starts a new workflow execution of the same type using the same workflow id and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.
Closes the workflow execution and records a WorkflowExecutionFailed event in the history.
Records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they do not need to look at the history beyond the marker event.
Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it will be canceled. If the activity task was already assigned to a worker, then the worker will be informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.
Requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.
Schedules an activity task.
Parameters: |
|
---|
Requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.
Requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.
Starts a timer for this workflow execution and records a TimerStarted event in the history. This timer will fire after the specified delay and record a TimerFired event.
Object-oriented interface to SWF wrapping boto.swf.layer1.Layer1
A versioned activity type.
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, TypeDeprecatedFault, SWFOperationNotPermittedError |
Returns information about the specified activity type. This includes configuration settings provided at registration time as well as other general information about the type.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Registers a new activity type along with its configuration settings in the specified domain.
Parameters: |
|
---|---|
Raises: | SWFTypeAlreadyExistsError, SWFLimitExceededError, UnknownResourceFault, SWFOperationNotPermittedError |
Base class for SimpleWorkflow activity workers.
Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided).
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified).
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also (optionally) specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Base class for SimpleWorkflow deciders.
Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Simple Workflow Domain.
Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Parameters: |
|
---|---|
Raises: | SWFOperationNotPermittedError, UnknownResourceFault |
Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 will be returned.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and is not guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 will be returned.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated will continue to run.
Parameters: | name (string) – The name of the domain to deprecate. |
---|---|
Raises: | UnknownResourceFault, DomainDeprecatedFault, SWFOperationNotPermittedError |
Returns information about the specified domain including description and status.
Parameters: | name (string) – The name of the domain to describe. |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
List list open/closed executions.
For a full list of available parameters refer to boto.swf.layer1.Layer1.list_closed_workflow_executions() and boto.swf.layer1.Layer1.list_open_workflow_executions()
Registers a new domain.
Parameters: |
|
---|---|
Raises: | SWFDomainAlreadyExistsError, SWFLimitExceededError, SWFOperationNotPermittedError |
Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.
Parameters: |
|
---|---|
Raises: | SWFOperationNotPermittedError, UnknownResourceFault |
An instance of a workflow.
Returns information about the specified workflow execution including its type and some statistics.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.
Parameters: |
|
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
A versioned workflow type.
Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, TypeDeprecatedFault, SWFOperationNotPermittedError |
Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.
Parameters: | |
---|---|
Raises: | UnknownResourceFault, SWFOperationNotPermittedError |
Registers a new workflow type and its configuration settings in the specified domain.
Parameters: |
|
---|---|
Raises: | SWFTypeAlreadyExistsError, SWFLimitExceededError, UnknownResourceFault, SWFOperationNotPermittedError |
Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.
Parameters: |
|
---|
Raises: | UnknownResourceFault, TypeDeprecatedFault, SWFWorkflowExecutionAlreadyStartedError, SWFLimitExceededError, SWFOperationNotPermittedError, DefaultUndefinedFault |
---|
Set default credentials.