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 the details of the |
|
ActivityTaskCancelRequestedEventAttributes |
Provides the details of the |
|
ActivityTaskCompletedEventAttributes |
Provides the details of the |
|
ActivityTaskFailedEventAttributes |
Provides the details of the |
|
ActivityTaskScheduledEventAttributes |
Provides the details of the |
|
ActivityTaskStartedEventAttributes |
Provides the details of the |
|
ActivityTaskStatus |
Status information about an activity task. |
|
ActivityTaskTimedOutEventAttributes |
Provides the 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 the 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 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 |
|
CancelTimerFailedEventAttributes |
Provides the details of the |
|
CancelWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
CancelWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
ChildWorkflowExecutionCanceledEventAttributes |
Provide details of the |
|
ChildWorkflowExecutionCompletedEventAttributes |
Provides the details of the |
|
ChildWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
ChildWorkflowExecutionStartedEventAttributes |
Provides the details of the |
|
ChildWorkflowExecutionTerminatedEventAttributes |
Provides the details of the |
|
ChildWorkflowExecutionTimedOutEventAttributes |
Provides the details of the |
|
CloseStatusFilter |
Used to filter the closed workflow executions in visibility APIs by their close status. |
|
CompleteWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
CompleteWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
ContinueAsNewWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
ContinueAsNewWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
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.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
CountClosedWorkflowExecutionsResponse |
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.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
CountOpenWorkflowExecutionsResponse |
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 isn't guaranteed to be exact. If you specify a task
list that no activity task was ever scheduled in then Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
CountPendingActivityTasksResponse |
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 isn't guaranteed to be exact. If you specify a task
list that no decision task was ever scheduled in then Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
CountPendingDecisionTasksResponse |
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
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: 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 the details of the |
|
DecisionTaskScheduledEventAttributes |
Provides details about the |
|
DecisionTaskStartedEventAttributes |
Provides the details of the |
|
DecisionTaskTimedOutEventAttributes |
Provides the details of the |
|
DefaultUndefinedException |
The
Some workflow execution parameters, such as the decision If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed. |
|
DeleteActivityTypeRequest |
Container for the parameters to the DeleteActivityType operation. Deletes the specified activity type. Note: Prior to deletion, activity types must first be deprecated. After an activity type has been deleted, you cannot schedule new activities of that type. Activities that started before the type was deleted 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 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 |
|
DeleteActivityTypeResponse |
This is the response object from the DeleteActivityType operation. |
|
DeleteWorkflowTypeRequest |
Container for the parameters to the DeleteWorkflowType operation. Deletes the specified workflow type. Note: Prior to deletion, workflow types must first be deprecated. After a workflow type has been deleted, you cannot create new executions of that type. Executions that started before the type was deleted 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 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 |
|
DeleteWorkflowTypeResponse |
This is the response object from the DeleteWorkflowType operation. |
|
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 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 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 |
|
DeprecateActivityTypeResponse |
This is the response object from the DeprecateActivityType operation. |
|
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 continues to run.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
DeprecateDomainResponse |
This is the response object from the DeprecateDomain operation. |
|
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 continues to run. A deprecated workflow type may still be
used when calling visibility actions.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
DeprecateWorkflowTypeResponse |
This is the response object from the DeprecateWorkflowType operation. |
|
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 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 |
|
DescribeActivityTypeResponse |
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 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 |
|
DescribeDomainResponse |
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.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
DescribeWorkflowExecutionResponse |
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, etc. Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
DescribeWorkflowTypeResponse |
Contains the response data from the DescribeWorkflowType operation. |
|
DomainAlreadyExistsException |
Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered. |
|
DomainConfiguration |
Contains the configuration settings of a domain. |
|
DomainDeprecatedException |
Returned when the specified domain has been deprecated. |
|
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 the details of the |
|
ExternalWorkflowExecutionSignaledEventAttributes |
Provides the details of the |
|
FailWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
FailWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
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
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
GetWorkflowExecutionHistoryResponse |
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 the details of the |
|
LambdaFunctionFailedEventAttributes |
Provides the details of the |
|
LambdaFunctionScheduledEventAttributes |
Provides the details of the |
|
LambdaFunctionStartedEventAttributes |
Provides the details of the |
|
LambdaFunctionTimedOutEventAttributes |
Provides details of the |
|
LimitExceededException |
Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS. |
|
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 Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
ListActivityTypesResponse |
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.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
ListClosedWorkflowExecutionsResponse |
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.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
ListDomainsResponse |
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.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
ListOpenWorkflowExecutionsResponse |
Contains the response data from the ListOpenWorkflowExecutions operation. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. List tags for a given domain. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource 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 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 |
|
ListWorkflowTypesResponse |
Contains the response data from the ListWorkflowTypes operation. |
|
MarkerRecordedEventAttributes |
Provides the details of the |
|
OperationNotPermittedException |
Returned when the caller doesn't have sufficient permissions to invoke the action. |
|
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
Workers should set their client side socket timeout to at least 70 seconds (10 seconds
higher than the maximum time service may hold the poll request).
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
PollForActivityTaskResponse |
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 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 taskToken is an empty string. Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).
Because the number of workflow history events for a single workflow execution might
be very large, the result returned might be split up across a number of pages. To
retrieve subsequent pages, make additional calls to Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
PollForDecisionTaskResponse |
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
This action resets the
This action doesn't in itself create an event in the workflow execution history. However,
if the task times out, the workflow execution history contains a
The This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.
If the Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
RecordActivityTaskHeartbeatResponse |
Contains the response data from the RecordActivityTaskHeartbeat operation. |
|
RecordMarkerDecisionAttributes |
Provides the 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 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 |
|
RecordMarkerFailedEventAttributes |
Provides the details of the |
|
RegisterActivityTypeRequest |
Container for the parameters to the RegisterActivityType operation.
Registers a new activity type along with its configuration settings in the
specified domain.
A Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
RegisterActivityTypeResponse |
This is the response object from the RegisterActivityType operation. |
|
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 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 |
|
RegisterDomainResponse |
This is the response object from the RegisterDomain operation. |
|
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.
If the type already exists, then a Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
RegisterWorkflowTypeResponse |
This is the response object from the RegisterWorkflowType operation. |
|
RequestCancelActivityTaskDecisionAttributes |
Provides the 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 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 |
|
RequestCancelActivityTaskFailedEventAttributes |
Provides the details of the |
|
RequestCancelExternalWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
RequestCancelExternalWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes |
Provides the details of the |
|
RequestCancelWorkflowExecutionRequest |
Container for the parameters to the RequestCancelWorkflowExecution operation.
Records a
If the runId isn't specified, the
Because this action allows the workflow to properly clean up and gracefully close,
it should be used instead of TerminateWorkflowExecution when possible.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
RequestCancelWorkflowExecutionResponse |
This is the response object from the RequestCancelWorkflowExecution operation. |
|
ResourceTag |
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: |
|
RespondActivityTaskCanceledRequest |
Container for the parameters to the RespondActivityTaskCanceled operation.
Used by workers to tell the service that the ActivityTask identified by the
These
Only use this operation if the 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 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 |
|
RespondActivityTaskCanceledResponse |
This is the response object from the RespondActivityTaskCanceled operation. |
|
RespondActivityTaskCompletedRequest |
Container for the parameters to the RespondActivityTaskCompleted operation.
Used by workers to tell the service that the ActivityTask identified by the
If the requested task doesn't complete successfully, use RespondActivityTaskFailed
instead. If the worker finds that the task is canceled through the 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 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 |
|
RespondActivityTaskCompletedResponse |
This is the response object from the RespondActivityTaskCompleted operation. |
|
RespondActivityTaskFailedRequest |
Container for the parameters to the RespondActivityTaskFailed operation.
Used by workers to tell the service that the ActivityTask identified by the
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 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 |
|
RespondActivityTaskFailedResponse |
This is the response object from the RespondActivityTaskFailed operation. |
|
RespondDecisionTaskCompletedRequest |
Container for the parameters to the RespondDecisionTaskCompleted operation.
Used by deciders to tell the service that the DecisionTask identified by the
A Access Control
If an IAM policy grants permission to use |
|
RespondDecisionTaskCompletedResponse |
This is the response object from the RespondDecisionTaskCompleted operation. |
|
Run |
Specifies the |
|
ScheduleActivityTaskDecisionAttributes |
Provides the 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 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 |
|
ScheduleActivityTaskFailedEventAttributes |
Provides the details of the |
|
ScheduleLambdaFunctionDecisionAttributes |
Decision attributes specified in |
|
ScheduleLambdaFunctionFailedEventAttributes |
Provides the details of the |
|
SignalExternalWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
SignalExternalWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
SignalExternalWorkflowExecutionInitiatedEventAttributes |
Provides the details of the |
|
SignalWorkflowExecutionRequest |
Container for the parameters to the SignalWorkflowExecution operation.
Records a
If a runId isn't specified, then the
If the specified workflow execution isn't open, this method fails with Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
SignalWorkflowExecutionResponse |
This is the response object from the SignalWorkflowExecution operation. |
|
SimpleWorkflowPaginatorFactory |
Paginators for the SimpleWorkflow service |
|
StartChildWorkflowExecutionDecisionAttributes |
Provides the 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 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 |
|
StartChildWorkflowExecutionFailedEventAttributes |
Provides the details of the |
|
StartChildWorkflowExecutionInitiatedEventAttributes |
Provides the details of the |
|
StartLambdaFunctionFailedEventAttributes |
Provides the details of the |
|
StartTimerDecisionAttributes |
Provides the 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 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 |
|
StartTimerFailedEventAttributes |
Provides the details of the |
|
StartWorkflowExecutionRequest |
Container for the parameters to the StartWorkflowExecution operation.
Starts an execution of the workflow type in the specified domain using the provided
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 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 |
|
StartWorkflowExecutionResponse |
Contains the response data from the StartWorkflowExecution operation. |
|
TagFilter |
Used to filter the workflow executions in visibility APIs based on a tag. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation.
Add a tag to a Amazon SWF domain.
Amazon SWF supports a maximum of 50 tags per resource.
|
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
TaskList |
Represents a task list. |
|
TerminateWorkflowExecutionRequest |
Container for the parameters to the TerminateWorkflowExecution operation.
Records a
If the identified workflow execution was in progress, it is terminated immediately.
If a runId isn't specified, then the
You should consider using RequestCancelWorkflowExecution action instead because
it allows the workflow to gracefully close while TerminateWorkflowExecution
doesn't.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
TerminateWorkflowExecutionResponse |
This is the response object from the TerminateWorkflowExecution operation. |
|
TimerCanceledEventAttributes |
Provides the details of the |
|
TimerFiredEventAttributes |
Provides the details of the |
|
TimerStartedEventAttributes |
Provides the details of the |
|
TooManyTagsException |
You've exceeded the number of tags allowed for a domain. |
|
TypeAlreadyExistsException |
Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered. |
|
TypeDeprecatedException |
Returned when the specified activity or workflow type was already deprecated. |
|
TypeNotDeprecatedException |
Returned when the resource type has not been deprecated. |
|
UndeprecateActivityTypeRequest |
Container for the parameters to the UndeprecateActivityType operation.
Undeprecates a previously deprecated activity type. After an activity type
has been undeprecated, you can create new tasks of that activity type.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
UndeprecateActivityTypeResponse |
This is the response object from the UndeprecateActivityType operation. |
|
UndeprecateDomainRequest |
Container for the parameters to the UndeprecateDomain operation.
Undeprecates a previously deprecated domain. After a domain has been undeprecated
it can be used to create new workflow executions or register new types.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
UndeprecateDomainResponse |
This is the response object from the UndeprecateDomain operation. |
|
UndeprecateWorkflowTypeRequest |
Container for the parameters to the UndeprecateWorkflowType operation.
Undeprecates a previously deprecated workflow type. After a workflow type has
been undeprecated, you can create new executions of that type.
This operation is eventually consistent. The results are best effort and may not exactly
reflect recent updates and changes.
Access Control You can use IAM policies to control this action's access to Amazon SWF resources as follows:
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 |
|
UndeprecateWorkflowTypeResponse |
This is the response object from the UndeprecateWorkflowType operation. |
|
UnknownResourceException |
Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Remove a tag from a Amazon SWF domain. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
WorkflowExecution |
Represents a workflow execution. |
|
WorkflowExecutionAlreadyStartedException |
Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain. |
|
WorkflowExecutionCanceledEventAttributes |
Provides the details of the |
|
WorkflowExecutionCancelRequestedEventAttributes |
Provides the details of the |
|
WorkflowExecutionCompletedEventAttributes |
Provides the 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 the details of the |
|
WorkflowExecutionCount |
Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions |
|
WorkflowExecutionDetail |
Contains details about a workflow execution. |
|
WorkflowExecutionFailedEventAttributes |
Provides the 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 the details of the |
|
WorkflowExecutionStartedEventAttributes |
Provides details of |
|
WorkflowExecutionTerminatedEventAttributes |
Provides the details of the |
|
WorkflowExecutionTimedOutEventAttributes |
Provides the 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. |
Name | Description | |
---|---|---|
IGetWorkflowExecutionHistoryPaginator |
Paginator for the GetWorkflowExecutionHistory operation |
|
IListActivityTypesPaginator |
Paginator for the ListActivityTypes operation |
|
IListClosedWorkflowExecutionsPaginator |
Paginator for the ListClosedWorkflowExecutions operation |
|
IListDomainsPaginator |
Paginator for the ListDomains operation |
|
IListOpenWorkflowExecutionsPaginator |
Paginator for the ListOpenWorkflowExecutions operation |
|
IListWorkflowTypesPaginator |
Paginator for the ListWorkflowTypes operation |
|
IPollForDecisionTaskPaginator |
Paginator for the PollForDecisionTask operation |
|
ISimpleWorkflowPaginatorFactory |
Paginators for the SimpleWorkflow service |