/******************************************************************************* * 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.APIGateway; using Amazon.APIGateway.Model; namespace Amazon.PowerShell.Cmdlets.AG { /// /// Simulate the invocation of a Method in your RestApi with headers, parameters, and /// an incoming request body. /// [Cmdlet("Test", "AGInvokeMethod")] [OutputType("Amazon.APIGateway.Model.TestInvokeMethodResponse")] [AWSCmdlet("Calls the Amazon API Gateway TestInvokeMethod API operation.", Operation = new[] {"TestInvokeMethod"}, SelectReturnType = typeof(Amazon.APIGateway.Model.TestInvokeMethodResponse))] [AWSCmdletOutput("Amazon.APIGateway.Model.TestInvokeMethodResponse", "This cmdlet returns an Amazon.APIGateway.Model.TestInvokeMethodResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class TestAGInvokeMethodCmdlet : AmazonAPIGatewayClientCmdlet, IExecutor { #region Parameter Body /// /// /// The simulated request body of an incoming invocation request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String Body { get; set; } #endregion #region Parameter ClientCertificateId /// /// /// A ClientCertificate identifier to use in the test invocation. API Gateway will use /// the certificate when making the HTTPS request to the defined back-end endpoint. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String ClientCertificateId { get; set; } #endregion #region Parameter Header /// /// /// A key-value map of headers to simulate an incoming invocation request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Headers")] public System.Collections.Hashtable Header { get; set; } #endregion #region Parameter HttpMethod /// /// /// Specifies a test invoke method request's HTTP method. /// /// #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 HttpMethod { get; set; } #endregion #region Parameter MultiValueHeader /// /// /// The headers as a map from string to list of values to simulate an incoming invocation /// request. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("MultiValueHeaders")] public System.Collections.Hashtable MultiValueHeader { get; set; } #endregion #region Parameter PathWithQueryString /// /// /// The URI path, including query string, of the simulated invocation request. Use this /// to specify path parameters and query string parameters. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public System.String PathWithQueryString { get; set; } #endregion #region Parameter ResourceId /// /// /// Specifies a test invoke method request's resource ID. /// /// #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 ResourceId { get; set; } #endregion #region Parameter RestApiId /// /// /// The string identifier of the associated RestApi. /// /// #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 RestApiId { get; set; } #endregion #region Parameter StageVariable /// /// /// A key-value map of stage variables to simulate an invocation on a deployed Stage. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("StageVariables")] public System.Collections.Hashtable StageVariable { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is '*'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.APIGateway.Model.TestInvokeMethodResponse). /// Specifying the name of a property of type Amazon.APIGateway.Model.TestInvokeMethodResponse 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; } = "*"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the RestApiId parameter. /// The -PassThru parameter is deprecated, use -Select '^RestApiId' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^RestApiId' instead. This parameter will be removed in a future version.")] [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] public SwitchParameter PassThru { get; set; } #endregion protected override void ProcessRecord() { this._AWSSignerType = "v4"; base.ProcessRecord(); 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.RestApiId; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Body = this.Body; context.ClientCertificateId = this.ClientCertificateId; if (this.Header != null) { context.Header = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Header.Keys) { context.Header.Add((String)hashKey, (String)(this.Header[hashKey])); } } context.HttpMethod = this.HttpMethod; #if MODULAR if (this.HttpMethod == null && ParameterWasBound(nameof(this.HttpMethod))) { WriteWarning("You are passing $null as a value for parameter HttpMethod 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.MultiValueHeader != null) { context.MultiValueHeader = new Dictionary>(StringComparer.Ordinal); foreach (var hashKey in this.MultiValueHeader.Keys) { object hashValue = this.MultiValueHeader[hashKey]; if (hashValue == null) { context.MultiValueHeader.Add((String)hashKey, null); continue; } var enumerable = SafeEnumerable(hashValue); var valueSet = new List(); foreach (var s in enumerable) { valueSet.Add((System.String)s); } context.MultiValueHeader.Add((String)hashKey, valueSet); } } context.PathWithQueryString = this.PathWithQueryString; context.ResourceId = this.ResourceId; #if MODULAR if (this.ResourceId == null && ParameterWasBound(nameof(this.ResourceId))) { WriteWarning("You are passing $null as a value for parameter ResourceId 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.RestApiId = this.RestApiId; #if MODULAR if (this.RestApiId == null && ParameterWasBound(nameof(this.RestApiId))) { WriteWarning("You are passing $null as a value for parameter RestApiId 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.StageVariable != null) { context.StageVariable = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.StageVariable.Keys) { context.StageVariable.Add((String)hashKey, (String)(this.StageVariable[hashKey])); } } // 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.APIGateway.Model.TestInvokeMethodRequest(); if (cmdletContext.Body != null) { request.Body = cmdletContext.Body; } if (cmdletContext.ClientCertificateId != null) { request.ClientCertificateId = cmdletContext.ClientCertificateId; } if (cmdletContext.Header != null) { request.Headers = cmdletContext.Header; } if (cmdletContext.HttpMethod != null) { request.HttpMethod = cmdletContext.HttpMethod; } if (cmdletContext.MultiValueHeader != null) { request.MultiValueHeaders = cmdletContext.MultiValueHeader; } if (cmdletContext.PathWithQueryString != null) { request.PathWithQueryString = cmdletContext.PathWithQueryString; } if (cmdletContext.ResourceId != null) { request.ResourceId = cmdletContext.ResourceId; } if (cmdletContext.RestApiId != null) { request.RestApiId = cmdletContext.RestApiId; } if (cmdletContext.StageVariable != null) { request.StageVariables = cmdletContext.StageVariable; } 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.APIGateway.Model.TestInvokeMethodResponse CallAWSServiceOperation(IAmazonAPIGateway client, Amazon.APIGateway.Model.TestInvokeMethodRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway", "TestInvokeMethod"); try { #if DESKTOP return client.TestInvokeMethod(request); #elif CORECLR return client.TestInvokeMethodAsync(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 Body { get; set; } public System.String ClientCertificateId { get; set; } public Dictionary Header { get; set; } public System.String HttpMethod { get; set; } public Dictionary> MultiValueHeader { get; set; } public System.String PathWithQueryString { get; set; } public System.String ResourceId { get; set; } public System.String RestApiId { get; set; } public Dictionary StageVariable { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }