start_workflow_execution ( $opt )

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.
    • name: String constraint. The key is swf:workflowType.name.
    • version: String constraint. The key is swf:workflowType.version.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails by throwing OperationNotPermitted. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • domain - string - Required - The name of the domain in which the workflow execution is created.
  • workflowId - string - Required - The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time. The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string “arn”.
  • workflowType - array - Required - The type of the workflow to start.
    • name - string - Required - The name of the workflow type. This field is required.

      The combination of workflow type name and version must be unique with in a domain.

    • version - string - Required - The version of the workflow type. This field is required.

      The combination of workflow type name and version must be unique with in a domain.

  • taskList - array - Optional - The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal string “arn”.
    • name - string - Required - The name of the task list.
  • input - string - Optional - The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.
  • executionStartToCloseTimeout - string - Optional - The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type. The duration is specified in seconds. The valid values are integers greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of “NONE” for this timeout; there is a one-year max limit on the time that a workflow execution can run.

    An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

  • tagList - string|array - Optional - The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter. Pass a string for a single value, or an indexed array for multiple values.
  • taskStartToCloseTimeout - string - Optional - Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType. The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.

  • childPolicy - string - Optional - If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType. The supported child policies are:
    • TERMINATE: the child executions will be terminated.
    • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
    • ABANDON: no action will be taken. The child executions will continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.

    [Allowed values: TERMINATE, REQUEST_CANCEL, ABANDON]
  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Workflow Execution

Shows an example of workflow execution methods.

This sample uses anonymous functions, which are only available in PHP 5.3+. For PHP 5.2 users, you must used named functions instead of anonymous ones.

$swf = new AmazonSWF();

// Setup
$timestamp = time();
$workflow_domain = 'my-domain' . $timestamp;
$workflow_type_name = 'my-workflow-type';
$activity_type_name = 'my-activity-type';

//-----------------------------------------------------------------//
// Start a workflow execution

echo '# Starting a new workflow execution...' . PHP_EOL;
$workflow = $swf->start_workflow_execution(array(
	'domain'       => $workflow_domain,
	'workflowId'   => 'my-workflow-execution',
	'workflowType' => array(
		'name'    => $workflow_type_name,
		'version' => '1.0'
	),
	'taskList'     => array(
		'name' => 'my-task-list'
	),
	'tagList'      => array('tag1', 'tag2'),
	'childPolicy'  => AmazonSWF::POLICY_TERMINATE,
	'taskStartToCloseTimeout'      => '30',
	'executionStartToCloseTimeout' => '30',
));

// Grab the Run ID
$run_id = (string) $workflow->body->runId;
echo 'Workflow Run ID: ';
echo $run_id . PHP_EOL;

if ($workflow->isOK())
{
	echo 'The workflow execution has started...' . PHP_EOL;
}
else
{
	echo 'The workflow execution has failed to start.';
}

echo PHP_EOL;

//-----------------------------------------------------------------//
// List open workflow executions

echo '# List of open executions...' . PHP_EOL;
$list_open_exec = $swf->list_open_workflow_executions(array(
	'domain'          => $workflow_domain,
	'typeFilter'      => array(
		'name'    => $workflow_type_name,
		'version' => '1.0'
	),
	'startTimeFilter' => array(
		'oldestDate' => strtotime('yesterday, midnight')
	)
))
->body->executionInfos();

if ($list_open_exec instanceof Countable)
{
	$list_open_exec->each(function($item)
	{
		echo (string) $item->execution->workflowId . PHP_EOL;
	});
}
elseif (isset($list_open_exec->executionInfos))
{
	echo (string) $list_open_exec->executionInfos->execution->workflowId . PHP_EOL;
}

echo PHP_EOL;

//-----------------------------------------------------------------//
// List closed workflow executions

echo '# List of closed executions...' . PHP_EOL;
$list_closed_exec = $swf->list_closed_workflow_executions(array(
	'domain'          => $workflow_domain,
	'typeFilter'      => array(
		'name'    => $workflow_type_name,
		'version' => '1.0'
	),
	'startTimeFilter' => array(
		'oldestDate' => strtotime('yesterday, midnight')
	)
))
->body->executionInfos();

if ($list_closed_exec instanceof Countable)
{
	$list_closed_exec->each(function($item)
	{
		echo (string) $item->execution->workflowId . PHP_EOL;
	});
}
elseif (isset($list_closed_exec->executionInfos))
{
	echo (string) $list_closed_exec->executionInfos->execution->workflowId . PHP_EOL;
}

echo PHP_EOL;

//-----------------------------------------------------------------//
// Count open workflow executions

echo 'Count of open executions: ';
$count_open_exec = $swf->count_open_workflow_executions(array(
	'domain'          => $workflow_domain,
	'typeFilter'      => array(
		'name'    => $workflow_type_name,
		'version' => '1.0'
	),
	'startTimeFilter' => array(
		'oldestDate' => strtotime('yesterday, midnight')
	)
));

echo (string) $count_open_exec->body->count . PHP_EOL;

//-----------------------------------------------------------------//
// Count closed workflow executions

echo 'Count of closed executions: ';
$count_closed_exec = $swf->count_closed_workflow_executions(array(
	'domain'          => $workflow_domain,
	'typeFilter'      => array(
		'name'    => $workflow_type_name,
		'version' => '1.0'
	),
	'startTimeFilter' => array(
		'oldestDate' => strtotime('yesterday, midnight')
	)
));

echo (string) $count_open_exec->body->count . PHP_EOL;

echo PHP_EOL;

//-----------------------------------------------------------------//
// Describe a workflow execution

echo '# Describing an execution\'s tags...' . PHP_EOL;
$describe = $swf->describe_workflow_execution(array(
	'domain'    => $workflow_domain,
	'execution' => array(
		'workflowId' => 'my-workflow-execution',
		'runId'      => $run_id,
	)
));

$tags = $describe->body->executionInfo->tagList->to_array()->getArrayCopy();
print_r($tags['tagList']);
echo PHP_EOL;

//-----------------------------------------------------------------//
// Get a workflow execution

$history_events = array();
echo '# Getting the timestamps of all of the events...' . PHP_EOL;
$swf->get_workflow_execution_history(array(
	'domain'    => $workflow_domain,
	'execution' => array(
		'workflowId' => 'my-workflow-execution',
		'runId'      => $run_id,
	)
))
->body->events()->each(function($item)
{
	echo (string) $item->eventType . PHP_EOL;
});

echo PHP_EOL;

//-----------------------------------------------------------------//
// Terminate a workflow execution

echo '# Terminating a workflow execution...' . PHP_EOL;
$workflow = $swf->terminate_workflow_execution(array(
	'domain'      => $workflow_domain,
	'workflowId'  => 'my-workflow-execution',
	'runId'       => $run_id,
	'childPolicy' => AmazonSWF::POLICY_TERMINATE,
	'reason'      => 'We\'re done with this workflow now.',
	'details'     => 'No really, we\'re done.',
));

Source

Method defined in services/swf.class.php | Toggle source view (12 lines) | View on GitHub

public function start_workflow_execution($opt = null)
{
    if (!$opt) $opt = array();
    
    // List (non-map)
    if (isset($opt['tagList']))
    {
        $opt['tagList'] = (is_array($opt['tagList']) ? $opt['tagList'] : array($opt['tagList']));
    }

    return $this->authenticate('StartWorkflowExecution', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback