/wp-content/plugins/backupbuddy/destinations/stash/lib/aws-sdk/services/swf.class.php

Large files files are truncated, but you can click here to view the full file

<?php
/*
 * Copyright 2010-2012 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

/**
 * The Amazon Simple Workflow Service API Reference is intended for programmers who need detailed
 * information about the Amazon SWF actions and data types.
 *  
 * For an broader overview of the Amazon SWF programming model, please go to the <a href=
 * "http://docs.amazonwebservices.com/amazonswf/latest/developerguide/">Amazon SWF Developer
 * Guide</a>.
 *  
 * This section provides an overview of Amazon SWF actions.
 *  
 * <strong>Action Categories</strong>
 *  
 * The Amazon SWF actions can be grouped into the following major categories.
 * 
 * <ul>
 * 	<li>Actions related to Activities</li>
 * 	<li>Actions related to Deciders</li>
 * 	<li>Actions related to Workflow Executions</li>
 * 	<li>Actions related to Administration</li>
 * 	<li>Actions related to Visibility</li>
 * </ul>
 * 
 * <strong>Actions related to Activities</strong>
 *  
 * The following are actions that are performed by activity workers:
 * 
 * <ul>
 * 	<li><a href="API_PollForActivityTask.html" title=
 * 		"PollForActivityTask">PollForActivityTask</a></li>
 * 	<li><a href="API_RespondActivityTaskCompleted.html" title=
 * 		"RespondActivityTaskCompleted">RespondActivityTaskCompleted</a></li>
 * 	<li><a href="API_RespondActivityTaskFailed.html" title=
 * 		"RespondActivityTaskFailed">RespondActivityTaskFailed</a></li>
 * 	<li><a href="API_RespondActivityTaskCanceled.html" title=
 * 		"RespondActivityTaskCanceled">RespondActivityTaskCanceled</a></li>
 * 	<li><a href="API_RecordActivityTaskHeartbeat.html" title=
 * 		"RecordActivityTaskHeartbeat">RecordActivityTaskHeartbeat</a></li>
 * </ul>
 * 
 * Activity workers use the <a href="API_PollForActivityTask.html" title=
 * "PollForActivityTask">PollForActivityTask</a> to get new activity tasks. After a worker
 * receives an activity task from Amazon SWF, it performs the task and responds using <a href=
 * "API_RespondActivityTaskCompleted.html" title=
 * "RespondActivityTaskCompleted">RespondActivityTaskCompleted</a> if successful or <a href=
 * "API_RespondActivityTaskFailed.html" title=
 * "RespondActivityTaskFailed">RespondActivityTaskFailed</a> if unsuccessful.
 *  
 * <strong>Actions related to Deciders</strong>
 *  
 * The following are actions that are performed by deciders:
 * 
 * <ul>
 * 	<li><a href="API_PollForDecisionTask.html" title=
 * 		"PollForDecisionTask">PollForDecisionTask</a></li>
 * 	<li><a href="API_RespondDecisionTaskCompleted.html" title=
 * 		"RespondDecisionTaskCompleted">RespondDecisionTaskCompleted</a></li>
 * </ul>
 * 
 * Deciders use <a href="API_PollForDecisionTask.html" title=
 * "PollForDecisionTask">PollForDecisionTask</a> to get decision tasks. After a decider receives a
 * decision task from Amazon SWF, it examines its workflow execution history and decides what to
 * do next. It calls <a href="API_RespondDecisionTaskCompleted.html" title=
 * "RespondDecisionTaskCompleted">RespondDecisionTaskCompleted</a> to complete the decision task
 * and provide zero or more next decisions.
 *  
 * <strong>Actions related to Workflow Executions</strong>
 *  
 * The following actions operate on a workflow execution:
 * 
 * <ul>
 * 	<li><a href="API_RequestCancelWorkflowExecution.html" title=
 * 		"RequestCancelWorkflowExecution">RequestCancelWorkflowExecution</a></li>
 * 	<li><a href="API_StartWorkflowExecution.html" title=
 * 		"StartWorkflowExecution">StartWorkflowExecution</a></li>
 * 	<li><a href="API_SignalWorkflowExecution.html" title=
 * 		"SignalWorkflowExecution">SignalWorkflowExecution</a></li>
 * 	<li><a href="API_TerminateWorkflowExecution.html" title=
 * 		"TerminateWorkflowExecution">TerminateWorkflowExecution</a></li>
 * </ul>
 * 
 * <strong>Actions related to Administration</strong>
 *  
 * Although you can perform administrative tasks from the Amazon SWF console, you can use the
 * actions in this section to automate functions or build your own administrative tools.
 *  
 * <strong>Activity Management</strong>
 * 
 * <ul>
 * 	<li><a href="API_RegisterActivityType.html" title=
 * 		"RegisterActivityType">RegisterActivityType</a></li>
 * 	<li><a href="API_DeprecateActivityType.html" title=
 * 		"DeprecateActivityType">DeprecateActivityType</a></li>
 * </ul>
 * 
 * <strong>Workflow Management</strong>
 * 
 * <ul>
 * 	<li><a href="API_RegisterWorkflowType.html" title=
 * 		"RegisterWorkflowType">RegisterWorkflowType</a></li>
 * 	<li><a href="API_DeprecateWorkflowType.html" title=
 * 		"DeprecateWorkflowType">DeprecateWorkflowType</a></li>
 * </ul>
 * 
 * <strong>Domain Management</strong>
 * 
 * <ul>
 * 	<li><a href="API_RegisterDomain.html" title="RegisterDomain">RegisterDomain</a></li>
 * 	<li><a href="API_DeprecateDomain.html" title="DeprecateDomain">DeprecateDomain</a></li>
 * </ul>
 * 
 * <strong>Workflow Execution Management</strong>
 * 
 * <ul>
 * 	<li><a href="API_RequestCancelWorkflowExecution.html" title=
 * 		"RequestCancelWorkflowExecution">RequestCancelWorkflowExecution</a></li>
 * 	<li><a href="API_TerminateWorkflowExecution.html" title=
 * 		"TerminateWorkflowExecution">TerminateWorkflowExecution</a></li>
 * </ul>
 * 
 * <strong>Visibility Actions</strong>
 *  
 * Although you can perform visibility actions from the Amazon SWF console, you can use the
 * actions in this section to build your own console or administrative tools.
 *  
 * <strong>Activity Visibility</strong>
 * 
 * <ul>
 * 	<li><a href="API_ListActivityTypes.html" title="ListActivities">ListActivityTypes</a></li>
 * 	<li><a href="API_DescribeActivityType.html" title=
 * 		"DescribeActivityType">DescribeActivity</a></li>
 * </ul>
 * 
 * <strong>Workflow Visibility</strong>
 * 
 * <ul>
 * 	<li><a href="API_ListWorkflowTypes.html" title="ListWorkflowTypes">ListWorkflowTypes</a></li>
 * 	<li><a href="API_DescribeWorkflowType.html" title=
 * 		"DescribeWorkflowType">DescribeWorkflowType</a></li>
 * </ul>
 * 
 * <strong>Workflow Execution Visibility</strong>
 * 
 * <ul>
 * 	<li><a href="API_DescribeWorkflowExecution.html" title=
 * 		"DescribeWorkflowExecution">DescribeWorkflowExecution</a></li>
 * 	<li><a href="API_ListOpenWorkflowExecutions.html" title=
 * 		"ListOpenWorkflowExecutions">ListOpenWorkflowExecutions</a></li>
 * 	<li><a href="API_ListClosedWorkflowExecutions.html" title=
 * 		"ListClosedWorkflowExecutions">ListClosedWorkflowExecutions</a></li>
 * 	<li><a href="API_CountOpenWorkflowExecutions.html" title=
 * 		"CountOpenWorkflowExecutions">CountOpenWorkflowExecutions</a></li>
 * 	<li><a href="API_CountClosedWorkflowExecutions.html" title=
 * 		"CountClosedWorkflowExecutions">CountClosedWorkflowExecutions</a></li>
 * 	<li><a href="API_GetWorkflowExecutionHistory.html" title=
 * 		"GetWorkflowExecutionHistory">GetWorkflowExecutionHistory</a></li>
 * </ul>
 * 
 * <strong>Domain Visibility</strong>
 * 
 * <ul>
 * 	<li><a href="API_ListDomains.html" title="ListDomains">ListDomains</a></li>
 * 	<li><a href="API_DescribeDomain.html" title="DescribeDomain">DescribeDomain</a></li>
 * </ul>
 * 
 * <strong>Task List Visibility</strong>
 * 
 * <ul>
 * 	<li><a href="API_CountPendingActivityTasks.html" title=
 * 		"CountPendingActivityTasks">CountPendingActivityTasks</a></li>
 * 	<li><a href="API_CountPendingDecisionTasks.html" title=
 * 		"CountPendingDecisionTasks">CountPendingDecisionTasks</a></li>
 * </ul>
 *
 * @version 2012.05.31
 * @license See the included NOTICE.md file for complete information.
 * @copyright See the included NOTICE.md file for complete information.
 * @link http://aws.amazon.com/simpleworkflow/ Amazon Simple Workflow
 * @link http://aws.amazon.com/simpleworkflow/documentation/ Amazon Simple Workflow documentation
 */
