/*******************************************************************************
* 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.WellArchitected;
using Amazon.WellArchitected.Model;
namespace Amazon.PowerShell.Cmdlets.WAT
{
///
/// Import a new custom lens or update an existing custom lens.
///
///
///
/// To update an existing custom lens, specify its ARN as the LensAlias
.
/// If no ARN is specified, a new custom lens is created.
///
/// The new or updated lens will have a status of DRAFT
. The lens cannot
/// be applied to workloads or shared with other Amazon Web Services accounts until it's
/// published with CreateLensVersion.
///
/// Lenses are defined in JSON. For more information, see JSON
/// format specification in the Well-Architected Tool User Guide.
///
/// A custom lens cannot exceed 500 KB in size.
/// Disclaimer
/// Do not include or gather personal identifiable information (PII) of end users or other
/// identifiable individuals in or via your custom lenses. If your custom lens or those
/// shared with you and used in your account do include or collect PII you are responsible
/// for: ensuring that the included PII is processed in accordance with applicable law,
/// providing adequate privacy notices, and obtaining necessary consents for processing
/// such data.
///
///
[Cmdlet("Import", "WATLens", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)]
[OutputType("Amazon.WellArchitected.Model.ImportLensResponse")]
[AWSCmdlet("Calls the AWS Well-Architected Tool ImportLens API operation.", Operation = new[] {"ImportLens"}, SelectReturnType = typeof(Amazon.WellArchitected.Model.ImportLensResponse))]
[AWSCmdletOutput("Amazon.WellArchitected.Model.ImportLensResponse",
"This cmdlet returns an Amazon.WellArchitected.Model.ImportLensResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class ImportWATLensCmdlet : AmazonWellArchitectedClientCmdlet, IExecutor
{
#region Parameter ClientRequestToken
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String ClientRequestToken { get; set; }
#endregion
#region Parameter JSONString
///
///
/// The JSON representation of a lens.
///
///
#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 JSONString { get; set; }
#endregion
#region Parameter LensAlias
///
///
/// The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
public System.String LensAlias { get; set; }
#endregion
#region Parameter Tag
///
///
/// Tags to associate to a lens.
///
///
[System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)]
[Alias("Tags")]
public System.Collections.Hashtable Tag { 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.WellArchitected.Model.ImportLensResponse).
/// Specifying the name of a property of type Amazon.WellArchitected.Model.ImportLensResponse 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 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 = string.Empty;
if (!ConfirmShouldProceed(this.Force.IsPresent, resourceIdentifiersText, "Import-WATLens (ImportLens)"))
{
return;
}
var context = new CmdletContext();
// allow for manipulation of parameters prior to loading into context
PreExecutionContextLoad(context);
if (ParameterWasBound(nameof(this.Select)))
{
context.Select = CreateSelectDelegate(Select) ??
throw new System.ArgumentException("Invalid value for -Select parameter.", nameof(this.Select));
}
context.ClientRequestToken = this.ClientRequestToken;
context.JSONString = this.JSONString;
#if MODULAR
if (this.JSONString == null && ParameterWasBound(nameof(this.JSONString)))
{
WriteWarning("You are passing $null as a value for parameter JSONString 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.LensAlias = this.LensAlias;
if (this.Tag != null)
{
context.Tag = new Dictionary(StringComparer.Ordinal);
foreach (var hashKey in this.Tag.Keys)
{
context.Tag.Add((String)hashKey, (String)(this.Tag[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.WellArchitected.Model.ImportLensRequest();
if (cmdletContext.ClientRequestToken != null)
{
request.ClientRequestToken = cmdletContext.ClientRequestToken;
}
if (cmdletContext.JSONString != null)
{
request.JSONString = cmdletContext.JSONString;
}
if (cmdletContext.LensAlias != null)
{
request.LensAlias = cmdletContext.LensAlias;
}
if (cmdletContext.Tag != null)
{
request.Tags = cmdletContext.Tag;
}
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.WellArchitected.Model.ImportLensResponse CallAWSServiceOperation(IAmazonWellArchitected client, Amazon.WellArchitected.Model.ImportLensRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Well-Architected Tool", "ImportLens");
try
{
#if DESKTOP
return client.ImportLens(request);
#elif CORECLR
return client.ImportLensAsync(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 ClientRequestToken { get; set; }
public System.String JSONString { get; set; }
public System.String LensAlias { get; set; }
public Dictionary Tag { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response;
}
}
}