/*******************************************************************************
* 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
{
///
/// 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:
/// -
/// Use a
Resource
element with the domain name to limit the action to only
/// specified domains.
/// -
/// Use an
Action
element to allow or deny permission to call this action.
/// -
/// Constrain the following parameters by using a
Condition
element with
/// the appropriate keys.
/// tagList.member.0
: The key is swf:tagList.member.0
.
/// tagList.member.1
: The key is swf:tagList.member.1
.
/// tagList.member.2
: The key is swf:tagList.member.2
.
/// tagList.member.3
: The key is swf:tagList.member.3
.
/// tagList.member.4
: The key is swf:tagList.member.4
.
/// taskList
: String constraint. The key is swf:taskList.name
.
/// workflowType.name
: String constraint. The key is swf:workflowType.name
.
/// workflowType.version
: String constraint. The key is swf:workflowType.version
.
///
/// 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("Start", "SWFWorkflowExecution", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("System.String")]
[AWSCmdlet("Calls the AWS Simple Workflow Service (SWF) StartWorkflowExecution API operation.", Operation = new[] {"StartWorkflowExecution"}, SelectReturnType = typeof(Amazon.SimpleWorkflow.Model.StartWorkflowExecutionResponse))]
[AWSCmdletOutput("System.String or Amazon.SimpleWorkflow.Model.StartWorkflowExecutionResponse",
"This cmdlet returns a System.String object.",
"The service call response (type Amazon.SimpleWorkflow.Model.StartWorkflowExecutionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class StartSWFWorkflowExecutionCmdlet : AmazonSimpleWorkflowClientCmdlet, IExecutor
{
#region Parameter ChildPolicy
///
///
/// If set, specifies the policy to use for the child workflow executions of this workflow
/// execution if it is terminated, by calling the TerminateWorkflowExecution action
/// explicitly or due to an expired timeout. This policy overrides the default child policy
/// specified when registering the workflow type using RegisterWorkflowType.The supported child policies are:TERMINATE
– The child executions are terminated.REQUEST_CANCEL
– A request to cancel is attempted for each child execution
/// by recording a WorkflowExecutionCancelRequested
event in its history.
/// It is up to the decider to take appropriate actions when it receives an execution
/// history with this event.ABANDON
– No action is taken. The child executions continue to run.
A child policy for this workflow execution must be specified either as a default for
/// the workflow type or through this parameter. If neither this parameter is set nor
/// a default child policy was specified at registration time then a fault is returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.SimpleWorkflow.ChildPolicy")]
public Amazon.SimpleWorkflow.ChildPolicy ChildPolicy { get; set; }
#endregion
#region Parameter Domain
///
///
/// The name of the domain in which the workflow execution is created.The specified string must not contain a :
(colon), /
(slash),
/// |
(vertical bar), or any control characters (\u0000-\u001f
/// | \u007f-\u009f
). Also, it must not be the literal string arn
.
///
///
#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 ExecutionStartToCloseTimeout
///
///
/// The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout
/// specified when registering the workflow type.The duration is specified in seconds; an integer greater than or equal to 0
.
/// Exceeding this limit causes the workflow execution to time out. Unlike some of the
/// other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this
/// timeout; there is a one-year max limit on the time that a workflow execution can run.An execution start-to-close timeout must be specified either through this parameter
/// or as a default when the workflow type is registered. If neither this parameter nor
/// a default execution start-to-close timeout is specified, a fault is returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ExecutionStartToCloseTimeout { get; set; }
#endregion
#region Parameter Input
///
///
/// The input for the workflow execution. This is a free form string which should be meaningful
/// to the workflow you are starting. This input
is made available to the
/// new workflow execution in the WorkflowExecutionStarted
history event.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Input { get; set; }
#endregion
#region Parameter LambdaRole
///
///
/// The IAM role to attach to this workflow execution.Executions of this workflow type need IAM roles to invoke Lambda functions. If you
/// don't attach an IAM role, any attempt to schedule a Lambda task fails. This results
/// in a ScheduleLambdaFunctionFailed
history event. For more information,
/// see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html
/// in the Amazon SWF Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LambdaRole { get; set; }
#endregion
#region Parameter TaskList_Name
///
///
/// The name of the task list.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TaskList_Name { get; set; }
#endregion
#region Parameter WorkflowType_Name
///
///
/// The name of the workflow type.The combination of workflow type name and version must be unique with in a domain.
///
///
#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 WorkflowType_Name { get; set; }
#endregion
#region Parameter TagList
///
///
/// The list of tags to associate with the workflow execution. You can specify a maximum
/// of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions
/// or ListClosedWorkflowExecutions and specifying a TagFilter.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String[] TagList { get; set; }
#endregion
#region Parameter TaskPriority
///
///
/// The task priority to use for this workflow execution. This overrides any default priority
/// that was assigned when the workflow type was registered. If not set, then the default
/// task priority for the workflow type is used. Valid values are integers that range
/// from Java's Integer.MIN_VALUE
(-2147483648) to Integer.MAX_VALUE
/// (2147483647). Higher numbers indicate higher priority.For more information about setting task priority, see Setting
/// Task Priority in the Amazon SWF Developer Guide.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TaskPriority { get; set; }
#endregion
#region Parameter TaskStartToCloseTimeout
///
///
/// Specifies the maximum duration of decision tasks for this workflow execution. This
/// parameter overrides the defaultTaskStartToCloseTimout
specified when
/// registering the workflow type using RegisterWorkflowType.The duration is specified in seconds, an integer greater than or equal to 0
.
/// You can use NONE
to specify unlimited duration.A task start-to-close timeout for this workflow execution must be specified either
/// as a default for the workflow type or through this parameter. If neither this parameter
/// is set nor a default task start-to-close timeout was specified at registration time
/// then a fault is returned.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String TaskStartToCloseTimeout { get; set; }
#endregion
#region Parameter WorkflowType_Version
///
///
/// The version of the workflow type.The combination of workflow type name and version must be unique with in a domain.
///
///
#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 WorkflowType_Version { get; set; }
#endregion
#region Parameter WorkflowId
///
///
/// The user defined identifier associated with the workflow execution. You can use this
/// to associate a custom identifier with the workflow execution. You may specify the
/// same identifier if a workflow execution is logically a restart of a previous
/// execution. You cannot have two open workflow executions with the same workflowId
/// at the same time within the same domain.The specified string must not contain a :
(colon), /
(slash),
/// |
(vertical bar), or any control characters (\u0000-\u001f
/// | \u007f-\u009f
). Also, it must not be the literal string arn
.
///
///
#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 WorkflowId { get; set; }
#endregion
#region Parameter Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Run.RunId'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleWorkflow.Model.StartWorkflowExecutionResponse).
/// Specifying the name of a property of type Amazon.SimpleWorkflow.Model.StartWorkflowExecutionResponse will result in that property being returned.
/// 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; } = "Run.RunId";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the WorkflowId parameter.
/// The -PassThru parameter is deprecated, use -Select '^WorkflowId' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^WorkflowId' 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.WorkflowType_Name), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-SWFWorkflowExecution (StartWorkflowExecution)"))
{
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.WorkflowId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.ChildPolicy = this.ChildPolicy;
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.ExecutionStartToCloseTimeout = this.ExecutionStartToCloseTimeout;
context.Input = this.Input;
context.LambdaRole = this.LambdaRole;
if (this.TagList != null)
{
context.TagList = new List(this.TagList);
}
context.TaskList_Name = this.TaskList_Name;
context.TaskPriority = this.TaskPriority;
context.TaskStartToCloseTimeout = this.TaskStartToCloseTimeout;
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
context.WorkflowType_Name = this.WorkflowType_Name;
#if MODULAR
if (this.WorkflowType_Name == null && ParameterWasBound(nameof(this.WorkflowType_Name)))
{
WriteWarning("You are passing $null as a value for parameter WorkflowType_Name 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.WorkflowType_Version = this.WorkflowType_Version;
#if MODULAR
if (this.WorkflowType_Version == null && ParameterWasBound(nameof(this.WorkflowType_Version)))
{
WriteWarning("You are passing $null as a value for parameter WorkflowType_Version 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.StartWorkflowExecutionRequest();
if (cmdletContext.ChildPolicy != null)
{
request.ChildPolicy = cmdletContext.ChildPolicy;
}
if (cmdletContext.Domain != null)
{
request.Domain = cmdletContext.Domain;
}
if (cmdletContext.ExecutionStartToCloseTimeout != null)
{
request.ExecutionStartToCloseTimeout = cmdletContext.ExecutionStartToCloseTimeout;
}
if (cmdletContext.Input != null)
{
request.Input = cmdletContext.Input;
}
if (cmdletContext.LambdaRole != null)
{
request.LambdaRole = cmdletContext.LambdaRole;
}
if (cmdletContext.TagList != null)
{
request.TagList = cmdletContext.TagList;
}
// populate TaskList
var requestTaskListIsNull = true;
request.TaskList = new Amazon.SimpleWorkflow.Model.TaskList();
System.String requestTaskList_taskList_Name = null;
if (cmdletContext.TaskList_Name != null)
{
requestTaskList_taskList_Name = cmdletContext.TaskList_Name;
}
if (requestTaskList_taskList_Name != null)
{
request.TaskList.Name = requestTaskList_taskList_Name;
requestTaskListIsNull = false;
}
// determine if request.TaskList should be set to null
if (requestTaskListIsNull)
{
request.TaskList = null;
}
if (cmdletContext.TaskPriority != null)
{
request.TaskPriority = cmdletContext.TaskPriority;
}
if (cmdletContext.TaskStartToCloseTimeout != null)
{
request.TaskStartToCloseTimeout = cmdletContext.TaskStartToCloseTimeout;
}
if (cmdletContext.WorkflowId != null)
{
request.WorkflowId = cmdletContext.WorkflowId;
}
// populate WorkflowType
var requestWorkflowTypeIsNull = true;
request.WorkflowType = new Amazon.SimpleWorkflow.Model.WorkflowType();
System.String requestWorkflowType_workflowType_Name = null;
if (cmdletContext.WorkflowType_Name != null)
{
requestWorkflowType_workflowType_Name = cmdletContext.WorkflowType_Name;
}
if (requestWorkflowType_workflowType_Name != null)
{
request.WorkflowType.Name = requestWorkflowType_workflowType_Name;
requestWorkflowTypeIsNull = false;
}
System.String requestWorkflowType_workflowType_Version = null;
if (cmdletContext.WorkflowType_Version != null)
{
requestWorkflowType_workflowType_Version = cmdletContext.WorkflowType_Version;
}
if (requestWorkflowType_workflowType_Version != null)
{
request.WorkflowType.Version = requestWorkflowType_workflowType_Version;
requestWorkflowTypeIsNull = false;
}
// determine if request.WorkflowType should be set to null
if (requestWorkflowTypeIsNull)
{
request.WorkflowType = 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;
}
public ExecutorContext CreateContext()
{
return new CmdletContext();
}
#endregion
#region AWS Service Operation Call
private Amazon.SimpleWorkflow.Model.StartWorkflowExecutionResponse CallAWSServiceOperation(IAmazonSimpleWorkflow client, Amazon.SimpleWorkflow.Model.StartWorkflowExecutionRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Simple Workflow Service (SWF)", "StartWorkflowExecution");
try
{
#if DESKTOP
return client.StartWorkflowExecution(request);
#elif CORECLR
return client.StartWorkflowExecutionAsync(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 Amazon.SimpleWorkflow.ChildPolicy ChildPolicy { get; set; }
public System.String Domain { get; set; }
public System.String ExecutionStartToCloseTimeout { get; set; }
public System.String Input { get; set; }
public System.String LambdaRole { get; set; }
public List TagList { get; set; }
public System.String TaskList_Name { get; set; }
public System.String TaskPriority { get; set; }
public System.String TaskStartToCloseTimeout { get; set; }
public System.String WorkflowId { get; set; }
public System.String WorkflowType_Name { get; set; }
public System.String WorkflowType_Version { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Run.RunId;
}
}
}