blib/lib/Paws/EC2/DescribeSpotInstanceRequests.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/DescribeSnapshotsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSpotInstanceRequestsResult.pm »
1  
2 package Paws::EC2::DescribeSpotInstanceRequests;
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 MaxResults => (is => 'ro', isa => 'Int');
7 1 has NextToken => (is => 'ro', isa => 'Str');
8 1 has SpotInstanceRequestIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SpotInstanceRequestId' );
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 => 'DescribeSpotInstanceRequests');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSpotInstanceRequestsResult');
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::DescribeSpotInstanceRequests - Arguments for method DescribeSpotInstanceRequests on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeSpotInstanceRequests on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeSpotInstanceRequests.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSpotInstanceRequests.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 # To describe a Spot Instance request
35 # This example describes the specified Spot Instance request.
36 my $DescribeSpotInstanceRequestsResult = $ec2->DescribeSpotInstanceRequests(
37 'SpotInstanceRequestIds' => ['sir-08b93456'] );
38  
39 # Results:
40 my $SpotInstanceRequests =
41 $DescribeSpotInstanceRequestsResult->SpotInstanceRequests;
42  
43 # Returns a L<Paws::EC2::DescribeSpotInstanceRequestsResult> object.
44  
45 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.
46 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeSpotInstanceRequests>
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 DryRun => Bool
52  
53 Checks whether you have the required permissions for the action,
54 without actually making the request, and provides an error response. If
55 you have the required permissions, the error response is
56 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
57  
58  
59  
60 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
61  
62 One or more filters.
63  
64 =over
65  
66 =item *
67  
68 C<availability-zone-group> - The Availability Zone group.
69  
70 =item *
71  
72 C<create-time> - The time stamp when the Spot Instance request was
73 created.
74  
75 =item *
76  
77 C<fault-code> - The fault code related to the request.
78  
79 =item *
80  
81 C<fault-message> - The fault message related to the request.
82  
83 =item *
84  
85 C<instance-id> - The ID of the instance that fulfilled the request.
86  
87 =item *
88  
89 C<launch-group> - The Spot Instance launch group.
90  
91 =item *
92  
93 C<launch.block-device-mapping.delete-on-termination> - Indicates
94 whether the EBS volume is deleted on instance termination.
95  
96 =item *
97  
98 C<launch.block-device-mapping.device-name> - The device name for the
99 volume in the block device mapping (for example, C</dev/sdh> or
100 C<xvdh>).
101  
102 =item *
103  
104 C<launch.block-device-mapping.snapshot-id> - The ID of the snapshot for
105 the EBS volume.
106  
107 =item *
108  
109 C<launch.block-device-mapping.volume-size> - The size of the EBS
110 volume, in GiB.
111  
112 =item *
113  
114 C<launch.block-device-mapping.volume-type> - The type of EBS volume:
115 C<gp2> for General Purpose SSD, C<io1> or C<io2> for Provisioned IOPS
116 SSD, C<st1> for Throughput Optimized HDD, C<sc1>for Cold HDD, or
117 C<standard> for Magnetic.
118  
119 =item *
120  
121 C<launch.group-id> - The ID of the security group for the instance.
122  
123 =item *
124  
125 C<launch.group-name> - The name of the security group for the instance.
126  
127 =item *
128  
129 C<launch.image-id> - The ID of the AMI.
130  
131 =item *
132  
133 C<launch.instance-type> - The type of instance (for example,
134 C<m3.medium>).
135  
136 =item *
137  
138 C<launch.kernel-id> - The kernel ID.
139  
140 =item *
141  
142 C<launch.key-name> - The name of the key pair the instance launched
143 with.
144  
145 =item *
146  
147 C<launch.monitoring-enabled> - Whether detailed monitoring is enabled
148 for the Spot Instance.
149  
150 =item *
151  
152 C<launch.ramdisk-id> - The RAM disk ID.
153  
154 =item *
155  
156 C<launched-availability-zone> - The Availability Zone in which the
157 request is launched.
158  
159 =item *
160  
161 C<network-interface.addresses.primary> - Indicates whether the IP
162 address is the primary private IP address.
163  
164 =item *
165  
166 C<network-interface.delete-on-termination> - Indicates whether the
167 network interface is deleted when the instance is terminated.
168  
169 =item *
170  
171 C<network-interface.description> - A description of the network
172 interface.
173  
174 =item *
175  
176 C<network-interface.device-index> - The index of the device for the
177 network interface attachment on the instance.
178  
179 =item *
180  
181 C<network-interface.group-id> - The ID of the security group associated
182 with the network interface.
183  
184 =item *
185  
186 C<network-interface.network-interface-id> - The ID of the network
187 interface.
188  
189 =item *
190  
191 C<network-interface.private-ip-address> - The primary private IP
192 address of the network interface.
193  
194 =item *
195  
196 C<network-interface.subnet-id> - The ID of the subnet for the instance.
197  
198 =item *
199  
200 C<product-description> - The product description associated with the
201 instance (C<Linux/UNIX> | C<Windows>).
202  
203 =item *
204  
205 C<spot-instance-request-id> - The Spot Instance request ID.
206  
207 =item *
208  
209 C<spot-price> - The maximum hourly price for any Spot Instance launched
210 to fulfill the request.
211  
212 =item *
213  
214 C<state> - The state of the Spot Instance request (C<open> | C<active>
215 | C<closed> | C<cancelled> | C<failed>). Spot request status
216 information can help you track your Amazon EC2 Spot Instance requests.
217 For more information, see Spot request status
218 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html)
219 in the I<Amazon EC2 User Guide for Linux Instances>.
220  
221 =item *
222  
223 C<status-code> - The short code describing the most recent evaluation
224 of your Spot Instance request.
225  
226 =item *
227  
228 C<status-message> - The message explaining the status of the Spot
229 Instance request.
230  
231 =item *
232  
233 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
234 the resource. Use the tag key in the filter name and the tag value as
235 the filter value. For example, to find all resources that have a tag
236 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
237 the filter name and C<TeamA> for the filter value.
238  
239 =item *
240  
241 C<tag-key> - The key of a tag assigned to the resource. Use this filter
242 to find all resources assigned a tag with a specific key, regardless of
243 the tag value.
244  
245 =item *
246  
247 C<type> - The type of Spot Instance request (C<one-time> |
248 C<persistent>).
249  
250 =item *
251  
252 C<valid-from> - The start date of the request.
253  
254 =item *
255  
256 C<valid-until> - The end date of the request.
257  
258 =back
259  
260  
261  
262  
263 =head2 MaxResults => Int
264  
265 The maximum number of results to return in a single call. Specify a
266 value between 5 and 1000. To retrieve the remaining results, make
267 another call with the returned C<NextToken> value.
268  
269  
270  
271 =head2 NextToken => Str
272  
273 The token to request the next set of results. This value is C<null>
274 when there are no more results to return.
275  
276  
277  
278 =head2 SpotInstanceRequestIds => ArrayRef[Str|Undef]
279  
280 One or more Spot Instance request IDs.
281  
282  
283  
284  
285 =head1 SEE ALSO
286  
287 This class forms part of L<Paws>, documenting arguments for method DescribeSpotInstanceRequests in L<Paws::EC2>
288  
289 =head1 BUGS and CONTRIBUTIONS
290  
291 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
292  
293 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
294  
295 =cut
296  
« blib/lib/Paws/EC2/DescribeSnapshotsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSpotInstanceRequestsResult.pm »