/* * Copyright 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. */ /* * Do not modify this file. This file is generated from the swf-2012-01-25.normal.json service model. */ using System; using System.Collections.Generic; using Amazon.Runtime; using Amazon.SimpleWorkflow.Model; namespace Amazon.SimpleWorkflow { /// /// Interface for accessing SimpleWorkflow /// /// Amazon Simple Workflow Service /// /// The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications /// that use Amazon's cloud to coordinate work across distributed components. In Amazon /// SWF, a task represents a logical unit of work that is performed by a component /// of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, /// scheduling, and concurrency in accordance with the logical flow of the application. /// /// /// /// Amazon SWF gives you full control over implementing tasks and coordinating them without /// worrying about underlying complexities such as tracking their progress and maintaining /// their state. /// /// /// /// This documentation serves as reference only. For a broader overview of the Amazon /// SWF programming model, see the Amazon /// SWF Developer Guide . /// /// public partial interface IAmazonSimpleWorkflow : IAmazonService, IDisposable { #if BCL45 || AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// ISimpleWorkflowPaginatorFactory Paginators { get; } #endif #region CountClosedWorkflowExecutions /// /// Returns the number of closed workflow executions within the given domain that meet /// the specified filtering criteria. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the CountClosedWorkflowExecutions service method. /// /// The response from the CountClosedWorkflowExecutions service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for CountClosedWorkflowExecutions Operation CountClosedWorkflowExecutionsResponse CountClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest request); /// /// Initiates the asynchronous execution of the CountClosedWorkflowExecutions operation. /// /// /// Container for the necessary parameters to execute the CountClosedWorkflowExecutions operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCountClosedWorkflowExecutions /// operation. /// REST API Reference for CountClosedWorkflowExecutions Operation IAsyncResult BeginCountClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CountClosedWorkflowExecutions operation. /// /// /// The IAsyncResult returned by the call to BeginCountClosedWorkflowExecutions. /// /// Returns a CountClosedWorkflowExecutionsResult from SimpleWorkflow. /// REST API Reference for CountClosedWorkflowExecutions Operation CountClosedWorkflowExecutionsResponse EndCountClosedWorkflowExecutions(IAsyncResult asyncResult); #endregion #region CountOpenWorkflowExecutions /// /// Returns the number of open workflow executions within the given domain that meet the /// specified filtering criteria. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the CountOpenWorkflowExecutions service method. /// /// The response from the CountOpenWorkflowExecutions service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for CountOpenWorkflowExecutions Operation CountOpenWorkflowExecutionsResponse CountOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest request); /// /// Initiates the asynchronous execution of the CountOpenWorkflowExecutions operation. /// /// /// Container for the necessary parameters to execute the CountOpenWorkflowExecutions operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCountOpenWorkflowExecutions /// operation. /// REST API Reference for CountOpenWorkflowExecutions Operation IAsyncResult BeginCountOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CountOpenWorkflowExecutions operation. /// /// /// The IAsyncResult returned by the call to BeginCountOpenWorkflowExecutions. /// /// Returns a CountOpenWorkflowExecutionsResult from SimpleWorkflow. /// REST API Reference for CountOpenWorkflowExecutions Operation CountOpenWorkflowExecutionsResponse EndCountOpenWorkflowExecutions(IAsyncResult asyncResult); #endregion #region CountPendingActivityTasks /// /// Returns the estimated number of activity tasks in the specified task list. The count /// returned is an approximation and isn't guaranteed to be exact. If you specify a task /// list that no activity task was ever scheduled in then 0 is returned. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the CountPendingActivityTasks service method. /// /// The response from the CountPendingActivityTasks service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for CountPendingActivityTasks Operation CountPendingActivityTasksResponse CountPendingActivityTasks(CountPendingActivityTasksRequest request); /// /// Initiates the asynchronous execution of the CountPendingActivityTasks operation. /// /// /// Container for the necessary parameters to execute the CountPendingActivityTasks operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCountPendingActivityTasks /// operation. /// REST API Reference for CountPendingActivityTasks Operation IAsyncResult BeginCountPendingActivityTasks(CountPendingActivityTasksRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CountPendingActivityTasks operation. /// /// /// The IAsyncResult returned by the call to BeginCountPendingActivityTasks. /// /// Returns a CountPendingActivityTasksResult from SimpleWorkflow. /// REST API Reference for CountPendingActivityTasks Operation CountPendingActivityTasksResponse EndCountPendingActivityTasks(IAsyncResult asyncResult); #endregion #region CountPendingDecisionTasks /// /// Returns the estimated number of decision tasks in the specified task list. The count /// returned is an approximation and isn't guaranteed to be exact. If you specify a task /// list that no decision task was ever scheduled in then 0 is returned. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the CountPendingDecisionTasks service method. /// /// The response from the CountPendingDecisionTasks service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for CountPendingDecisionTasks Operation CountPendingDecisionTasksResponse CountPendingDecisionTasks(CountPendingDecisionTasksRequest request); /// /// Initiates the asynchronous execution of the CountPendingDecisionTasks operation. /// /// /// Container for the necessary parameters to execute the CountPendingDecisionTasks operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndCountPendingDecisionTasks /// operation. /// REST API Reference for CountPendingDecisionTasks Operation IAsyncResult BeginCountPendingDecisionTasks(CountPendingDecisionTasksRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the CountPendingDecisionTasks operation. /// /// /// The IAsyncResult returned by the call to BeginCountPendingDecisionTasks. /// /// Returns a CountPendingDecisionTasksResult from SimpleWorkflow. /// REST API Reference for CountPendingDecisionTasks Operation CountPendingDecisionTasksResponse EndCountPendingDecisionTasks(IAsyncResult asyncResult); #endregion #region DeprecateActivityType /// /// Deprecates the specified activity type. 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 continue to run. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DeprecateActivityType service method. /// /// The response from the DeprecateActivityType service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned when the specified activity or workflow type was already deprecated. /// /// /// 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. /// /// REST API Reference for DeprecateActivityType Operation DeprecateActivityTypeResponse DeprecateActivityType(DeprecateActivityTypeRequest request); /// /// Initiates the asynchronous execution of the DeprecateActivityType operation. /// /// /// Container for the necessary parameters to execute the DeprecateActivityType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeprecateActivityType /// operation. /// REST API Reference for DeprecateActivityType Operation IAsyncResult BeginDeprecateActivityType(DeprecateActivityTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeprecateActivityType operation. /// /// /// The IAsyncResult returned by the call to BeginDeprecateActivityType. /// /// Returns a DeprecateActivityTypeResult from SimpleWorkflow. /// REST API Reference for DeprecateActivityType Operation DeprecateActivityTypeResponse EndDeprecateActivityType(IAsyncResult asyncResult); #endregion #region DeprecateDomain /// /// 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 continues to run. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DeprecateDomain service method. /// /// The response from the DeprecateDomain service method, as returned by SimpleWorkflow. /// /// Returned when the specified domain has been deprecated. /// /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for DeprecateDomain Operation DeprecateDomainResponse DeprecateDomain(DeprecateDomainRequest request); /// /// Initiates the asynchronous execution of the DeprecateDomain operation. /// /// /// Container for the necessary parameters to execute the DeprecateDomain operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeprecateDomain /// operation. /// REST API Reference for DeprecateDomain Operation IAsyncResult BeginDeprecateDomain(DeprecateDomainRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeprecateDomain operation. /// /// /// The IAsyncResult returned by the call to BeginDeprecateDomain. /// /// Returns a DeprecateDomainResult from SimpleWorkflow. /// REST API Reference for DeprecateDomain Operation DeprecateDomainResponse EndDeprecateDomain(IAsyncResult asyncResult); #endregion #region DeprecateWorkflowType /// /// Deprecates the specified workflow type. After a workflow type has been deprecated, /// you cannot create new executions of that type. Executions that were started before /// the type was deprecated continues to run. A deprecated workflow type may still be /// used when calling visibility actions. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DeprecateWorkflowType service method. /// /// The response from the DeprecateWorkflowType service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned when the specified activity or workflow type was already deprecated. /// /// /// 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. /// /// REST API Reference for DeprecateWorkflowType Operation DeprecateWorkflowTypeResponse DeprecateWorkflowType(DeprecateWorkflowTypeRequest request); /// /// Initiates the asynchronous execution of the DeprecateWorkflowType operation. /// /// /// Container for the necessary parameters to execute the DeprecateWorkflowType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDeprecateWorkflowType /// operation. /// REST API Reference for DeprecateWorkflowType Operation IAsyncResult BeginDeprecateWorkflowType(DeprecateWorkflowTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DeprecateWorkflowType operation. /// /// /// The IAsyncResult returned by the call to BeginDeprecateWorkflowType. /// /// Returns a DeprecateWorkflowTypeResult from SimpleWorkflow. /// REST API Reference for DeprecateWorkflowType Operation DeprecateWorkflowTypeResponse EndDeprecateWorkflowType(IAsyncResult asyncResult); #endregion #region DescribeActivityType /// /// Returns information about the specified activity type. This includes configuration /// settings provided when the type was registered and other general information about /// the type. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeActivityType service method. /// /// The response from the DescribeActivityType service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for DescribeActivityType Operation DescribeActivityTypeResponse DescribeActivityType(DescribeActivityTypeRequest request); /// /// Initiates the asynchronous execution of the DescribeActivityType operation. /// /// /// Container for the necessary parameters to execute the DescribeActivityType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeActivityType /// operation. /// REST API Reference for DescribeActivityType Operation IAsyncResult BeginDescribeActivityType(DescribeActivityTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeActivityType operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeActivityType. /// /// Returns a DescribeActivityTypeResult from SimpleWorkflow. /// REST API Reference for DescribeActivityType Operation DescribeActivityTypeResponse EndDescribeActivityType(IAsyncResult asyncResult); #endregion #region DescribeDomain /// /// Returns information about the specified domain, including description and status. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeDomain service method. /// /// The response from the DescribeDomain service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for DescribeDomain Operation DescribeDomainResponse DescribeDomain(DescribeDomainRequest request); /// /// Initiates the asynchronous execution of the DescribeDomain operation. /// /// /// Container for the necessary parameters to execute the DescribeDomain operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeDomain /// operation. /// REST API Reference for DescribeDomain Operation IAsyncResult BeginDescribeDomain(DescribeDomainRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeDomain operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeDomain. /// /// Returns a DescribeDomainResult from SimpleWorkflow. /// REST API Reference for DescribeDomain Operation DescribeDomainResponse EndDescribeDomain(IAsyncResult asyncResult); #endregion #region DescribeWorkflowExecution /// /// Returns information about the specified workflow execution including its type and /// some statistics. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeWorkflowExecution service method. /// /// The response from the DescribeWorkflowExecution service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for DescribeWorkflowExecution Operation DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest request); /// /// Initiates the asynchronous execution of the DescribeWorkflowExecution operation. /// /// /// Container for the necessary parameters to execute the DescribeWorkflowExecution operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeWorkflowExecution /// operation. /// REST API Reference for DescribeWorkflowExecution Operation IAsyncResult BeginDescribeWorkflowExecution(DescribeWorkflowExecutionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeWorkflowExecution operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeWorkflowExecution. /// /// Returns a DescribeWorkflowExecutionResult from SimpleWorkflow. /// REST API Reference for DescribeWorkflowExecution Operation DescribeWorkflowExecutionResponse EndDescribeWorkflowExecution(IAsyncResult asyncResult); #endregion #region DescribeWorkflowType /// /// Returns information about the specified workflow type. This includes configuration /// settings specified when the type was registered and other information such as creation /// date, current status, etc. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeWorkflowType service method. /// /// The response from the DescribeWorkflowType service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for DescribeWorkflowType Operation DescribeWorkflowTypeResponse DescribeWorkflowType(DescribeWorkflowTypeRequest request); /// /// Initiates the asynchronous execution of the DescribeWorkflowType operation. /// /// /// Container for the necessary parameters to execute the DescribeWorkflowType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeWorkflowType /// operation. /// REST API Reference for DescribeWorkflowType Operation IAsyncResult BeginDescribeWorkflowType(DescribeWorkflowTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the DescribeWorkflowType operation. /// /// /// The IAsyncResult returned by the call to BeginDescribeWorkflowType. /// /// Returns a DescribeWorkflowTypeResult from SimpleWorkflow. /// REST API Reference for DescribeWorkflowType Operation DescribeWorkflowTypeResponse EndDescribeWorkflowType(IAsyncResult asyncResult); #endregion #region GetWorkflowExecutionHistory /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the GetWorkflowExecutionHistory service method. /// /// The response from the GetWorkflowExecutionHistory service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for GetWorkflowExecutionHistory Operation GetWorkflowExecutionHistoryResponse GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest request); /// /// Initiates the asynchronous execution of the GetWorkflowExecutionHistory operation. /// /// /// Container for the necessary parameters to execute the GetWorkflowExecutionHistory operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndGetWorkflowExecutionHistory /// operation. /// REST API Reference for GetWorkflowExecutionHistory Operation IAsyncResult BeginGetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the GetWorkflowExecutionHistory operation. /// /// /// The IAsyncResult returned by the call to BeginGetWorkflowExecutionHistory. /// /// Returns a GetWorkflowExecutionHistoryResult from SimpleWorkflow. /// REST API Reference for GetWorkflowExecutionHistory Operation GetWorkflowExecutionHistoryResponse EndGetWorkflowExecutionHistory(IAsyncResult asyncResult); #endregion #region ListActivityTypes /// /// 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 nextPageToken /// returned by the initial call. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the ListActivityTypes service method. /// /// The response from the ListActivityTypes service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for ListActivityTypes Operation ListActivityTypesResponse ListActivityTypes(ListActivityTypesRequest request); /// /// Initiates the asynchronous execution of the ListActivityTypes operation. /// /// /// Container for the necessary parameters to execute the ListActivityTypes operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListActivityTypes /// operation. /// REST API Reference for ListActivityTypes Operation IAsyncResult BeginListActivityTypes(ListActivityTypesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListActivityTypes operation. /// /// /// The IAsyncResult returned by the call to BeginListActivityTypes. /// /// Returns a ListActivityTypesResult from SimpleWorkflow. /// REST API Reference for ListActivityTypes Operation ListActivityTypesResponse EndListActivityTypes(IAsyncResult asyncResult); #endregion #region ListClosedWorkflowExecutions /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the ListClosedWorkflowExecutions service method. /// /// The response from the ListClosedWorkflowExecutions service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for ListClosedWorkflowExecutions Operation ListClosedWorkflowExecutionsResponse ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest request); /// /// Initiates the asynchronous execution of the ListClosedWorkflowExecutions operation. /// /// /// Container for the necessary parameters to execute the ListClosedWorkflowExecutions operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListClosedWorkflowExecutions /// operation. /// REST API Reference for ListClosedWorkflowExecutions Operation IAsyncResult BeginListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListClosedWorkflowExecutions operation. /// /// /// The IAsyncResult returned by the call to BeginListClosedWorkflowExecutions. /// /// Returns a ListClosedWorkflowExecutionsResult from SimpleWorkflow. /// REST API Reference for ListClosedWorkflowExecutions Operation ListClosedWorkflowExecutionsResponse EndListClosedWorkflowExecutions(IAsyncResult asyncResult); #endregion #region ListDomains /// /// 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. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the ListDomains service method. /// /// The response from the ListDomains service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// REST API Reference for ListDomains Operation ListDomainsResponse ListDomains(ListDomainsRequest request); /// /// Initiates the asynchronous execution of the ListDomains operation. /// /// /// Container for the necessary parameters to execute the ListDomains operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListDomains /// operation. /// REST API Reference for ListDomains Operation IAsyncResult BeginListDomains(ListDomainsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListDomains operation. /// /// /// The IAsyncResult returned by the call to BeginListDomains. /// /// Returns a ListDomainsResult from SimpleWorkflow. /// REST API Reference for ListDomains Operation ListDomainsResponse EndListDomains(IAsyncResult asyncResult); #endregion #region ListOpenWorkflowExecutions /// /// 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 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the ListOpenWorkflowExecutions service method. /// /// The response from the ListOpenWorkflowExecutions service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for ListOpenWorkflowExecutions Operation ListOpenWorkflowExecutionsResponse ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest request); /// /// Initiates the asynchronous execution of the ListOpenWorkflowExecutions operation. /// /// /// Container for the necessary parameters to execute the ListOpenWorkflowExecutions operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListOpenWorkflowExecutions /// operation. /// REST API Reference for ListOpenWorkflowExecutions Operation IAsyncResult BeginListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListOpenWorkflowExecutions operation. /// /// /// The IAsyncResult returned by the call to BeginListOpenWorkflowExecutions. /// /// Returns a ListOpenWorkflowExecutionsResult from SimpleWorkflow. /// REST API Reference for ListOpenWorkflowExecutions Operation ListOpenWorkflowExecutionsResponse EndListOpenWorkflowExecutions(IAsyncResult asyncResult); #endregion #region ListTagsForResource /// /// List tags for a given domain. /// /// Container for the necessary parameters to execute the ListTagsForResource service method. /// /// The response from the ListTagsForResource service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse ListTagsForResource(ListTagsForResourceRequest request); /// /// Initiates the asynchronous execution of the ListTagsForResource operation. /// /// /// Container for the necessary parameters to execute the ListTagsForResource operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListTagsForResource /// operation. /// REST API Reference for ListTagsForResource Operation IAsyncResult BeginListTagsForResource(ListTagsForResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListTagsForResource operation. /// /// /// The IAsyncResult returned by the call to BeginListTagsForResource. /// /// Returns a ListTagsForResourceResult from SimpleWorkflow. /// REST API Reference for ListTagsForResource Operation ListTagsForResourceResponse EndListTagsForResource(IAsyncResult asyncResult); #endregion #region ListWorkflowTypes /// /// Returns information about workflow types in the specified domain. The results may /// be split into multiple pages that can be retrieved by making the call repeatedly. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the ListWorkflowTypes service method. /// /// The response from the ListWorkflowTypes service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for ListWorkflowTypes Operation ListWorkflowTypesResponse ListWorkflowTypes(ListWorkflowTypesRequest request); /// /// Initiates the asynchronous execution of the ListWorkflowTypes operation. /// /// /// Container for the necessary parameters to execute the ListWorkflowTypes operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndListWorkflowTypes /// operation. /// REST API Reference for ListWorkflowTypes Operation IAsyncResult BeginListWorkflowTypes(ListWorkflowTypesRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the ListWorkflowTypes operation. /// /// /// The IAsyncResult returned by the call to BeginListWorkflowTypes. /// /// Returns a ListWorkflowTypesResult from SimpleWorkflow. /// REST API Reference for ListWorkflowTypes Operation ListWorkflowTypesResponse EndListWorkflowTypes(IAsyncResult asyncResult); #endregion #region PollForActivityTask /// /// Used by workers to get an ActivityTask from the specified activity taskList. /// This initiates a long poll, where the service holds the HTTP connection open and responds /// as soon as a task becomes available. The maximum time the service holds on to the /// request before responding is 60 seconds. If no task is available within 60 seconds, /// the poll returns an empty result. An empty result, in this context, means that an /// ActivityTask is returned, but that the value of taskToken is an empty string. If a /// task is returned, the worker should use its type to identify and process it correctly. /// /// /// /// Workers should set their client side socket timeout to at least 70 seconds (10 seconds /// higher than the maximum time service may hold the poll request). /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the PollForActivityTask service method. /// /// The response from the PollForActivityTask service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for PollForActivityTask Operation PollForActivityTaskResponse PollForActivityTask(PollForActivityTaskRequest request); /// /// Initiates the asynchronous execution of the PollForActivityTask operation. /// /// /// Container for the necessary parameters to execute the PollForActivityTask operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForActivityTask /// operation. /// REST API Reference for PollForActivityTask Operation IAsyncResult BeginPollForActivityTask(PollForActivityTaskRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PollForActivityTask operation. /// /// /// The IAsyncResult returned by the call to BeginPollForActivityTask. /// /// Returns a PollForActivityTaskResult from SimpleWorkflow. /// REST API Reference for PollForActivityTask Operation PollForActivityTaskResponse EndPollForActivityTask(IAsyncResult asyncResult); #endregion #region PollForDecisionTask /// /// Used by deciders to get a DecisionTask from the specified decision taskList. /// A decision task may be returned for any open workflow execution that is using the /// specified task list. The task includes a paginated view of the history of the workflow /// execution. The decider should use the workflow type and the history to determine how /// to properly handle the task. /// /// /// /// This action initiates a long poll, where the service holds the HTTP connection open /// and responds as soon a task becomes available. If no decision task is available in /// the specified task list before the timeout of 60 seconds expires, an empty result /// is returned. An empty result, in this context, means that a DecisionTask is returned, /// but that the value of taskToken is an empty string. /// /// /// /// Deciders should set their client side socket timeout to at least 70 seconds (10 seconds /// higher than the timeout). /// /// /// /// Because the number of workflow history events for a single workflow execution might /// be very large, the result returned might be split up across a number of pages. To /// retrieve subsequent pages, make additional calls to PollForDecisionTask /// using the nextPageToken returned by the initial call. Note that you do /// not call GetWorkflowExecutionHistory with this nextPageToken. /// Instead, call PollForDecisionTask again. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the PollForDecisionTask service method. /// /// The response from the PollForDecisionTask service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for PollForDecisionTask Operation PollForDecisionTaskResponse PollForDecisionTask(PollForDecisionTaskRequest request); /// /// Initiates the asynchronous execution of the PollForDecisionTask operation. /// /// /// Container for the necessary parameters to execute the PollForDecisionTask operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndPollForDecisionTask /// operation. /// REST API Reference for PollForDecisionTask Operation IAsyncResult BeginPollForDecisionTask(PollForDecisionTaskRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the PollForDecisionTask operation. /// /// /// The IAsyncResult returned by the call to BeginPollForDecisionTask. /// /// Returns a PollForDecisionTaskResult from SimpleWorkflow. /// REST API Reference for PollForDecisionTask Operation PollForDecisionTaskResponse EndPollForDecisionTask(IAsyncResult asyncResult); #endregion #region RecordActivityTaskHeartbeat /// /// Used by activity workers to report to the service that the ActivityTask represented /// by the specified taskToken is still making progress. The worker can also /// specify details of the progress, for example percent complete, using the details /// parameter. This action can also be used by the worker as a mechanism to check if cancellation /// is being requested for the activity task. If a cancellation is being attempted for /// the specified task, then the boolean cancelRequested flag returned by /// the service is set to true. /// /// /// /// This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout /// is specified in RegisterActivityType. /// /// /// /// This action doesn't in itself create an event in the workflow execution history. However, /// if the task times out, the workflow execution history contains a ActivityTaskTimedOut /// event that contains the information from the last heartbeat generated by the activity /// worker. /// /// /// /// The taskStartToCloseTimeout of an activity type is the maximum duration /// of an activity task, regardless of the number of RecordActivityTaskHeartbeat /// requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType. /// /// /// /// This operation is only useful for long-lived activities to report liveliness of the /// task and to determine if a cancellation is being attempted. /// /// /// /// If the cancelRequested flag returns true, a cancellation /// is being attempted. If the worker can cancel the activity, it should respond with /// RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RecordActivityTaskHeartbeat service method. /// /// The response from the RecordActivityTaskHeartbeat service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for RecordActivityTaskHeartbeat Operation RecordActivityTaskHeartbeatResponse RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest request); /// /// Initiates the asynchronous execution of the RecordActivityTaskHeartbeat operation. /// /// /// Container for the necessary parameters to execute the RecordActivityTaskHeartbeat operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRecordActivityTaskHeartbeat /// operation. /// REST API Reference for RecordActivityTaskHeartbeat Operation IAsyncResult BeginRecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RecordActivityTaskHeartbeat operation. /// /// /// The IAsyncResult returned by the call to BeginRecordActivityTaskHeartbeat. /// /// Returns a RecordActivityTaskHeartbeatResult from SimpleWorkflow. /// REST API Reference for RecordActivityTaskHeartbeat Operation RecordActivityTaskHeartbeatResponse EndRecordActivityTaskHeartbeat(IAsyncResult asyncResult); #endregion #region RegisterActivityType /// /// Registers a new activity type along with its configuration settings in the /// specified domain. /// /// /// /// A TypeAlreadyExists fault is returned if the type already exists in the /// domain. You cannot change any configuration settings of the type after its registration, /// and it must be registered as a new version. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RegisterActivityType service method. /// /// The response from the RegisterActivityType service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned if the type already exists in the specified domain. You may get this fault /// if you are registering a type that is either already registered or deprecated, or /// if you undeprecate a type that is currently registered. /// /// /// 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. /// /// REST API Reference for RegisterActivityType Operation RegisterActivityTypeResponse RegisterActivityType(RegisterActivityTypeRequest request); /// /// Initiates the asynchronous execution of the RegisterActivityType operation. /// /// /// Container for the necessary parameters to execute the RegisterActivityType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterActivityType /// operation. /// REST API Reference for RegisterActivityType Operation IAsyncResult BeginRegisterActivityType(RegisterActivityTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RegisterActivityType operation. /// /// /// The IAsyncResult returned by the call to BeginRegisterActivityType. /// /// Returns a RegisterActivityTypeResult from SimpleWorkflow. /// REST API Reference for RegisterActivityType Operation RegisterActivityTypeResponse EndRegisterActivityType(IAsyncResult asyncResult); #endregion #region RegisterDomain /// /// Registers a new domain. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RegisterDomain service method. /// /// The response from the RegisterDomain service method, as returned by SimpleWorkflow. /// /// Returned if the domain already exists. You may get this fault if you are registering /// a domain that is either already registered or deprecated, or if you undeprecate a /// domain that is currently registered. /// /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// You've exceeded the number of tags allowed for a domain. /// /// REST API Reference for RegisterDomain Operation RegisterDomainResponse RegisterDomain(RegisterDomainRequest request); /// /// Initiates the asynchronous execution of the RegisterDomain operation. /// /// /// Container for the necessary parameters to execute the RegisterDomain operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterDomain /// operation. /// REST API Reference for RegisterDomain Operation IAsyncResult BeginRegisterDomain(RegisterDomainRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RegisterDomain operation. /// /// /// The IAsyncResult returned by the call to BeginRegisterDomain. /// /// Returns a RegisterDomainResult from SimpleWorkflow. /// REST API Reference for RegisterDomain Operation RegisterDomainResponse EndRegisterDomain(IAsyncResult asyncResult); #endregion #region RegisterWorkflowType /// /// Registers a new workflow type and its configuration settings in the specified /// domain. /// /// /// /// The retention period for the workflow history is set by the RegisterDomain /// action. /// /// /// /// If the type already exists, then a TypeAlreadyExists fault is returned. /// You cannot change the configuration settings of a workflow type once it is registered /// and it must be registered as a new version. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RegisterWorkflowType service method. /// /// The response from the RegisterWorkflowType service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned if the type already exists in the specified domain. You may get this fault /// if you are registering a type that is either already registered or deprecated, or /// if you undeprecate a type that is currently registered. /// /// /// 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. /// /// REST API Reference for RegisterWorkflowType Operation RegisterWorkflowTypeResponse RegisterWorkflowType(RegisterWorkflowTypeRequest request); /// /// Initiates the asynchronous execution of the RegisterWorkflowType operation. /// /// /// Container for the necessary parameters to execute the RegisterWorkflowType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRegisterWorkflowType /// operation. /// REST API Reference for RegisterWorkflowType Operation IAsyncResult BeginRegisterWorkflowType(RegisterWorkflowTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RegisterWorkflowType operation. /// /// /// The IAsyncResult returned by the call to BeginRegisterWorkflowType. /// /// Returns a RegisterWorkflowTypeResult from SimpleWorkflow. /// REST API Reference for RegisterWorkflowType Operation RegisterWorkflowTypeResponse EndRegisterWorkflowType(IAsyncResult asyncResult); #endregion #region RequestCancelWorkflowExecution /// /// Records a WorkflowExecutionCancelRequested event in the currently running /// workflow execution identified by the given domain, workflowId, and runId. This logically /// requests the cancellation of the workflow execution as a whole. It is up to the decider /// to take appropriate actions when it receives an execution history with this event. /// /// /// /// If the runId isn't specified, the WorkflowExecutionCancelRequested event /// is recorded in the history of the current open workflow execution with the specified /// workflowId in the domain. /// /// /// /// Because this action allows the workflow to properly clean up and gracefully close, /// it should be used instead of TerminateWorkflowExecution when possible. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RequestCancelWorkflowExecution service method. /// /// The response from the RequestCancelWorkflowExecution service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for RequestCancelWorkflowExecution Operation RequestCancelWorkflowExecutionResponse RequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest request); /// /// Initiates the asynchronous execution of the RequestCancelWorkflowExecution operation. /// /// /// Container for the necessary parameters to execute the RequestCancelWorkflowExecution operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRequestCancelWorkflowExecution /// operation. /// REST API Reference for RequestCancelWorkflowExecution Operation IAsyncResult BeginRequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RequestCancelWorkflowExecution operation. /// /// /// The IAsyncResult returned by the call to BeginRequestCancelWorkflowExecution. /// /// Returns a RequestCancelWorkflowExecutionResult from SimpleWorkflow. /// REST API Reference for RequestCancelWorkflowExecution Operation RequestCancelWorkflowExecutionResponse EndRequestCancelWorkflowExecution(IAsyncResult asyncResult); #endregion #region RespondActivityTaskCanceled /// /// Used by workers to tell the service that the ActivityTask identified by the /// taskToken was successfully canceled. Additional details /// can be provided using the details argument. /// /// /// /// These details (if provided) appear in the ActivityTaskCanceled /// event added to the workflow history. /// /// /// /// Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat /// request returns true and if the activity can be safely undone or abandoned. /// /// /// /// A task is considered open from the time that it is scheduled until it is closed. Therefore /// a task is reported as open while a worker is processing it. A task is closed after /// it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, /// RespondActivityTaskFailed, or the task has timed /// out. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RespondActivityTaskCanceled service method. /// /// The response from the RespondActivityTaskCanceled service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for RespondActivityTaskCanceled Operation RespondActivityTaskCanceledResponse RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest request); /// /// Initiates the asynchronous execution of the RespondActivityTaskCanceled operation. /// /// /// Container for the necessary parameters to execute the RespondActivityTaskCanceled operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRespondActivityTaskCanceled /// operation. /// REST API Reference for RespondActivityTaskCanceled Operation IAsyncResult BeginRespondActivityTaskCanceled(RespondActivityTaskCanceledRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RespondActivityTaskCanceled operation. /// /// /// The IAsyncResult returned by the call to BeginRespondActivityTaskCanceled. /// /// Returns a RespondActivityTaskCanceledResult from SimpleWorkflow. /// REST API Reference for RespondActivityTaskCanceled Operation RespondActivityTaskCanceledResponse EndRespondActivityTaskCanceled(IAsyncResult asyncResult); #endregion #region RespondActivityTaskCompleted /// /// Used by workers to tell the service that the ActivityTask identified by the /// taskToken completed successfully with a result (if provided). /// The result appears in the ActivityTaskCompleted event in /// the workflow history. /// /// /// /// If the requested task doesn't complete successfully, use RespondActivityTaskFailed /// instead. If the worker finds that the task is canceled through the canceled /// flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean /// up and then call RespondActivityTaskCanceled. /// /// /// /// A task is considered open from the time that it is scheduled until it is closed. Therefore /// a task is reported as open while a worker is processing it. A task is closed after /// it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, /// RespondActivityTaskFailed, or the task has timed /// out. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RespondActivityTaskCompleted service method. /// /// The response from the RespondActivityTaskCompleted service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for RespondActivityTaskCompleted Operation RespondActivityTaskCompletedResponse RespondActivityTaskCompleted(RespondActivityTaskCompletedRequest request); /// /// Initiates the asynchronous execution of the RespondActivityTaskCompleted operation. /// /// /// Container for the necessary parameters to execute the RespondActivityTaskCompleted operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRespondActivityTaskCompleted /// operation. /// REST API Reference for RespondActivityTaskCompleted Operation IAsyncResult BeginRespondActivityTaskCompleted(RespondActivityTaskCompletedRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RespondActivityTaskCompleted operation. /// /// /// The IAsyncResult returned by the call to BeginRespondActivityTaskCompleted. /// /// Returns a RespondActivityTaskCompletedResult from SimpleWorkflow. /// REST API Reference for RespondActivityTaskCompleted Operation RespondActivityTaskCompletedResponse EndRespondActivityTaskCompleted(IAsyncResult asyncResult); #endregion #region RespondActivityTaskFailed /// /// Used by workers to tell the service that the ActivityTask identified by the /// taskToken has failed with reason (if specified). The reason /// and details appear in the ActivityTaskFailed event added /// to the workflow history. /// /// /// /// A task is considered open from the time that it is scheduled until it is closed. Therefore /// a task is reported as open while a worker is processing it. A task is closed after /// it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, /// RespondActivityTaskFailed, or the task has timed /// out. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the RespondActivityTaskFailed service method. /// /// The response from the RespondActivityTaskFailed service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for RespondActivityTaskFailed Operation RespondActivityTaskFailedResponse RespondActivityTaskFailed(RespondActivityTaskFailedRequest request); /// /// Initiates the asynchronous execution of the RespondActivityTaskFailed operation. /// /// /// Container for the necessary parameters to execute the RespondActivityTaskFailed operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRespondActivityTaskFailed /// operation. /// REST API Reference for RespondActivityTaskFailed Operation IAsyncResult BeginRespondActivityTaskFailed(RespondActivityTaskFailedRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RespondActivityTaskFailed operation. /// /// /// The IAsyncResult returned by the call to BeginRespondActivityTaskFailed. /// /// Returns a RespondActivityTaskFailedResult from SimpleWorkflow. /// REST API Reference for RespondActivityTaskFailed Operation RespondActivityTaskFailedResponse EndRespondActivityTaskFailed(IAsyncResult asyncResult); #endregion #region RespondDecisionTaskCompleted /// /// Used by deciders to tell the service that the DecisionTask identified by the /// taskToken has successfully completed. The decisions argument /// specifies the list of decisions made while processing the task. /// /// /// /// A DecisionTaskCompleted event is added to the workflow history. The executionContext /// specified is attached to the event in the workflow execution history. /// /// /// /// Access Control /// /// /// /// If an IAM policy grants permission to use RespondDecisionTaskCompleted, /// it can express permissions for the list of decisions in the decisions /// parameter. Each of the decisions has one or more parameters, much like a regular API /// call. To allow for policies to be as readable as possible, you can express permissions /// on decisions as if they were actual API calls, including applying conditions to some /// parameters. For more information, see Using /// IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide. /// /// /// Container for the necessary parameters to execute the RespondDecisionTaskCompleted service method. /// /// The response from the RespondDecisionTaskCompleted service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for RespondDecisionTaskCompleted Operation RespondDecisionTaskCompletedResponse RespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest request); /// /// Initiates the asynchronous execution of the RespondDecisionTaskCompleted operation. /// /// /// Container for the necessary parameters to execute the RespondDecisionTaskCompleted operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndRespondDecisionTaskCompleted /// operation. /// REST API Reference for RespondDecisionTaskCompleted Operation IAsyncResult BeginRespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the RespondDecisionTaskCompleted operation. /// /// /// The IAsyncResult returned by the call to BeginRespondDecisionTaskCompleted. /// /// Returns a RespondDecisionTaskCompletedResult from SimpleWorkflow. /// REST API Reference for RespondDecisionTaskCompleted Operation RespondDecisionTaskCompletedResponse EndRespondDecisionTaskCompleted(IAsyncResult asyncResult); #endregion #region SignalWorkflowExecution /// /// Records a WorkflowExecutionSignaled event in the workflow execution history /// and creates a decision task for the workflow execution identified by the given domain, /// workflowId and runId. The event is recorded with the specified user defined signalName /// and input (if provided). /// /// /// /// If a runId isn't specified, then the WorkflowExecutionSignaled event /// is recorded in the history of the current open workflow with the matching workflowId /// in the domain. /// /// /// /// If the specified workflow execution isn't open, this method fails with UnknownResource. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the SignalWorkflowExecution service method. /// /// The response from the SignalWorkflowExecution service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for SignalWorkflowExecution Operation SignalWorkflowExecutionResponse SignalWorkflowExecution(SignalWorkflowExecutionRequest request); /// /// Initiates the asynchronous execution of the SignalWorkflowExecution operation. /// /// /// Container for the necessary parameters to execute the SignalWorkflowExecution operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndSignalWorkflowExecution /// operation. /// REST API Reference for SignalWorkflowExecution Operation IAsyncResult BeginSignalWorkflowExecution(SignalWorkflowExecutionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the SignalWorkflowExecution operation. /// /// /// The IAsyncResult returned by the call to BeginSignalWorkflowExecution. /// /// Returns a SignalWorkflowExecutionResult from SimpleWorkflow. /// REST API Reference for SignalWorkflowExecution Operation SignalWorkflowExecutionResponse EndSignalWorkflowExecution(IAsyncResult asyncResult); #endregion #region StartWorkflowExecution /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the StartWorkflowExecution service method. /// /// The response from the StartWorkflowExecution service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned when the specified activity or workflow type was already deprecated. /// /// /// 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. /// /// /// Returned by StartWorkflowExecution when an open execution with the same workflowId /// is already running in the specified domain. /// /// REST API Reference for StartWorkflowExecution Operation StartWorkflowExecutionResponse StartWorkflowExecution(StartWorkflowExecutionRequest request); /// /// Initiates the asynchronous execution of the StartWorkflowExecution operation. /// /// /// Container for the necessary parameters to execute the StartWorkflowExecution operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndStartWorkflowExecution /// operation. /// REST API Reference for StartWorkflowExecution Operation IAsyncResult BeginStartWorkflowExecution(StartWorkflowExecutionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the StartWorkflowExecution operation. /// /// /// The IAsyncResult returned by the call to BeginStartWorkflowExecution. /// /// Returns a StartWorkflowExecutionResult from SimpleWorkflow. /// REST API Reference for StartWorkflowExecution Operation StartWorkflowExecutionResponse EndStartWorkflowExecution(IAsyncResult asyncResult); #endregion #region TagResource /// /// Add a tag to a Amazon SWF domain. /// /// /// /// Amazon SWF supports a maximum of 50 tags per resource. /// /// /// /// Container for the necessary parameters to execute the TagResource service method. /// /// The response from the TagResource service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// You've exceeded the number of tags allowed for a domain. /// /// /// 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. /// /// REST API Reference for TagResource Operation TagResourceResponse TagResource(TagResourceRequest request); /// /// Initiates the asynchronous execution of the TagResource operation. /// /// /// Container for the necessary parameters to execute the TagResource operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTagResource /// operation. /// REST API Reference for TagResource Operation IAsyncResult BeginTagResource(TagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TagResource operation. /// /// /// The IAsyncResult returned by the call to BeginTagResource. /// /// Returns a TagResourceResult from SimpleWorkflow. /// REST API Reference for TagResource Operation TagResourceResponse EndTagResource(IAsyncResult asyncResult); #endregion #region TerminateWorkflowExecution /// /// Records a WorkflowExecutionTerminated event and forces closure of the /// workflow execution identified by the given domain, runId, and workflowId. The child /// policy, registered with the workflow type or specified when starting this execution, /// is applied to any open child workflow executions of this workflow execution. /// /// /// /// If the identified workflow execution was in progress, it is terminated immediately. /// /// /// /// If a runId isn't specified, then the WorkflowExecutionTerminated event /// is recorded in the history of the current open workflow with the matching workflowId /// in the domain. /// /// /// /// You should consider using RequestCancelWorkflowExecution action instead because /// it allows the workflow to gracefully close while TerminateWorkflowExecution /// doesn't. /// /// /// /// Access Control /// /// /// /// You can use IAM policies to control this action's access to Amazon SWF resources as /// follows: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the TerminateWorkflowExecution service method. /// /// The response from the TerminateWorkflowExecution service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for TerminateWorkflowExecution Operation TerminateWorkflowExecutionResponse TerminateWorkflowExecution(TerminateWorkflowExecutionRequest request); /// /// Initiates the asynchronous execution of the TerminateWorkflowExecution operation. /// /// /// Container for the necessary parameters to execute the TerminateWorkflowExecution operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndTerminateWorkflowExecution /// operation. /// REST API Reference for TerminateWorkflowExecution Operation IAsyncResult BeginTerminateWorkflowExecution(TerminateWorkflowExecutionRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the TerminateWorkflowExecution operation. /// /// /// The IAsyncResult returned by the call to BeginTerminateWorkflowExecution. /// /// Returns a TerminateWorkflowExecutionResult from SimpleWorkflow. /// REST API Reference for TerminateWorkflowExecution Operation TerminateWorkflowExecutionResponse EndTerminateWorkflowExecution(IAsyncResult asyncResult); #endregion #region UndeprecateActivityType /// /// Undeprecates a previously deprecated activity type. After an activity type /// has been undeprecated, you can create new tasks of that activity type. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the UndeprecateActivityType service method. /// /// The response from the UndeprecateActivityType service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned if the type already exists in the specified domain. You may get this fault /// if you are registering a type that is either already registered or deprecated, or /// if you undeprecate a type that is currently registered. /// /// /// 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. /// /// REST API Reference for UndeprecateActivityType Operation UndeprecateActivityTypeResponse UndeprecateActivityType(UndeprecateActivityTypeRequest request); /// /// Initiates the asynchronous execution of the UndeprecateActivityType operation. /// /// /// Container for the necessary parameters to execute the UndeprecateActivityType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUndeprecateActivityType /// operation. /// REST API Reference for UndeprecateActivityType Operation IAsyncResult BeginUndeprecateActivityType(UndeprecateActivityTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UndeprecateActivityType operation. /// /// /// The IAsyncResult returned by the call to BeginUndeprecateActivityType. /// /// Returns a UndeprecateActivityTypeResult from SimpleWorkflow. /// REST API Reference for UndeprecateActivityType Operation UndeprecateActivityTypeResponse EndUndeprecateActivityType(IAsyncResult asyncResult); #endregion #region UndeprecateDomain /// /// Undeprecates a previously deprecated domain. After a domain has been undeprecated /// it can be used to create new workflow executions or register new types. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the UndeprecateDomain service method. /// /// The response from the UndeprecateDomain service method, as returned by SimpleWorkflow. /// /// Returned if the domain already exists. You may get this fault if you are registering /// a domain that is either already registered or deprecated, or if you undeprecate a /// domain that is currently registered. /// /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for UndeprecateDomain Operation UndeprecateDomainResponse UndeprecateDomain(UndeprecateDomainRequest request); /// /// Initiates the asynchronous execution of the UndeprecateDomain operation. /// /// /// Container for the necessary parameters to execute the UndeprecateDomain operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUndeprecateDomain /// operation. /// REST API Reference for UndeprecateDomain Operation IAsyncResult BeginUndeprecateDomain(UndeprecateDomainRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UndeprecateDomain operation. /// /// /// The IAsyncResult returned by the call to BeginUndeprecateDomain. /// /// Returns a UndeprecateDomainResult from SimpleWorkflow. /// REST API Reference for UndeprecateDomain Operation UndeprecateDomainResponse EndUndeprecateDomain(IAsyncResult asyncResult); #endregion #region UndeprecateWorkflowType /// /// Undeprecates a previously deprecated workflow type. After a workflow type has /// been undeprecated, you can create new executions of that type. /// /// /// /// 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: /// /// /// /// 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. /// /// /// Container for the necessary parameters to execute the UndeprecateWorkflowType service method. /// /// The response from the UndeprecateWorkflowType service method, as returned by SimpleWorkflow. /// /// Returned when the caller doesn't have sufficient permissions to invoke the action. /// /// /// Returned if the type already exists in the specified domain. You may get this fault /// if you are registering a type that is either already registered or deprecated, or /// if you undeprecate a type that is currently registered. /// /// /// 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. /// /// REST API Reference for UndeprecateWorkflowType Operation UndeprecateWorkflowTypeResponse UndeprecateWorkflowType(UndeprecateWorkflowTypeRequest request); /// /// Initiates the asynchronous execution of the UndeprecateWorkflowType operation. /// /// /// Container for the necessary parameters to execute the UndeprecateWorkflowType operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUndeprecateWorkflowType /// operation. /// REST API Reference for UndeprecateWorkflowType Operation IAsyncResult BeginUndeprecateWorkflowType(UndeprecateWorkflowTypeRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UndeprecateWorkflowType operation. /// /// /// The IAsyncResult returned by the call to BeginUndeprecateWorkflowType. /// /// Returns a UndeprecateWorkflowTypeResult from SimpleWorkflow. /// REST API Reference for UndeprecateWorkflowType Operation UndeprecateWorkflowTypeResponse EndUndeprecateWorkflowType(IAsyncResult asyncResult); #endregion #region UntagResource /// /// Remove a tag from a Amazon SWF domain. /// /// Container for the necessary parameters to execute the UntagResource service method. /// /// The response from the UntagResource service method, as returned by SimpleWorkflow. /// /// 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 caller doesn't have sufficient permissions to invoke the action. /// /// /// 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. /// /// REST API Reference for UntagResource Operation UntagResourceResponse UntagResource(UntagResourceRequest request); /// /// Initiates the asynchronous execution of the UntagResource operation. /// /// /// Container for the necessary parameters to execute the UntagResource operation on AmazonSimpleWorkflowClient. /// An AsyncCallback delegate that is invoked when the operation completes. /// A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback /// procedure using the AsyncState property. /// /// An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndUntagResource /// operation. /// REST API Reference for UntagResource Operation IAsyncResult BeginUntagResource(UntagResourceRequest request, AsyncCallback callback, object state); /// /// Finishes the asynchronous execution of the UntagResource operation. /// /// /// The IAsyncResult returned by the call to BeginUntagResource. /// /// Returns a UntagResourceResult from SimpleWorkflow. /// REST API Reference for UntagResource Operation UntagResourceResponse EndUntagResource(IAsyncResult asyncResult); #endregion } }