class AmazonSWF extends CFRuntime
{
	/*%******************************************************************************************%*/
	// CLASS CONSTANTS

	/**
	 * Specify the queue URL for the United States East (Northern Virginia) Region.
	 */
	const REGION_US_E1 = 'swf.us-east-1.amazonaws.com';

	/**
	 * Specify the queue URL for the United States East (Northern Virginia) Region.
	 */
	const REGION_VIRGINIA = self::REGION_US_E1;

	/**
	 * Default service endpoint.
	 */
	const DEFAULT_URL = self::REGION_US_E1;


	/*%******************************************************************************************%*/
	// STATUS CONSTANTS

	/**
	 * Status: Registered
	 */
	const STATUS_REGISTERED = 'REGISTERED';

	/**
	 * Status: Deprecated
	 */
	const STATUS_DEPRECATED = 'DEPRECATED';


	/*%******************************************************************************************%*/
	// POLICY CONSTANTS

	/**
	 * Policy: Terminate
	 */
	const POLICY_TERMINATE = 'TERMINATE';

	/**
	 * Policy: Request Cancel
	 */
	const POLICY_REQUEST_CANCEL = 'REQUEST_CANCEL';

	/**
	 * Policy: Abandon
	 */
	const POLICY_ABANDON = 'ABANDON';


