File Coverage

blib/lib/Paws/EC2/DescribeSpotInstanceRequests.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EC2::DescribeSpotInstanceRequests;
3 1     1   352 use Moose;
  1     1   3  
  1         5  
  1         510  
  1         3  
  1         8  
4             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6             has SpotInstanceRequestIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SpotInstanceRequestId' );
7              
8 1     1   5363 use MooseX::ClassAttribute;
  1     1   2  
  1         7  
  1         6502  
  1         3  
  1         10  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSpotInstanceRequests');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSpotInstanceRequestsResult');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::EC2::DescribeSpotInstanceRequests - Arguments for method DescribeSpotInstanceRequests on Paws::EC2
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeSpotInstanceRequests on the
24             Amazon Elastic Compute Cloud service. Use the attributes of this class
25             as arguments to method DescribeSpotInstanceRequests.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSpotInstanceRequests.
28              
29             As an example:
30              
31             $service_obj->DescribeSpotInstanceRequests(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 DryRun => Bool
39              
40             Checks whether you have the required permissions for the action,
41             without actually making the request, and provides an error response. If
42             you have the required permissions, the error response is
43             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
44              
45              
46              
47             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
48              
49             One or more filters.
50              
51             =over
52              
53             =item *
54              
55             C<availability-zone-group> - The Availability Zone group.
56              
57             =item *
58              
59             C<create-time> - The time stamp when the Spot instance request was
60             created.
61              
62             =item *
63              
64             C<fault-code> - The fault code related to the request.
65              
66             =item *
67              
68             C<fault-message> - The fault message related to the request.
69              
70             =item *
71              
72             C<instance-id> - The ID of the instance that fulfilled the request.
73              
74             =item *
75              
76             C<launch-group> - The Spot instance launch group.
77              
78             =item *
79              
80             C<launch.block-device-mapping.delete-on-termination> - Indicates
81             whether the Amazon EBS volume is deleted on instance termination.
82              
83             =item *
84              
85             C<launch.block-device-mapping.device-name> - The device name for the
86             Amazon EBS volume (for example, C</dev/sdh>).
87              
88             =item *
89              
90             C<launch.block-device-mapping.snapshot-id> - The ID of the snapshot
91             used for the Amazon EBS volume.
92              
93             =item *
94              
95             C<launch.block-device-mapping.volume-size> - The size of the Amazon EBS
96             volume, in GiB.
97              
98             =item *
99              
100             C<launch.block-device-mapping.volume-type> - The type of the Amazon EBS
101             volume: C<gp2> for General Purpose SSD, C<io1> for Provisioned IOPS
102             SSD, C<st1> for Throughput Optimized HDD, C<sc1>for Cold HDD, or
103             C<standard> for Magnetic.
104              
105             =item *
106              
107             C<launch.group-id> - The security group for the instance.
108              
109             =item *
110              
111             C<launch.image-id> - The ID of the AMI.
112              
113             =item *
114              
115             C<launch.instance-type> - The type of instance (for example,
116             C<m3.medium>).
117              
118             =item *
119              
120             C<launch.kernel-id> - The kernel ID.
121              
122             =item *
123              
124             C<launch.key-name> - The name of the key pair the instance launched
125             with.
126              
127             =item *
128              
129             C<launch.monitoring-enabled> - Whether detailed monitoring is enabled
130             for the Spot instance.
131              
132             =item *
133              
134             C<launch.ramdisk-id> - The RAM disk ID.
135              
136             =item *
137              
138             C<launched-availability-zone> - The Availability Zone in which the bid
139             is launched.
140              
141             =item *
142              
143             C<network-interface.addresses.primary> - Indicates whether the IP
144             address is the primary private IP address.
145              
146             =item *
147              
148             C<network-interface.delete-on-termination> - Indicates whether the
149             network interface is deleted when the instance is terminated.
150              
151             =item *
152              
153             C<network-interface.description> - A description of the network
154             interface.
155              
156             =item *
157              
158             C<network-interface.device-index> - The index of the device for the
159             network interface attachment on the instance.
160              
161             =item *
162              
163             C<network-interface.group-id> - The ID of the security group associated
164             with the network interface.
165              
166             =item *
167              
168             C<network-interface.network-interface-id> - The ID of the network
169             interface.
170              
171             =item *
172              
173             C<network-interface.private-ip-address> - The primary private IP
174             address of the network interface.
175              
176             =item *
177              
178             C<network-interface.subnet-id> - The ID of the subnet for the instance.
179              
180             =item *
181              
182             C<product-description> - The product description associated with the
183             instance (C<Linux/UNIX> | C<Windows>).
184              
185             =item *
186              
187             C<spot-instance-request-id> - The Spot instance request ID.
188              
189             =item *
190              
191             C<spot-price> - The maximum hourly price for any Spot instance launched
192             to fulfill the request.
193              
194             =item *
195              
196             C<state> - The state of the Spot instance request (C<open> | C<active>
197             | C<closed> | C<cancelled> | C<failed>). Spot bid status information
198             can help you track your Amazon EC2 Spot instance requests. For more
199             information, see Spot Bid Status in the Amazon Elastic Compute Cloud
200             User Guide.
201              
202             =item *
203              
204             C<status-code> - The short code describing the most recent evaluation
205             of your Spot instance request.
206              
207             =item *
208              
209             C<status-message> - The message explaining the status of the Spot
210             instance request.
211              
212             =item *
213              
214             C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
215             the resource. Specify the key of the tag in the filter name and the
216             value of the tag in the filter value. For example, for the tag
217             Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
218             filter value.
219              
220             =item *
221              
222             C<tag-key> - The key of a tag assigned to the resource. This filter is
223             independent of the C<tag-value> filter. For example, if you use both
224             the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
225             resources assigned both the tag key Purpose (regardless of what the
226             tag's value is), and the tag value X (regardless of what the tag's key
227             is). If you want to list only resources where Purpose is X, see the
228             C<tag>:I<key>=I<value> filter.
229              
230             =item *
231              
232             C<tag-value> - The value of a tag assigned to the resource. This filter
233             is independent of the C<tag-key> filter.
234              
235             =item *
236              
237             C<type> - The type of Spot instance request (C<one-time> |
238             C<persistent>).
239              
240             =item *
241              
242             C<valid-from> - The start date of the request.
243              
244             =item *
245              
246             C<valid-until> - The end date of the request.
247              
248             =back
249              
250              
251              
252              
253             =head2 SpotInstanceRequestIds => ArrayRef[Str|Undef]
254              
255             One or more Spot instance request IDs.
256              
257              
258              
259              
260             =head1 SEE ALSO
261              
262             This class forms part of L<Paws>, documenting arguments for method DescribeSpotInstanceRequests in L<Paws::EC2>
263              
264             =head1 BUGS and CONTRIBUTIONS
265              
266             The source code is located here: https://github.com/pplu/aws-sdk-perl
267              
268             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
269              
270             =cut
271