/*******************************************************************************
* 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.PaymentCryptography;
using Amazon.PaymentCryptography.Model;
namespace Amazon.PowerShell.Cmdlets.PAYCC
{
/// <summary>
/// Lists the keys in the caller's Amazon Web Services account and Amazon Web Services
/// Region. You can filter the list of keys.
///
///
/// <para>
/// This is a paginated operation, which means that each response might contain only a
/// subset of all the keys. When the response contains only a subset of keys, it includes
/// a <code>NextToken</code> value. Use this value in a subsequent <code>ListKeys</code>
/// request to get more keys. When you receive a response with no NextToken (or an empty
/// or null value), that means there are no more keys to get.
/// </para><para><b>Cross-account use:</b> This operation can't be used across different Amazon Web
/// Services accounts.
/// </para><para><b>Related operations:</b></para><ul><li><para><a>CreateKey</a></para></li><li><para><a>DeleteKey</a></para></li><li><para><a>GetKey</a></para></li></ul>
/// </summary>
[Cmdlet("Get", "PAYCCKeyList")]
[OutputType("Amazon.PaymentCryptography.Model.KeySummary")]
[AWSCmdlet("Calls the Payment Cryptography Control Plane ListKeys API operation.", Operation = new[] {"ListKeys"}, SelectReturnType = typeof(Amazon.PaymentCryptography.Model.ListKeysResponse))]
[AWSCmdletOutput("Amazon.PaymentCryptography.Model.KeySummary or Amazon.PaymentCryptography.Model.ListKeysResponse",
"This cmdlet returns a collection of Amazon.PaymentCryptography.Model.KeySummary objects.",
"The service call response (type Amazon.PaymentCryptography.Model.ListKeysResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetPAYCCKeyListCmdlet : AmazonPaymentCryptographyClientCmdlet, IExecutor
{
#region Parameter KeyState
/// <summary>
/// <para>
/// <para>The key state of the keys you want to list.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(Position = 0, ValueFromPipelineByPropertyName = true, ValueFromPipeline = true)]
[AWSConstantClassSource("Amazon.PaymentCryptography.KeyState")]
public Amazon.PaymentCryptography.KeyState KeyState { get; set; }
#endregion
#region Parameter MaxResult
/// <summary>
/// <para>
/// <para>Use this parameter to specify the maximum number of items to return. When this value
/// is present, Amazon Web Services Payment Cryptography does not return more than the
/// specified number of items, but it might return fewer.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("MaxResults")]
public System.Int32? MaxResult { get; set; }
#endregion
#region Parameter NextToken
/// <summary>
/// <para>
/// <para>Use this parameter in a subsequent request after you receive a response with truncated
/// results. Set it to the value of <code>NextToken</code> from the truncated response
/// you just received.</para>
/// </para>
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String NextToken { get; set; }
#endregion
#region Parameter Select
/// <summary>
/// Use the -Select parameter to control the cmdlet output. The default value is 'Keys'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptography.Model.ListKeysResponse).
/// Specifying the name of a property of type Amazon.PaymentCryptography.Model.ListKeysResponse will result in that property being returned.
/// Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
/// </summary>
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public string Select { get; set; } = "Keys";
#endregion
#region Parameter PassThru
/// <summary>
/// Changes the cmdlet behavior to return the value passed to the KeyState parameter.
/// The -PassThru parameter is deprecated, use -Select '^KeyState' instead. This parameter will be removed in a future version.
/// </summary>
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^KeyState' 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<Amazon.PaymentCryptography.Model.ListKeysResponse, GetPAYCCKeyListCmdlet>(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.KeyState;
}
#pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute
context.KeyState = this.KeyState;
context.MaxResult = this.MaxResult;
context.NextToken = this.NextToken;
// 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.PaymentCryptography.Model.ListKeysRequest();
if (cmdletContext.KeyState != null)
{
request.KeyState = cmdletContext.KeyState;
}
if (cmdletContext.MaxResult != null)
{
request.MaxResults = cmdletContext.MaxResult.Value;
}
if (cmdletContext.NextToken != null)
{
request.NextToken = cmdletContext.NextToken;
}
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.PaymentCryptography.Model.ListKeysResponse CallAWSServiceOperation(IAmazonPaymentCryptography client, Amazon.PaymentCryptography.Model.ListKeysRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "Payment Cryptography Control Plane", "ListKeys");
try
{
#if DESKTOP
return client.ListKeys(request);
#elif CORECLR
return client.ListKeysAsync(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 Amazon.PaymentCryptography.KeyState KeyState { get; set; }
public System.Int32? MaxResult { get; set; }
public System.String NextToken { get; set; }
public System.Func<Amazon.PaymentCryptography.Model.ListKeysResponse, GetPAYCCKeyListCmdlet, object> Select { get; set; } =
(response, cmdlet) => response.Keys;
}
}
}