/******************************************************************************* * 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.ComputeOptimizer; using Amazon.ComputeOptimizer.Model; namespace Amazon.PowerShell.Cmdlets.CO { /// /// Returns the projected utilization metrics of Amazon EC2 instance recommendations. /// /// /// The Cpu and Memory metrics are the only projected utilization /// metrics returned when you run this action. Additionally, the Memory metric /// is returned only for resources that have the unified CloudWatch agent installed on /// them. For more information, see Enabling /// Memory Utilization with the CloudWatch Agent. /// /// [Cmdlet("Get", "COEC2RecommendationProjectedMetric")] [OutputType("Amazon.ComputeOptimizer.Model.RecommendedOptionProjectedMetric")] [AWSCmdlet("Calls the AWS Compute Optimizer GetEC2RecommendationProjectedMetrics API operation.", Operation = new[] {"GetEC2RecommendationProjectedMetrics"}, SelectReturnType = typeof(Amazon.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsResponse))] [AWSCmdletOutput("Amazon.ComputeOptimizer.Model.RecommendedOptionProjectedMetric or Amazon.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsResponse", "This cmdlet returns a collection of Amazon.ComputeOptimizer.Model.RecommendedOptionProjectedMetric objects.", "The service call response (type Amazon.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack." )] public partial class GetCOEC2RecommendationProjectedMetricCmdlet : AmazonComputeOptimizerClientCmdlet, IExecutor { #region Parameter RecommendationPreferences_CpuVendorArchitecture /// /// /// Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling /// group recommendations.For example, when you specify AWS_ARM64 with: /// /// [System.Management.Automation.Parameter(ValueFromPipelineByPropertyName = true)] [Alias("RecommendationPreferences_CpuVendorArchitectures")] public System.String[] RecommendationPreferences_CpuVendorArchitecture { get; set; } #endregion #region Parameter EndTime /// /// /// The timestamp of the last projected metrics data point to return. /// /// #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] public System.DateTime? EndTime { get; set; } #endregion #region Parameter InstanceArn /// /// /// The Amazon Resource Name (ARN) of the instances for which to return recommendation /// projected metrics. /// /// #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 InstanceArn { get; set; } #endregion #region Parameter Period /// /// /// The granularity, in seconds, of the projected metrics data points. /// /// #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] public System.Int32? Period { get; set; } #endregion #region Parameter StartTime /// /// /// The timestamp of the first projected metrics data point to return. /// /// #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] public System.DateTime? StartTime { get; set; } #endregion #region Parameter Stat /// /// /// The statistic of the projected metrics. /// /// #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.ComputeOptimizer.MetricStatistic")] public Amazon.ComputeOptimizer.MetricStatistic Stat { get; set; } #endregion #region Parameter Select /// /// Use the -Select parameter to control the cmdlet output. The default value is 'RecommendedOptionProjectedMetrics'. /// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsResponse). /// Specifying the name of a property of type Amazon.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsResponse 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; } = "RecommendedOptionProjectedMetrics"; #endregion #region Parameter PassThru /// /// Changes the cmdlet behavior to return the value passed to the InstanceArn parameter. /// The -PassThru parameter is deprecated, use -Select '^InstanceArn' instead. This parameter will be removed in a future version. /// [System.Obsolete("The -PassThru parameter is deprecated, use -Select '^InstanceArn' 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.InstanceArn; } #pragma warning restore CS0618, CS0612 //A class member was marked with the Obsolete attribute context.EndTime = this.EndTime; #if MODULAR if (this.EndTime == null && ParameterWasBound(nameof(this.EndTime))) { WriteWarning("You are passing $null as a value for parameter EndTime 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.InstanceArn = this.InstanceArn; #if MODULAR if (this.InstanceArn == null && ParameterWasBound(nameof(this.InstanceArn))) { WriteWarning("You are passing $null as a value for parameter InstanceArn 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.Period = this.Period; #if MODULAR if (this.Period == null && ParameterWasBound(nameof(this.Period))) { WriteWarning("You are passing $null as a value for parameter Period 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.RecommendationPreferences_CpuVendorArchitecture != null) { context.RecommendationPreferences_CpuVendorArchitecture = new List(this.RecommendationPreferences_CpuVendorArchitecture); } context.StartTime = this.StartTime; #if MODULAR if (this.StartTime == null && ParameterWasBound(nameof(this.StartTime))) { WriteWarning("You are passing $null as a value for parameter StartTime 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.Stat = this.Stat; #if MODULAR if (this.Stat == null && ParameterWasBound(nameof(this.Stat))) { WriteWarning("You are passing $null as a value for parameter Stat 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.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsRequest(); if (cmdletContext.EndTime != null) { request.EndTime = cmdletContext.EndTime.Value; } if (cmdletContext.InstanceArn != null) { request.InstanceArn = cmdletContext.InstanceArn; } if (cmdletContext.Period != null) { request.Period = cmdletContext.Period.Value; } // populate RecommendationPreferences var requestRecommendationPreferencesIsNull = true; request.RecommendationPreferences = new Amazon.ComputeOptimizer.Model.RecommendationPreferences(); List requestRecommendationPreferences_recommendationPreferences_CpuVendorArchitecture = null; if (cmdletContext.RecommendationPreferences_CpuVendorArchitecture != null) { requestRecommendationPreferences_recommendationPreferences_CpuVendorArchitecture = cmdletContext.RecommendationPreferences_CpuVendorArchitecture; } if (requestRecommendationPreferences_recommendationPreferences_CpuVendorArchitecture != null) { request.RecommendationPreferences.CpuVendorArchitectures = requestRecommendationPreferences_recommendationPreferences_CpuVendorArchitecture; requestRecommendationPreferencesIsNull = false; } // determine if request.RecommendationPreferences should be set to null if (requestRecommendationPreferencesIsNull) { request.RecommendationPreferences = null; } if (cmdletContext.StartTime != null) { request.StartTime = cmdletContext.StartTime.Value; } if (cmdletContext.Stat != null) { request.Stat = cmdletContext.Stat; } 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.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsResponse CallAWSServiceOperation(IAmazonComputeOptimizer client, Amazon.ComputeOptimizer.Model.GetEC2RecommendationProjectedMetricsRequest request) { Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Compute Optimizer", "GetEC2RecommendationProjectedMetrics"); try { #if DESKTOP return client.GetEC2RecommendationProjectedMetrics(request); #elif CORECLR return client.GetEC2RecommendationProjectedMetricsAsync(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.DateTime? EndTime { get; set; } public System.String InstanceArn { get; set; } public System.Int32? Period { get; set; } public List RecommendationPreferences_CpuVendorArchitecture { get; set; } public System.DateTime? StartTime { get; set; } public Amazon.ComputeOptimizer.MetricStatistic Stat { get; set; } public System.Func Select { get; set; } = (response, cmdlet) => response.RecommendedOptionProjectedMetrics; } } }