/******************************************************************************* * 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.Glue; using Amazon.Glue.Model; namespace Amazon.PowerShell.Cmdlets.GLUE { /// /// Updates an existing machine learning transform. Call this operation to tune the algorithm /// parameters to achieve better results. /// /// /// /// After calling this operation, you can call the StartMLEvaluationTaskRun /// operation to assess how well your new parameters achieved your goals (such as improving /// the quality of your machine learning transform, or making it more cost-effective). /// /// [Cmdlet("Update", "GLUEMLTransform", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS Glue UpdateMLTransform API operation.", Operation = new[] {"UpdateMLTransform"}, SelectReturnType = typeof(Amazon.Glue.Model.UpdateMLTransformResponse))] [AWSCmdletOutput("System.String or Amazon.Glue.Model.UpdateMLTransformResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Glue.Model.UpdateMLTransformResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class UpdateGLUEMLTransformCmdlet : AmazonGlueClientCmdlet, IExecutor { #region Parameter FindMatchesParameters_AccuracyCostTradeoff /// /// /// The value that is selected when tuning your transform for a balance between accuracy /// and cost. A value of 0.5 means that the system balances accuracy and cost concerns. /// A value of 1.0 means a bias purely for accuracy, which typically results in a higher /// cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, /// which results in a less accurate FindMatches transform, sometimes with /// unacceptable accuracy.Accuracy measures how well the transform finds true positives and true negatives. /// Increasing accuracy requires more machine resources and cost. But it also results /// in increased recall. Cost measures how many compute resources, and thus money, are consumed to run the /// transform. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Parameters_FindMatchesParameters_AccuracyCostTradeoff")] public System.Double? FindMatchesParameters_AccuracyCostTradeoff { get; set; } #endregion #region Parameter Description /// /// /// A description of the transform. The default is an empty string. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Description { get; set; } #endregion #region Parameter FindMatchesParameters_EnforceProvidedLabel /// /// /// The value to switch on or off to force the output to match the provided labels from /// users. If the value is True, the find matches transform /// forces the output to match the provided labels. The results override the normal conflation /// results. If the value is False, the find matches transform /// does not ensure all the labels provided are respected, and the results rely on the /// trained model.Note that setting this value to true may increase the conflation execution time. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Parameters_FindMatchesParameters_EnforceProvidedLabels")] public System.Boolean? FindMatchesParameters_EnforceProvidedLabel { get; set; } #endregion #region Parameter GlueVersion /// /// /// This value determines which version of Glue this machine learning transform is compatible /// with. Glue 1.0 is recommended for most customers. If the value is not set, the Glue /// compatibility defaults to Glue 0.9. For more information, see Glue /// Versions in the developer guide. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String GlueVersion { get; set; } #endregion #region Parameter MaxCapacity /// /// /// The number of Glue data processing units (DPUs) that are allocated to task runs for /// this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a /// relative measure of processing power that consists of 4 vCPUs of compute capacity /// and 16 GB of memory. For more information, see the Glue /// pricing page. When the WorkerType field is set to a value other than Standard, /// the MaxCapacity field is set automatically and becomes read-only. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Double? MaxCapacity { get; set; } #endregion #region Parameter MaxRetry /// /// /// The maximum number of times to retry a task for this transform after a task run fails. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MaxRetries")] public System.Int32? MaxRetry { get; set; } #endregion #region Parameter Name /// /// /// The unique name that you gave the transform when you created it. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Name { get; set; } #endregion #region Parameter NumberOfWorker /// /// /// The number of workers of a defined workerType that are allocated when /// this task runs. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NumberOfWorkers")] public System.Int32? NumberOfWorker { get; set; } #endregion #region Parameter FindMatchesParameters_PrecisionRecallTradeoff /// /// /// The value selected when tuning your transform for a balance between precision and /// recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for /// precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, /// choosing values close to 1.0 means very low recall, and choosing values close to 0.0 /// results in very low precision.The precision metric indicates how often your model is correct when it predicts a /// match. The recall metric indicates that for an actual match, how often your model predicts /// the match. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Parameters_FindMatchesParameters_PrecisionRecallTradeoff")] public System.Double? FindMatchesParameters_PrecisionRecallTradeoff { get; set; } #endregion #region Parameter FindMatchesParameters_PrimaryKeyColumnName /// /// /// The name of a column that uniquely identifies rows in the source table. Used to help /// identify matching records. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Parameters_FindMatchesParameters_PrimaryKeyColumnName")] public System.String FindMatchesParameters_PrimaryKeyColumnName { get; set; } #endregion #region Parameter Role /// /// /// The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Role { get; set; } #endregion #region Parameter Timeout /// /// /// The timeout for a task run for this transform in minutes. This is the maximum time /// that a task run for this transform can consume resources before it is terminated and /// enters TIMEOUT status. The default is 2,880 minutes (48 hours). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Int32? Timeout { get; set; } #endregion #region Parameter TransformId /// /// /// A unique identifier that was generated when the transform was created. /// /// #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 TransformId { get; set; } #endregion #region Parameter Parameters_TransformType /// /// /// The type of machine learning transform.For information about the types of machine learning transforms, see Creating /// Machine Learning Transforms. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Glue.TransformType")] public Amazon.Glue.TransformType Parameters_TransformType { get; set; } #endregion #region Parameter WorkerType /// /// /// The type of predefined worker that is allocated when this task runs. Accepts a value /// of Standard, G.1X, or G.2X. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [AWSConstantClassSource("Amazon.Glue.WorkerType")] public Amazon.Glue.WorkerType WorkerType { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'TransformId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.UpdateMLTransformResponse). /// Specifying the name of a property of type Amazon.Glue.Model.UpdateMLTransformResponse 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; } = "TransformId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the TransformId parameter. /// The -PassThru parameter is deprecated, use -Select '^TransformId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^TransformId' 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.TransformId), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Update-GLUEMLTransform (UpdateMLTransform)")) { 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.TransformId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Description = this.Description; context.GlueVersion = this.GlueVersion; context.MaxCapacity = this.MaxCapacity; context.MaxRetry = this.MaxRetry; context.Name = this.Name; context.NumberOfWorker = this.NumberOfWorker; context.FindMatchesParameters_AccuracyCostTradeoff = this.FindMatchesParameters_AccuracyCostTradeoff; context.FindMatchesParameters_EnforceProvidedLabel = this.FindMatchesParameters_EnforceProvidedLabel; context.FindMatchesParameters_PrecisionRecallTradeoff = this.FindMatchesParameters_PrecisionRecallTradeoff; context.FindMatchesParameters_PrimaryKeyColumnName = this.FindMatchesParameters_PrimaryKeyColumnName; context.Parameters_TransformType = this.Parameters_TransformType; context.Role = this.Role; context.Timeout = this.Timeout; context.TransformId = this.TransformId; #if MODULAR if (this.TransformId == null && ParameterWasBound(nameof(this.TransformId))) { WriteWarning("You are passing $null as a value for parameter TransformId 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.WorkerType = this.WorkerType; // 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.Glue.Model.UpdateMLTransformRequest(); if (cmdletContext.Description != null) { request.Description = cmdletContext.Description; } if (cmdletContext.GlueVersion != null) { request.GlueVersion = cmdletContext.GlueVersion; } if (cmdletContext.MaxCapacity != null) { request.MaxCapacity = cmdletContext.MaxCapacity.Value; } if (cmdletContext.MaxRetry != null) { request.MaxRetries = cmdletContext.MaxRetry.Value; } if (cmdletContext.Name != null) { request.Name = cmdletContext.Name; } if (cmdletContext.NumberOfWorker != null) { request.NumberOfWorkers = cmdletContext.NumberOfWorker.Value; } // populate Parameters var requestParametersIsNull = true; request.Parameters = new Amazon.Glue.Model.TransformParameters(); Amazon.Glue.TransformType requestParameters_parameters_TransformType = null; if (cmdletContext.Parameters_TransformType != null) { requestParameters_parameters_TransformType = cmdletContext.Parameters_TransformType; } if (requestParameters_parameters_TransformType != null) { request.Parameters.TransformType = requestParameters_parameters_TransformType; requestParametersIsNull = false; } Amazon.Glue.Model.FindMatchesParameters requestParameters_parameters_FindMatchesParameters = null; // populate FindMatchesParameters var requestParameters_parameters_FindMatchesParametersIsNull = true; requestParameters_parameters_FindMatchesParameters = new Amazon.Glue.Model.FindMatchesParameters(); System.Double? requestParameters_parameters_FindMatchesParameters_findMatchesParameters_AccuracyCostTradeoff = null; if (cmdletContext.FindMatchesParameters_AccuracyCostTradeoff != null) { requestParameters_parameters_FindMatchesParameters_findMatchesParameters_AccuracyCostTradeoff = cmdletContext.FindMatchesParameters_AccuracyCostTradeoff.Value; } if (requestParameters_parameters_FindMatchesParameters_findMatchesParameters_AccuracyCostTradeoff != null) { requestParameters_parameters_FindMatchesParameters.AccuracyCostTradeoff = requestParameters_parameters_FindMatchesParameters_findMatchesParameters_AccuracyCostTradeoff.Value; requestParameters_parameters_FindMatchesParametersIsNull = false; } System.Boolean? requestParameters_parameters_FindMatchesParameters_findMatchesParameters_EnforceProvidedLabel = null; if (cmdletContext.FindMatchesParameters_EnforceProvidedLabel != null) { requestParameters_parameters_FindMatchesParameters_findMatchesParameters_EnforceProvidedLabel = cmdletContext.FindMatchesParameters_EnforceProvidedLabel.Value; } if (requestParameters_parameters_FindMatchesParameters_findMatchesParameters_EnforceProvidedLabel != null) { requestParameters_parameters_FindMatchesParameters.EnforceProvidedLabels = requestParameters_parameters_FindMatchesParameters_findMatchesParameters_EnforceProvidedLabel.Value; requestParameters_parameters_FindMatchesParametersIsNull = false; } System.Double? requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrecisionRecallTradeoff = null; if (cmdletContext.FindMatchesParameters_PrecisionRecallTradeoff != null) { requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrecisionRecallTradeoff = cmdletContext.FindMatchesParameters_PrecisionRecallTradeoff.Value; } if (requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrecisionRecallTradeoff != null) { requestParameters_parameters_FindMatchesParameters.PrecisionRecallTradeoff = requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrecisionRecallTradeoff.Value; requestParameters_parameters_FindMatchesParametersIsNull = false; } System.String requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrimaryKeyColumnName = null; if (cmdletContext.FindMatchesParameters_PrimaryKeyColumnName != null) { requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrimaryKeyColumnName = cmdletContext.FindMatchesParameters_PrimaryKeyColumnName; } if (requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrimaryKeyColumnName != null) { requestParameters_parameters_FindMatchesParameters.PrimaryKeyColumnName = requestParameters_parameters_FindMatchesParameters_findMatchesParameters_PrimaryKeyColumnName; requestParameters_parameters_FindMatchesParametersIsNull = false; } // determine if requestParameters_parameters_FindMatchesParameters should be set to null if (requestParameters_parameters_FindMatchesParametersIsNull) { requestParameters_parameters_FindMatchesParameters = null; } if (requestParameters_parameters_FindMatchesParameters != null) { request.Parameters.FindMatchesParameters = requestParameters_parameters_FindMatchesParameters; requestParametersIsNull = false; } // determine if request.Parameters should be set to null if (requestParametersIsNull) { request.Parameters = null; } if (cmdletContext.Role != null) { request.Role = cmdletContext.Role; } if (cmdletContext.Timeout != null) { request.Timeout = cmdletContext.Timeout.Value; } if (cmdletContext.TransformId != null) { request.TransformId = cmdletContext.TransformId; } if (cmdletContext.WorkerType != null) { request.WorkerType = cmdletContext.WorkerType; } 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.Glue.Model.UpdateMLTransformResponse CallAWSServiceOperation(IAmazonGlue client, Amazon.Glue.Model.UpdateMLTransformRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Glue", "UpdateMLTransform"); try { #if DESKTOP return client.UpdateMLTransform(request); #elif CORECLR return client.UpdateMLTransformAsync(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 Description { get; set; } public System.String GlueVersion { get; set; } public System.Double? MaxCapacity { get; set; } public System.Int32? MaxRetry { get; set; } public System.String Name { get; set; } public System.Int32? NumberOfWorker { get; set; } public System.Double? FindMatchesParameters_AccuracyCostTradeoff { get; set; } public System.Boolean? FindMatchesParameters_EnforceProvidedLabel { get; set; } public System.Double? FindMatchesParameters_PrecisionRecallTradeoff { get; set; } public System.String FindMatchesParameters_PrimaryKeyColumnName { get; set; } public Amazon.Glue.TransformType Parameters_TransformType { get; set; } public System.String Role { get; set; } public System.Int32? Timeout { get; set; } public System.String TransformId { get; set; } public Amazon.Glue.WorkerType WorkerType { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.TransformId; } } }