/******************************************************************************* * 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.Rekognition; using Amazon.Rekognition.Model; namespace Amazon.PowerShell.Cmdlets.REK { /// /// Creates a new version of a model and begins training. Models are managed as part of /// an Amazon Rekognition Custom Labels project. The response from CreateProjectVersion /// is an Amazon Resource Name (ARN) for the version of the model. /// /// /// /// Training uses the training and test datasets associated with the project. For more /// information, see Creating training and test dataset in the Amazon Rekognition Custom /// Labels Developer Guide. /// /// You can train a model in a project that doesn't have associated datasets by specifying /// manifest files in the TrainingData and TestingData fields. /// /// /// If you open the console after training a model with manifest files, Amazon Rekognition /// Custom Labels creates the datasets for you using the most recent manifest files. You /// can no longer train a model version for the project by specifying manifest files. /// /// /// Instead of training with a project without associated datasets, we recommend that /// you use the manifest files to create training and test datasets for the project. /// /// Training takes a while to complete. You can get the current status by calling DescribeProjectVersions. /// Training completed successfully if the value of the Status field is TRAINING_COMPLETED. /// /// If training fails, see Debugging a failed model training in the Amazon Rekognition /// Custom Labels developer guide. /// /// Once training has successfully completed, call DescribeProjectVersions to get /// the training results and evaluate the model. For more information, see Improving a /// trained Amazon Rekognition Custom Labels model in the Amazon Rekognition Custom /// Labels developers guide. /// /// After evaluating the model, you start the model by calling StartProjectVersion. /// /// This operation requires permissions to perform the rekognition:CreateProjectVersion /// action. /// /// [Cmdlet("New", "REKProjectVersion", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the Amazon Rekognition CreateProjectVersion API operation.", Operation = new[] {"CreateProjectVersion"}, SelectReturnType = typeof(Amazon.Rekognition.Model.CreateProjectVersionResponse))] [AWSCmdletOutput("System.String or Amazon.Rekognition.Model.CreateProjectVersionResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Rekognition.Model.CreateProjectVersionResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class NewREKProjectVersionCmdlet : AmazonRekognitionClientCmdlet, IExecutor { #region Parameter TestingData_Asset /// /// /// The assets used for testing. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TestingData_Assets")] public Amazon.Rekognition.Model.Asset[] TestingData_Asset { get; set; } #endregion #region Parameter TrainingData_Asset /// /// /// A Sagemaker GroundTruth manifest file that contains the training images (assets). /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("TrainingData_Assets")] public Amazon.Rekognition.Model.Asset[] TrainingData_Asset { get; set; } #endregion #region Parameter TestingData_AutoCreate /// /// /// If specified, Amazon Rekognition Custom Labels temporarily splits the training dataset /// (80%) to create a test dataset (20%) for the training job. After training completes, /// the test dataset is not stored and the training dataset reverts to its previous size. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? TestingData_AutoCreate { get; set; } #endregion #region Parameter KmsKeyId /// /// /// The identifier for your AWS Key Management Service key (AWS KMS key). You can supply /// the Amazon Resource Name (ARN) of your KMS key, the ID of your KMS key, an alias for /// your KMS key, or an alias ARN. The key is used to encrypt training and test images /// copied into the service for model training. Your source images are unaffected. The /// key is also used to encrypt training results and manifest files written to the output /// Amazon S3 bucket (OutputConfig).If you choose to use your own KMS key, you need the following permissions on the KMS /// key.If you don't specify a value for KmsKeyId, images copied into the service /// are encrypted using a key that AWS owns and manages. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String KmsKeyId { get; set; } #endregion #region Parameter ProjectArn /// /// /// The ARN of the Amazon Rekognition Custom Labels project that manages the model that /// you want to train. /// /// #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 OutputConfig_S3Bucket /// /// /// The S3 bucket where training output is placed. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OutputConfig_S3Bucket { get; set; } #endregion #region Parameter OutputConfig_S3KeyPrefix /// /// /// The prefix applied to the training output files. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String OutputConfig_S3KeyPrefix { get; set; } #endregion #region Parameter Tag /// /// /// A set of tags (key-value pairs) that you want to attach to the model. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Tags")] public System.Collections.Hashtable Tag { get; set; } #endregion #region Parameter VersionName /// /// /// A name for the version of the model. This value must be unique. /// /// #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 VersionName { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ProjectVersionArn'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Rekognition.Model.CreateProjectVersionResponse). /// Specifying the name of a property of type Amazon.Rekognition.Model.CreateProjectVersionResponse 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; } = "ProjectVersionArn"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the VersionName parameter. /// The -PassThru parameter is deprecated, use -Select '^VersionName' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^VersionName' 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.VersionName), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "New-REKProjectVersion (CreateProjectVersion)")) { 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.VersionName; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.KmsKeyId = this.KmsKeyId; context.OutputConfig_S3Bucket = this.OutputConfig_S3Bucket; context.OutputConfig_S3KeyPrefix = this.OutputConfig_S3KeyPrefix; 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 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])); } } if (this.TestingData_Asset != null) { context.TestingData_Asset = new List(this.TestingData_Asset); } context.TestingData_AutoCreate = this.TestingData_AutoCreate; if (this.TrainingData_Asset != null) { context.TrainingData_Asset = new List(this.TrainingData_Asset); } context.VersionName = this.VersionName; #if MODULAR if (this.VersionName == null && ParameterWasBound(nameof(this.VersionName))) { WriteWarning("You are passing $null as a value for parameter VersionName 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.Rekognition.Model.CreateProjectVersionRequest(); if (cmdletContext.KmsKeyId != null) { request.KmsKeyId = cmdletContext.KmsKeyId; } // populate OutputConfig var requestOutputConfigIsNull = true; request.OutputConfig = new Amazon.Rekognition.Model.OutputConfig(); System.String requestOutputConfig_outputConfig_S3Bucket = null; if (cmdletContext.OutputConfig_S3Bucket != null) { requestOutputConfig_outputConfig_S3Bucket = cmdletContext.OutputConfig_S3Bucket; } if (requestOutputConfig_outputConfig_S3Bucket != null) { request.OutputConfig.S3Bucket = requestOutputConfig_outputConfig_S3Bucket; requestOutputConfigIsNull = false; } System.String requestOutputConfig_outputConfig_S3KeyPrefix = null; if (cmdletContext.OutputConfig_S3KeyPrefix != null) { requestOutputConfig_outputConfig_S3KeyPrefix = cmdletContext.OutputConfig_S3KeyPrefix; } if (requestOutputConfig_outputConfig_S3KeyPrefix != null) { request.OutputConfig.S3KeyPrefix = requestOutputConfig_outputConfig_S3KeyPrefix; requestOutputConfigIsNull = false; } // determine if request.OutputConfig should be set to null if (requestOutputConfigIsNull) { request.OutputConfig = null; } if (cmdletContext.ProjectArn != null) { request.ProjectArn = cmdletContext.ProjectArn; } if (cmdletContext.Tag != null) { request.Tags = cmdletContext.Tag; } // populate TestingData var requestTestingDataIsNull = true; request.TestingData = new Amazon.Rekognition.Model.TestingData(); List requestTestingData_testingData_Asset = null; if (cmdletContext.TestingData_Asset != null) { requestTestingData_testingData_Asset = cmdletContext.TestingData_Asset; } if (requestTestingData_testingData_Asset != null) { request.TestingData.Assets = requestTestingData_testingData_Asset; requestTestingDataIsNull = false; } System.Boolean? requestTestingData_testingData_AutoCreate = null; if (cmdletContext.TestingData_AutoCreate != null) { requestTestingData_testingData_AutoCreate = cmdletContext.TestingData_AutoCreate.Value; } if (requestTestingData_testingData_AutoCreate != null) { request.TestingData.AutoCreate = requestTestingData_testingData_AutoCreate.Value; requestTestingDataIsNull = false; } // determine if request.TestingData should be set to null if (requestTestingDataIsNull) { request.TestingData = null; } // populate TrainingData var requestTrainingDataIsNull = true; request.TrainingData = new Amazon.Rekognition.Model.TrainingData(); List requestTrainingData_trainingData_Asset = null; if (cmdletContext.TrainingData_Asset != null) { requestTrainingData_trainingData_Asset = cmdletContext.TrainingData_Asset; } if (requestTrainingData_trainingData_Asset != null) { request.TrainingData.Assets = requestTrainingData_trainingData_Asset; requestTrainingDataIsNull = false; } // determine if request.TrainingData should be set to null if (requestTrainingDataIsNull) { request.TrainingData = null; } if (cmdletContext.VersionName != null) { request.VersionName = cmdletContext.VersionName; } 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.Rekognition.Model.CreateProjectVersionResponse CallAWSServiceOperation(IAmazonRekognition client, Amazon.Rekognition.Model.CreateProjectVersionRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon Rekognition", "CreateProjectVersion"); try { #if DESKTOP return client.CreateProjectVersion(request); #elif CORECLR return client.CreateProjectVersionAsync(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 KmsKeyId { get; set; } public System.String OutputConfig_S3Bucket { get; set; } public System.String OutputConfig_S3KeyPrefix { get; set; } public System.String ProjectArn { get; set; } public Dictionary Tag { get; set; } public List TestingData_Asset { get; set; } public System.Boolean? TestingData_AutoCreate { get; set; } public List TrainingData_Asset { get; set; } public System.String VersionName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ProjectVersionArn; } } }