blib/lib/Paws/EC2/DescribeReservedInstances.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeRegionsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeReservedInstancesOfferings.pm »
1  
2 package Paws::EC2::DescribeReservedInstances;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6 1 has OfferingClass => (is => 'ro', isa => 'Str');
7 1 has OfferingType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'offeringType' );
8 1 has ReservedInstancesIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ReservedInstancesId' );
9  
10 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeReservedInstances');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeReservedInstancesResult');
14 1 class_has _result_key => (isa => 'Str', is => 'ro');
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::EC2::DescribeReservedInstances - Arguments for method DescribeReservedInstances on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeReservedInstances on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeReservedInstances.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeReservedInstances.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 my $DescribeReservedInstancesResult = $ec2->DescribeReservedInstances(
35 DryRun => 1, # OPTIONAL
36 Filters => [
37 {
38 Name => 'MyString', # OPTIONAL
39 Values => [
40 'MyString', ... # OPTIONAL
41 ], # OPTIONAL
42 },
43 ...
44 ], # OPTIONAL
45 OfferingClass => 'standard', # OPTIONAL
46 OfferingType => 'Heavy Utilization', # OPTIONAL
47 ReservedInstancesIds => [ 'MyReservationId', ... ], # OPTIONAL
48 );
49  
50 # Results:
51 my $ReservedInstances = $DescribeReservedInstancesResult->ReservedInstances;
52  
53 # Returns a L<Paws::EC2::DescribeReservedInstancesResult> 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/ec2/DescribeReservedInstances>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 DryRun => Bool
62  
63 Checks whether you have the required permissions for the action,
64 without actually making the request, and provides an error response. If
65 you have the required permissions, the error response is
66 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
67  
68  
69  
70 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
71  
72 One or more filters.
73  
74 =over
75  
76 =item *
77  
78 C<availability-zone> - The Availability Zone where the Reserved
79 Instance can be used.
80  
81 =item *
82  
83 C<duration> - The duration of the Reserved Instance (one year or three
84 years), in seconds (C<31536000> | C<94608000>).
85  
86 =item *
87  
88 C<end> - The time when the Reserved Instance expires (for example,
89 2015-08-07T11:54:42.000Z).
90  
91 =item *
92  
93 C<fixed-price> - The purchase price of the Reserved Instance (for
94 example, 9800.0).
95  
96 =item *
97  
98 C<instance-type> - The instance type that is covered by the
99 reservation.
100  
101 =item *
102  
103 C<scope> - The scope of the Reserved Instance (C<Region> or
104 C<Availability Zone>).
105  
106 =item *
107  
108 C<product-description> - The Reserved Instance product platform
109 description. Instances that include C<(Amazon VPC)> in the product
110 platform description will only be displayed to EC2-Classic account
111 holders and are for use with Amazon VPC (C<Linux/UNIX> | C<Linux/UNIX
112 (Amazon VPC)> | C<SUSE Linux> | C<SUSE Linux (Amazon VPC)> | C<Red Hat
113 Enterprise Linux> | C<Red Hat Enterprise Linux (Amazon VPC)> | C<Red
114 Hat Enterprise Linux with HA (Amazon VPC)> | C<Windows> | C<Windows
115 (Amazon VPC)> | C<Windows with SQL Server Standard> | C<Windows with
116 SQL Server Standard (Amazon VPC)> | C<Windows with SQL Server Web> |
117 C<Windows with SQL Server Web (Amazon VPC)> | C<Windows with SQL Server
118 Enterprise> | C<Windows with SQL Server Enterprise (Amazon VPC)>).
119  
120 =item *
121  
122 C<reserved-instances-id> - The ID of the Reserved Instance.
123  
124 =item *
125  
126 C<start> - The time at which the Reserved Instance purchase request was
127 placed (for example, 2014-08-07T11:54:42.000Z).
128  
129 =item *
130  
131 C<state> - The state of the Reserved Instance (C<payment-pending> |
132 C<active> | C<payment-failed> | C<retired>).
133  
134 =item *
135  
136 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
137 the resource. Use the tag key in the filter name and the tag value as
138 the filter value. For example, to find all resources that have a tag
139 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
140 the filter name and C<TeamA> for the filter value.
141  
142 =item *
143  
144 C<tag-key> - The key of a tag assigned to the resource. Use this filter
145 to find all resources assigned a tag with a specific key, regardless of
146 the tag value.
147  
148 =item *
149  
150 C<usage-price> - The usage price of the Reserved Instance, per hour
151 (for example, 0.84).
152  
153 =back
154  
155  
156  
157  
158 =head2 OfferingClass => Str
159  
160 Describes whether the Reserved Instance is Standard or Convertible.
161  
162 Valid values are: C<"standard">, C<"convertible">
163  
164 =head2 OfferingType => Str
165  
166 The Reserved Instance offering type. If you are using tools that
167 predate the 2011-11-01 API version, you only have access to the
168 C<Medium Utilization> Reserved Instance offering type.
169  
170 Valid values are: C<"Heavy Utilization">, C<"Medium Utilization">, C<"Light Utilization">, C<"No Upfront">, C<"Partial Upfront">, C<"All Upfront">
171  
172 =head2 ReservedInstancesIds => ArrayRef[Str|Undef]
173  
174 One or more Reserved Instance IDs.
175  
176 Default: Describes all your Reserved Instances, or only those otherwise
177 specified.
178  
179  
180  
181  
182 =head1 SEE ALSO
183  
184 This class forms part of L<Paws>, documenting arguments for method DescribeReservedInstances in L<Paws::EC2>
185  
186 =head1 BUGS and CONTRIBUTIONS
187  
188 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
189  
190 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
191  
192 =cut
193  
« blib/lib/Paws/EC2/DescribeRegionsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeReservedInstancesOfferings.pm »