	/*%******************************************************************************************%*/
	// CONSTRUCTOR

	/**
	 * Constructs a new instance of <AmazonSWF>.
	 *
	 * @param array $options (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>certificate_authority</code> - <code>boolean</code> - Optional - Determines which Cerificate Authority file to use. A value of boolean <code>false</code> will use the Certificate Authority file available on the system. A value of boolean <code>true</code> will use the Certificate Authority provided by the SDK. Passing a file system path to a Certificate Authority file (chmodded to <code>0755</code>) will use that. Leave this set to <code>false</code> if you're not sure.</li>
	 * 	<li><code>credentials</code> - <code>string</code> - Optional - The name of the credential set to use for authentication.</li>
	 * 	<li><code>default_cache_config</code> - <code>string</code> - Optional - This option allows a preferred storage type to be configured for long-term caching. This can be changed later using the <set_cache_config()> method. Valid values are: <code>apc</code>, <code>xcache</code>, or a file system path such as <code>./cache</code> or <code>/tmp/cache/</code>.</li>
	 * 	<li><code>key</code> - <code>string</code> - Optional - Your AWS key, or a session key. If blank, the default credential set will be used.</li>
	 * 	<li><code>secret</code> - <code>string</code> - Optional - Your AWS secret key, or a session secret key. If blank, the default credential set will be used.</li>
	 * 	<li><code>token</code> - <code>string</code> - Optional - An AWS session token.</li></ul>
	 * @return void
	 */
	public function __construct(array $options = array())
	{
		$this->api_version = '2012-01-25';
		$this->hostname = self::DEFAULT_URL;
		$this->auth_class = 'AuthV3JSON';
		$this->operation_prefix = "x-amz-target:SimpleWorkflowService.";

		return parent::__construct($options);
	}


