« blib/lib/Paws/EC2/DescribeReservedInstancesModificationsResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeScheduledInstanceAvailabilityResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeScheduledInstanceAvailability; | ||
| 3 | use Moose; | ||
| 4 | has DryRun => (is => 'ro', isa => 'Bool'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); | ||
| 6 | has FirstSlotStartTimeRange => (is => 'ro', isa => 'Paws::EC2::SlotDateTimeRangeRequest', required => 1); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 8 | has MaxSlotDurationInHours => (is => 'ro', isa => 'Int'); | ||
| 9 | has MinSlotDurationInHours => (is => 'ro', isa => 'Int'); | ||
| 10 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 11 | has Recurrence => (is => 'ro', isa => 'Paws::EC2::ScheduledInstanceRecurrenceRequest', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeScheduledInstanceAvailability'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeScheduledInstanceAvailabilityResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::EC2::DescribeScheduledInstanceAvailability - Arguments for method DescribeScheduledInstanceAvailability on L<Paws::EC2> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method DescribeScheduledInstanceAvailability on the | ||
| 29 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 30 | as arguments to method DescribeScheduledInstanceAvailability. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeScheduledInstanceAvailability. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $ec2 = Paws->service('EC2'); | ||
| 37 | # To describe an available schedule | ||
| 38 | # This example describes a schedule that occurs every week on Sunday, starting | ||
| 39 | # on the specified date. Note that the output contains a single schedule as an | ||
| 40 | # example. | ||
| 41 | my $DescribeScheduledInstanceAvailabilityResult = | ||
| 42 | $ec2->DescribeScheduledInstanceAvailability( | ||
| 43 | 'FirstSlotStartTimeRange' => { | ||
| 44 | 'EarliestTime' => '2016-01-31T00:00:00Z', | ||
| 45 | 'LatestTime' => '2016-01-31T04:00:00Z' | ||
| 46 | }, | ||
| 47 | 'Recurrence' => { | ||
| 48 | 'Frequency' => 'Weekly', | ||
| 49 | 'Interval' => 1, | ||
| 50 | 'OccurrenceDays' => [1] | ||
| 51 | } | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $ScheduledInstanceAvailabilitySet = | ||
| 56 | $DescribeScheduledInstanceAvailabilityResult | ||
| 57 | ->ScheduledInstanceAvailabilitySet; | ||
| 58 | |||
| 59 | # Returns a L<Paws::EC2::DescribeScheduledInstanceAvailabilityResult> object. | ||
| 60 | |||
| 61 | 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. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeScheduledInstanceAvailability> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 DryRun => Bool | ||
| 68 | |||
| 69 | Checks whether you have the required permissions for the action, | ||
| 70 | without actually making the request, and provides an error response. If | ||
| 71 | you have the required permissions, the error response is | ||
| 72 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 77 | |||
| 78 | The filters. | ||
| 79 | |||
| 80 | =over | ||
| 81 | |||
| 82 | =item * | ||
| 83 | |||
| 84 | C<availability-zone> - The Availability Zone (for example, | ||
| 85 | C<us-west-2a>). | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<instance-type> - The instance type (for example, C<c4.large>). | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<network-platform> - The network platform (C<EC2-Classic> or | ||
| 94 | C<EC2-VPC>). | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | C<platform> - The platform (C<Linux/UNIX> or C<Windows>). | ||
| 99 | |||
| 100 | =back | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> FirstSlotStartTimeRange => L<Paws::EC2::SlotDateTimeRangeRequest> | ||
| 106 | |||
| 107 | The time period for the first schedule to start. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 MaxResults => Int | ||
| 112 | |||
| 113 | The maximum number of results to return in a single call. This value | ||
| 114 | can be between 5 and 300. The default value is 300. To retrieve the | ||
| 115 | remaining results, make another call with the returned C<NextToken> | ||
| 116 | value. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 MaxSlotDurationInHours => Int | ||
| 121 | |||
| 122 | The maximum available duration, in hours. This value must be greater | ||
| 123 | than C<MinSlotDurationInHours> and less than 1,720. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 MinSlotDurationInHours => Int | ||
| 128 | |||
| 129 | The minimum available duration, in hours. The minimum required duration | ||
| 130 | is 1,200 hours per year. For example, the minimum daily schedule is 4 | ||
| 131 | hours, the minimum weekly schedule is 24 hours, and the minimum monthly | ||
| 132 | schedule is 100 hours. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 NextToken => Str | ||
| 137 | |||
| 138 | The token for the next set of results. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> Recurrence => L<Paws::EC2::ScheduledInstanceRecurrenceRequest> | ||
| 143 | |||
| 144 | The schedule recurrence. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head1 SEE ALSO | ||
| 150 | |||
| 151 | This class forms part of L<Paws>, documenting arguments for method DescribeScheduledInstanceAvailability in L<Paws::EC2> | ||
| 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 |