AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
ActivityTask | Unit of work sent to an activity worker. | |
ActivityTaskCanceledEventAttributes |
Provides details of the ActivityTaskCanceled event.
|
|
ActivityTaskCancelRequestedEventAttributes |
Provides details of the ActivityTaskCancelRequested event.
|
|
ActivityTaskCompletedEventAttributes |
Provides details of the ActivityTaskCompleted event.
|
|
ActivityTaskFailedEventAttributes |
Provides details of the ActivityTaskFailed event.
|
|
ActivityTaskScheduledEventAttributes |
Provides details of the ActivityTaskScheduled event.
|
|
ActivityTaskStartedEventAttributes |
Provides details of the ActivityTaskStarted event.
|
|
ActivityTaskStatus | Status information about an activity task. | |
ActivityTaskTimedOutEventAttributes |
Provides details of the ActivityTaskTimedOut event.
|
|
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 CancelTimer decision.
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 CancelTimerFailed event.
|
|
CancelWorkflowExecutionDecisionAttributes |
Provides details of the CancelWorkflowExecution decision.
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 CancelWorkflowExecutionFailed event.
|
|
ChildWorkflowExecutionCanceledEventAttributes |
Provide details of the ChildWorkflowExecutionCanceled event.
|
|
ChildWorkflowExecutionCompletedEventAttributes |
Provides details of the ChildWorkflowExecutionCompleted event.
|
|
ChildWorkflowExecutionFailedEventAttributes |
Provides details of the ChildWorkflowExecutionFailed event.
|
|
ChildWorkflowExecutionStartedEventAttributes |
Provides details of the ChildWorkflowExecutionStarted event.
|
|
ChildWorkflowExecutionTerminatedEventAttributes |
Provides details of the ChildWorkflowExecutionTerminated event.
|
|
ChildWorkflowExecutionTimedOutEventAttributes |
Provides details of the ChildWorkflowExecutionTimedOut event.
|
|
CloseStatusFilter | Used to filter the closed workflow executions in visibility APIs by their close status. | |
CompleteWorkflowExecutionDecisionAttributes |
Provides details of the CompleteWorkflowExecution decision.
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 CompleteWorkflowExecutionFailed event.
|
|
ContinueAsNewWorkflowExecutionDecisionAttributes |
Provides details of the ContinueAsNewWorkflowExecution decision.
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 ContinueAsNewWorkflowExecutionFailed event.
|
|
CountClosedWorkflowExecutionsRequest |
Container for the parameters to the CountClosedWorkflowExecutions operation.
Returns the number of closed workflow executions within the given domain that meet
the specified filtering criteria.
Access Control You can use IAM policies to control this action'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. |
|
CountClosedWorkflowExecutionsResponse | Configuration for accessing Amazon CountClosedWorkflowExecutions service | |
CountClosedWorkflowExecutionsResult | Contains the response data from the CountClosedWorkflowExecutions operation. | |
CountOpenWorkflowExecutionsRequest |
Container for the parameters to the CountOpenWorkflowExecutions operation.
Returns the number of open workflow executions within the given domain that meet the
specified filtering criteria.
Access Control You can use IAM policies to control this action'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. |
|
CountOpenWorkflowExecutionsResponse | Configuration for accessing Amazon CountOpenWorkflowExecutions service | |
CountOpenWorkflowExecutionsResult | Contains the response data from the CountOpenWorkflowExecutions operation. | |
CountPendingActivityTasksRequest |
Container for the parameters to the CountPendingActivityTasks operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
CountPendingActivityTasksResponse | Configuration for accessing Amazon CountPendingActivityTasks service | |
CountPendingActivityTasksResult | Contains the response data from the CountPendingActivityTasks operation. | |
CountPendingDecisionTasksRequest |
Container for the parameters to the CountPendingDecisionTasks operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
CountPendingDecisionTasksResponse | Configuration for accessing Amazon CountPendingDecisionTasks service | |
CountPendingDecisionTasksResult | Contains the response data from the CountPendingDecisionTasks operation. | |
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 DecisionTaskCompleted event.
|
|
DecisionTaskScheduledEventAttributes |
Provides details about the DecisionTaskScheduled event.
|
|
DecisionTaskStartedEventAttributes |
Provides details of the DecisionTaskStarted event.
|
|
DecisionTaskTimedOutEventAttributes |
Provides details of the DecisionTaskTimedOut event.
|
|
DefaultUndefinedException | SimpleWorkflow exception | |
DeprecateActivityTypeRequest |
Container for the parameters to the DeprecateActivityType operation.
Deprecates the specified activity type. After an activity type has been deprecated,
you cannot create new tasks of that activity type. Tasks of this type that were scheduled
before the type was deprecated will continue to run.
Access Control You can use IAM policies to control this action'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. |
|
DeprecateActivityTypeResponse | ||
DeprecateDomainRequest |
Container for the parameters to the DeprecateDomain operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
DeprecateDomainResponse | ||
DeprecateWorkflowTypeRequest |
Container for the parameters to the DeprecateWorkflowType operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
DeprecateWorkflowTypeResponse | ||
DescribeActivityTypeRequest |
Container for the parameters to the DescribeActivityType operation.
Returns information about the specified activity type. This includes configuration
settings provided when the type was registered and other general information about
the type.
Access Control You can use IAM policies to control this action'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. |
|
DescribeActivityTypeResponse | Configuration for accessing Amazon DescribeActivityType service | |
DescribeActivityTypeResult | Contains the response data from the DescribeActivityType operation. | |
DescribeDomainRequest |
Container for the parameters to the DescribeDomain operation.
Returns information about the specified domain, including description and status.
Access Control You can use IAM policies to control this action'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. |
|
DescribeDomainResponse | Configuration for accessing Amazon DescribeDomain service | |
DescribeDomainResult | Contains the response data from the DescribeDomain operation. | |
DescribeWorkflowExecutionRequest |
Container for the parameters to the DescribeWorkflowExecution operation.
Returns information about the specified workflow execution including its type and
some statistics.
Access Control You can use IAM policies to control this action'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. |
|
DescribeWorkflowExecutionResponse | Configuration for accessing Amazon DescribeWorkflowExecution service | |
DescribeWorkflowExecutionResult | Contains the response data from the DescribeWorkflowExecution operation. | |
DescribeWorkflowTypeRequest |
Container for the parameters to the DescribeWorkflowType operation.
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, and so on.
Access Control You can use IAM policies to control this action'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. |
|
DescribeWorkflowTypeResponse | Configuration for accessing Amazon DescribeWorkflowType service | |
DescribeWorkflowTypeResult | Contains the response data from the DescribeWorkflowType operation. | |
DomainAlreadyExistsException | SimpleWorkflow exception | |
DomainConfiguration | Contains the configuration settings of a domain. | |
DomainDeprecatedException | SimpleWorkflow exception | |
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: "oldestDate": 1325376070.
|
|
ExternalWorkflowExecutionCancelRequestedEventAttributes |
Provides details of the ExternalWorkflowExecutionCancelRequested event.
|
|
ExternalWorkflowExecutionSignaledEventAttributes |
Provides details of the ExternalWorkflowExecutionSignaled event.
|
|
FailWorkflowExecutionDecisionAttributes |
Provides details of the FailWorkflowExecution decision.
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 FailWorkflowExecutionFailed event.
|
|
GetWorkflowExecutionHistoryRequest |
Container for the parameters to the GetWorkflowExecutionHistory operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
GetWorkflowExecutionHistoryResponse | Configuration for accessing Amazon GetWorkflowExecutionHistory service | |
GetWorkflowExecutionHistoryResult | Contains the response data from the GetWorkflowExecutionHistory operation. | |
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 LambdaFunctionCompleted event.
|
|
LambdaFunctionFailedEventAttributes |
Provides details for the LambdaFunctionFailed event.
|
|
LambdaFunctionScheduledEventAttributes |
Provides details for the LambdaFunctionScheduled event.
|
|
LambdaFunctionStartedEventAttributes |
Provides details for the LambdaFunctionStarted event.
|
|
LambdaFunctionTimedOutEventAttributes |
Provides details for the LambdaFunctionTimedOut event.
|
|
LimitExceededException | SimpleWorkflow exception | |
ListActivityTypesRequest |
Container for the parameters to the ListActivityTypes operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
ListActivityTypesResponse | Configuration for accessing Amazon ListActivityTypes service | |
ListActivityTypesResult | Contains the response data from the ListActivityTypes operation. | |
ListClosedWorkflowExecutionsRequest |
Container for the parameters to the ListClosedWorkflowExecutions operation.
Returns a list of closed workflow executions in the specified domain that meet the
filtering criteria. The results may be split into multiple pages. To retrieve subsequent
pages, make the call again using the nextPageToken returned by the initial call.
Access Control You can use IAM policies to control this action'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. |
|
ListClosedWorkflowExecutionsResponse | Configuration for accessing Amazon ListClosedWorkflowExecutions service | |
ListClosedWorkflowExecutionsResult | Contains the response data from the ListClosedWorkflowExecutions operation. | |
ListDomainsRequest |
Container for the parameters to the ListDomains operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
ListDomainsResponse | Configuration for accessing Amazon ListDomains service | |
ListDomainsResult | Contains the response data from the ListDomains operation. | |
ListOpenWorkflowExecutionsRequest |
Container for the parameters to the ListOpenWorkflowExecutions operation.
Returns a list of open workflow executions in the specified domain that meet the filtering
criteria. The results may be split into multiple pages. To retrieve subsequent pages,
make the call again using the nextPageToken returned by the initial call.
Access Control You can use IAM policies to control this action'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. |
|
ListOpenWorkflowExecutionsResponse | Configuration for accessing Amazon ListOpenWorkflowExecutions service | |
ListOpenWorkflowExecutionsResult | Contains the response data from the ListOpenWorkflowExecutions operation. | |
ListWorkflowTypesRequest |
Container for the parameters to the ListWorkflowTypes operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
ListWorkflowTypesResponse | Configuration for accessing Amazon ListWorkflowTypes service | |
ListWorkflowTypesResult | Contains the response data from the ListWorkflowTypes operation. | |
MarkerRecordedEventAttributes |
Provides details of the MarkerRecorded event.
|
|
OperationNotPermittedException | SimpleWorkflow exception | |
PendingTaskCount | Contains the count of tasks in a task list. | |
PollForActivityTaskRequest |
Container for the parameters to the PollForActivityTask operation.
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.
Access Control You can use IAM policies to control this action'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. |
|
PollForActivityTaskResponse | Configuration for accessing Amazon PollForActivityTask service | |
PollForActivityTaskResult | Contains the response data from the PollForActivityTask operation. | |
PollForDecisionTaskRequest |
Container for the parameters to the PollForDecisionTask operation.
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.
This action initiates a long poll, where the service holds the HTTP connection open
and responds as soon a task becomes available. If no decision task is available in
the specified task list before the timeout of 60 seconds expires, an empty result
is returned. An empty result, in this context, means that a DecisionTask is returned,
but that the value of PollForDecisionTask using the nextPageToken
returned by the initial call. Note that you do not call GetWorkflowExecutionHistory
with this nextPageToken . Instead, call PollForDecisionTask
again.Access Control You can use IAM policies to control this action'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. |
|
PollForDecisionTaskResponse | Configuration for accessing Amazon PollForDecisionTask service | |
PollForDecisionTaskResult | Contains the response data from the PollForDecisionTask operation. | |
RecordActivityTaskHeartbeatRequest |
Container for the parameters to the RecordActivityTaskHeartbeat operation.
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 .
This action resets the
This action does not in itself create an event in the workflow execution history.
However, if the task times out, the workflow execution history will contain a taskStartToCloseTimeout of an activity type is the maximum
duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat
requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.cancelRequested flag returns true , a cancellation is
being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled.
Otherwise, it should ignore the cancellation request.Access Control You can use IAM policies to control this action'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. |
|
RecordActivityTaskHeartbeatResponse | Configuration for accessing Amazon RecordActivityTaskHeartbeat service | |
RecordActivityTaskHeartbeatResult | Contains the response data from the RecordActivityTaskHeartbeat operation. | |
RecordMarkerDecisionAttributes |
Provides details of the RecordMarker decision.
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 RecordMarkerFailed event.
|
|
RegisterActivityTypeRequest |
Container for the parameters to the RegisterActivityType operation.
Registers a new activity type along with its configuration settings in the
specified domain.
TypeAlreadyExists fault is returned if the type already
exists in the domain. You cannot change any configuration settings of the type after
its registration, and it must be registered as a new version.Access Control You can use IAM policies to control this action'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. |
|
RegisterActivityTypeResponse | ||
RegisterDomainRequest |
Container for the parameters to the RegisterDomain operation.
Registers a new domain.
Access Control You can use IAM policies to control this action'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. |
|
RegisterDomainResponse | ||
RegisterWorkflowTypeRequest |
Container for the parameters to the RegisterWorkflowType operation.
Registers a new workflow type and its configuration settings in the specified
domain.
The retention period for the workflow history is set by the RegisterDomain action. TypeAlreadyExists fault
is returned. You cannot change the configuration settings of a workflow type once
it is registered and it must be registered as a new version.Access Control You can use IAM policies to control this action'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. |
|
RegisterWorkflowTypeResponse | ||
RequestCancelActivityTaskDecisionAttributes |
Provides details of the RequestCancelActivityTask decision.
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 RequestCancelActivityTaskFailed event.
|
|
RequestCancelExternalWorkflowExecutionDecisionAttributes |
Provides details of the RequestCancelExternalWorkflowExecution decision.
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 RequestCancelExternalWorkflowExecutionFailed
event.
|
|
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes |
Provides details of the RequestCancelExternalWorkflowExecutionInitiated
event.
|
|
RequestCancelWorkflowExecutionRequest |
Container for the parameters to the RequestCancelWorkflowExecution operation.
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.
WorkflowExecutionCancelRequested
event is recorded in the history of the current open workflow execution with the specified
workflowId in the domain.Access Control You can use IAM policies to control this action'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. |
|
RequestCancelWorkflowExecutionResponse | ||
RespondActivityTaskCanceledRequest |
Container for the parameters to the RespondActivityTaskCanceled operation.
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.
These canceled flag of a RecordActivityTaskHeartbeat
request returns true and if the activity can be safely undone or abandoned.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action'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. |
|
RespondActivityTaskCanceledResponse | ||
RespondActivityTaskCompletedRequest |
Container for the parameters to the RespondActivityTaskCompleted operation.
Used by workers to tell the service that the ActivityTask identified by the
taskToken completed successfully with a result (if provided).
The result appears in the ActivityTaskCompleted event in
the workflow history.
canceled
flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean
up and then call RespondActivityTaskCanceled.A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action'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. |
|
RespondActivityTaskCompletedResponse | ||
RespondActivityTaskFailedRequest |
Container for the parameters to the RespondActivityTaskFailed operation.
Used by workers to tell the service that the ActivityTask identified by the
taskToken has failed with reason (if specified). The reason
and details appear in the ActivityTaskFailed event added
to the workflow history.
A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out. Access Control You can use IAM policies to control this action'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. |
|
RespondActivityTaskFailedResponse | ||
RespondDecisionTaskCompletedRequest |
Container for the parameters to the RespondDecisionTaskCompleted operation.
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.
A Access Control
If an IAM policy grants permission to use |
|
RespondDecisionTaskCompletedResponse | ||
Run |
Specifies the runId of a workflow execution.
|
|
ScheduleActivityTaskDecisionAttributes |
Provides details of the ScheduleActivityTask decision.
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 ScheduleActivityTaskFailed event.
|
|
ScheduleLambdaFunctionDecisionAttributes |
Provides details of the ScheduleLambdaFunction decision.
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 ScheduleLambdaFunctionFailed event.
|
|
SignalExternalWorkflowExecutionDecisionAttributes |
Provides details of the SignalExternalWorkflowExecution decision.
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 SignalExternalWorkflowExecutionFailed event.
|
|
SignalExternalWorkflowExecutionInitiatedEventAttributes |
Provides details of the SignalExternalWorkflowExecutionInitiated event.
|
|
SignalWorkflowExecutionRequest |
Container for the parameters to the SignalWorkflowExecution operation.
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).
WorkflowExecutionSignaled
event is recorded in the history of the current open workflow with the matching workflowId
in the domain.UnknownResource .Access Control You can use IAM policies to control this action'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. |
|
SignalWorkflowExecutionResponse | ||
StartChildWorkflowExecutionDecisionAttributes |
Provides details of the StartChildWorkflowExecution decision.
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 StartChildWorkflowExecutionFailed event.
|
|
StartChildWorkflowExecutionInitiatedEventAttributes |
Provides details of the StartChildWorkflowExecutionInitiated event.
|
|
StartLambdaFunctionFailedEventAttributes |
Provides details for the StartLambdaFunctionFailed event.
|
|
StartTimerDecisionAttributes |
Provides details of the StartTimer decision.
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 StartTimerFailed event.
|
|
StartWorkflowExecutionRequest |
Container for the parameters to the StartWorkflowExecution operation.
Starts an execution of the workflow type in the specified domain using the provided
workflowId and input data.
This action returns the newly started workflow execution. Access Control You can use IAM policies to control this action'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. |
|
StartWorkflowExecutionResponse | Configuration for accessing Amazon StartWorkflowExecution service | |
StartWorkflowExecutionResult | Contains the response data from the StartWorkflowExecution operation. | |
TagFilter | Used to filter the workflow executions in visibility APIs based on a tag. | |
TaskList | Represents a task list. | |
TerminateWorkflowExecutionRequest |
Container for the parameters to the TerminateWorkflowExecution operation.
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.
WorkflowExecutionTerminated
event is recorded in the history of the current open workflow with the matching workflowId
in the domain.Access Control You can use IAM policies to control this action'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. |
|
TerminateWorkflowExecutionResponse | ||
TimerCanceledEventAttributes |
Provides details of the TimerCanceled event.
|
|
TimerFiredEventAttributes |
Provides details of the TimerFired event.
|
|
TimerStartedEventAttributes |
Provides details of the TimerStarted event.
|
|
TypeAlreadyExistsException | SimpleWorkflow exception | |
TypeDeprecatedException | SimpleWorkflow exception | |
UnknownResourceException | SimpleWorkflow exception | |
WorkflowExecution | Represents a workflow execution. | |
WorkflowExecutionAlreadyStartedException | SimpleWorkflow exception | |
WorkflowExecutionCanceledEventAttributes |
Provides details of the WorkflowExecutionCanceled event.
|
|
WorkflowExecutionCancelRequestedEventAttributes |
Provides details of the WorkflowExecutionCancelRequested event.
|
|
WorkflowExecutionCompletedEventAttributes |
Provides details of the WorkflowExecutionCompleted event.
|
|
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 WorkflowExecutionContinuedAsNew event.
|
|
WorkflowExecutionCount | Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions | |
WorkflowExecutionDetail | Contains details about a workflow execution. | |
WorkflowExecutionFailedEventAttributes |
Provides details of the WorkflowExecutionFailed event.
|
|
WorkflowExecutionFilter |
Used to filter the workflow executions in visibility APIs by their workflowId .
|
|
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 WorkflowExecutionSignaled event.
|
|
WorkflowExecutionStartedEventAttributes |
Provides details of WorkflowExecutionStarted event.
|
|
WorkflowExecutionTerminatedEventAttributes |
Provides details of the WorkflowExecutionTerminated event.
|
|
WorkflowExecutionTimedOutEventAttributes |
Provides details of the WorkflowExecutionTimedOut event.
|
|
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. |