/******************************************************************************* * 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.NimbleStudio; using Amazon.NimbleStudio.Model; namespace Amazon.PowerShell.Cmdlets.NS { /// /// Creates a streaming session in a studio. /// /// /// /// After invoking this operation, you must poll GetStreamingSession until the streaming /// session is in the READY state. /// /// [Cmdlet("New", "NSStreamingSession", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.NimbleStudio.Model.StreamingSession")] [AWSCmdlet("Calls the Amazon Nimble Studio CreateStreamingSession API operation.", Operation = new[] {"CreateStreamingSession"}, SelectReturnType = typeof(Amazon.NimbleStudio.Model.CreateStreamingSessionResponse))] [AWSCmdletOutput("Amazon.NimbleStudio.Model.StreamingSession or Amazon.NimbleStudio.Model.CreateStreamingSessionResponse", "This cmdlet returns an Amazon.NimbleStudio.Model.StreamingSession object.", "The service call response (type Amazon.NimbleStudio.Model.CreateStreamingSessionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewNSStreamingSessionCmdlet : AmazonNimbleStudioClientCmdlet, IExecutor { #region Parameter Ec2InstanceType /// /// /// The EC2 Instance type used for the streaming session. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.NimbleStudio.StreamingInstanceType")] public Amazon.NimbleStudio.StreamingInstanceType Ec2InstanceType { get; set; } #endregion #region Parameter LaunchProfileId /// /// /// The ID of the launch profile used to control access from the streaming session. /// /// #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 LaunchProfileId { get; set; } #endregion #region Parameter OwnedBy /// /// /// The user ID of the user that owns the streaming session. The user that owns the session /// will be logging into the session and interacting with the virtual workstation. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OwnedBy { get; set; } #endregion #region Parameter StreamingImageId /// /// /// The ID of the streaming image. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String StreamingImageId { get; set; } #endregion #region Parameter StudioId /// /// /// The studio ID. /// /// #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 StudioId { get; set; } #endregion #region Parameter Tag /// /// /// A collection of labels, in the form of key-value pairs, that apply to this resource. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public System.Collections.Hashtable Tag { get; set; } #endregion #region Parameter ClientToken /// /// /// Unique, case-sensitive identifier that you provide to ensure the idempotency of the /// request. If you don’t specify a client token, the Amazon Web Services SDK automatically /// generates a client token and uses it for the request to ensure idempotency. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientToken { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'Session'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.NimbleStudio.Model.CreateStreamingSessionResponse). /// Specifying the name of a property of type Amazon.NimbleStudio.Model.CreateStreamingSessionResponse 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; } = "Session"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the StudioId parameter. /// The -PassThru parameter is deprecated, use -Select '^StudioId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^StudioId' 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.StudioId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-NSStreamingSession (CreateStreamingSession)")) { 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.StudioId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientToken = this.ClientToken; context.Ec2InstanceType = this.Ec2InstanceType; context.LaunchProfileId = this.LaunchProfileId; #if MODULAR if (this.LaunchProfileId == null && ParameterWasBound(nameof(this.LaunchProfileId))) { WriteWarning("You are passing $null as a value for parameter LaunchProfileId 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.OwnedBy = this.OwnedBy; context.StreamingImageId = this.StreamingImageId; context.StudioId = this.StudioId; #if MODULAR if (this.StudioId == null && ParameterWasBound(nameof(this.StudioId))) { WriteWarning("You are passing $null as a value for parameter StudioId 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 if (this.Tag != null) { context.Tag = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Tag.Keys) { context.Tag.Add((String)hashKey, (String)(this.Tag[hashKey])); } } // 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.NimbleStudio.Model.CreateStreamingSessionRequest(); if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.Ec2InstanceType != null) { request.Ec2InstanceType = cmdletContext.Ec2InstanceType; } if (cmdletContext.LaunchProfileId != null) { request.LaunchProfileId = cmdletContext.LaunchProfileId; } if (cmdletContext.OwnedBy != null) { request.OwnedBy = cmdletContext.OwnedBy; } if (cmdletContext.StreamingImageId != null) { request.StreamingImageId = cmdletContext.StreamingImageId; } if (cmdletContext.StudioId != null) { request.StudioId = cmdletContext.StudioId; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } 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.NimbleStudio.Model.CreateStreamingSessionResponse CallAWSServiceOperation(IAmazonNimbleStudio client, Amazon.NimbleStudio.Model.CreateStreamingSessionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Nimble Studio", "CreateStreamingSession"); try { #if DESKTOP return client.CreateStreamingSession(request); #elif CORECLR return client.CreateStreamingSessionAsync(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 ClientToken { get; set; } public Amazon.NimbleStudio.StreamingInstanceType Ec2InstanceType { get; set; } public System.String LaunchProfileId { get; set; } public System.String OwnedBy { get; set; } public System.String StreamingImageId { get; set; } public System.String StudioId { get; set; } public Dictionary Tag { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Session; } } }