/*******************************************************************************
* 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.Omics;
using Amazon.Omics.Model;
namespace Amazon.PowerShell.Cmdlets.OMICS
{
/// <summary>
/// Starts a run.
/// </summary>
[Cmdlet("Start", "OMICSRun", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.Omics.Model.StartRunResponse")]
[AWSCmdlet("Calls the Amazon Omics StartRun API operation.", Operation = new[] {"StartRun"}, SelectReturnType = typeof(Amazon.Omics.Model.StartRunResponse))]
[AWSCmdletOutput("Amazon.Omics.Model.StartRunResponse",
"This cmdlet returns an Amazon.Omics.Model.StartRunResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class StartOMICSRunCmdlet : AmazonOmicsClientCmdlet, IExecutor
{
#region Parameter LogLevel
/// <summary>
/// <para>
/// <para>A log level for the run.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Omics.RunLogLevel")]
public Amazon.Omics.RunLogLevel LogLevel { get; set; }
#endregion
#region Parameter Name
/// <summary>
/// <para>
/// <para>A name for the run.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String Name { get; set; }
#endregion
#region Parameter OutputUri
/// <summary>
/// <para>
/// <para>An output URI for the run.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String OutputUri { get; set; }
#endregion
#region Parameter Parameter
/// <summary>
/// <para>
/// <para>Parameters for the run.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Parameters")]
public System.Management.Automation.PSObject Parameter { get; set; }
#endregion
#region Parameter Priority
/// <summary>
/// <para>
/// <para>A priority for the run.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? Priority { get; set; }
#endregion
#region Parameter RequestId
/// <summary>
/// <para>
/// <para>To ensure that requests don't run multiple times, specify a unique ID for each request.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RequestId { get; set; }
#endregion
#region Parameter RoleArn
/// <summary>
/// <para>
/// <para>A service role for the run.</para>
/// </para>
/// </summary>
#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 RoleArn { get; set; }
#endregion
#region Parameter RunGroupId
/// <summary>
/// <para>
/// <para>The run's group ID.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RunGroupId { get; set; }
#endregion
#region Parameter RunId
/// <summary>
/// <para>
/// <para>The run's ID.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String RunId { get; set; }
#endregion
#region Parameter StorageCapacity
/// <summary>
/// <para>
/// <para>A storage capacity for the run in gigabytes.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.Int32? StorageCapacity { get; set; }
#endregion
#region Parameter Tag
/// <summary>
/// <para>
/// <para>Tags for the run.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { get; set; }
#endregion
#region Parameter WorkflowId
/// <summary>
/// <para>
/// <para>The run's workflow ID.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String WorkflowId { get; set; }
#endregion
#region Parameter WorkflowType
/// <summary>
/// <para>
/// <para>The run's workflows type.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[AWSConstantClassSource("Amazon.Omics.WorkflowType")]
public Amazon.Omics.WorkflowType WorkflowType { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is '*'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Omics.Model.StartRunResponse).
/// Specifying the name of a property of type Amazon.Omics.Model.StartRunResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "*";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the RoleArn parameter.
/// The -PassThru parameter is deprecated, use -Select '^RoleArn' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RoleArn' 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
/// <summary>
/// This parameter overrides confirmation prompts to force
/// the cmdlet to continue its operation. This parameter should always
/// be used with caution.
/// </summary>
[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.RoleArn), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-OMICSRun (StartRun)"))
{
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<Amazon.Omics.Model.StartRunResponse, StartOMICSRunCmdlet>(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.RoleArn;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.LogLevel = this.LogLevel;
context.Name = this.Name;
context.OutputUri = this.OutputUri;
context.Parameter = this.Parameter;
context.Priority = this.Priority;
context.RequestId = this.RequestId;
context.RoleArn = this.RoleArn;
#if MODULAR
if (this.RoleArn == null && ParameterWasBound(nameof(this.RoleArn)))
{
WriteWarning("You are passing $null as a value for parameter RoleArn 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.RunGroupId = this.RunGroupId;
context.RunId = this.RunId;
context.StorageCapacity = this.StorageCapacity;
if (this.Tag != null)
{
context.Tag = new Dictionary<System.String, System.String>(StringComparer.Ordinal);
foreach (var hashKey in this.Tag.Keys)
{
context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey]));
}
}
context.WorkflowId = this.WorkflowId;
context.WorkflowType = this.WorkflowType;
// 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.Omics.Model.StartRunRequest();
if (cmdletContext.LogLevel != null)
{
request.LogLevel = cmdletContext.LogLevel;
}
if (cmdletContext.Name != null)
{
request.Name = cmdletContext.Name;
}
if (cmdletContext.OutputUri != null)
{
request.OutputUri = cmdletContext.OutputUri;
}
if (cmdletContext.Parameter != null)
{
request.Parameters = Amazon.PowerShell.Common.DocumentHelper.ToDocument(cmdletContext.Parameter);
}
if (cmdletContext.Priority != null)
{
request.Priority = cmdletContext.Priority.Value;
}
if (cmdletContext.RequestId != null)
{
request.RequestId = cmdletContext.RequestId;
}
if (cmdletContext.RoleArn != null)
{
request.RoleArn = cmdletContext.RoleArn;
}
if (cmdletContext.RunGroupId != null)
{
request.RunGroupId = cmdletContext.RunGroupId;
}
if (cmdletContext.RunId != null)
{
request.RunId = cmdletContext.RunId;
}
if (cmdletContext.StorageCapacity != null)
{
request.StorageCapacity = cmdletContext.StorageCapacity.Value;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
if (cmdletContext.WorkflowId != null)
{
request.WorkflowId = cmdletContext.WorkflowId;
}
if (cmdletContext.WorkflowType != null)
{
request.WorkflowType = cmdletContext.WorkflowType;
}
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.Omics.Model.StartRunResponse CallAWSServiceOperation(IAmazonOmics client, Amazon.Omics.Model.StartRunRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Omics", "StartRun");
try
{
#if DESKTOP
return client.StartRun(request);
#elif CORECLR
return client.StartRunAsync(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.Omics.RunLogLevel LogLevel { get; set; }
public System.String Name { get; set; }
public System.String OutputUri { get; set; }
public System.Management.Automation.PSObject Parameter { get; set; }
public System.Int32? Priority { get; set; }
public System.String RequestId { get; set; }
public System.String RoleArn { get; set; }
public System.String RunGroupId { get; set; }
public System.String RunId { get; set; }
public System.Int32? StorageCapacity { get; set; }
public Dictionary<System.String, System.String> Tag { get; set; }
public System.String WorkflowId { get; set; }
public Amazon.Omics.WorkflowType WorkflowType { get; set; }
public System.Func<Amazon.Omics.Model.StartRunResponse, StartOMICSRunCmdlet, object> Select { get; set; } =
(response, cmdlet) => response;
}
}
}