« blib/lib/Paws/EC2/DescribeScheduledInstanceAvailabilityResult.pm
↑ Summary
blib/lib/Paws/EC2/DescribeScheduledInstancesResult.pm »
| 1 | |||
| 2 | package Paws::EC2::DescribeScheduledInstances; | ||
| 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 MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has ScheduledInstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ScheduledInstanceId' ); | ||
| 9 | has SlotStartTimeRange => (is => 'ro', isa => 'Paws::EC2::SlotStartTimeRangeRequest'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeScheduledInstances'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeScheduledInstancesResult'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::EC2::DescribeScheduledInstances - Arguments for method DescribeScheduledInstances on L<Paws::EC2> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method DescribeScheduledInstances on the | ||
| 27 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 28 | as arguments to method DescribeScheduledInstances. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeScheduledInstances. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $ec2 = Paws->service('EC2'); | ||
| 35 | # To describe your Scheduled Instances | ||
| 36 | # This example describes the specified Scheduled Instance. | ||
| 37 | my $DescribeScheduledInstancesResult = $ec2->DescribeScheduledInstances( | ||
| 38 | 'ScheduledInstanceIds' => ['sci-1234-1234-1234-1234-123456789012'] ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $ScheduledInstanceSet = | ||
| 42 | $DescribeScheduledInstancesResult->ScheduledInstanceSet; | ||
| 43 | |||
| 44 | # Returns a L<Paws::EC2::DescribeScheduledInstancesResult> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeScheduledInstances> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DryRun => Bool | ||
| 53 | |||
| 54 | Checks whether you have the required permissions for the action, | ||
| 55 | without actually making the request, and provides an error response. If | ||
| 56 | you have the required permissions, the error response is | ||
| 57 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 Filters => ArrayRef[L<Paws::EC2::Filter>] | ||
| 62 | |||
| 63 | The filters. | ||
| 64 | |||
| 65 | =over | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<availability-zone> - The Availability Zone (for example, | ||
| 70 | C<us-west-2a>). | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | C<instance-type> - The instance type (for example, C<c4.large>). | ||
| 75 | |||
| 76 | =item * | ||
| 77 | |||
| 78 | C<network-platform> - The network platform (C<EC2-Classic> or | ||
| 79 | C<EC2-VPC>). | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<platform> - The platform (C<Linux/UNIX> or C<Windows>). | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 MaxResults => Int | ||
| 91 | |||
| 92 | The maximum number of results to return in a single call. This value | ||
| 93 | can be between 5 and 300. The default value is 100. To retrieve the | ||
| 94 | remaining results, make another call with the returned C<NextToken> | ||
| 95 | value. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 NextToken => Str | ||
| 100 | |||
| 101 | The token for the next set of results. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 ScheduledInstanceIds => ArrayRef[Str|Undef] | ||
| 106 | |||
| 107 | The Scheduled Instance IDs. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 SlotStartTimeRange => L<Paws::EC2::SlotStartTimeRangeRequest> | ||
| 112 | |||
| 113 | The time period for the first schedule to start. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, documenting arguments for method DescribeScheduledInstances in L<Paws::EC2> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |