-
Notifications
You must be signed in to change notification settings - Fork 546
/
DescribeInstancesCommand.ts
401 lines (398 loc) · 30.2 KB
/
DescribeInstancesCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
// smithy-typescript generated code
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { EC2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EC2Client";
import { commonParams } from "../endpoint/EndpointParameters";
import { DescribeInstancesRequest, DescribeInstancesResult } from "../models/models_4";
import { de_DescribeInstancesCommand, se_DescribeInstancesCommand } from "../protocols/Aws_ec2";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link DescribeInstancesCommand}.
*/
export interface DescribeInstancesCommandInput extends DescribeInstancesRequest {}
/**
* @public
*
* The output of {@link DescribeInstancesCommand}.
*/
export interface DescribeInstancesCommandOutput extends DescribeInstancesResult, __MetadataBearer {}
/**
* <p>Describes the specified instances or all instances.</p>
* <p>If you specify instance IDs, the output includes information for only the specified
* instances. If you specify filters, the output includes information for only those
* instances that meet the filter criteria. If you do not specify instance IDs or filters,
* the output includes information for all instances, which can affect performance. We
* recommend that you use pagination to ensure that the operation returns quickly and
* successfully.</p>
* <p>If you specify an instance ID that is not valid, an error is returned. If you specify
* an instance that you do not own, it is not included in the output.</p>
* <p>Recently terminated instances might appear in the returned results. This interval is
* usually less than one hour.</p>
* <p>If you describe instances in the rare case where an Availability Zone is experiencing
* a service disruption and you specify instance IDs that are in the affected zone, or do
* not specify any instance IDs at all, the call fails. If you describe instances and
* specify only instance IDs that are in an unaffected zone, the call works
* normally.</p>
* <note>
* <p>The order of the elements in the response, including those within nested
* structures, might vary. Applications should not assume the elements appear in a
* particular order.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { EC2Client, DescribeInstancesCommand } from "@aws-sdk/client-ec2"; // ES Modules import
* // const { EC2Client, DescribeInstancesCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
* const client = new EC2Client(config);
* const input = { // DescribeInstancesRequest
* Filters: [ // FilterList
* { // Filter
* Name: "STRING_VALUE",
* Values: [ // ValueStringList
* "STRING_VALUE",
* ],
* },
* ],
* InstanceIds: [ // InstanceIdStringList
* "STRING_VALUE",
* ],
* DryRun: true || false,
* MaxResults: Number("int"),
* NextToken: "STRING_VALUE",
* };
* const command = new DescribeInstancesCommand(input);
* const response = await client.send(command);
* // { // DescribeInstancesResult
* // Reservations: [ // ReservationList
* // { // Reservation
* // Groups: [ // GroupIdentifierList
* // { // GroupIdentifier
* // GroupName: "STRING_VALUE",
* // GroupId: "STRING_VALUE",
* // },
* // ],
* // Instances: [ // InstanceList
* // { // Instance
* // AmiLaunchIndex: Number("int"),
* // ImageId: "STRING_VALUE",
* // InstanceId: "STRING_VALUE",
* // InstanceType: "a1.medium" || "a1.large" || "a1.xlarge" || "a1.2xlarge" || "a1.4xlarge" || "a1.metal" || "c1.medium" || "c1.xlarge" || "c3.large" || "c3.xlarge" || "c3.2xlarge" || "c3.4xlarge" || "c3.8xlarge" || "c4.large" || "c4.xlarge" || "c4.2xlarge" || "c4.4xlarge" || "c4.8xlarge" || "c5.large" || "c5.xlarge" || "c5.2xlarge" || "c5.4xlarge" || "c5.9xlarge" || "c5.12xlarge" || "c5.18xlarge" || "c5.24xlarge" || "c5.metal" || "c5a.large" || "c5a.xlarge" || "c5a.2xlarge" || "c5a.4xlarge" || "c5a.8xlarge" || "c5a.12xlarge" || "c5a.16xlarge" || "c5a.24xlarge" || "c5ad.large" || "c5ad.xlarge" || "c5ad.2xlarge" || "c5ad.4xlarge" || "c5ad.8xlarge" || "c5ad.12xlarge" || "c5ad.16xlarge" || "c5ad.24xlarge" || "c5d.large" || "c5d.xlarge" || "c5d.2xlarge" || "c5d.4xlarge" || "c5d.9xlarge" || "c5d.12xlarge" || "c5d.18xlarge" || "c5d.24xlarge" || "c5d.metal" || "c5n.large" || "c5n.xlarge" || "c5n.2xlarge" || "c5n.4xlarge" || "c5n.9xlarge" || "c5n.18xlarge" || "c5n.metal" || "c6g.medium" || "c6g.large" || "c6g.xlarge" || "c6g.2xlarge" || "c6g.4xlarge" || "c6g.8xlarge" || "c6g.12xlarge" || "c6g.16xlarge" || "c6g.metal" || "c6gd.medium" || "c6gd.large" || "c6gd.xlarge" || "c6gd.2xlarge" || "c6gd.4xlarge" || "c6gd.8xlarge" || "c6gd.12xlarge" || "c6gd.16xlarge" || "c6gd.metal" || "c6gn.medium" || "c6gn.large" || "c6gn.xlarge" || "c6gn.2xlarge" || "c6gn.4xlarge" || "c6gn.8xlarge" || "c6gn.12xlarge" || "c6gn.16xlarge" || "c6i.large" || "c6i.xlarge" || "c6i.2xlarge" || "c6i.4xlarge" || "c6i.8xlarge" || "c6i.12xlarge" || "c6i.16xlarge" || "c6i.24xlarge" || "c6i.32xlarge" || "c6i.metal" || "cc1.4xlarge" || "cc2.8xlarge" || "cg1.4xlarge" || "cr1.8xlarge" || "d2.xlarge" || "d2.2xlarge" || "d2.4xlarge" || "d2.8xlarge" || "d3.xlarge" || "d3.2xlarge" || "d3.4xlarge" || "d3.8xlarge" || "d3en.xlarge" || "d3en.2xlarge" || "d3en.4xlarge" || "d3en.6xlarge" || "d3en.8xlarge" || "d3en.12xlarge" || "dl1.24xlarge" || "f1.2xlarge" || "f1.4xlarge" || "f1.16xlarge" || "g2.2xlarge" || "g2.8xlarge" || "g3.4xlarge" || "g3.8xlarge" || "g3.16xlarge" || "g3s.xlarge" || "g4ad.xlarge" || "g4ad.2xlarge" || "g4ad.4xlarge" || "g4ad.8xlarge" || "g4ad.16xlarge" || "g4dn.xlarge" || "g4dn.2xlarge" || "g4dn.4xlarge" || "g4dn.8xlarge" || "g4dn.12xlarge" || "g4dn.16xlarge" || "g4dn.metal" || "g5.xlarge" || "g5.2xlarge" || "g5.4xlarge" || "g5.8xlarge" || "g5.12xlarge" || "g5.16xlarge" || "g5.24xlarge" || "g5.48xlarge" || "g5g.xlarge" || "g5g.2xlarge" || "g5g.4xlarge" || "g5g.8xlarge" || "g5g.16xlarge" || "g5g.metal" || "hi1.4xlarge" || "hpc6a.48xlarge" || "hs1.8xlarge" || "h1.2xlarge" || "h1.4xlarge" || "h1.8xlarge" || "h1.16xlarge" || "i2.xlarge" || "i2.2xlarge" || "i2.4xlarge" || "i2.8xlarge" || "i3.large" || "i3.xlarge" || "i3.2xlarge" || "i3.4xlarge" || "i3.8xlarge" || "i3.16xlarge" || "i3.metal" || "i3en.large" || "i3en.xlarge" || "i3en.2xlarge" || "i3en.3xlarge" || "i3en.6xlarge" || "i3en.12xlarge" || "i3en.24xlarge" || "i3en.metal" || "im4gn.large" || "im4gn.xlarge" || "im4gn.2xlarge" || "im4gn.4xlarge" || "im4gn.8xlarge" || "im4gn.16xlarge" || "inf1.xlarge" || "inf1.2xlarge" || "inf1.6xlarge" || "inf1.24xlarge" || "is4gen.medium" || "is4gen.large" || "is4gen.xlarge" || "is4gen.2xlarge" || "is4gen.4xlarge" || "is4gen.8xlarge" || "m1.small" || "m1.medium" || "m1.large" || "m1.xlarge" || "m2.xlarge" || "m2.2xlarge" || "m2.4xlarge" || "m3.medium" || "m3.large" || "m3.xlarge" || "m3.2xlarge" || "m4.large" || "m4.xlarge" || "m4.2xlarge" || "m4.4xlarge" || "m4.10xlarge" || "m4.16xlarge" || "m5.large" || "m5.xlarge" || "m5.2xlarge" || "m5.4xlarge" || "m5.8xlarge" || "m5.12xlarge" || "m5.16xlarge" || "m5.24xlarge" || "m5.metal" || "m5a.large" || "m5a.xlarge" || "m5a.2xlarge" || "m5a.4xlarge" || "m5a.8xlarge" || "m5a.12xlarge" || "m5a.16xlarge" || "m5a.24xlarge" || "m5ad.large" || "m5ad.xlarge" || "m5ad.2xlarge" || "m5ad.4xlarge" || "m5ad.8xlarge" || "m5ad.12xlarge" || "m5ad.16xlarge" || "m5ad.24xlarge" || "m5d.large" || "m5d.xlarge" || "m5d.2xlarge" || "m5d.4xlarge" || "m5d.8xlarge" || "m5d.12xlarge" || "m5d.16xlarge" || "m5d.24xlarge" || "m5d.metal" || "m5dn.large" || "m5dn.xlarge" || "m5dn.2xlarge" || "m5dn.4xlarge" || "m5dn.8xlarge" || "m5dn.12xlarge" || "m5dn.16xlarge" || "m5dn.24xlarge" || "m5dn.metal" || "m5n.large" || "m5n.xlarge" || "m5n.2xlarge" || "m5n.4xlarge" || "m5n.8xlarge" || "m5n.12xlarge" || "m5n.16xlarge" || "m5n.24xlarge" || "m5n.metal" || "m5zn.large" || "m5zn.xlarge" || "m5zn.2xlarge" || "m5zn.3xlarge" || "m5zn.6xlarge" || "m5zn.12xlarge" || "m5zn.metal" || "m6a.large" || "m6a.xlarge" || "m6a.2xlarge" || "m6a.4xlarge" || "m6a.8xlarge" || "m6a.12xlarge" || "m6a.16xlarge" || "m6a.24xlarge" || "m6a.32xlarge" || "m6a.48xlarge" || "m6g.metal" || "m6g.medium" || "m6g.large" || "m6g.xlarge" || "m6g.2xlarge" || "m6g.4xlarge" || "m6g.8xlarge" || "m6g.12xlarge" || "m6g.16xlarge" || "m6gd.metal" || "m6gd.medium" || "m6gd.large" || "m6gd.xlarge" || "m6gd.2xlarge" || "m6gd.4xlarge" || "m6gd.8xlarge" || "m6gd.12xlarge" || "m6gd.16xlarge" || "m6i.large" || "m6i.xlarge" || "m6i.2xlarge" || "m6i.4xlarge" || "m6i.8xlarge" || "m6i.12xlarge" || "m6i.16xlarge" || "m6i.24xlarge" || "m6i.32xlarge" || "m6i.metal" || "mac1.metal" || "p2.xlarge" || "p2.8xlarge" || "p2.16xlarge" || "p3.2xlarge" || "p3.8xlarge" || "p3.16xlarge" || "p3dn.24xlarge" || "p4d.24xlarge" || "r3.large" || "r3.xlarge" || "r3.2xlarge" || "r3.4xlarge" || "r3.8xlarge" || "r4.large" || "r4.xlarge" || "r4.2xlarge" || "r4.4xlarge" || "r4.8xlarge" || "r4.16xlarge" || "r5.large" || "r5.xlarge" || "r5.2xlarge" || "r5.4xlarge" || "r5.8xlarge" || "r5.12xlarge" || "r5.16xlarge" || "r5.24xlarge" || "r5.metal" || "r5a.large" || "r5a.xlarge" || "r5a.2xlarge" || "r5a.4xlarge" || "r5a.8xlarge" || "r5a.12xlarge" || "r5a.16xlarge" || "r5a.24xlarge" || "r5ad.large" || "r5ad.xlarge" || "r5ad.2xlarge" || "r5ad.4xlarge" || "r5ad.8xlarge" || "r5ad.12xlarge" || "r5ad.16xlarge" || "r5ad.24xlarge" || "r5b.large" || "r5b.xlarge" || "r5b.2xlarge" || "r5b.4xlarge" || "r5b.8xlarge" || "r5b.12xlarge" || "r5b.16xlarge" || "r5b.24xlarge" || "r5b.metal" || "r5d.large" || "r5d.xlarge" || "r5d.2xlarge" || "r5d.4xlarge" || "r5d.8xlarge" || "r5d.12xlarge" || "r5d.16xlarge" || "r5d.24xlarge" || "r5d.metal" || "r5dn.large" || "r5dn.xlarge" || "r5dn.2xlarge" || "r5dn.4xlarge" || "r5dn.8xlarge" || "r5dn.12xlarge" || "r5dn.16xlarge" || "r5dn.24xlarge" || "r5dn.metal" || "r5n.large" || "r5n.xlarge" || "r5n.2xlarge" || "r5n.4xlarge" || "r5n.8xlarge" || "r5n.12xlarge" || "r5n.16xlarge" || "r5n.24xlarge" || "r5n.metal" || "r6g.medium" || "r6g.large" || "r6g.xlarge" || "r6g.2xlarge" || "r6g.4xlarge" || "r6g.8xlarge" || "r6g.12xlarge" || "r6g.16xlarge" || "r6g.metal" || "r6gd.medium" || "r6gd.large" || "r6gd.xlarge" || "r6gd.2xlarge" || "r6gd.4xlarge" || "r6gd.8xlarge" || "r6gd.12xlarge" || "r6gd.16xlarge" || "r6gd.metal" || "r6i.large" || "r6i.xlarge" || "r6i.2xlarge" || "r6i.4xlarge" || "r6i.8xlarge" || "r6i.12xlarge" || "r6i.16xlarge" || "r6i.24xlarge" || "r6i.32xlarge" || "r6i.metal" || "t1.micro" || "t2.nano" || "t2.micro" || "t2.small" || "t2.medium" || "t2.large" || "t2.xlarge" || "t2.2xlarge" || "t3.nano" || "t3.micro" || "t3.small" || "t3.medium" || "t3.large" || "t3.xlarge" || "t3.2xlarge" || "t3a.nano" || "t3a.micro" || "t3a.small" || "t3a.medium" || "t3a.large" || "t3a.xlarge" || "t3a.2xlarge" || "t4g.nano" || "t4g.micro" || "t4g.small" || "t4g.medium" || "t4g.large" || "t4g.xlarge" || "t4g.2xlarge" || "u-6tb1.56xlarge" || "u-6tb1.112xlarge" || "u-9tb1.112xlarge" || "u-12tb1.112xlarge" || "u-6tb1.metal" || "u-9tb1.metal" || "u-12tb1.metal" || "u-18tb1.metal" || "u-24tb1.metal" || "vt1.3xlarge" || "vt1.6xlarge" || "vt1.24xlarge" || "x1.16xlarge" || "x1.32xlarge" || "x1e.xlarge" || "x1e.2xlarge" || "x1e.4xlarge" || "x1e.8xlarge" || "x1e.16xlarge" || "x1e.32xlarge" || "x2iezn.2xlarge" || "x2iezn.4xlarge" || "x2iezn.6xlarge" || "x2iezn.8xlarge" || "x2iezn.12xlarge" || "x2iezn.metal" || "x2gd.medium" || "x2gd.large" || "x2gd.xlarge" || "x2gd.2xlarge" || "x2gd.4xlarge" || "x2gd.8xlarge" || "x2gd.12xlarge" || "x2gd.16xlarge" || "x2gd.metal" || "z1d.large" || "z1d.xlarge" || "z1d.2xlarge" || "z1d.3xlarge" || "z1d.6xlarge" || "z1d.12xlarge" || "z1d.metal" || "x2idn.16xlarge" || "x2idn.24xlarge" || "x2idn.32xlarge" || "x2iedn.xlarge" || "x2iedn.2xlarge" || "x2iedn.4xlarge" || "x2iedn.8xlarge" || "x2iedn.16xlarge" || "x2iedn.24xlarge" || "x2iedn.32xlarge" || "c6a.large" || "c6a.xlarge" || "c6a.2xlarge" || "c6a.4xlarge" || "c6a.8xlarge" || "c6a.12xlarge" || "c6a.16xlarge" || "c6a.24xlarge" || "c6a.32xlarge" || "c6a.48xlarge" || "c6a.metal" || "m6a.metal" || "i4i.large" || "i4i.xlarge" || "i4i.2xlarge" || "i4i.4xlarge" || "i4i.8xlarge" || "i4i.16xlarge" || "i4i.32xlarge" || "i4i.metal" || "x2idn.metal" || "x2iedn.metal" || "c7g.medium" || "c7g.large" || "c7g.xlarge" || "c7g.2xlarge" || "c7g.4xlarge" || "c7g.8xlarge" || "c7g.12xlarge" || "c7g.16xlarge" || "mac2.metal" || "c6id.large" || "c6id.xlarge" || "c6id.2xlarge" || "c6id.4xlarge" || "c6id.8xlarge" || "c6id.12xlarge" || "c6id.16xlarge" || "c6id.24xlarge" || "c6id.32xlarge" || "c6id.metal" || "m6id.large" || "m6id.xlarge" || "m6id.2xlarge" || "m6id.4xlarge" || "m6id.8xlarge" || "m6id.12xlarge" || "m6id.16xlarge" || "m6id.24xlarge" || "m6id.32xlarge" || "m6id.metal" || "r6id.large" || "r6id.xlarge" || "r6id.2xlarge" || "r6id.4xlarge" || "r6id.8xlarge" || "r6id.12xlarge" || "r6id.16xlarge" || "r6id.24xlarge" || "r6id.32xlarge" || "r6id.metal" || "r6a.large" || "r6a.xlarge" || "r6a.2xlarge" || "r6a.4xlarge" || "r6a.8xlarge" || "r6a.12xlarge" || "r6a.16xlarge" || "r6a.24xlarge" || "r6a.32xlarge" || "r6a.48xlarge" || "r6a.metal" || "p4de.24xlarge" || "u-3tb1.56xlarge" || "u-18tb1.112xlarge" || "u-24tb1.112xlarge" || "trn1.2xlarge" || "trn1.32xlarge" || "hpc6id.32xlarge" || "c6in.large" || "c6in.xlarge" || "c6in.2xlarge" || "c6in.4xlarge" || "c6in.8xlarge" || "c6in.12xlarge" || "c6in.16xlarge" || "c6in.24xlarge" || "c6in.32xlarge" || "m6in.large" || "m6in.xlarge" || "m6in.2xlarge" || "m6in.4xlarge" || "m6in.8xlarge" || "m6in.12xlarge" || "m6in.16xlarge" || "m6in.24xlarge" || "m6in.32xlarge" || "m6idn.large" || "m6idn.xlarge" || "m6idn.2xlarge" || "m6idn.4xlarge" || "m6idn.8xlarge" || "m6idn.12xlarge" || "m6idn.16xlarge" || "m6idn.24xlarge" || "m6idn.32xlarge" || "r6in.large" || "r6in.xlarge" || "r6in.2xlarge" || "r6in.4xlarge" || "r6in.8xlarge" || "r6in.12xlarge" || "r6in.16xlarge" || "r6in.24xlarge" || "r6in.32xlarge" || "r6idn.large" || "r6idn.xlarge" || "r6idn.2xlarge" || "r6idn.4xlarge" || "r6idn.8xlarge" || "r6idn.12xlarge" || "r6idn.16xlarge" || "r6idn.24xlarge" || "r6idn.32xlarge" || "c7g.metal" || "m7g.medium" || "m7g.large" || "m7g.xlarge" || "m7g.2xlarge" || "m7g.4xlarge" || "m7g.8xlarge" || "m7g.12xlarge" || "m7g.16xlarge" || "m7g.metal" || "r7g.medium" || "r7g.large" || "r7g.xlarge" || "r7g.2xlarge" || "r7g.4xlarge" || "r7g.8xlarge" || "r7g.12xlarge" || "r7g.16xlarge" || "r7g.metal" || "c6in.metal" || "m6in.metal" || "m6idn.metal" || "r6in.metal" || "r6idn.metal" || "inf2.xlarge" || "inf2.8xlarge" || "inf2.24xlarge" || "inf2.48xlarge" || "trn1n.32xlarge" || "i4g.large" || "i4g.xlarge" || "i4g.2xlarge" || "i4g.4xlarge" || "i4g.8xlarge" || "i4g.16xlarge" || "hpc7g.4xlarge" || "hpc7g.8xlarge" || "hpc7g.16xlarge" || "c7gn.medium" || "c7gn.large" || "c7gn.xlarge" || "c7gn.2xlarge" || "c7gn.4xlarge" || "c7gn.8xlarge" || "c7gn.12xlarge" || "c7gn.16xlarge" || "p5.48xlarge" || "m7i.large" || "m7i.xlarge" || "m7i.2xlarge" || "m7i.4xlarge" || "m7i.8xlarge" || "m7i.12xlarge" || "m7i.16xlarge" || "m7i.24xlarge" || "m7i.48xlarge" || "m7i-flex.large" || "m7i-flex.xlarge" || "m7i-flex.2xlarge" || "m7i-flex.4xlarge" || "m7i-flex.8xlarge" || "m7a.medium" || "m7a.large" || "m7a.xlarge" || "m7a.2xlarge" || "m7a.4xlarge" || "m7a.8xlarge" || "m7a.12xlarge" || "m7a.16xlarge" || "m7a.24xlarge" || "m7a.32xlarge" || "m7a.48xlarge" || "m7a.metal-48xl" || "hpc7a.12xlarge" || "hpc7a.24xlarge" || "hpc7a.48xlarge" || "hpc7a.96xlarge" || "c7gd.medium" || "c7gd.large" || "c7gd.xlarge" || "c7gd.2xlarge" || "c7gd.4xlarge" || "c7gd.8xlarge" || "c7gd.12xlarge" || "c7gd.16xlarge" || "m7gd.medium" || "m7gd.large" || "m7gd.xlarge" || "m7gd.2xlarge" || "m7gd.4xlarge" || "m7gd.8xlarge" || "m7gd.12xlarge" || "m7gd.16xlarge" || "r7gd.medium" || "r7gd.large" || "r7gd.xlarge" || "r7gd.2xlarge" || "r7gd.4xlarge" || "r7gd.8xlarge" || "r7gd.12xlarge" || "r7gd.16xlarge" || "r7a.medium" || "r7a.large" || "r7a.xlarge" || "r7a.2xlarge" || "r7a.4xlarge" || "r7a.8xlarge" || "r7a.12xlarge" || "r7a.16xlarge" || "r7a.24xlarge" || "r7a.32xlarge" || "r7a.48xlarge" || "c7i.large" || "c7i.xlarge" || "c7i.2xlarge" || "c7i.4xlarge" || "c7i.8xlarge" || "c7i.12xlarge" || "c7i.16xlarge" || "c7i.24xlarge" || "c7i.48xlarge" || "mac2-m2pro.metal" || "r7iz.large" || "r7iz.xlarge" || "r7iz.2xlarge" || "r7iz.4xlarge" || "r7iz.8xlarge" || "r7iz.12xlarge" || "r7iz.16xlarge" || "r7iz.32xlarge" || "c7a.medium" || "c7a.large" || "c7a.xlarge" || "c7a.2xlarge" || "c7a.4xlarge" || "c7a.8xlarge" || "c7a.12xlarge" || "c7a.16xlarge" || "c7a.24xlarge" || "c7a.32xlarge" || "c7a.48xlarge" || "c7a.metal-48xl" || "r7a.metal-48xl" || "r7i.large" || "r7i.xlarge" || "r7i.2xlarge" || "r7i.4xlarge" || "r7i.8xlarge" || "r7i.12xlarge" || "r7i.16xlarge" || "r7i.24xlarge" || "r7i.48xlarge" || "dl2q.24xlarge" || "mac2-m2.metal" || "i4i.12xlarge" || "i4i.24xlarge" || "c7i.metal-24xl" || "c7i.metal-48xl" || "m7i.metal-24xl" || "m7i.metal-48xl" || "r7i.metal-24xl" || "r7i.metal-48xl" || "r7iz.metal-16xl" || "r7iz.metal-32xl" || "c7gd.metal" || "m7gd.metal" || "r7gd.metal",
* // KernelId: "STRING_VALUE",
* // KeyName: "STRING_VALUE",
* // LaunchTime: new Date("TIMESTAMP"),
* // Monitoring: { // Monitoring
* // State: "disabled" || "disabling" || "enabled" || "pending",
* // },
* // Placement: { // Placement
* // AvailabilityZone: "STRING_VALUE",
* // Affinity: "STRING_VALUE",
* // GroupName: "STRING_VALUE",
* // PartitionNumber: Number("int"),
* // HostId: "STRING_VALUE",
* // Tenancy: "default" || "dedicated" || "host",
* // SpreadDomain: "STRING_VALUE",
* // HostResourceGroupArn: "STRING_VALUE",
* // GroupId: "STRING_VALUE",
* // },
* // Platform: "Windows",
* // PrivateDnsName: "STRING_VALUE",
* // PrivateIpAddress: "STRING_VALUE",
* // ProductCodes: [ // ProductCodeList
* // { // ProductCode
* // ProductCodeId: "STRING_VALUE",
* // ProductCodeType: "devpay" || "marketplace",
* // },
* // ],
* // PublicDnsName: "STRING_VALUE",
* // PublicIpAddress: "STRING_VALUE",
* // RamdiskId: "STRING_VALUE",
* // State: { // InstanceState
* // Code: Number("int"),
* // Name: "pending" || "running" || "shutting-down" || "terminated" || "stopping" || "stopped",
* // },
* // StateTransitionReason: "STRING_VALUE",
* // SubnetId: "STRING_VALUE",
* // VpcId: "STRING_VALUE",
* // Architecture: "i386" || "x86_64" || "arm64" || "x86_64_mac" || "arm64_mac",
* // BlockDeviceMappings: [ // InstanceBlockDeviceMappingList
* // { // InstanceBlockDeviceMapping
* // DeviceName: "STRING_VALUE",
* // Ebs: { // EbsInstanceBlockDevice
* // AttachTime: new Date("TIMESTAMP"),
* // DeleteOnTermination: true || false,
* // Status: "attaching" || "attached" || "detaching" || "detached",
* // VolumeId: "STRING_VALUE",
* // AssociatedResource: "STRING_VALUE",
* // VolumeOwnerId: "STRING_VALUE",
* // },
* // },
* // ],
* // ClientToken: "STRING_VALUE",
* // EbsOptimized: true || false,
* // EnaSupport: true || false,
* // Hypervisor: "ovm" || "xen",
* // IamInstanceProfile: { // IamInstanceProfile
* // Arn: "STRING_VALUE",
* // Id: "STRING_VALUE",
* // },
* // InstanceLifecycle: "spot" || "scheduled" || "capacity-block",
* // ElasticGpuAssociations: [ // ElasticGpuAssociationList
* // { // ElasticGpuAssociation
* // ElasticGpuId: "STRING_VALUE",
* // ElasticGpuAssociationId: "STRING_VALUE",
* // ElasticGpuAssociationState: "STRING_VALUE",
* // ElasticGpuAssociationTime: "STRING_VALUE",
* // },
* // ],
* // ElasticInferenceAcceleratorAssociations: [ // ElasticInferenceAcceleratorAssociationList
* // { // ElasticInferenceAcceleratorAssociation
* // ElasticInferenceAcceleratorArn: "STRING_VALUE",
* // ElasticInferenceAcceleratorAssociationId: "STRING_VALUE",
* // ElasticInferenceAcceleratorAssociationState: "STRING_VALUE",
* // ElasticInferenceAcceleratorAssociationTime: new Date("TIMESTAMP"),
* // },
* // ],
* // NetworkInterfaces: [ // InstanceNetworkInterfaceList
* // { // InstanceNetworkInterface
* // Association: { // InstanceNetworkInterfaceAssociation
* // CarrierIp: "STRING_VALUE",
* // CustomerOwnedIp: "STRING_VALUE",
* // IpOwnerId: "STRING_VALUE",
* // PublicDnsName: "STRING_VALUE",
* // PublicIp: "STRING_VALUE",
* // },
* // Attachment: { // InstanceNetworkInterfaceAttachment
* // AttachTime: new Date("TIMESTAMP"),
* // AttachmentId: "STRING_VALUE",
* // DeleteOnTermination: true || false,
* // DeviceIndex: Number("int"),
* // Status: "attaching" || "attached" || "detaching" || "detached",
* // NetworkCardIndex: Number("int"),
* // EnaSrdSpecification: { // InstanceAttachmentEnaSrdSpecification
* // EnaSrdEnabled: true || false,
* // EnaSrdUdpSpecification: { // InstanceAttachmentEnaSrdUdpSpecification
* // EnaSrdUdpEnabled: true || false,
* // },
* // },
* // },
* // Description: "STRING_VALUE",
* // Groups: [
* // {
* // GroupName: "STRING_VALUE",
* // GroupId: "STRING_VALUE",
* // },
* // ],
* // Ipv6Addresses: [ // InstanceIpv6AddressList
* // { // InstanceIpv6Address
* // Ipv6Address: "STRING_VALUE",
* // IsPrimaryIpv6: true || false,
* // },
* // ],
* // MacAddress: "STRING_VALUE",
* // NetworkInterfaceId: "STRING_VALUE",
* // OwnerId: "STRING_VALUE",
* // PrivateDnsName: "STRING_VALUE",
* // PrivateIpAddress: "STRING_VALUE",
* // PrivateIpAddresses: [ // InstancePrivateIpAddressList
* // { // InstancePrivateIpAddress
* // Association: {
* // CarrierIp: "STRING_VALUE",
* // CustomerOwnedIp: "STRING_VALUE",
* // IpOwnerId: "STRING_VALUE",
* // PublicDnsName: "STRING_VALUE",
* // PublicIp: "STRING_VALUE",
* // },
* // Primary: true || false,
* // PrivateDnsName: "STRING_VALUE",
* // PrivateIpAddress: "STRING_VALUE",
* // },
* // ],
* // SourceDestCheck: true || false,
* // Status: "available" || "associated" || "attaching" || "in-use" || "detaching",
* // SubnetId: "STRING_VALUE",
* // VpcId: "STRING_VALUE",
* // InterfaceType: "STRING_VALUE",
* // Ipv4Prefixes: [ // InstanceIpv4PrefixList
* // { // InstanceIpv4Prefix
* // Ipv4Prefix: "STRING_VALUE",
* // },
* // ],
* // Ipv6Prefixes: [ // InstanceIpv6PrefixList
* // { // InstanceIpv6Prefix
* // Ipv6Prefix: "STRING_VALUE",
* // },
* // ],
* // ConnectionTrackingConfiguration: { // ConnectionTrackingSpecificationResponse
* // TcpEstablishedTimeout: Number("int"),
* // UdpStreamTimeout: Number("int"),
* // UdpTimeout: Number("int"),
* // },
* // },
* // ],
* // OutpostArn: "STRING_VALUE",
* // RootDeviceName: "STRING_VALUE",
* // RootDeviceType: "ebs" || "instance-store",
* // SecurityGroups: "<GroupIdentifierList>",
* // SourceDestCheck: true || false,
* // SpotInstanceRequestId: "STRING_VALUE",
* // SriovNetSupport: "STRING_VALUE",
* // StateReason: { // StateReason
* // Code: "STRING_VALUE",
* // Message: "STRING_VALUE",
* // },
* // Tags: [ // TagList
* // { // Tag
* // Key: "STRING_VALUE",
* // Value: "STRING_VALUE",
* // },
* // ],
* // VirtualizationType: "hvm" || "paravirtual",
* // CpuOptions: { // CpuOptions
* // CoreCount: Number("int"),
* // ThreadsPerCore: Number("int"),
* // AmdSevSnp: "enabled" || "disabled",
* // },
* // CapacityReservationId: "STRING_VALUE",
* // CapacityReservationSpecification: { // CapacityReservationSpecificationResponse
* // CapacityReservationPreference: "open" || "none",
* // CapacityReservationTarget: { // CapacityReservationTargetResponse
* // CapacityReservationId: "STRING_VALUE",
* // CapacityReservationResourceGroupArn: "STRING_VALUE",
* // },
* // },
* // HibernationOptions: { // HibernationOptions
* // Configured: true || false,
* // },
* // Licenses: [ // LicenseList
* // { // LicenseConfiguration
* // LicenseConfigurationArn: "STRING_VALUE",
* // },
* // ],
* // MetadataOptions: { // InstanceMetadataOptionsResponse
* // State: "pending" || "applied",
* // HttpTokens: "optional" || "required",
* // HttpPutResponseHopLimit: Number("int"),
* // HttpEndpoint: "disabled" || "enabled",
* // HttpProtocolIpv6: "disabled" || "enabled",
* // InstanceMetadataTags: "disabled" || "enabled",
* // },
* // EnclaveOptions: { // EnclaveOptions
* // Enabled: true || false,
* // },
* // BootMode: "legacy-bios" || "uefi" || "uefi-preferred",
* // PlatformDetails: "STRING_VALUE",
* // UsageOperation: "STRING_VALUE",
* // UsageOperationUpdateTime: new Date("TIMESTAMP"),
* // PrivateDnsNameOptions: { // PrivateDnsNameOptionsResponse
* // HostnameType: "ip-name" || "resource-name",
* // EnableResourceNameDnsARecord: true || false,
* // EnableResourceNameDnsAAAARecord: true || false,
* // },
* // Ipv6Address: "STRING_VALUE",
* // TpmSupport: "STRING_VALUE",
* // MaintenanceOptions: { // InstanceMaintenanceOptions
* // AutoRecovery: "disabled" || "default",
* // },
* // CurrentInstanceBootMode: "legacy-bios" || "uefi",
* // },
* // ],
* // OwnerId: "STRING_VALUE",
* // RequesterId: "STRING_VALUE",
* // ReservationId: "STRING_VALUE",
* // },
* // ],
* // NextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param DescribeInstancesCommandInput - {@link DescribeInstancesCommandInput}
* @returns {@link DescribeInstancesCommandOutput}
* @see {@link DescribeInstancesCommandInput} for command's `input` shape.
* @see {@link DescribeInstancesCommandOutput} for command's `response` shape.
* @see {@link EC2ClientResolvedConfig | config} for EC2Client's `config` shape.
*
* @throws {@link EC2ServiceException}
* <p>Base exception class for all service exceptions from EC2 service.</p>
*
* @public
* @example To describe an Amazon EC2 instance
* ```javascript
* // This example describes the specified instance.
* const input = {
* "InstanceIds": [
* "i-1234567890abcdef0"
* ]
* };
* const command = new DescribeInstancesCommand(input);
* await client.send(command);
* // example id: to-describe-an-amazon-ec2-instance-1529025982172
* ```
*
* @example To describe the instances with a specific instance type
* ```javascript
* // This example describes the instances with the t2.micro instance type.
* const input = {
* "Filters": [
* {
* "Name": "instance-type",
* "Values": [
* "t2.micro"
* ]
* }
* ]
* };
* const command = new DescribeInstancesCommand(input);
* await client.send(command);
* // example id: to-describe-the-instances-with-the-instance-type-t2micro-1529026147602
* ```
*
* @example To describe the instances with a specific tag
* ```javascript
* // This example describes the instances with the Purpose=test tag.
* const input = {
* "Filters": [
* {
* "Name": "tag:Purpose",
* "Values": [
* "test"
* ]
* }
* ]
* };
* const command = new DescribeInstancesCommand(input);
* await client.send(command);
* // example id: to-describe-the-instances-with-a-specific-tag-1529026251928
* ```
*
*/
export class DescribeInstancesCommand extends $Command
.classBuilder<
DescribeInstancesCommandInput,
DescribeInstancesCommandOutput,
EC2ClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
})
.m(function (this: any, Command: any, cs: any, config: EC2ClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("AmazonEC2", "DescribeInstances", {})
.n("EC2Client", "DescribeInstancesCommand")
.f(void 0, void 0)
.ser(se_DescribeInstancesCommand)
.de(de_DescribeInstancesCommand)
.build() {}