/******************************************************************************* * 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 { /// /// Modifies the name, description, and rules in a device pool given the attributes and /// the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as /// a whole (or not at all). /// [Cmdlet("Update", "DFDevicePool", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.DeviceFarm.Model.DevicePool")] [AWSCmdlet("Calls the AWS Device Farm UpdateDevicePool API operation.", Operation = new[] {"UpdateDevicePool"}, SelectReturnType = typeof(Amazon.DeviceFarm.Model.UpdateDevicePoolResponse))] [AWSCmdletOutput("Amazon.DeviceFarm.Model.DevicePool or Amazon.DeviceFarm.Model.UpdateDevicePoolResponse", "This cmdlet returns an Amazon.DeviceFarm.Model.DevicePool object.", "The service call response (type Amazon.DeviceFarm.Model.UpdateDevicePoolResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateDFDevicePoolCmdlet : AmazonDeviceFarmClientCmdlet, IExecutor { #region Parameter Arn /// /// /// The Amazon Resource Name (ARN) of the Device Farm device pool to update. /// /// #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 Arn { get; set; } #endregion #region Parameter ClearMaxDevice /// /// /// Sets whether the maxDevices parameter applies to your device pool. If /// you set this parameter to true, the maxDevices parameter /// does not apply, and Device Farm does not limit the number of devices that it adds /// to your device pool. In this case, Device Farm adds all available devices that meet /// the criteria specified in the rules parameter.If you use this parameter in your request, you cannot use the maxDevices /// parameter in the same request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ClearMaxDevices")] public System.Boolean? ClearMaxDevice { get; set; } #endregion #region Parameter Description /// /// /// A description of the device pool to update. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter MaxDevice /// /// /// The number of devices that Device Farm can add to your device pool. Device Farm adds /// devices that are available and that meet the criteria that you assign for the rules /// parameter. Depending on how many devices meet these constraints, your device pool /// might contain fewer devices than the value for this parameter.By specifying the maximum number of devices, you can control the costs that you incur /// by running tests.If you use this parameter in your request, you cannot use the clearMaxDevices /// parameter in the same request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxDevices")] public System.Int32? MaxDevice { get; set; } #endregion #region Parameter Name /// /// /// A string that represents the name of the device pool to update. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Name { get; set; } #endregion #region Parameter Rule /// /// /// Represents the rules to modify for the device pool. Updating rules is optional. If /// you update rules for your request, the update replaces the existing rules. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Rules")] public Amazon.DeviceFarm.Model.Rule[] Rule { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'DevicePool'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.DeviceFarm.Model.UpdateDevicePoolResponse). /// Specifying the name of a property of type Amazon.DeviceFarm.Model.UpdateDevicePoolResponse 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; } = "DevicePool"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Arn parameter. /// The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Arn' 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.Arn), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-DFDevicePool (UpdateDevicePool)")) { 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.Arn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Arn = this.Arn; #if MODULAR if (this.Arn == null && ParameterWasBound(nameof(this.Arn))) { WriteWarning("You are passing $null as a value for parameter Arn 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.ClearMaxDevice = this.ClearMaxDevice; context.Description = this.Description; context.MaxDevice = this.MaxDevice; context.Name = this.Name; if (this.Rule != null) { context.Rule = new List(this.Rule); } // 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.UpdateDevicePoolRequest(); if (cmdletContext.Arn != null) { request.Arn = cmdletContext.Arn; } if (cmdletContext.ClearMaxDevice != null) { request.ClearMaxDevices = cmdletContext.ClearMaxDevice.Value; } if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.MaxDevice != null) { request.MaxDevices = cmdletContext.MaxDevice.Value; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.Rule != null) { request.Rules = cmdletContext.Rule; } 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.UpdateDevicePoolResponse CallAWSServiceOperation(IAmazonDeviceFarm client, Amazon.DeviceFarm.Model.UpdateDevicePoolRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Device Farm", "UpdateDevicePool"); try { #if DESKTOP return client.UpdateDevicePool(request); #elif CORECLR return client.UpdateDevicePoolAsync(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 Arn { get; set; } public System.Boolean? ClearMaxDevice { get; set; } public System.String Description { get; set; } public System.Int32? MaxDevice { get; set; } public System.String Name { get; set; } public List Rule { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.DevicePool; } } }