/*******************************************************************************
* Copyright 2012-2019 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.
* *****************************************************************************
*
* AWS Tools for Windows (TM) PowerShell (TM)
*
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Management.Automation;
using System.Text;
using Amazon.PowerShell.Common;
using Amazon.Runtime;
using Amazon.SimpleWorkflow;
using Amazon.SimpleWorkflow.Model;
namespace Amazon.PowerShell.Cmdlets.SWF
{
///
/// 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:
/// -
/// Use a
Resource
element with the domain name to limit the action to only
/// specified domains.
/// -
/// Use an
Action
element to allow or deny permission to call this action.
/// -
/// You cannot use an IAM policy to constrain this action's parameters.
///
/// If the caller 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.
///
///
[Cmdlet("Send", "SWFSignalToWorkflowExecution", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("None")]
[AWSCmdlet("Calls the AWS Simple Workflow Service (SWF) SignalWorkflowExecution API operation.", Operation = new[] {"SignalWorkflowExecution"}, SelectReturnType = typeof(Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionResponse))]
[AWSCmdletOutput("None or Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionResponse",
"This cmdlet does not generate any output." +
"The service response (type Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class SendSWFSignalToWorkflowExecutionCmdlet : AmazonSimpleWorkflowClientCmdlet, IExecutor
{
#region Parameter Domain
///
///
/// The name of the domain containing the workflow execution to signal.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String Domain { get; set; }
#endregion
#region Parameter Input
///
///
/// Data to attach to the WorkflowExecutionSignaled
event in the target workflow
/// execution's history.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Input { get; set; }
#endregion
#region Parameter RunId
///
///
/// The runId of the workflow execution to signal.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RunId { get; set; }
#endregion
#region Parameter SignalName
///
///
/// The name of the signal. This name must be meaningful to the target workflow.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
#else
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String SignalName { get; set; }
#endregion
#region Parameter WorkflowId
///
///
/// The workflowId of the workflow execution to signal.
///
///
#if !MODULAR
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
#else
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)]
[System.Management.Automation.AllowEmptyString]
[System.Management.Automation.AllowNull]
#endif
[Amazon.PowerShell.Common.AWSRequiredParameter]
public System.String WorkflowId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionResponse).
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the SignalName parameter.
/// The -PassThru parameter is deprecated, use -Select '^SignalName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^SignalName' instead. This parameter will be removed in a future version.")]
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter PassThru { get; set; }
#endregion
#region Parameter Force
///
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public SwitchParameter Force { get; set; }
#endregion
protected override void ProcessRecord()
{
this._AWSSignerType = "v4";
base.ProcessRecord();
var resourceIdentifiersText = FormatParameterValuesForConfirmationMsg(nameof(this.WorkflowId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Send-SWFSignalToWorkflowExecution (SignalWorkflowExecution)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
#pragma warning disable CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
if (this.PassThru.IsPresent)
{
throw new System.ArgumentException("-PassThru cannot be used when -Select is specified.", nameof(this.Select));
}
}
else if (this.PassThru.IsPresent)
{
context.Select = (response, cmdlet) => this.SignalName;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.Domain = this.Domain;
#if MODULAR
if (this.Domain == null && ParameterWasBound(nameof(this.Domain)))
{
WriteWarning("You are passing $null as a value for parameter Domain which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.Input = this.Input;
context.RunId = this.RunId;
context.SignalName = this.SignalName;
#if MODULAR
if (this.SignalName == null && ParameterWasBound(nameof(this.SignalName)))
{
WriteWarning("You are passing $null as a value for parameter SignalName which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
context.WorkflowId = this.WorkflowId;
#if MODULAR
if (this.WorkflowId == null && ParameterWasBound(nameof(this.WorkflowId)))
{
WriteWarning("You are passing $null as a value for parameter WorkflowId which is marked as required. In case you believe this parameter was incorrectly marked as required, report this by opening an issue at https://github.com/aws/aws-tools-for-powershell/issues.");
}
#endif
// allow further manipulation of loaded context prior to processing
PostExecutionContextLoad(context);
var output = Execute(context) as CmdletOutput;
ProcessOutput(output);
}
#region IExecutor Members
public object Execute(ExecutorContext context)
{
var cmdletContext = context as CmdletContext;
// create request
var request = new Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest();
if (cmdletContext.Domain != null)
{
request.Domain = cmdletContext.Domain;
}
if (cmdletContext.Input != null)
{
request.Input = cmdletContext.Input;
}
if (cmdletContext.RunId != null)
{
request.RunId = cmdletContext.RunId;
}
if (cmdletContext.SignalName != null)
{
request.SignalName = cmdletContext.SignalName;
}
if (cmdletContext.WorkflowId != null)
{
request.WorkflowId = cmdletContext.WorkflowId;
}
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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionResponse CallAWSServiceOperation(IAmazonSimpleWorkflow client, Amazon.SimpleWorkflow.Model.SignalWorkflowExecutionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Simple Workflow Service (SWF)", "SignalWorkflowExecution");
try
{
#if DESKTOP
return client.SignalWorkflowExecution(request);
#elif CORECLR
return client.SignalWorkflowExecutionAsync(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;
}
}
#endregion
internal partial class CmdletContext : ExecutorContext
{
public System.String Domain { get; set; }
public System.String Input { get; set; }
public System.String RunId { get; set; }
public System.String SignalName { get; set; }
public System.String WorkflowId { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => null;
}
}
}