	/*%******************************************************************************************%*/
	// SETTERS

	/**
	 * This allows you to explicitly sets the region for the service to use.
	 *
	 * @param string $region (Required) The region to explicitly set. Available options are <REGION_US_E1>.
	 * @return $this A reference to the current instance.
	 */
	public function set_region($region)
	{
		// @codeCoverageIgnoreStart
		$this->set_hostname($region);
		return $this;
		// @codeCoverageIgnoreEnd
	}


	/*%******************************************************************************************%*/
	// SERVICE METHODS

	/**
	 * Returns the number of closed workflow executions within the given domain that meet the
	 * specified filtering criteria.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain containing the workflow executions to count.</li>
	 * 	<li><code>startTimeFilter</code> - <code>array</code> - Optional - If specified, only workflow executions that meet the start time criteria of the filter are counted. <p class="note"> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> <ul>
	 * 		<li><code>oldestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 		<li><code>latestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 	</ul></li>
	 * 	<li><code>closeTimeFilter</code> - <code>array</code> - Optional - If specified, only workflow executions that meet the close time criteria of the filter are counted. <p class="note"> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> <ul>
	 * 		<li><code>oldestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 		<li><code>latestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 	</ul></li>
	 * 	<li><code>executionFilter</code> - <code>array</code> - Optional - If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>workflowId</code> - <code>string</code> - Required - The workflowId to pass of match the criteria of this filter.</li>
	 * 	</ul></li>
	 * 	<li><code>typeFilter</code> - <code>array</code> - Optional - If specified, indicates the type of the workflow executions to be counted. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - Name of the workflow type. This field is required.</li>
	 * 		<li><code>version</code> - <code>string</code> - Optional - Version of the workflow type.</li>
	 * 	</ul></li>
	 * 	<li><code>tagFilter</code> - <code>array</code> - Optional - If specified, only executions that have a tag that matches the filter are counted. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>tag</code> - <code>string</code> - Required - Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.</li>
	 * 	</ul></li>
	 * 	<li><code>closeStatusFilter</code> - <code>array</code> - Optional - If specified, only workflow executions that match this close status are counted. This filter has an affect only if <code>executionStatus</code> is specified as <code>CLOSED</code>. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>status</code> - <code>string</code> - 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: <code>COMPLETED</code>, <code>FAILED</code>, <code>CANCELED</code>, <code>TERMINATED</code>, <code>CONTINUED_AS_NEW</code>, <code>TIMED_OUT</code>]</li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function count_closed_workflow_executions($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('CountClosedWorkflowExecutions', $opt);
	}

	/**
	 * Returns the number of open workflow executions within the given domain that meet the specified
	 * filtering criteria.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain containing the workflow executions to count.</li>
	 * 	<li><code>startTimeFilter</code> - <code>array</code> - Required - Specifies the start time criteria that workflow executions must meet in order to be counted. <ul>
	 * 		<li><code>oldestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 		<li><code>latestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 	</ul></li>
	 * 	<li><code>typeFilter</code> - <code>array</code> - Optional - Specifies the type of the workflow executions to be counted. <p class="note"> <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - Name of the workflow type. This field is required.</li>
	 * 		<li><code>version</code> - <code>string</code> - Optional - Version of the workflow type.</li>
	 * 	</ul></li>
	 * 	<li><code>tagFilter</code> - <code>array</code> - Optional - If specified, only executions that have a tag that matches the filter are counted. <p class="note"> <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>tag</code> - <code>string</code> - Required - Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.</li>
	 * 	</ul></li>
	 * 	<li><code>executionFilter</code> - <code>array</code> - Optional - If specified, only workflow executions matching the <code>WorkflowId</code> in the filter are counted. <p class="note"> <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>workflowId</code> - <code>string</code> - Required - The workflowId to pass of match the criteria of this filter.</li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function count_open_workflow_executions($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('CountOpenWorkflowExecutions', $opt);
	}

	/**
	 * Returns the estimated number of activity tasks in the specified task list. The count returned
	 * is an approximation and is not guaranteed to be exact. If you specify a task list that no
	 * activity task was ever scheduled in then 0 will be returned.
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain that contains the task list.</li>
	 * 	<li><code>taskList</code> - <code>array</code> - Required - The name of the task list. <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - The name of the task list.</li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function count_pending_activity_tasks($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('CountPendingActivityTasks', $opt);
	}

	/**
	 * Returns the estimated number of decision tasks in the specified task list. The count returned
	 * is an approximation and is not guaranteed to be exact. If you specify a task list that no
	 * decision task was ever scheduled in then 0 will be returned.
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain that contains the task list.</li>
	 * 	<li><code>taskList</code> - <code>array</code> - Required - The name of the task list. <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - The name of the task list.</li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function count_pending_decision_tasks($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('CountPendingDecisionTasks', $opt);
	}

	/**
	 * Deprecates the specified <em>activity type</em>. 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 will continue to run.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain in which the activity type is registered.</li>
	 * 	<li><code>activityType</code> - <code>array</code> - Required - The activity type to deprecate. <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - The name of this activity. <p class="note">The combination of activity type name and version must be unique within a domain.</p></li>
	 * 		<li><code>version</code> - <code>string</code> - Required - The version of this activity. <p class="note">The combination of activity type name and version must be unique with in a domain.</p></li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function deprecate_activity_type($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DeprecateActivityType', $opt);
	}

	/**
	 * 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 will continue to run.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>name</code> - <code>string</code> - Required - The name of the domain to deprecate.</li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function deprecate_domain($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DeprecateDomain', $opt);
	}

	/**
	 * Deprecates the specified <em>workflow type</em>. After a workflow type has been deprecated, you
	 * cannot create new executions of that type. Executions that were started before the type was
	 * deprecated will continue to run. A deprecated workflow type may still be used when calling
	 * visibility actions.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain in which the workflow type is registered.</li>
	 * 	<li><code>workflowType</code> - <code>array</code> - Required - The workflow type to deprecate. <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - The name of the workflow type. This field is required. <p class="note">The combination of workflow type name and version must be unique with in a domain.</p></li>
	 * 		<li><code>version</code> - <code>string</code> - Required - The version of the workflow type. This field is required. <p class="note">The combination of workflow type name and version must be unique with in a domain.</p></li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function deprecate_workflow_type($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DeprecateWorkflowType', $opt);
	}

	/**
	 * Returns information about the specified activity type. This includes configuration settings
	 * provided at registration time as well as other general information about the type.
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain in which the activity type is registered.</li>
	 * 	<li><code>activityType</code> - <code>array</code> - Required - The activity type to describe. <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - The name of this activity. <p class="note">The combination of activity type name and version must be unique within a domain.</p></li>
	 * 		<li><code>version</code> - <code>string</code> - Required - The version of this activity. <p class="note">The combination of activity type name and version must be unique with in a domain.</p></li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function describe_activity_type($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DescribeActivityType', $opt);
	}

	/**
	 * Returns information about the specified domain including description and status.
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>name</code> - <code>string</code> - Required - The name of the domain to describe.</li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function describe_domain($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DescribeDomain', $opt);
	}

	/**
	 * Returns information about the specified workflow execution including its type and some
	 * statistics.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain containing the workflow execution.</li>
	 * 	<li><code>execution</code> - <code>array</code> - Required - The workflow execution to describe. <ul>
	 * 		<li><code>workflowId</code> - <code>string</code> - Required - The user defined identifier associated with the workflow execution.</li>
	 * 		<li><code>runId</code> - <code>string</code> - Required - A system generated unique identifier for the workflow execution.</li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function describe_workflow_execution($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DescribeWorkflowExecution', $opt);
	}

	/**
	 * Returns information about the specified <em>workflow type</em>. This includes configuration
	 * settings specified when the type was registered and other information such as creation date,
	 * current status, etc.
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain in which this workflow type is registered.</li>
	 * 	<li><code>workflowType</code> - <code>array</code> - Required - The workflow type to describe. <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - The name of the workflow type. This field is required. <p class="note">The combination of workflow type name and version must be unique with in a domain.</p></li>
	 * 		<li><code>version</code> - <code>string</code> - Required - The version of the workflow type. This field is required. <p class="note">The combination of workflow type name and version must be unique with in a domain.</p></li>
	 * 	</ul></li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function describe_workflow_type($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('DescribeWorkflowType', $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 <code>nextPageToken</code>
	 * returned by the initial call.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain containing the workflow execution.</li>
	 * 	<li><code>execution</code> - <code>array</code> - Required - Specifies the workflow execution for which to return the history. <ul>
	 * 		<li><code>workflowId</code> - <code>string</code> - Required - The user defined identifier associated with the workflow execution.</li>
	 * 		<li><code>runId</code> - <code>string</code> - Required - A system generated unique identifier for the workflow execution.</li>
	 * 	</ul></li>
	 * 	<li><code>nextPageToken</code> - <code>string</code> - Optional - If a <code>NextPageToken</code> 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.</li>
	 * 	<li><code>maximumPageSize</code> - <code>integer</code> - Optional - Specifies the maximum number of history events returned in one page. The next page in the result is identified by the <code>NextPageToken</code> returned. By default 100 history events are returned in a page but the caller can override this value to a page size <em>smaller</em> 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, a smaller page size is returned.</li>
	 * 	<li><code>reverseOrder</code> - <code>boolean</code> - Optional - When set to <code>true</code>, returns the events in reverse order. By default the results are returned in ascending order of the <code>eventTimeStamp</code> of the events.</li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function get_workflow_execution_history($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('GetWorkflowExecutionHistory', $opt);
	}

	/**
	 * 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 <code>nextPageToken</code> returned by the
	 * initial call.
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain in which the activity types have been registered.</li>
	 * 	<li><code>name</code> - <code>string</code> - Optional - If specified, only lists the activity types that have this name.</li>
	 * 	<li><code>registrationStatus</code> - <code>string</code> - Required - Specifies the registration status of the activity types to list. [Allowed values: <code>REGISTERED</code>, <code>DEPRECATED</code>]</li>
	 * 	<li><code>nextPageToken</code> - <code>string</code> - Optional - If on a previous call to this method a <code>NextResultToken</code> was returned, the results have more than one page. To get the next page of results, repeat the call with the <code>nextPageToken</code> and keep all other arguments unchanged.</li>
	 * 	<li><code>maximumPageSize</code> - <code>integer</code> - 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 <em>smaller</em> than the default. You cannot specify a page size greater than 100. Note that the number of types may be less than the maxiumum page size, in which case, a smaller page size is returned.</li>
	 * 	<li><code>reverseOrder</code> - <code>boolean</code> - Optional - When set to <code>true</code>, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the <code>name</code> of the activity types.</li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function list_activity_types($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('ListActivityTypes', $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.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>domain</code> - <code>string</code> - Required - The name of the domain that contains the workflow executions to list.</li>
	 * 	<li><code>startTimeFilter</code> - <code>array</code> - 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. <p class="note"> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> <ul>
	 * 		<li><code>oldestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 		<li><code>latestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 	</ul></li>
	 * 	<li><code>closeTimeFilter</code> - <code>array</code> - 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. <p class="note"> <code>startTimeFilter</code> and <code>closeTimeFilter</code> are mutually exclusive. You must specify one of these in a request but not both.</p> <ul>
	 * 		<li><code>oldestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 		<li><code>latestDate</code> - <code>string</code> - 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 <php:strtotime()>.</li>
	 * 	</ul></li>
	 * 	<li><code>executionFilter</code> - <code>array</code> - Optional - If specified, only workflow executions matching the workflow id specified in the filter are returned. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>workflowId</code> - <code>string</code> - Required - The workflowId to pass of match the criteria of this filter.</li>
	 * 	</ul></li>
	 * 	<li><code>closeStatusFilter</code> - <code>array</code> - Optional - If specified, only workflow executions that match this <em>close status</em> are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>status</code> - <code>string</code> - 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: <code>COMPLETED</code>, <code>FAILED</code>, <code>CANCELED</code>, <code>TERMINATED</code>, <code>CONTINUED_AS_NEW</code>, <code>TIMED_OUT</code>]</li>
	 * 	</ul></li>
	 * 	<li><code>typeFilter</code> - <code>array</code> - Optional - If specified, only executions of the type specified in the filter are returned. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>name</code> - <code>string</code> - Required - Name of the workflow type. This field is required.</li>
	 * 		<li><code>version</code> - <code>string</code> - Optional - Version of the workflow type.</li>
	 * 	</ul></li>
	 * 	<li><code>tagFilter</code> - <code>array</code> - Optional - If specified, only executions that have the matching tag are listed. <p class="note"> <code>closeStatusFilter</code>, <code>executionFilter</code>, <code>typeFilter</code> and <code>tagFilter</code> are mutually exclusive. You can specify at most one of these in a request.</p> <ul>
	 * 		<li><code>tag</code> - <code>string</code> - Required - Specifies the tag that must be associated with the execution for it to meet the filter criteria. This field is required.</li>
	 * 	</ul></li>
	 * 	<li><code>nextPageToken</code> - <code>string</code> - Optional - If on a previous call to this method a <code>NextPageToken</code> 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.</li>
	 * 	<li><code>maximumPageSize</code> - <code>integer</code> - 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 <em>smaller</em> 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, a smaller page size is returned.</li>
	 * 	<li><code>reverseOrder</code> - <code>boolean</code> - Optional - When set to <code>true</code>, 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.</li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function list_closed_workflow_executions($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('ListClosedWorkflowExecutions', $opt);
	}

	/**
	 * 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.
	 * 
	 * <p class="note">
	 * This operation is eventually consistent. The results are best effort and may not exactly
	 * reflect recent updates and changes.
	 * </p>
	 *
	 * @param array $opt (Optional) An associative array of parameters that can have the following keys: <ul>
	 * 	<li><code>nextPageToken</code> - <code>string</code> - Optional - If on a previous call to this method a <code>NextPageToken</code> was returned, the result has more than one page. To get the next page of results, repeat the call with the returned token and all other arguments unchanged.</li>
	 * 	<li><code>registrationStatus</code> - <code>string</code> - Required - Specifies the registration status of the domains to list. [Allowed values: <code>REGISTERED</code>, <code>DEPRECATED</code>]</li>
	 * 	<li><code>maximumPageSize</code> - <code>integer</code> - 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 <em>smaller</em> than the default. You cannot specify a page size greater than 100. Note that the number of domains may be less than the maxiumum page size, in which case, a smaller page size is returned.</li>
	 * 	<li><code>reverseOrder</code> - <code>boolean</code> - Optional - When set to <code>true</code>, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the <code>name</code> of the domains.</li>
	 * 	<li><code>curlopts</code> - <code>array</code> - Optional - A set of values to pass directly into <code>curl_setopt()</code>, where the key is a pre-defined <code>CURLOPT_*</code> constant.</li>
	 * 	<li><code>returnCurlHandle</code> - <code>boolean</code> - 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.</li></ul>
	 * @return CFResponse A <CFResponse> object containing a parsed HTTP response.
	 */
	public function list_domains($opt = null)
	{
		if (!$opt) $opt = array();
		
		return $this->authenticate('ListDomains', $opt);
	}

	/**
	 * 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 nextPa…

Large files files are truncated, but you can click here to view the full file