list_closed_workflow_executions ( $opt )

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:

  • 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.
    • tag: String constraint. The key is swf:tagFilter.tag.
    • typeFilter.name: String constraint. String constraint. The key is swf:typeFilter.name.
    • typeFilter.version: String constraint. String constraint. The key is swf:typeFilter.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 that contains the workflow executions to list.
  • startTimeFilter - array - Optional - If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    • oldestDate - string - Required - Specifies the oldest start or close date and time to return. May be passed as a number of seconds since UNIX Epoch, or any string compatible with strtotime().
    • latestDate - string - Optional - Specifies the latest start or close date and time to return. May be passed as a number of seconds since UNIX Epoch, or any string compatible with strtotime().
  • closeTimeFilter - array - Optional - If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    • oldestDate - string - Required - Specifies the oldest start or close date and time to return. May be passed as a number of seconds since UNIX Epoch, or any string compatible with strtotime().
    • latestDate - string - Optional - Specifies the latest start or close date and time to return. May be passed as a number of seconds since UNIX Epoch, or any string compatible with strtotime().
  • executionFilter - array - Optional - If specified, only workflow executions matching the workflow id specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • workflowId - string - Required - The workflowId to pass of match the criteria of this filter.
  • closeStatusFilter - array - Optional - If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • status - string - Required - The close status that must match the close status of an execution for it to meet the criteria of this filter. This field is required. [Allowed values: COMPLETED, FAILED, CANCELED, TERMINATED, CONTINUED_AS_NEW, TIMED_OUT]
  • typeFilter - array - Optional - If specified, only executions of the type specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • name - string - Required - Name of the workflow type. This field is required.
    • version - string - Optional - Version of the workflow type.
  • tagFilter - array - Optional - If specified, only executions that have the matching tag are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    • tag - string - Required - Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.
  • nextPageToken - string - Optional - If on a previous call to this method a NextPageToken was returned, the results are being paginated. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.
  • maximumPageSize - integer - Optional - The maximum number of results returned in each page. The default is 100, but the caller can override this value to a page size smaller than the default. You cannot specify a page size greater than 100. Note that the number of executions 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 results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.
  • 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 list_closed_workflow_executions($opt = null)
{
    if (!$opt) $opt = array();
    
    return $this->authenticate('ListClosedWorkflowExecutions', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback