/******************************************************************************* * 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 { /// /// Once you have a ruleset definition (either recommended or your own), you call this /// operation to evaluate the ruleset against a data source (Glue table). The evaluation /// computes results which you can retrieve with the GetDataQualityResult /// API. /// [Cmdlet("Start", "GLUEDataQualityRulesetEvaluationRun", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("System.String")] [AWSCmdlet("Calls the AWS Glue StartDataQualityRulesetEvaluationRun API operation.", Operation = new[] {"StartDataQualityRulesetEvaluationRun"}, SelectReturnType = typeof(Amazon.Glue.Model.StartDataQualityRulesetEvaluationRunResponse))] [AWSCmdletOutput("System.String or Amazon.Glue.Model.StartDataQualityRulesetEvaluationRunResponse", "This cmdlet returns a System.String object.", "The service call response (type Amazon.Glue.Model.StartDataQualityRulesetEvaluationRunResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartGLUEDataQualityRulesetEvaluationRunCmdlet : AmazonGlueClientCmdlet, IExecutor { #region Parameter AdditionalDataSource /// /// /// A map of reference strings to additional data sources you can specify for an evaluation /// run. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("AdditionalDataSources")] public System.Collections.Hashtable AdditionalDataSource { get; set; } #endregion #region Parameter GlueTable_AdditionalOption /// /// /// Additional options for the table. Currently there are two keys supported: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DataSource_GlueTable_AdditionalOptions")] public System.Collections.Hashtable GlueTable_AdditionalOption { get; set; } #endregion #region Parameter GlueTable_CatalogId /// /// /// A unique identifier for the Glue Data Catalog. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DataSource_GlueTable_CatalogId")] public System.String GlueTable_CatalogId { get; set; } #endregion #region Parameter AdditionalRunOptions_CloudWatchMetricsEnabled /// /// /// Whether or not to enable CloudWatch metrics. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.Boolean? AdditionalRunOptions_CloudWatchMetricsEnabled { get; set; } #endregion #region Parameter GlueTable_ConnectionName /// /// /// The name of the connection to the Glue Data Catalog. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("DataSource_GlueTable_ConnectionName")] public System.String GlueTable_ConnectionName { get; set; } #endregion #region Parameter GlueTable_DatabaseName /// /// /// A database name in the Glue Data Catalog. /// /// #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] [Alias("DataSource_GlueTable_DatabaseName")] public System.String GlueTable_DatabaseName { get; set; } #endregion #region Parameter NumberOfWorker /// /// /// The number of G.1X workers to be used in the run. The default is 5. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("NumberOfWorkers")] public System.Int32? NumberOfWorker { get; set; } #endregion #region Parameter AdditionalRunOptions_ResultsS3Prefix /// /// /// Prefix for Amazon S3 to store results. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String AdditionalRunOptions_ResultsS3Prefix { get; set; } #endregion #region Parameter Role /// /// /// An IAM role supplied to encrypt the results of the run. /// /// #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 Role { get; set; } #endregion #region Parameter RulesetName /// /// /// A list of ruleset names. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowEmptyCollection] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [Alias("RulesetNames")] public System.String[] RulesetName { get; set; } #endregion #region Parameter GlueTable_TableName /// /// /// A table name in the Glue Data Catalog. /// /// #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] [Alias("DataSource_GlueTable_TableName")] public System.String GlueTable_TableName { get; set; } #endregion #region Parameter Timeout /// /// /// The timeout for a run in minutes. This is the maximum time that a run 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 ClientToken /// /// /// Used for idempotency and is recommended to be set to a random ID (such as a UUID) /// to avoid creating or starting multiple instances of the same resource. /// /// [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 'RunId'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Glue.Model.StartDataQualityRulesetEvaluationRunResponse). /// Specifying the name of a property of type Amazon.Glue.Model.StartDataQualityRulesetEvaluationRunResponse 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; } = "RunId"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the Role parameter. /// The -PassThru parameter is deprecated, use -Select '^Role' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Role' 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 = string.Empty; if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-GLUEDataQualityRulesetEvaluationRun (StartDataQualityRulesetEvaluationRun)")) { 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.Role; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute if (this.AdditionalDataSource != null) { context.AdditionalDataSource = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.AdditionalDataSource.Keys) { context.AdditionalDataSource.Add((String)hashKey, (DataSource)(this.AdditionalDataSource[hashKey])); } } context.AdditionalRunOptions_CloudWatchMetricsEnabled = this.AdditionalRunOptions_CloudWatchMetricsEnabled; context.AdditionalRunOptions_ResultsS3Prefix = this.AdditionalRunOptions_ResultsS3Prefix; context.ClientToken = this.ClientToken; if (this.GlueTable_AdditionalOption != null) { context.GlueTable_AdditionalOption = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.GlueTable_AdditionalOption.Keys) { context.GlueTable_AdditionalOption.Add((String)hashKey, (String)(this.GlueTable_AdditionalOption[hashKey])); } } context.GlueTable_CatalogId = this.GlueTable_CatalogId; context.GlueTable_ConnectionName = this.GlueTable_ConnectionName; context.GlueTable_DatabaseName = this.GlueTable_DatabaseName; #if MODULAR if (this.GlueTable_DatabaseName == null && ParameterWasBound(nameof(this.GlueTable_DatabaseName))) { WriteWarning("You are passing $null as a value for parameter GlueTable_DatabaseName 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.GlueTable_TableName = this.GlueTable_TableName; #if MODULAR if (this.GlueTable_TableName == null && ParameterWasBound(nameof(this.GlueTable_TableName))) { WriteWarning("You are passing $null as a value for parameter GlueTable_TableName 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.NumberOfWorker = this.NumberOfWorker; context.Role = this.Role; #if MODULAR if (this.Role == null && ParameterWasBound(nameof(this.Role))) { WriteWarning("You are passing $null as a value for parameter Role 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.RulesetName != null) { context.RulesetName = new List(this.RulesetName); } #if MODULAR if (this.RulesetName == null && ParameterWasBound(nameof(this.RulesetName))) { WriteWarning("You are passing $null as a value for parameter RulesetName 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.Timeout = this.Timeout; // 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.StartDataQualityRulesetEvaluationRunRequest(); if (cmdletContext.AdditionalDataSource != null) { request.AdditionalDataSources = cmdletContext.AdditionalDataSource; } // populate AdditionalRunOptions var requestAdditionalRunOptionsIsNull = true; request.AdditionalRunOptions = new Amazon.Glue.Model.DataQualityEvaluationRunAdditionalRunOptions(); System.Boolean? requestAdditionalRunOptions_additionalRunOptions_CloudWatchMetricsEnabled = null; if (cmdletContext.AdditionalRunOptions_CloudWatchMetricsEnabled != null) { requestAdditionalRunOptions_additionalRunOptions_CloudWatchMetricsEnabled = cmdletContext.AdditionalRunOptions_CloudWatchMetricsEnabled.Value; } if (requestAdditionalRunOptions_additionalRunOptions_CloudWatchMetricsEnabled != null) { request.AdditionalRunOptions.CloudWatchMetricsEnabled = requestAdditionalRunOptions_additionalRunOptions_CloudWatchMetricsEnabled.Value; requestAdditionalRunOptionsIsNull = false; } System.String requestAdditionalRunOptions_additionalRunOptions_ResultsS3Prefix = null; if (cmdletContext.AdditionalRunOptions_ResultsS3Prefix != null) { requestAdditionalRunOptions_additionalRunOptions_ResultsS3Prefix = cmdletContext.AdditionalRunOptions_ResultsS3Prefix; } if (requestAdditionalRunOptions_additionalRunOptions_ResultsS3Prefix != null) { request.AdditionalRunOptions.ResultsS3Prefix = requestAdditionalRunOptions_additionalRunOptions_ResultsS3Prefix; requestAdditionalRunOptionsIsNull = false; } // determine if request.AdditionalRunOptions should be set to null if (requestAdditionalRunOptionsIsNull) { request.AdditionalRunOptions = null; } if (cmdletContext.ClientToken != null) { request.ClientToken = cmdletContext.ClientToken; } // populate DataSource var requestDataSourceIsNull = true; request.DataSource = new Amazon.Glue.Model.DataSource(); Amazon.Glue.Model.GlueTable requestDataSource_dataSource_GlueTable = null; // populate GlueTable var requestDataSource_dataSource_GlueTableIsNull = true; requestDataSource_dataSource_GlueTable = new Amazon.Glue.Model.GlueTable(); Dictionary requestDataSource_dataSource_GlueTable_glueTable_AdditionalOption = null; if (cmdletContext.GlueTable_AdditionalOption != null) { requestDataSource_dataSource_GlueTable_glueTable_AdditionalOption = cmdletContext.GlueTable_AdditionalOption; } if (requestDataSource_dataSource_GlueTable_glueTable_AdditionalOption != null) { requestDataSource_dataSource_GlueTable.AdditionalOptions = requestDataSource_dataSource_GlueTable_glueTable_AdditionalOption; requestDataSource_dataSource_GlueTableIsNull = false; } System.String requestDataSource_dataSource_GlueTable_glueTable_CatalogId = null; if (cmdletContext.GlueTable_CatalogId != null) { requestDataSource_dataSource_GlueTable_glueTable_CatalogId = cmdletContext.GlueTable_CatalogId; } if (requestDataSource_dataSource_GlueTable_glueTable_CatalogId != null) { requestDataSource_dataSource_GlueTable.CatalogId = requestDataSource_dataSource_GlueTable_glueTable_CatalogId; requestDataSource_dataSource_GlueTableIsNull = false; } System.String requestDataSource_dataSource_GlueTable_glueTable_ConnectionName = null; if (cmdletContext.GlueTable_ConnectionName != null) { requestDataSource_dataSource_GlueTable_glueTable_ConnectionName = cmdletContext.GlueTable_ConnectionName; } if (requestDataSource_dataSource_GlueTable_glueTable_ConnectionName != null) { requestDataSource_dataSource_GlueTable.ConnectionName = requestDataSource_dataSource_GlueTable_glueTable_ConnectionName; requestDataSource_dataSource_GlueTableIsNull = false; } System.String requestDataSource_dataSource_GlueTable_glueTable_DatabaseName = null; if (cmdletContext.GlueTable_DatabaseName != null) { requestDataSource_dataSource_GlueTable_glueTable_DatabaseName = cmdletContext.GlueTable_DatabaseName; } if (requestDataSource_dataSource_GlueTable_glueTable_DatabaseName != null) { requestDataSource_dataSource_GlueTable.DatabaseName = requestDataSource_dataSource_GlueTable_glueTable_DatabaseName; requestDataSource_dataSource_GlueTableIsNull = false; } System.String requestDataSource_dataSource_GlueTable_glueTable_TableName = null; if (cmdletContext.GlueTable_TableName != null) { requestDataSource_dataSource_GlueTable_glueTable_TableName = cmdletContext.GlueTable_TableName; } if (requestDataSource_dataSource_GlueTable_glueTable_TableName != null) { requestDataSource_dataSource_GlueTable.TableName = requestDataSource_dataSource_GlueTable_glueTable_TableName; requestDataSource_dataSource_GlueTableIsNull = false; } // determine if requestDataSource_dataSource_GlueTable should be set to null if (requestDataSource_dataSource_GlueTableIsNull) { requestDataSource_dataSource_GlueTable = null; } if (requestDataSource_dataSource_GlueTable != null) { request.DataSource.GlueTable = requestDataSource_dataSource_GlueTable; requestDataSourceIsNull = false; } // determine if request.DataSource should be set to null if (requestDataSourceIsNull) { request.DataSource = null; } if (cmdletContext.NumberOfWorker != null) { request.NumberOfWorkers = cmdletContext.NumberOfWorker.Value; } if (cmdletContext.Role != null) { request.Role = cmdletContext.Role; } if (cmdletContext.RulesetName != null) { request.RulesetNames = cmdletContext.RulesetName; } if (cmdletContext.Timeout != null) { request.Timeout = cmdletContext.Timeout.Value; } 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.StartDataQualityRulesetEvaluationRunResponse CallAWSServiceOperation(IAmazonGlue client, Amazon.Glue.Model.StartDataQualityRulesetEvaluationRunRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Glue", "StartDataQualityRulesetEvaluationRun"); try { #if DESKTOP return client.StartDataQualityRulesetEvaluationRun(request); #elif CORECLR return client.StartDataQualityRulesetEvaluationRunAsync(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 Dictionary AdditionalDataSource { get; set; } public System.Boolean? AdditionalRunOptions_CloudWatchMetricsEnabled { get; set; } public System.String AdditionalRunOptions_ResultsS3Prefix { get; set; } public System.String ClientToken { get; set; } public Dictionary GlueTable_AdditionalOption { get; set; } public System.String GlueTable_CatalogId { get; set; } public System.String GlueTable_ConnectionName { get; set; } public System.String GlueTable_DatabaseName { get; set; } public System.String GlueTable_TableName { get; set; } public System.Int32? NumberOfWorker { get; set; } public System.String Role { get; set; } public List RulesetName { get; set; } public System.Int32? Timeout { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.RunId; } } }