New API Documentation - Developer Preview Available
We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.
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:
Use a Resource element with the domain name to limit the action to
only specified domains.
Use an Action element to allow or deny permission to call this
action.
Constrain the following parameters by using a Condition element with
the appropriate keys.
tagList.member.0: The key is swf:tagList.member.0.
tagList.member.1: The key is swf:tagList.member.1.
tagList.member.2: The key is swf:tagList.member.2.
tagList.member.3: The key is swf:tagList.member.3.
tagList.member.4: The key is swf:tagList.member.4.
taskList: String constraint. The key is
swf:taskList.name.
workflowType.name: String constraint. The key is
swf:workflowType.name.
workflowType.version: String constraint. The key is
swf:workflowType.version.
If the caller doesn't have sufficient permissions to invoke the action, or the
parameter values fall outside the specified constraints, the action fails. The associated
event attribute's cause parameter is set to OPERATION_NOT_PERMITTED.
For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF
Workflows in the Amazon SWF Developer Guide.
Example
Use a bare-bones client and the command you need to make an API call.
The StartWorkflowExecution API action was called without the required
parameters set.
Some workflow execution parameters, such as the decision taskList, must be
set to start the execution. However, these parameters might have been set as defaults when the
workflow type was registered. In this case, you can omit these parameters from the
StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow
type.
If these parameters aren't set and no default parameters were defined in the workflow
type, this error is displayed.
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.
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.
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:
Use a
Resource
element with the domain name to limit the action to only specified domains.Use an
Action
element to allow or deny permission to call this action.Constrain the following parameters by using a
Condition
element with the appropriate keys.tagList.member.0
: The key isswf:tagList.member.0
.tagList.member.1
: The key isswf:tagList.member.1
.tagList.member.2
: The key isswf:tagList.member.2
.tagList.member.3
: The key isswf:tagList.member.3
.tagList.member.4
: The key isswf:tagList.member.4
.taskList
: String constraint. The key isswf:taskList.name
.workflowType.name
: String constraint. The key isswf:workflowType.name
.workflowType.version
: String constraint. The key isswf:workflowType.version
.If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's
cause
parameter is set toOPERATION_NOT_PERMITTED
. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.Example
Use a bare-bones client and the command you need to make an API call.
Param
StartWorkflowExecutionCommandInput
Returns
StartWorkflowExecutionCommandOutput
See
input
shape.response
shape.config
shape.Throws
DefaultUndefinedFault (client fault)
The
StartWorkflowExecution
API action was called without the required parameters set.Some workflow execution parameters, such as the decision
taskList
, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from theStartWorkflowExecution
call and Amazon SWF uses the values defined in the workflow type.If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.
Throws
LimitExceededFault (client fault)
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.
Throws
OperationNotPermittedFault (client fault)
Returned when the caller doesn't have sufficient permissions to invoke the action.
Throws
TypeDeprecatedFault (client fault)
Returned when the specified activity or workflow type was already deprecated.
Throws
UnknownResourceFault (client fault)
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.
Throws
WorkflowExecutionAlreadyStartedFault (client fault)
Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.
Throws
SWFServiceException
Base exception class for all service exceptions from SWF service.