/******************************************************************************* * 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 { /// /// Exports a deployed version of a RestApi in a specified format. /// [Cmdlet("Get", "AGExport")] [OutputType("Amazon.APIGateway.Model.GetExportResponse")] [AWSCmdlet("Calls the Amazon API Gateway GetExport API operation.", Operation = new[] {"GetExport"}, SelectReturnType = typeof(Amazon.APIGateway.Model.GetExportResponse))] [AWSCmdletOutput("Amazon.APIGateway.Model.GetExportResponse", "This cmdlet returns an Amazon.APIGateway.Model.GetExportResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetAGExportCmdlet : AmazonAPIGatewayClientCmdlet, IExecutor { #region Parameter Accept /// /// /// The content-type of the export, for example application/json. Currently /// application/json and application/yaml are supported for /// exportType ofoas30 and swagger. This should /// be specified in the Accept header for direct API requests. /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("Accepts")] public System.String Accept { get; set; } #endregion #region Parameter ExportType /// /// /// The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' /// for Swagger/OpenAPI 2.0. /// /// #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 ExportType { get; set; } #endregion #region Parameter Parameter /// /// /// A key-value map of query string parameters that specify properties of the export, /// depending on the requested exportType. For exportTypeoas30 /// and swagger, any combination of the following parameters are supported: /// extensions='integrations' or extensions='apigateway' will /// export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' /// will export the API with x-amazon-apigateway-authorizer extensions. postman /// will export the API with Postman extensions, allowing for import to the Postman tool /// /// [System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)] [Alias("Parameters")] public System.Collections.Hashtable Parameter { get; set; } #endregion #region Parameter RestApiId /// /// /// The string identifier of the associated RestApi. /// /// #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 RestApiId { get; set; } #endregion #region Parameter StageName /// /// /// The name of the Stage that will be exported. /// /// #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 StageName { 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.GetExportResponse). /// Specifying the name of a property of type Amazon.APIGateway.Model.GetExportResponse 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 Parameter parameter. /// The -PassThru parameter is deprecated, use -Select '^Parameter' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^Parameter' 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.Parameter; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.Accept = this.Accept; context.ExportType = this.ExportType; #if MODULAR if (this.ExportType == null && ParameterWasBound(nameof(this.ExportType))) { WriteWarning("You are passing $null as a value for parameter ExportType 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.Parameter != null) { context.Parameter = new Dictionary(StringComparer.Ordinal); foreach (var hashKey in this.Parameter.Keys) { context.Parameter.Add((String)hashKey, (String)(this.Parameter[hashKey])); } } 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 context.StageName = this.StageName; #if MODULAR if (this.StageName == null && ParameterWasBound(nameof(this.StageName))) { WriteWarning("You are passing $null as a value for parameter StageName 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.APIGateway.Model.GetExportRequest(); if (cmdletContext.Accept != null) { request.Accepts = cmdletContext.Accept; } if (cmdletContext.ExportType != null) { request.ExportType = cmdletContext.ExportType; } if (cmdletContext.Parameter != null) { request.Parameters = cmdletContext.Parameter; } if (cmdletContext.RestApiId != null) { request.RestApiId = cmdletContext.RestApiId; } if (cmdletContext.StageName != null) { request.StageName = cmdletContext.StageName; } 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.GetExportResponse CallAWSServiceOperation(IAmazonAPIGateway client, Amazon.APIGateway.Model.GetExportRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway", "GetExport"); try { #if DESKTOP return client.GetExport(request); #elif CORECLR return client.GetExportAsync(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 Accept { get; set; } public System.String ExportType { get; set; } public Dictionary Parameter { get; set; } public System.String RestApiId { get; set; } public System.String StageName { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response; } } }