« blib/lib/Paws/AutoScalingPlans/DescribeScalingPlansResponse.pm
↑ Summary
blib/lib/Paws/AutoScalingPlans/GetScalingPlanResourceForecastDataResponse.pm »
| 1 | |||
| 2 | package Paws::AutoScalingPlans::GetScalingPlanResourceForecastData; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has ForecastDataType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ResourceId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has ScalableDimension => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ScalingPlanName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has ScalingPlanVersion => (is => 'ro', isa => 'Int', required => 1); | ||
| 10 | has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has StartTime => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetScalingPlanResourceForecastData'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AutoScalingPlans::GetScalingPlanResourceForecastDataResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::AutoScalingPlans::GetScalingPlanResourceForecastData - Arguments for method GetScalingPlanResourceForecastData on L<Paws::AutoScalingPlans> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method GetScalingPlanResourceForecastData on the | ||
| 29 | L<AWS Auto Scaling Plans|Paws::AutoScalingPlans> service. Use the attributes of this class | ||
| 30 | as arguments to method GetScalingPlanResourceForecastData. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetScalingPlanResourceForecastData. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $autoscaling-plans = Paws->service('AutoScalingPlans'); | ||
| 37 | my $GetScalingPlanResourceForecastDataResponse = | ||
| 38 | $autoscaling -plans->GetScalingPlanResourceForecastData( | ||
| 39 | EndTime => '1970-01-01T01:00:00', | ||
| 40 | ForecastDataType => 'CapacityForecast', | ||
| 41 | ResourceId => 'MyXmlString', | ||
| 42 | ScalableDimension => 'autoscaling:autoScalingGroup:DesiredCapacity', | ||
| 43 | ScalingPlanName => 'MyScalingPlanName', | ||
| 44 | ScalingPlanVersion => 1, | ||
| 45 | ServiceNamespace => 'autoscaling', | ||
| 46 | StartTime => '1970-01-01T01:00:00', | ||
| 47 | |||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $Datapoints = $GetScalingPlanResourceForecastDataResponse->Datapoints; | ||
| 52 | |||
| 53 | # Returns a L<Paws::AutoScalingPlans::GetScalingPlanResourceForecastDataResponse> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/autoscaling-plans/GetScalingPlanResourceForecastData> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> EndTime => Str | ||
| 62 | |||
| 63 | The exclusive end time of the time range for the forecast data to get. | ||
| 64 | The maximum time duration between the start and end time is seven days. | ||
| 65 | |||
| 66 | Although this parameter can accept a date and time that is more than | ||
| 67 | two days in the future, the availability of forecast data has limits. | ||
| 68 | AWS Auto Scaling only issues forecasts for periods of two days in | ||
| 69 | advance. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> ForecastDataType => Str | ||
| 74 | |||
| 75 | The type of forecast data to get. | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<LoadForecast>: The load metric forecast. | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | C<CapacityForecast>: The capacity forecast. | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<ScheduledActionMinCapacity>: The minimum capacity for each scheduled | ||
| 90 | scaling action. This data is calculated as the larger of two values: | ||
| 91 | the capacity forecast or the minimum capacity in the scaling | ||
| 92 | instruction. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<ScheduledActionMaxCapacity>: The maximum capacity for each scheduled | ||
| 97 | scaling action. The calculation used is determined by the predictive | ||
| 98 | scaling maximum capacity behavior setting in the scaling instruction. | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | Valid values are: C<"CapacityForecast">, C<"LoadForecast">, C<"ScheduledActionMinCapacity">, C<"ScheduledActionMaxCapacity"> | ||
| 104 | |||
| 105 | =head2 B<REQUIRED> ResourceId => Str | ||
| 106 | |||
| 107 | The ID of the resource. This string consists of a prefix | ||
| 108 | (C<autoScalingGroup>) followed by the name of a specified Auto Scaling | ||
| 109 | group (C<my-asg>). Example: C<autoScalingGroup/my-asg>. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 B<REQUIRED> ScalableDimension => Str | ||
| 114 | |||
| 115 | The scalable dimension for the resource. The only valid value is | ||
| 116 | C<autoscaling:autoScalingGroup:DesiredCapacity>. | ||
| 117 | |||
| 118 | Valid values are: C<"autoscaling:autoScalingGroup:DesiredCapacity">, C<"ecs:service:DesiredCount">, C<"ec2:spot-fleet-request:TargetCapacity">, C<"rds:cluster:ReadReplicaCount">, C<"dynamodb:table:ReadCapacityUnits">, C<"dynamodb:table:WriteCapacityUnits">, C<"dynamodb:index:ReadCapacityUnits">, C<"dynamodb:index:WriteCapacityUnits"> | ||
| 119 | |||
| 120 | =head2 B<REQUIRED> ScalingPlanName => Str | ||
| 121 | |||
| 122 | The name of the scaling plan. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> ScalingPlanVersion => Int | ||
| 127 | |||
| 128 | The version number of the scaling plan. Currently, the only valid value | ||
| 129 | is C<1>. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> ServiceNamespace => Str | ||
| 134 | |||
| 135 | The namespace of the AWS service. The only valid value is | ||
| 136 | C<autoscaling>. | ||
| 137 | |||
| 138 | Valid values are: C<"autoscaling">, C<"ecs">, C<"ec2">, C<"rds">, C<"dynamodb"> | ||
| 139 | |||
| 140 | =head2 B<REQUIRED> StartTime => Str | ||
| 141 | |||
| 142 | The inclusive start time of the time range for the forecast data to | ||
| 143 | get. The date and time can be at most 56 days before the current date | ||
| 144 | and time. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head1 SEE ALSO | ||
| 150 | |||
| 151 | This class forms part of L<Paws>, documenting arguments for method GetScalingPlanResourceForecastData in L<Paws::AutoScalingPlans> | ||
| 152 | |||
| 153 | =head1 BUGS and CONTRIBUTIONS | ||
| 154 | |||
| 155 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 156 | |||
| 157 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 158 | |||
| 159 | =cut | ||
| 160 |