libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Description

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.

Synopsis

Creating a Request

data GetScalingPlanResourceForecastData Source #

Constructors

GetScalingPlanResourceForecastData' 

Fields

  • scalingPlanName :: Text

    The name of the scaling plan.

  • scalingPlanVersion :: Integer

    The version number of the scaling plan. Currently, the only valid value is 1.

  • serviceNamespace :: ServiceNamespace

    The namespace of the AWS service. The only valid value is autoscaling.

  • resourceId :: Text

    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.

  • scalableDimension :: ScalableDimension

    The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

  • forecastDataType :: 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.
  • startTime :: POSIX

    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.

  • endTime :: POSIX

    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.

Instances

Instances details
Eq GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Read GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Show GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Generic GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Associated Types

type Rep GetScalingPlanResourceForecastData :: Type -> Type #

NFData GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Hashable GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

ToJSON GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

AWSRequest GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

ToHeaders GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

ToPath GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

ToQuery GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

type Rep GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

type Rep GetScalingPlanResourceForecastData = D1 ('MetaData "GetScalingPlanResourceForecastData" "Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData" "libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans" 'False) (C1 ('MetaCons "GetScalingPlanResourceForecastData'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "scalingPlanName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "scalingPlanVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "serviceNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNamespace) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "scalableDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalableDimension) :*: S1 ('MetaSel ('Just "forecastDataType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ForecastDataType)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))
type AWSResponse GetScalingPlanResourceForecastData Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

newGetScalingPlanResourceForecastData Source #

Create a value of GetScalingPlanResourceForecastData with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:scalingPlanName:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_scalingPlanName - The name of the scaling plan.

$sel:scalingPlanVersion:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_scalingPlanVersion - The version number of the scaling plan. Currently, the only valid value is 1.

$sel:serviceNamespace:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_serviceNamespace - The namespace of the AWS service. The only valid value is autoscaling.

$sel:resourceId:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_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.

$sel:scalableDimension:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_scalableDimension - The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

$sel:forecastDataType:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_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.

$sel:startTime:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_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.

$sel:endTime:GetScalingPlanResourceForecastData', getScalingPlanResourceForecastData_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.

Request Lenses

getScalingPlanResourceForecastData_scalingPlanVersion :: Lens' GetScalingPlanResourceForecastData Integer Source #

The version number of the scaling plan. Currently, the only valid value is 1.

getScalingPlanResourceForecastData_serviceNamespace :: Lens' GetScalingPlanResourceForecastData ServiceNamespace Source #

The namespace of the AWS service. The only valid value is autoscaling.

getScalingPlanResourceForecastData_resourceId :: Lens' GetScalingPlanResourceForecastData Text Source #

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.

getScalingPlanResourceForecastData_scalableDimension :: Lens' GetScalingPlanResourceForecastData ScalableDimension Source #

The scalable dimension for the resource. The only valid value is autoscaling:autoScalingGroup:DesiredCapacity.

getScalingPlanResourceForecastData_forecastDataType :: Lens' GetScalingPlanResourceForecastData ForecastDataType Source #

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.

getScalingPlanResourceForecastData_startTime :: Lens' GetScalingPlanResourceForecastData UTCTime Source #

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.

getScalingPlanResourceForecastData_endTime :: Lens' GetScalingPlanResourceForecastData UTCTime Source #

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.

Destructuring the Response

data GetScalingPlanResourceForecastDataResponse Source #

Constructors

GetScalingPlanResourceForecastDataResponse' 

Fields

Instances

Instances details
Eq GetScalingPlanResourceForecastDataResponse Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Read GetScalingPlanResourceForecastDataResponse Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Show GetScalingPlanResourceForecastDataResponse Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

Generic GetScalingPlanResourceForecastDataResponse Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

NFData GetScalingPlanResourceForecastDataResponse Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

type Rep GetScalingPlanResourceForecastDataResponse Source # 
Instance details

Defined in Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData

type Rep GetScalingPlanResourceForecastDataResponse = D1 ('MetaData "GetScalingPlanResourceForecastDataResponse" "Amazonka.AutoScalingPlans.GetScalingPlanResourceForecastData" "libZSservicesZSamazonka-autoscaling-plansZSamazonka-autoscaling-plans" 'False) (C1 ('MetaCons "GetScalingPlanResourceForecastDataResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "datapoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Datapoint])))

Response Lenses