/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::AutoScalingPlans::GetScalingPlanResourceForecastData

NAME

Paws::AutoScalingPlans::GetScalingPlanResourceForecastData - Arguments for method GetScalingPlanResourceForecastData on Paws::AutoScalingPlans

DESCRIPTION

This class represents the parameters used for calling the method GetScalingPlanResourceForecastData on the AWS Auto Scaling Plans service. Use the attributes of this class as arguments to method GetScalingPlanResourceForecastData.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetScalingPlanResourceForecastData.

SYNOPSIS

my $autoscaling-plans = Paws->service('AutoScalingPlans');
my $GetScalingPlanResourceForecastDataResponse =
  $autoscaling -plans->GetScalingPlanResourceForecastData(
  EndTime            => '1970-01-01T01:00:00',
  ForecastDataType   => 'CapacityForecast',
  ResourceId         => 'MyXmlString',
  ScalableDimension  => 'autoscaling:autoScalingGroup:DesiredCapacity',
  ScalingPlanName    => 'MyScalingPlanName',
  ScalingPlanVersion => 1,
  ServiceNamespace   => 'autoscaling',
  StartTime          => '1970-01-01T01:00:00',

  );

# Results:
my $Datapoints = $GetScalingPlanResourceForecastDataResponse->Datapoints;

# Returns a Paws::AutoScalingPlans::GetScalingPlanResourceForecastDataResponse object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans/GetScalingPlanResourceForecastData

ATTRIBUTES

REQUIRED EndTime => Str

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.

REQUIRED ForecastDataType => Str

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.

Valid values are: "CapacityForecast", "LoadForecast", "ScheduledActionMinCapacity", "ScheduledActionMaxCapacity"

REQUIRED ResourceId => Str

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.

REQUIRED ScalableDimension => Str

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

Valid values are: "autoscaling:autoScalingGroup:DesiredCapacity", "ecs:service:DesiredCount", "ec2:spot-fleet-request:TargetCapacity", "rds:cluster:ReadReplicaCount", "dynamodb:table:ReadCapacityUnits", "dynamodb:table:WriteCapacityUnits", "dynamodb:index:ReadCapacityUnits", "dynamodb:index:WriteCapacityUnits"

REQUIRED ScalingPlanName => Str

The name of the scaling plan.

REQUIRED ScalingPlanVersion => Int

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

REQUIRED ServiceNamespace => Str

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

Valid values are: "autoscaling", "ecs", "ec2", "rds", "dynamodb"

REQUIRED StartTime => Str

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetScalingPlanResourceForecastData in Paws::AutoScalingPlans

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues