/******************************************************************************* * 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.DeviceFarm; using Amazon.DeviceFarm.Model; namespace Amazon.PowerShell.Cmdlets.DF { /// /// Specifies and starts a remote access session. /// [Cmdlet("New", "DFRemoteAccessSession", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DeviceFarm.Model.RemoteAccessSession")] [AWSCmdlet("Calls the AWS Device Farm CreateRemoteAccessSession API operation.", Operation = new[] {"CreateRemoteAccessSession"}, SelectReturnType = typeof(Amazon.DeviceFarm.Model.CreateRemoteAccessSessionResponse))] [AWSCmdletOutput("Amazon.DeviceFarm.Model.RemoteAccessSession or Amazon.DeviceFarm.Model.CreateRemoteAccessSessionResponse", "This cmdlet returns an Amazon.DeviceFarm.Model.RemoteAccessSession object.", "The service call response (type Amazon.DeviceFarm.Model.CreateRemoteAccessSessionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewDFRemoteAccessSessionCmdlet : AmazonDeviceFarmClientCmdlet, IExecutor { #region Parameter Configuration_BillingMethod /// /// /// The billing method for the remote access session. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DeviceFarm.BillingMethod")] public Amazon.DeviceFarm.BillingMethod Configuration_BillingMethod { get; set; } #endregion #region Parameter ClientId /// /// /// Unique identifier for the client. If you want access to multiple devices on the same /// client, you should pass the same clientId value in each call to CreateRemoteAccessSession. /// This identifier is required only if remoteDebugEnabled is set to true.Remote debugging is no /// longer supported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientId { get; set; } #endregion #region Parameter DeviceArn /// /// /// The ARN of the device for which you want to create a remote access session. /// /// #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 DeviceArn { get; set; } #endregion #region Parameter InstanceArn /// /// /// The Amazon Resource Name (ARN) of the device instance for which you want to create /// a remote access session. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String InstanceArn { get; set; } #endregion #region Parameter InteractionMode /// /// /// The interaction mode of the remote access session. Valid values are: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.DeviceFarm.InteractionMode")] public Amazon.DeviceFarm.InteractionMode InteractionMode { get; set; } #endregion #region Parameter Name /// /// /// The name of the remote access session to create. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Name { get; set; } #endregion #region Parameter ProjectArn /// /// /// The Amazon Resource Name (ARN) of the project for which you want to create a remote /// access 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 ProjectArn { get; set; } #endregion #region Parameter RemoteDebugEnabled /// /// /// Set to true if you want to access devices remotely for debugging in your /// remote access session.Remote debugging is no /// longer supported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? RemoteDebugEnabled { get; set; } #endregion #region Parameter RemoteRecordAppArn /// /// /// The Amazon Resource Name (ARN) for the app to be recorded in the remote access session. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String RemoteRecordAppArn { get; set; } #endregion #region Parameter RemoteRecordEnabled /// /// /// Set to true to enable remote recording for the remote access session. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? RemoteRecordEnabled { get; set; } #endregion #region Parameter SkipAppResign /// /// /// When set to true, for private devices, Device Farm does not sign your /// app again. For public devices, Device Farm always signs your apps again.For more information on how Device Farm modifies your uploads during tests, see Do you modify my app? /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? SkipAppResign { get; set; } #endregion #region Parameter SshPublicKey /// /// /// Ignored. The public key of the ssh key pair you want to use for connecting /// to remote devices in your remote debugging session. This key is required only if remoteDebugEnabled /// is set to true.Remote debugging is no /// longer supported. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SshPublicKey { get; set; } #endregion #region Parameter Configuration_VpceConfigurationArn /// /// /// An array of ARNs included in the VPC endpoint configuration. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Configuration_VpceConfigurationArns")] public System.String[] Configuration_VpceConfigurationArn { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'RemoteAccessSession'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DeviceFarm.Model.CreateRemoteAccessSessionResponse). /// Specifying the name of a property of type Amazon.DeviceFarm.Model.CreateRemoteAccessSessionResponse 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; } = "RemoteAccessSession"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the DeviceArn parameter. /// The -PassThru parameter is deprecated, use -Select '^DeviceArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^DeviceArn' 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.DeviceArn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-DFRemoteAccessSession (CreateRemoteAccessSession)")) { 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.DeviceArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.ClientId = this.ClientId; context.Configuration_BillingMethod = this.Configuration_BillingMethod; if (this.Configuration_VpceConfigurationArn != null) { context.Configuration_VpceConfigurationArn = new List(this.Configuration_VpceConfigurationArn); } context.DeviceArn = this.DeviceArn; #if MODULAR if (this.DeviceArn == null && ParameterWasBound(nameof(this.DeviceArn))) { WriteWarning("You are passing $null as a value for parameter DeviceArn 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.InstanceArn = this.InstanceArn; context.InteractionMode = this.InteractionMode; context.Name = this.Name; context.ProjectArn = this.ProjectArn; #if MODULAR if (this.ProjectArn == null && ParameterWasBound(nameof(this.ProjectArn))) { WriteWarning("You are passing $null as a value for parameter ProjectArn 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.RemoteDebugEnabled = this.RemoteDebugEnabled; context.RemoteRecordAppArn = this.RemoteRecordAppArn; context.RemoteRecordEnabled = this.RemoteRecordEnabled; context.SkipAppResign = this.SkipAppResign; context.SshPublicKey = this.SshPublicKey; // 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.DeviceFarm.Model.CreateRemoteAccessSessionRequest(); if (cmdletContext.ClientId != null) { request.ClientId = cmdletContext.ClientId; } // populate Configuration var requestConfigurationIsNull = true; request.Configuration = new Amazon.DeviceFarm.Model.CreateRemoteAccessSessionConfiguration(); Amazon.DeviceFarm.BillingMethod requestConfiguration_configuration_BillingMethod = null; if (cmdletContext.Configuration_BillingMethod != null) { requestConfiguration_configuration_BillingMethod = cmdletContext.Configuration_BillingMethod; } if (requestConfiguration_configuration_BillingMethod != null) { request.Configuration.BillingMethod = requestConfiguration_configuration_BillingMethod; requestConfigurationIsNull = false; } List requestConfiguration_configuration_VpceConfigurationArn = null; if (cmdletContext.Configuration_VpceConfigurationArn != null) { requestConfiguration_configuration_VpceConfigurationArn = cmdletContext.Configuration_VpceConfigurationArn; } if (requestConfiguration_configuration_VpceConfigurationArn != null) { request.Configuration.VpceConfigurationArns = requestConfiguration_configuration_VpceConfigurationArn; requestConfigurationIsNull = false; } // determine if request.Configuration should be set to null if (requestConfigurationIsNull) { request.Configuration = null; } if (cmdletContext.DeviceArn != null) { request.DeviceArn = cmdletContext.DeviceArn; } if (cmdletContext.InstanceArn != null) { request.InstanceArn = cmdletContext.InstanceArn; } if (cmdletContext.InteractionMode != null) { request.InteractionMode = cmdletContext.InteractionMode; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.ProjectArn != null) { request.ProjectArn = cmdletContext.ProjectArn; } if (cmdletContext.RemoteDebugEnabled != null) { request.RemoteDebugEnabled = cmdletContext.RemoteDebugEnabled.Value; } if (cmdletContext.RemoteRecordAppArn != null) { request.RemoteRecordAppArn = cmdletContext.RemoteRecordAppArn; } if (cmdletContext.RemoteRecordEnabled != null) { request.RemoteRecordEnabled = cmdletContext.RemoteRecordEnabled.Value; } if (cmdletContext.SkipAppResign != null) { request.SkipAppResign = cmdletContext.SkipAppResign.Value; } if (cmdletContext.SshPublicKey != null) { request.SshPublicKey = cmdletContext.SshPublicKey; } 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.DeviceFarm.Model.CreateRemoteAccessSessionResponse CallAWSServiceOperation(IAmazonDeviceFarm client, Amazon.DeviceFarm.Model.CreateRemoteAccessSessionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Device Farm", "CreateRemoteAccessSession"); try { #if DESKTOP return client.CreateRemoteAccessSession(request); #elif CORECLR return client.CreateRemoteAccessSessionAsync(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 ClientId { get; set; } public Amazon.DeviceFarm.BillingMethod Configuration_BillingMethod { get; set; } public List Configuration_VpceConfigurationArn { get; set; } public System.String DeviceArn { get; set; } public System.String InstanceArn { get; set; } public Amazon.DeviceFarm.InteractionMode InteractionMode { get; set; } public System.String Name { get; set; } public System.String ProjectArn { get; set; } public System.Boolean? RemoteDebugEnabled { get; set; } public System.String RemoteRecordAppArn { get; set; } public System.Boolean? RemoteRecordEnabled { get; set; } public System.Boolean? SkipAppResign { get; set; } public System.String SshPublicKey { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.RemoteAccessSession; } } }