/******************************************************************************* * 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.LookoutforVision; using Amazon.LookoutforVision.Model; namespace Amazon.PowerShell.Cmdlets.LFV { /// /// Stops the hosting of a running model. The operation might take a while to complete. /// To check the current status, call DescribeModel. /// /// /// /// After the model hosting stops, the Status of the model is TRAINED. /// /// This operation requires permissions to perform the lookoutvision:StopModel /// operation. /// /// [Cmdlet("Stop", "LFVModel", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.LookoutforVision.ModelHostingStatus")] [AWSCmdlet("Calls the Amazon Lookout for Vision StopModel API operation.", Operation = new[] {"StopModel"}, SelectReturnType = typeof(Amazon.LookoutforVision.Model.StopModelResponse))] [AWSCmdletOutput("Amazon.LookoutforVision.ModelHostingStatus or Amazon.LookoutforVision.Model.StopModelResponse", "This cmdlet returns an Amazon.LookoutforVision.ModelHostingStatus object.", "The service call response (type Amazon.LookoutforVision.Model.StopModelResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StopLFVModelCmdlet : AmazonLookoutforVisionClientCmdlet, IExecutor { #region Parameter ModelVersion /// /// /// The version of the model that you want to stop. /// /// #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 ModelVersion { get; set; } #endregion #region Parameter ProjectName /// /// /// The name of the project that contains the model that you want to stop. /// /// #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 ProjectName { get; set; } #endregion #region Parameter ClientToken /// /// /// ClientToken is an idempotency token that ensures a call to StopModel /// completes only once. You choose the value to pass. For example, An issue might prevent /// you from getting a response from StopModel. In this case, safely retry /// your call to StopModel by using the same ClientToken parameter /// value.If you don't supply a value for ClientToken, the AWS SDK you are using /// inserts a value for you. This prevents retries after a network error from making multiple /// stop requests. You'll need to provide your own value for other use cases. An error occurs if the other input parameters are not the same as in the first request. /// Using a different value for ClientToken is considered a new call to StopModel. /// An idempotency token is active for 8 hours. /// /// [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 'Status'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.LookoutforVision.Model.StopModelResponse). /// Specifying the name of a property of type Amazon.LookoutforVision.Model.StopModelResponse 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; } = "Status"; #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.ProjectName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Stop-LFVModel (StopModel)")) { return; } var context = new CmdletContext(); // allow for manipulation of parameters prior to loading into context PreExecutionContextLoad(context); if (ParameterWasBound(nameof(this.Select))) { context.Select = CreateSelectDelegate(Select) ?? throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select)); } context.ClientToken = this.ClientToken; context.ModelVersion = this.ModelVersion; #if MODULAR if (this.ModelVersion == null && ParameterWasBound(nameof(this.ModelVersion))) { WriteWarning("You are passing $null as a value for parameter ModelVersion 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.ProjectName = this.ProjectName; #if MODULAR if (this.ProjectName == null && ParameterWasBound(nameof(this.ProjectName))) { WriteWarning("You are passing $null as a value for parameter ProjectName 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.LookoutforVision.Model.StopModelRequest(); if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } if (cmdletContext.ModelVersion != null) { request.ModelVersion = cmdletContext.ModelVersion; } if (cmdletContext.ProjectName != null) { request.ProjectName = cmdletContext.ProjectName; } 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.LookoutforVision.Model.StopModelResponse CallAWSServiceOperation(IAmazonLookoutforVision client, Amazon.LookoutforVision.Model.StopModelRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Lookout for Vision", "StopModel"); try { #if DESKTOP return client.StopModel(request); #elif CORECLR return client.StopModelAsync(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 System.String ModelVersion { get; set; } public System.String ProjectName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.Status; } } }