/// <summary>
/// Initiates the asynchronous execution of the DescribeWorkflowExecution operation.
/// <seealso cref="Amazon.SimpleWorkflow.AmazonSimpleWorkflow.DescribeWorkflowExecution"/>
/// </summary>
///
/// <param name="describeWorkflowExecutionRequest">Container for the necessary parameters to execute the DescribeWorkflowExecution operation on
/// AmazonSimpleWorkflow.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking
/// EndDescribeWorkflowExecution operation.</returns>
public IAsyncResult BeginDescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest, AsyncCallback callback, object state)
{
return invokeDescribeWorkflowExecution(describeWorkflowExecutionRequest, callback, state, false);
}
/// <summary>
/// <para> Returns information about the specified workflow execution including its type and some statistics. </para> <para><b>NOTE:</b> This
/// operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. </para>
/// </summary>
///
/// <param name="describeWorkflowExecutionRequest">Container for the necessary parameters to execute the DescribeWorkflowExecution service
/// method on AmazonSimpleWorkflow.</param>
///
/// <returns>The response from the DescribeWorkflowExecution service method, as returned by AmazonSimpleWorkflow.</returns>
///
/// <exception cref="OperationNotPermittedException"/>
/// <exception cref="UnknownResourceException"/>
public DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
{
IAsyncResult asyncResult = invokeDescribeWorkflowExecution(describeWorkflowExecutionRequest, null, null, true);
return EndDescribeWorkflowExecution(asyncResult);
}
/// <summary>
/// <para> Returns information about the specified workflow execution including its type and some statistics. </para> <para><b>NOTE:</b> This
/// operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. </para> <para>
/// <b>Access Control</b> </para> <para>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</para>
/// <ul>
/// <li>Use a <c>Resource</c> element with the domain name to limit the action to only specified domains.</li>
/// <li>Use an <c>Action</c> element to allow or deny permission to call this action.</li>
/// <li>You cannot use an IAM policy to constrain this action's parameters.</li>
///
/// </ul>
/// <para>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified
/// constraints, the action fails by throwing <c>OperationNotPermitted</c> . For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>
/// .</para>
/// </summary>
///
/// <param name="describeWorkflowExecutionRequest">Container for the necessary parameters to execute the DescribeWorkflowExecution service
/// method on AmazonSimpleWorkflow.</param>
///
/// <returns>The response from the DescribeWorkflowExecution service method, as returned by AmazonSimpleWorkflow.</returns>
///
/// <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException" />
/// <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException" />
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public Task<DescribeWorkflowExecutionResponse> DescribeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeWorkflowExecutionRequestMarshaller();
var unmarshaller = DescribeWorkflowExecutionResponseUnmarshaller.GetInstance();
return Invoke<IRequest, DescribeWorkflowExecutionRequest, DescribeWorkflowExecutionResponse>(describeWorkflowExecutionRequest, marshaller, unmarshaller, signer, cancellationToken);
}
IAsyncResult invokeDescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest, AsyncCallback callback, object state, bool synchronized)
{
IRequest irequest = new DescribeWorkflowExecutionRequestMarshaller().Marshall(describeWorkflowExecutionRequest);
var unmarshaller = DescribeWorkflowExecutionResponseUnmarshaller.GetInstance();
AsyncResult result = new AsyncResult(irequest, callback, state, synchronized, signer, unmarshaller);
Invoke(result);
return result;
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeWorkflowExecution operation.
/// <seealso cref="Amazon.SimpleWorkflow.IAmazonSimpleWorkflow"/>
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution operation.</param>
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
/// <returns>The task object representing the asynchronous operation.</returns>
public Task<DescribeWorkflowExecutionResponse> DescribeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeWorkflowExecutionRequestMarshaller();
var unmarshaller = DescribeWorkflowExecutionResponseUnmarshaller.Instance;
return InvokeAsync<DescribeWorkflowExecutionRequest,DescribeWorkflowExecutionResponse>(request, marshaller,
unmarshaller, cancellationToken);
}
internal DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest request)
{
var task = DescribeWorkflowExecutionAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
ExceptionDispatchInfo.Capture(e.InnerException).Throw();
return null;
}
}
private Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionResponse CallAWSServiceOperation(IAmazonSimpleWorkflow client, Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Simple Workflow Service (SWF)", "DescribeWorkflowExecution");
try
{
#if DESKTOP
return(client.DescribeWorkflowExecution(request));
#elif CORECLR
return(client.DescribeWorkflowExecutionAsync(request).GetAwaiter().GetResult());
#else
#error "Unknown build edition"
#endif
}
catch (AmazonServiceException exc)
{
var webException = exc.InnerException as System.Net.WebException;
if (webException != null)
{
throw new Exception(Utils.Common.FormatNameResolutionFailureMessage(client.Config, webException.Message), webException);
}
throw;
}
}
/// <summary>
/// Returns information about the specified workflow execution including its type and
/// some statistics.
///
///
/// <para>
/// <b>Access Control</b>
/// </para>
///
/// <para>
/// You can use IAM policies to control this action's access to Amazon SWF resources as
/// follows:
/// </para>
/// <ul> <li>Use a <code>Resource</code> element with the domain name to limit the action
/// to only specified domains.</li> <li>Use an <code>Action</code> element to allow or
/// deny permission to call this action.</li> <li>You cannot use an IAM policy to constrain
/// this action's parameters.</li> </ul>
/// <para>
/// If the caller does not have sufficient permissions to invoke the action, or the parameter
/// values fall outside the specified constraints, the action fails by throwing <code>OperationNotPermitted</code>.
/// For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using
/// IAM to Manage Access to Amazon SWF Workflows</a>.
/// </para>
/// </summary>
/// <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution service method.</param>
///
/// <returns>The response from the DescribeWorkflowExecution service method, as returned by SimpleWorkflow.</returns>
/// <exception cref="OperationNotPermittedException">
/// Returned when the caller does not have sufficient permissions to invoke the action.
/// </exception>
/// <exception cref="UnknownResourceException">
/// 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.
/// </exception>
public DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest request)
{
var marshaller = new DescribeWorkflowExecutionRequestMarshaller();
var unmarshaller = DescribeWorkflowExecutionResponseUnmarshaller.Instance;
return Invoke<DescribeWorkflowExecutionRequest,DescribeWorkflowExecutionResponse>(request, marshaller, unmarshaller);
}
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.SimpleWorkflow.Model.DescribeWorkflowExecutionRequest();
if (cmdletContext.Domain != null)
{
request.Domain = cmdletContext.Domain;
}
// populate Execution
var requestExecutionIsNull = true;
request.Execution = new Amazon.SimpleWorkflow.Model.WorkflowExecution();
System.String requestExecution_execution_RunId = null;
if (cmdletContext.Execution_RunId != null)
{
requestExecution_execution_RunId = cmdletContext.Execution_RunId;
}
if (requestExecution_execution_RunId != null)
{
request.Execution.RunId = requestExecution_execution_RunId;
requestExecutionIsNull = false;
}
System.String requestExecution_execution_WorkflowId = null;
if (cmdletContext.Execution_WorkflowId != null)
{
requestExecution_execution_WorkflowId = cmdletContext.Execution_WorkflowId;
}
if (requestExecution_execution_WorkflowId != null)
{
request.Execution.WorkflowId = requestExecution_execution_WorkflowId;
requestExecutionIsNull = false;
}
// determine if request.Execution should be set to null
if (requestExecutionIsNull)
{
request.Execution = null;
}
CmdletOutput output;
// issue call
var client = Client ?? CreateClient(_CurrentCredentials, _RegionEndpoint);
try
{
var response = CallAWSServiceOperation(client, request);
object pipelineOutput = null;
pipelineOutput = cmdletContext.Select(response, this);
output = new CmdletOutput
{
PipelineOutput = pipelineOutput,
ServiceResponse = response
};
}
catch (Exception e)
{
output = new CmdletOutput {
ErrorResponse = e
};
}
return(output);
}
/// <summary>
/// Initiates the asynchronous execution of the DescribeWorkflowExecution operation.
/// </summary>
///
/// <param name="request">Container for the necessary parameters to execute the DescribeWorkflowExecution operation on AmazonSimpleWorkflowClient.</param>
/// <param name="callback">An AsyncCallback delegate that is invoked when the operation completes.</param>
/// <param name="state">A user-defined state object that is passed to the callback procedure. Retrieve this object from within the callback
/// procedure using the AsyncState property.</param>
///
/// <returns>An IAsyncResult that can be used to poll or wait for results, or both; this value is also needed when invoking EndDescribeWorkflowExecution
/// operation.</returns>
public IAsyncResult BeginDescribeWorkflowExecution(DescribeWorkflowExecutionRequest request, AsyncCallback callback, object state)
{
var marshaller = new DescribeWorkflowExecutionRequestMarshaller();
var unmarshaller = DescribeWorkflowExecutionResponseUnmarshaller.Instance;
return BeginInvoke<DescribeWorkflowExecutionRequest>(request, marshaller, unmarshaller,
callback, state);
}
/// <summary>
/// <para> Returns information about the specified workflow execution including its type and some statistics. </para> <para><b>NOTE:</b> This
/// operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. </para> <para>
/// <b>Access Control</b> </para> <para>You can use IAM policies to control this action's access to Amazon SWF resources as follows:</para>
/// <ul>
/// <li>Use a <c>Resource</c> element with the domain name to limit the action to only specified domains.</li>
/// <li>Use an <c>Action</c> element to allow or deny permission to call this action.</li>
/// <li>You cannot use an IAM policy to constrain this action's parameters.</li>
///
/// </ul>
/// <para>If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified
/// constraints, the action fails by throwing <c>OperationNotPermitted</c> . For details and example IAM policies, see <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF Workflows</a>
/// .</para>
/// </summary>
///
/// <param name="describeWorkflowExecutionRequest">Container for the necessary parameters to execute the DescribeWorkflowExecution service
/// method on AmazonSimpleWorkflow.</param>
///
/// <returns>The response from the DescribeWorkflowExecution service method, as returned by AmazonSimpleWorkflow.</returns>
///
/// <exception cref="T:Amazon.SimpleWorkflow.Model.OperationNotPermittedException" />
/// <exception cref="T:Amazon.SimpleWorkflow.Model.UnknownResourceException" />
/// <param name="cancellationToken">
/// A cancellation token that can be used by other objects or threads to receive notice of cancellation.
/// </param>
public async Task<DescribeWorkflowExecutionResponse> DescribeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest, CancellationToken cancellationToken = default(CancellationToken))
{
var marshaller = new DescribeWorkflowExecutionRequestMarshaller();
var unmarshaller = DescribeWorkflowExecutionResponseUnmarshaller.GetInstance();
var response = await Invoke<IRequest, DescribeWorkflowExecutionRequest, DescribeWorkflowExecutionResponse>(describeWorkflowExecutionRequest, marshaller, unmarshaller, signer, cancellationToken)
.ConfigureAwait(continueOnCapturedContext: false);
return response;
}
internal DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest request)
{
var task = DescribeWorkflowExecutionAsync(request);
try
{
return task.Result;
}
catch(AggregateException e)
{
throw e.InnerException;
}
}
/// <summary>
/// <para> Returns information about the specified workflow execution including its type and some statistics. </para> <para><b>NOTE:</b> This
/// operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes. </para>
/// </summary>
///
/// <param name="describeWorkflowExecutionRequest">Container for the necessary parameters to execute the DescribeWorkflowExecution service
/// method on AmazonSimpleWorkflow.</param>
///
/// <returns>The response from the DescribeWorkflowExecution service method, as returned by AmazonSimpleWorkflow.</returns>
///
/// <exception cref="OperationNotPermittedException"/>
/// <exception cref="UnknownResourceException"/>
public DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeWorkflowExecutionRequest)
{
IRequest<DescribeWorkflowExecutionRequest> request = new DescribeWorkflowExecutionRequestMarshaller().Marshall(describeWorkflowExecutionRequest);
DescribeWorkflowExecutionResponse response = Invoke<DescribeWorkflowExecutionRequest, DescribeWorkflowExecutionResponse> (request, this.signer, DescribeWorkflowExecutionResponseUnmarshaller.GetInstance());
return response;
}
