get_workflow_execution_history ( $opt )

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.

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:

  • 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.
  • You cannot use an IAM policy to constrain this action’s parameters.

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 containing the workflow execution.
  • execution - array - Required - Specifies the workflow execution for which to return the history.
    • workflowId - string - Required - The user defined identifier associated with the workflow execution.
    • runId - string - Required - A system generated unique identifier for the workflow execution.
  • nextPageToken - string - Optional - If a NextPageToken is returned, the result has more than one pages. To get the next page, repeat the call and specify the nextPageToken with all other arguments unchanged.
  • maximumPageSize - integer - Optional - Specifies the maximum number of history events returned in one page. The next page in the result is identified by the NextPageToken returned. By default 100 history events are returned in a page but the caller can override this value to a page size smaller than the default. You cannot specify a page size larger than 100. Note that the number of events may be less than the maxiumum page size, in which case, the returned page will have fewer results than the maximumPageSize specified.
  • reverseOrder - boolean - Optional - When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.
  • 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 (6 lines) | View on GitHub

public function get_workflow_execution_history($opt = null)
{
    if (!$opt) $opt = array();
    
    return $this->authenticate('GetWorkflowExecutionHistory', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback