/******************************************************************************* * 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.CleanRooms; using Amazon.CleanRooms.Model; namespace Amazon.PowerShell.Cmdlets.CRS { /// /// Creates a protected query that is started by Clean Rooms . /// [Cmdlet("Start", "CRSProtectedQuery", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] [OutputType("Amazon.CleanRooms.Model.ProtectedQuery")] [AWSCmdlet("Calls the AWS Clean Rooms Service StartProtectedQuery API operation.", Operation = new[] {"StartProtectedQuery"}, SelectReturnType = typeof(Amazon.CleanRooms.Model.StartProtectedQueryResponse))] [AWSCmdletOutput("Amazon.CleanRooms.Model.ProtectedQuery or Amazon.CleanRooms.Model.StartProtectedQueryResponse", "This cmdlet returns an Amazon.CleanRooms.Model.ProtectedQuery object.", "The service call response (type Amazon.CleanRooms.Model.StartProtectedQueryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class StartCRSProtectedQueryCmdlet : AmazonCleanRoomsClientCmdlet, IExecutor { protected override bool IsSensitiveRequest { get; set; } = true; protected override bool IsSensitiveResponse { get; set; } = true; #region Parameter S3_Bucket /// /// /// The S3 bucket to unload the protected query results. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ResultConfiguration_OutputConfiguration_S3_Bucket")] public System.String S3_Bucket { get; set; } #endregion #region Parameter S3_KeyPrefix /// /// /// The S3 prefix to unload the protected query results. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ResultConfiguration_OutputConfiguration_S3_KeyPrefix")] public System.String S3_KeyPrefix { get; set; } #endregion #region Parameter MembershipIdentifier /// /// /// A unique identifier for the membership to run this query against. Currently accepts /// a membership ID. /// /// #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 MembershipIdentifier { get; set; } #endregion #region Parameter SqlParameters_QueryString /// /// /// The query string to be submitted. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String SqlParameters_QueryString { get; set; } #endregion #region Parameter S3_ResultFormat /// /// /// Intended file format of the result. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("ResultConfiguration_OutputConfiguration_S3_ResultFormat")] [AWSConstantClassSource("Amazon.CleanRooms.ResultFormat")] public Amazon.CleanRooms.ResultFormat S3_ResultFormat { get; set; } #endregion #region Parameter Type /// /// /// The type of the protected query to be started. /// /// #if !MODULAR [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] #else [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true, Mandatory = true)] [System.Management.Automation.AllowNull] #endif [Amazon.PowerShell.Common.AWSRequiredParameter] [AWSConstantClassSource("Amazon.CleanRooms.ProtectedQueryType")] public Amazon.CleanRooms.ProtectedQueryType Type { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'ProtectedQuery'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRooms.Model.StartProtectedQueryResponse). /// Specifying the name of a property of type Amazon.CleanRooms.Model.StartProtectedQueryResponse 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; } = "ProtectedQuery"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the MembershipIdentifier parameter. /// The -PassThru parameter is deprecated, use -Select '^MembershipIdentifier' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^MembershipIdentifier' 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.MembershipIdentifier), MyInvocation.BoundParameters); if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Start-CRSProtectedQuery (StartProtectedQuery)")) { 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.MembershipIdentifier; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.MembershipIdentifier = this.MembershipIdentifier; #if MODULAR if (this.MembershipIdentifier == null && ParameterWasBound(nameof(this.MembershipIdentifier))) { WriteWarning("You are passing $null as a value for parameter MembershipIdentifier 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.S3_Bucket = this.S3_Bucket; context.S3_KeyPrefix = this.S3_KeyPrefix; context.S3_ResultFormat = this.S3_ResultFormat; context.SqlParameters_QueryString = this.SqlParameters_QueryString; context.Type = this.Type; #if MODULAR if (this.Type == null && ParameterWasBound(nameof(this.Type))) { WriteWarning("You are passing $null as a value for parameter Type 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.CleanRooms.Model.StartProtectedQueryRequest(); if (cmdletContext.MembershipIdentifier != null) { request.MembershipIdentifier = cmdletContext.MembershipIdentifier; } // populate ResultConfiguration var requestResultConfigurationIsNull = true; request.ResultConfiguration = new Amazon.CleanRooms.Model.ProtectedQueryResultConfiguration(); Amazon.CleanRooms.Model.ProtectedQueryOutputConfiguration requestResultConfiguration_resultConfiguration_OutputConfiguration = null; // populate OutputConfiguration var requestResultConfiguration_resultConfiguration_OutputConfigurationIsNull = true; requestResultConfiguration_resultConfiguration_OutputConfiguration = new Amazon.CleanRooms.Model.ProtectedQueryOutputConfiguration(); Amazon.CleanRooms.Model.ProtectedQueryS3OutputConfiguration requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3 = null; // populate S3 var requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3IsNull = true; requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3 = new Amazon.CleanRooms.Model.ProtectedQueryS3OutputConfiguration(); System.String requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_Bucket = null; if (cmdletContext.S3_Bucket != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_Bucket = cmdletContext.S3_Bucket; } if (requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_Bucket != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3.Bucket = requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_Bucket; requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3IsNull = false; } System.String requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_KeyPrefix = null; if (cmdletContext.S3_KeyPrefix != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_KeyPrefix = cmdletContext.S3_KeyPrefix; } if (requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_KeyPrefix != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3.KeyPrefix = requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_KeyPrefix; requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3IsNull = false; } Amazon.CleanRooms.ResultFormat requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_ResultFormat = null; if (cmdletContext.S3_ResultFormat != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_ResultFormat = cmdletContext.S3_ResultFormat; } if (requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_ResultFormat != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3.ResultFormat = requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3_s3_ResultFormat; requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3IsNull = false; } // determine if requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3 should be set to null if (requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3IsNull) { requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3 = null; } if (requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3 != null) { requestResultConfiguration_resultConfiguration_OutputConfiguration.S3 = requestResultConfiguration_resultConfiguration_OutputConfiguration_resultConfiguration_OutputConfiguration_S3; requestResultConfiguration_resultConfiguration_OutputConfigurationIsNull = false; } // determine if requestResultConfiguration_resultConfiguration_OutputConfiguration should be set to null if (requestResultConfiguration_resultConfiguration_OutputConfigurationIsNull) { requestResultConfiguration_resultConfiguration_OutputConfiguration = null; } if (requestResultConfiguration_resultConfiguration_OutputConfiguration != null) { request.ResultConfiguration.OutputConfiguration = requestResultConfiguration_resultConfiguration_OutputConfiguration; requestResultConfigurationIsNull = false; } // determine if request.ResultConfiguration should be set to null if (requestResultConfigurationIsNull) { request.ResultConfiguration = null; } // populate SqlParameters var requestSqlParametersIsNull = true; request.SqlParameters = new Amazon.CleanRooms.Model.ProtectedQuerySQLParameters(); System.String requestSqlParameters_sqlParameters_QueryString = null; if (cmdletContext.SqlParameters_QueryString != null) { requestSqlParameters_sqlParameters_QueryString = cmdletContext.SqlParameters_QueryString; } if (requestSqlParameters_sqlParameters_QueryString != null) { request.SqlParameters.QueryString = requestSqlParameters_sqlParameters_QueryString; requestSqlParametersIsNull = false; } // determine if request.SqlParameters should be set to null if (requestSqlParametersIsNull) { request.SqlParameters = null; } if (cmdletContext.Type != null) { request.Type = cmdletContext.Type; } 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.CleanRooms.Model.StartProtectedQueryResponse CallAWSServiceOperation(IAmazonCleanRooms client, Amazon.CleanRooms.Model.StartProtectedQueryRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Clean Rooms Service", "StartProtectedQuery"); try { #if DESKTOP return client.StartProtectedQuery(request); #elif CORECLR return client.StartProtectedQueryAsync(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 MembershipIdentifier { get; set; } public System.String S3_Bucket { get; set; } public System.String S3_KeyPrefix { get; set; } public Amazon.CleanRooms.ResultFormat S3_ResultFormat { get; set; } public System.String SqlParameters_QueryString { get; set; } public Amazon.CleanRooms.ProtectedQueryType Type { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.ProtectedQuery; } } }