/*******************************************************************************
* 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
{
///
/// Creates a customization of a GatewayResponse of a specified response type and status
/// code on the given RestApi.
///
[Cmdlet("Write", "AGGatewayResponse", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.APIGateway.Model.PutGatewayResponseResponse")]
[AWSCmdlet("Calls the Amazon API Gateway PutGatewayResponse API operation.", Operation = new[] {"PutGatewayResponse"}, SelectReturnType = typeof(Amazon.APIGateway.Model.PutGatewayResponseResponse))]
[AWSCmdletOutput("Amazon.APIGateway.Model.PutGatewayResponseResponse",
"This cmdlet returns an Amazon.APIGateway.Model.PutGatewayResponseResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class WriteAGGatewayResponseCmdlet : AmazonAPIGatewayClientCmdlet, IExecutor
{
#region Parameter ResponseParameter
///
///
/// Response parameters (paths, query strings and headers) of the GatewayResponse as a
/// string-to-string map of key-value pairs.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ResponseParameters")]
public System.Collections.Hashtable ResponseParameter { get; set; }
#endregion
#region Parameter ResponseTemplate
///
///
/// Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("ResponseTemplates")]
public System.Collections.Hashtable ResponseTemplate { get; set; }
#endregion
#region Parameter ResponseType
///
///
/// The response type of the associated GatewayResponse
///
///
#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.APIGateway.GatewayResponseType")]
public Amazon.APIGateway.GatewayResponseType ResponseType { 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 StatusCode
///
///
/// The HTTP status code of the GatewayResponse.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String StatusCode { 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.PutGatewayResponseResponse).
/// Specifying the name of a property of type Amazon.APIGateway.Model.PutGatewayResponseResponse 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
#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.RestApiId), MyInvocation.BoundParameters);
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Write-AGGatewayResponse (PutGatewayResponse)"))
{
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.RestApiId;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
if (this.ResponseParameter != null)
{
context.ResponseParameter = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.ResponseParameter.Keys)
{
context.ResponseParameter.Add((String)hashKey, (String)(this.ResponseParameter[hashKey]));
}
}
if (this.ResponseTemplate != null)
{
context.ResponseTemplate = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.ResponseTemplate.Keys)
{
context.ResponseTemplate.Add((String)hashKey, (String)(this.ResponseTemplate[hashKey]));
}
}
context.ResponseType = this.ResponseType;
#if MODULAR
if (this.ResponseType == null && ParameterWasBound(nameof(this.ResponseType)))
{
WriteWarning("You are passing $null as a value for parameter ResponseType 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
context.StatusCode = this.StatusCode;
// 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.PutGatewayResponseRequest();
if (cmdletContext.ResponseParameter != null)
{
request.ResponseParameters = cmdletContext.ResponseParameter;
}
if (cmdletContext.ResponseTemplate != null)
{
request.ResponseTemplates = cmdletContext.ResponseTemplate;
}
if (cmdletContext.ResponseType != null)
{
request.ResponseType = cmdletContext.ResponseType;
}
if (cmdletContext.RestApiId != null)
{
request.RestApiId = cmdletContext.RestApiId;
}
if (cmdletContext.StatusCode != null)
{
request.StatusCode = cmdletContext.StatusCode;
}
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.PutGatewayResponseResponse CallAWSServiceOperation(IAmazonAPIGateway client, Amazon.APIGateway.Model.PutGatewayResponseRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Amazon API Gateway", "PutGatewayResponse");
try
{
#if DESKTOP
return client.PutGatewayResponse(request);
#elif CORECLR
return client.PutGatewayResponseAsync(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 ResponseParameter { get; set; }
public Dictionary ResponseTemplate { get; set; }
public Amazon.APIGateway.GatewayResponseType ResponseType { get; set; }
public System.String RestApiId { get; set; }
public System.String StatusCode { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}