/*******************************************************************************
* 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.AutoScalingPlans;
using Amazon.AutoScalingPlans.Model;
namespace Amazon.PowerShell.Cmdlets.ASP
{
///
/// Retrieves the forecast data for a scalable resource.
///
///
///
/// Capacity forecasts are represented as predicted values, or data points, that are calculated
/// using historical data points from a specified CloudWatch load metric. Data points
/// are available for up to 56 days.
///
///
[Cmdlet("Get", "ASPScalingPlanResourceForecastData")]
[OutputType("Amazon.AutoScalingPlans.Model.Datapoint")]
[AWSCmdlet("Calls the AWS Auto Scaling Plans GetScalingPlanResourceForecastData API operation.", Operation = new[] {"GetScalingPlanResourceForecastData"}, SelectReturnType = typeof(Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataResponse))]
[AWSCmdletOutput("Amazon.AutoScalingPlans.Model.Datapoint or Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataResponse",
"This cmdlet returns a collection of Amazon.AutoScalingPlans.Model.Datapoint objects.",
"The service call response (type Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack."
)]
public partial class GetASPScalingPlanResourceForecastDataCmdlet : AmazonAutoScalingPlansClientCmdlet, IExecutor
{
#region Parameter EndTime
///
///
/// The exclusive end time of the time range for the forecast data to get. The maximum
/// time duration between the start and end time is seven days. Although this parameter can accept a date and time that is more than two days in the
/// future, the availability of forecast data has limits. AWS Auto Scaling only issues
/// forecasts for periods of two days in advance.
///
///
#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 ForecastDataType
///
///
/// The type of forecast data to get.LoadForecast
: The load metric forecast. CapacityForecast
: The capacity forecast. ScheduledActionMinCapacity
: The minimum capacity for each scheduled
/// scaling action. This data is calculated as the larger of two values: the capacity
/// forecast or the minimum capacity in the scaling instruction.ScheduledActionMaxCapacity
: The maximum capacity for each scheduled
/// scaling action. The calculation used is determined by the predictive scaling maximum
/// capacity behavior setting in the scaling instruction.
///
///
#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.AutoScalingPlans.ForecastDataType")]
public Amazon.AutoScalingPlans.ForecastDataType ForecastDataType { get; set; }
#endregion
#region Parameter ResourceId
///
///
/// The ID of the resource. This string consists of a prefix (autoScalingGroup
)
/// followed by the name of a specified Auto Scaling group (my-asg
). Example:
/// autoScalingGroup/my-asg
.
///
///
#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 ResourceId { get; set; }
#endregion
#region Parameter ScalableDimension
///
///
/// The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity
.
///
///
///
#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.AutoScalingPlans.ScalableDimension")]
public Amazon.AutoScalingPlans.ScalableDimension ScalableDimension { get; set; }
#endregion
#region Parameter ScalingPlanName
///
///
/// The name of the scaling plan.
///
///
#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 ScalingPlanName { get; set; }
#endregion
#region Parameter ScalingPlanVersion
///
///
/// The version number of the scaling plan. Currently, the only valid value is 1
.
///
///
#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.Int64? ScalingPlanVersion { get; set; }
#endregion
#region Parameter ServiceNamespace
///
///
/// The namespace of the AWS service. The only valid value is autoscaling
.
///
///
///
#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.AutoScalingPlans.ServiceNamespace")]
public Amazon.AutoScalingPlans.ServiceNamespace ServiceNamespace { get; set; }
#endregion
#region Parameter StartTime
///
///
/// The inclusive start time of the time range for the forecast data to get. The date
/// and time can be at most 56 days before the current date and time.
///
///
#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 Select
///
/// Use the -Select parameter to control the cmdlet output. The default value is 'Datapoints'.
/// Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataResponse).
/// Specifying the name of a property of type Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataResponse 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; } = "Datapoints";
#endregion
#region Parameter PassThru
///
/// Changes the cmdlet behavior to return the value passed to the ScalingPlanName parameter.
/// The -PassThru parameter is deprecated, use -Select '^ScalingPlanName' instead. This parameter will be removed in a future version.
///
[System.Obsolete("The -PassThru parameter is deprecated, use -Select '^ScalingPlanName' 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.ScalingPlanName;
}
#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.ForecastDataType = this.ForecastDataType;
#if MODULAR
if (this.ForecastDataType == null && ParameterWasBound(nameof(this.ForecastDataType)))
{
WriteWarning("You are passing $null as a value for parameter ForecastDataType 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.ResourceId = this.ResourceId;
#if MODULAR
if (this.ResourceId == null && ParameterWasBound(nameof(this.ResourceId)))
{
WriteWarning("You are passing $null as a value for parameter ResourceId 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.ScalableDimension = this.ScalableDimension;
#if MODULAR
if (this.ScalableDimension == null && ParameterWasBound(nameof(this.ScalableDimension)))
{
WriteWarning("You are passing $null as a value for parameter ScalableDimension 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.ScalingPlanName = this.ScalingPlanName;
#if MODULAR
if (this.ScalingPlanName == null && ParameterWasBound(nameof(this.ScalingPlanName)))
{
WriteWarning("You are passing $null as a value for parameter ScalingPlanName 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.ScalingPlanVersion = this.ScalingPlanVersion;
#if MODULAR
if (this.ScalingPlanVersion == null && ParameterWasBound(nameof(this.ScalingPlanVersion)))
{
WriteWarning("You are passing $null as a value for parameter ScalingPlanVersion 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.ServiceNamespace = this.ServiceNamespace;
#if MODULAR
if (this.ServiceNamespace == null && ParameterWasBound(nameof(this.ServiceNamespace)))
{
WriteWarning("You are passing $null as a value for parameter ServiceNamespace 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.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
// 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.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataRequest();
if (cmdletContext.EndTime != null)
{
request.EndTime = cmdletContext.EndTime.Value;
}
if (cmdletContext.ForecastDataType != null)
{
request.ForecastDataType = cmdletContext.ForecastDataType;
}
if (cmdletContext.ResourceId != null)
{
request.ResourceId = cmdletContext.ResourceId;
}
if (cmdletContext.ScalableDimension != null)
{
request.ScalableDimension = cmdletContext.ScalableDimension;
}
if (cmdletContext.ScalingPlanName != null)
{
request.ScalingPlanName = cmdletContext.ScalingPlanName;
}
if (cmdletContext.ScalingPlanVersion != null)
{
request.ScalingPlanVersion = cmdletContext.ScalingPlanVersion.Value;
}
if (cmdletContext.ServiceNamespace != null)
{
request.ServiceNamespace = cmdletContext.ServiceNamespace;
}
if (cmdletContext.StartTime != null)
{
request.StartTime = cmdletContext.StartTime.Value;
}
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.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataResponse CallAWSServiceOperation(IAmazonAutoScalingPlans client, Amazon.AutoScalingPlans.Model.GetScalingPlanResourceForecastDataRequest request)
{
Utils.Common.WriteVerboseEndpointMessage(this, client.Config, "AWS Auto Scaling Plans", "GetScalingPlanResourceForecastData");
try
{
#if DESKTOP
return client.GetScalingPlanResourceForecastData(request);
#elif CORECLR
return client.GetScalingPlanResourceForecastDataAsync(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 Amazon.AutoScalingPlans.ForecastDataType ForecastDataType { get; set; }
public System.String ResourceId { get; set; }
public Amazon.AutoScalingPlans.ScalableDimension ScalableDimension { get; set; }
public System.String ScalingPlanName { get; set; }
public System.Int64? ScalingPlanVersion { get; set; }
public Amazon.AutoScalingPlans.ServiceNamespace ServiceNamespace { get; set; }
public System.DateTime? StartTime { get; set; }
public System.Func Select { get; set; } =
(response, cmdlet) => response.Datapoints;
}
}
}