@aws-sdk/client-greengrassv2 3.379.1 → 3.385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +289 -0
- package/package.json +5 -5
|
@@ -19,6 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
19
|
*/
|
|
20
20
|
export interface AssociateClientDeviceWithCoreDeviceEntry {
|
|
21
21
|
/**
|
|
22
|
+
* @public
|
|
22
23
|
* <p>The name of the IoT thing that represents the client device to associate.</p>
|
|
23
24
|
*/
|
|
24
25
|
thingName: string | undefined;
|
|
@@ -31,14 +32,17 @@ export interface AssociateClientDeviceWithCoreDeviceEntry {
|
|
|
31
32
|
*/
|
|
32
33
|
export interface AssociateClientDeviceWithCoreDeviceErrorEntry {
|
|
33
34
|
/**
|
|
35
|
+
* @public
|
|
34
36
|
* <p>The name of the IoT thing whose associate request failed.</p>
|
|
35
37
|
*/
|
|
36
38
|
thingName?: string;
|
|
37
39
|
/**
|
|
40
|
+
* @public
|
|
38
41
|
* <p>The error code for the request.</p>
|
|
39
42
|
*/
|
|
40
43
|
code?: string;
|
|
41
44
|
/**
|
|
45
|
+
* @public
|
|
42
46
|
* <p>A message that provides additional information about the error.</p>
|
|
43
47
|
*/
|
|
44
48
|
message?: string;
|
|
@@ -50,10 +54,12 @@ export interface AssociateClientDeviceWithCoreDeviceErrorEntry {
|
|
|
50
54
|
*/
|
|
51
55
|
export interface AssociatedClientDevice {
|
|
52
56
|
/**
|
|
57
|
+
* @public
|
|
53
58
|
* <p>The name of the IoT thing that represents the associated client device.</p>
|
|
54
59
|
*/
|
|
55
60
|
thingName?: string;
|
|
56
61
|
/**
|
|
62
|
+
* @public
|
|
57
63
|
* <p>The time that the client device was associated, expressed in ISO 8601 format.</p>
|
|
58
64
|
*/
|
|
59
65
|
associationTimestamp?: Date;
|
|
@@ -63,6 +69,7 @@ export interface AssociatedClientDevice {
|
|
|
63
69
|
*/
|
|
64
70
|
export interface AssociateServiceRoleToAccountRequest {
|
|
65
71
|
/**
|
|
72
|
+
* @public
|
|
66
73
|
* <p>The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your
|
|
67
74
|
* Amazon Web Services account in this Amazon Web Services Region.</p>
|
|
68
75
|
*/
|
|
@@ -73,6 +80,7 @@ export interface AssociateServiceRoleToAccountRequest {
|
|
|
73
80
|
*/
|
|
74
81
|
export interface AssociateServiceRoleToAccountResponse {
|
|
75
82
|
/**
|
|
83
|
+
* @public
|
|
76
84
|
* <p>The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this
|
|
77
85
|
* Amazon Web Services Region.</p>
|
|
78
86
|
*/
|
|
@@ -86,6 +94,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
86
94
|
readonly name: "InternalServerException";
|
|
87
95
|
readonly $fault: "server";
|
|
88
96
|
/**
|
|
97
|
+
* @public
|
|
89
98
|
* <p>The amount of time to wait before you retry the request.</p>
|
|
90
99
|
*/
|
|
91
100
|
retryAfterSeconds?: number;
|
|
@@ -100,10 +109,12 @@ export declare class InternalServerException extends __BaseException {
|
|
|
100
109
|
*/
|
|
101
110
|
export interface ValidationExceptionField {
|
|
102
111
|
/**
|
|
112
|
+
* @public
|
|
103
113
|
* <p>The name of the exception field.</p>
|
|
104
114
|
*/
|
|
105
115
|
name: string | undefined;
|
|
106
116
|
/**
|
|
117
|
+
* @public
|
|
107
118
|
* <p>The message of the exception field.</p>
|
|
108
119
|
*/
|
|
109
120
|
message: string | undefined;
|
|
@@ -131,10 +142,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
131
142
|
readonly name: "ValidationException";
|
|
132
143
|
readonly $fault: "client";
|
|
133
144
|
/**
|
|
145
|
+
* @public
|
|
134
146
|
* <p>The reason for the validation exception.</p>
|
|
135
147
|
*/
|
|
136
148
|
reason?: ValidationExceptionReason | string;
|
|
137
149
|
/**
|
|
150
|
+
* @public
|
|
138
151
|
* <p>The list of fields that failed to validate.</p>
|
|
139
152
|
*/
|
|
140
153
|
fields?: ValidationExceptionField[];
|
|
@@ -148,10 +161,12 @@ export declare class ValidationException extends __BaseException {
|
|
|
148
161
|
*/
|
|
149
162
|
export interface BatchAssociateClientDeviceWithCoreDeviceRequest {
|
|
150
163
|
/**
|
|
164
|
+
* @public
|
|
151
165
|
* <p>The list of client devices to associate.</p>
|
|
152
166
|
*/
|
|
153
167
|
entries?: AssociateClientDeviceWithCoreDeviceEntry[];
|
|
154
168
|
/**
|
|
169
|
+
* @public
|
|
155
170
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
156
171
|
*/
|
|
157
172
|
coreDeviceThingName: string | undefined;
|
|
@@ -161,6 +176,7 @@ export interface BatchAssociateClientDeviceWithCoreDeviceRequest {
|
|
|
161
176
|
*/
|
|
162
177
|
export interface BatchAssociateClientDeviceWithCoreDeviceResponse {
|
|
163
178
|
/**
|
|
179
|
+
* @public
|
|
164
180
|
* <p>The list of any errors for the entries in the request. Each error entry contains the name
|
|
165
181
|
* of the IoT thing that failed to associate.</p>
|
|
166
182
|
*/
|
|
@@ -174,10 +190,12 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
174
190
|
readonly name: "ResourceNotFoundException";
|
|
175
191
|
readonly $fault: "client";
|
|
176
192
|
/**
|
|
193
|
+
* @public
|
|
177
194
|
* <p>The ID of the resource that isn't found.</p>
|
|
178
195
|
*/
|
|
179
196
|
resourceId: string | undefined;
|
|
180
197
|
/**
|
|
198
|
+
* @public
|
|
181
199
|
* <p>The type of the resource that isn't found.</p>
|
|
182
200
|
*/
|
|
183
201
|
resourceType: string | undefined;
|
|
@@ -195,14 +213,17 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
195
213
|
readonly name: "ThrottlingException";
|
|
196
214
|
readonly $fault: "client";
|
|
197
215
|
/**
|
|
216
|
+
* @public
|
|
198
217
|
* <p>The code for the quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
199
218
|
*/
|
|
200
219
|
quotaCode?: string;
|
|
201
220
|
/**
|
|
221
|
+
* @public
|
|
202
222
|
* <p>The code for the service in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
203
223
|
*/
|
|
204
224
|
serviceCode?: string;
|
|
205
225
|
/**
|
|
226
|
+
* @public
|
|
206
227
|
* <p>The amount of time to wait before you retry the request.</p>
|
|
207
228
|
*/
|
|
208
229
|
retryAfterSeconds?: number;
|
|
@@ -218,6 +239,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
218
239
|
*/
|
|
219
240
|
export interface DisassociateClientDeviceFromCoreDeviceEntry {
|
|
220
241
|
/**
|
|
242
|
+
* @public
|
|
221
243
|
* <p>The name of the IoT thing that represents the client device to disassociate.</p>
|
|
222
244
|
*/
|
|
223
245
|
thingName: string | undefined;
|
|
@@ -227,10 +249,12 @@ export interface DisassociateClientDeviceFromCoreDeviceEntry {
|
|
|
227
249
|
*/
|
|
228
250
|
export interface BatchDisassociateClientDeviceFromCoreDeviceRequest {
|
|
229
251
|
/**
|
|
252
|
+
* @public
|
|
230
253
|
* <p>The list of client devices to disassociate.</p>
|
|
231
254
|
*/
|
|
232
255
|
entries?: DisassociateClientDeviceFromCoreDeviceEntry[];
|
|
233
256
|
/**
|
|
257
|
+
* @public
|
|
234
258
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
235
259
|
*/
|
|
236
260
|
coreDeviceThingName: string | undefined;
|
|
@@ -243,14 +267,17 @@ export interface BatchDisassociateClientDeviceFromCoreDeviceRequest {
|
|
|
243
267
|
*/
|
|
244
268
|
export interface DisassociateClientDeviceFromCoreDeviceErrorEntry {
|
|
245
269
|
/**
|
|
270
|
+
* @public
|
|
246
271
|
* <p>The name of the IoT thing whose disassociate request failed.</p>
|
|
247
272
|
*/
|
|
248
273
|
thingName?: string;
|
|
249
274
|
/**
|
|
275
|
+
* @public
|
|
250
276
|
* <p>The error code for the request.</p>
|
|
251
277
|
*/
|
|
252
278
|
code?: string;
|
|
253
279
|
/**
|
|
280
|
+
* @public
|
|
254
281
|
* <p>A message that provides additional information about the error.</p>
|
|
255
282
|
*/
|
|
256
283
|
message?: string;
|
|
@@ -260,6 +287,7 @@ export interface DisassociateClientDeviceFromCoreDeviceErrorEntry {
|
|
|
260
287
|
*/
|
|
261
288
|
export interface BatchDisassociateClientDeviceFromCoreDeviceResponse {
|
|
262
289
|
/**
|
|
290
|
+
* @public
|
|
263
291
|
* <p>The list of any errors for the entries in the request. Each error entry contains the name
|
|
264
292
|
* of the IoT thing that failed to disassociate.</p>
|
|
265
293
|
*/
|
|
@@ -270,6 +298,7 @@ export interface BatchDisassociateClientDeviceFromCoreDeviceResponse {
|
|
|
270
298
|
*/
|
|
271
299
|
export interface CancelDeploymentRequest {
|
|
272
300
|
/**
|
|
301
|
+
* @public
|
|
273
302
|
* <p>The ID of the deployment.</p>
|
|
274
303
|
*/
|
|
275
304
|
deploymentId: string | undefined;
|
|
@@ -279,6 +308,7 @@ export interface CancelDeploymentRequest {
|
|
|
279
308
|
*/
|
|
280
309
|
export interface CancelDeploymentResponse {
|
|
281
310
|
/**
|
|
311
|
+
* @public
|
|
282
312
|
* <p>A message that communicates if the cancel was successful.</p>
|
|
283
313
|
*/
|
|
284
314
|
message?: string;
|
|
@@ -292,10 +322,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
292
322
|
readonly name: "ConflictException";
|
|
293
323
|
readonly $fault: "client";
|
|
294
324
|
/**
|
|
325
|
+
* @public
|
|
295
326
|
* <p>The ID of the resource that conflicts with the request.</p>
|
|
296
327
|
*/
|
|
297
328
|
resourceId: string | undefined;
|
|
298
329
|
/**
|
|
330
|
+
* @public
|
|
299
331
|
* <p>The type of the resource that conflicts with the request.</p>
|
|
300
332
|
*/
|
|
301
333
|
resourceType: string | undefined;
|
|
@@ -338,15 +370,18 @@ export type VendorGuidance = (typeof VendorGuidance)[keyof typeof VendorGuidance
|
|
|
338
370
|
*/
|
|
339
371
|
export interface CloudComponentStatus {
|
|
340
372
|
/**
|
|
373
|
+
* @public
|
|
341
374
|
* <p>The state of the component version.</p>
|
|
342
375
|
*/
|
|
343
376
|
componentState?: CloudComponentState | string;
|
|
344
377
|
/**
|
|
378
|
+
* @public
|
|
345
379
|
* <p>A message that communicates details, such as errors, about the status of the component
|
|
346
380
|
* version.</p>
|
|
347
381
|
*/
|
|
348
382
|
message?: string;
|
|
349
383
|
/**
|
|
384
|
+
* @public
|
|
350
385
|
* <p>A dictionary of errors that communicate why the component version is in an error state.
|
|
351
386
|
* For example, if IoT Greengrass can't access an artifact for the component version, then
|
|
352
387
|
* <code>errors</code> contains the artifact's URI as a key, and the error message as the value
|
|
@@ -354,6 +389,7 @@ export interface CloudComponentStatus {
|
|
|
354
389
|
*/
|
|
355
390
|
errors?: Record<string, string>;
|
|
356
391
|
/**
|
|
392
|
+
* @public
|
|
357
393
|
* <p>The vendor guidance state for the component version. This state indicates whether
|
|
358
394
|
* the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:</p>
|
|
359
395
|
* <ul>
|
|
@@ -375,6 +411,7 @@ export interface CloudComponentStatus {
|
|
|
375
411
|
*/
|
|
376
412
|
vendorGuidance?: VendorGuidance | string;
|
|
377
413
|
/**
|
|
414
|
+
* @public
|
|
378
415
|
* <p>A message that communicates details about the vendor guidance state
|
|
379
416
|
* of the component version. This message communicates why a component version is discontinued or deleted.</p>
|
|
380
417
|
*/
|
|
@@ -386,12 +423,14 @@ export interface CloudComponentStatus {
|
|
|
386
423
|
*/
|
|
387
424
|
export interface ComponentPlatform {
|
|
388
425
|
/**
|
|
426
|
+
* @public
|
|
389
427
|
* <p>The friendly name of the platform. This name helps you identify the platform.</p>
|
|
390
428
|
* <p>If you omit this parameter, IoT Greengrass creates a friendly name from the <code>os</code> and
|
|
391
429
|
* <code>architecture</code> of the platform.</p>
|
|
392
430
|
*/
|
|
393
431
|
name?: string;
|
|
394
432
|
/**
|
|
433
|
+
* @public
|
|
395
434
|
* <p>A dictionary of attributes for the platform. The IoT Greengrass Core software defines the
|
|
396
435
|
* <code>os</code> and <code>architecture</code> by default. You can specify additional
|
|
397
436
|
* platform attributes for a core device when you deploy the Greengrass nucleus component. For more
|
|
@@ -406,26 +445,32 @@ export interface ComponentPlatform {
|
|
|
406
445
|
*/
|
|
407
446
|
export interface ComponentLatestVersion {
|
|
408
447
|
/**
|
|
448
|
+
* @public
|
|
409
449
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
410
450
|
*/
|
|
411
451
|
arn?: string;
|
|
412
452
|
/**
|
|
453
|
+
* @public
|
|
413
454
|
* <p>The version of the component.</p>
|
|
414
455
|
*/
|
|
415
456
|
componentVersion?: string;
|
|
416
457
|
/**
|
|
458
|
+
* @public
|
|
417
459
|
* <p>The time at which the component was created, expressed in ISO 8601 format.</p>
|
|
418
460
|
*/
|
|
419
461
|
creationTimestamp?: Date;
|
|
420
462
|
/**
|
|
463
|
+
* @public
|
|
421
464
|
* <p>The description of the component version.</p>
|
|
422
465
|
*/
|
|
423
466
|
description?: string;
|
|
424
467
|
/**
|
|
468
|
+
* @public
|
|
425
469
|
* <p>The publisher of the component version.</p>
|
|
426
470
|
*/
|
|
427
471
|
publisher?: string;
|
|
428
472
|
/**
|
|
473
|
+
* @public
|
|
429
474
|
* <p>The platforms that the component version supports.</p>
|
|
430
475
|
*/
|
|
431
476
|
platforms?: ComponentPlatform[];
|
|
@@ -436,14 +481,17 @@ export interface ComponentLatestVersion {
|
|
|
436
481
|
*/
|
|
437
482
|
export interface Component {
|
|
438
483
|
/**
|
|
484
|
+
* @public
|
|
439
485
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
440
486
|
*/
|
|
441
487
|
arn?: string;
|
|
442
488
|
/**
|
|
489
|
+
* @public
|
|
443
490
|
* <p>The name of the component.</p>
|
|
444
491
|
*/
|
|
445
492
|
componentName?: string;
|
|
446
493
|
/**
|
|
494
|
+
* @public
|
|
447
495
|
* <p>The latest version of the component and its details.</p>
|
|
448
496
|
*/
|
|
449
497
|
latestVersion?: ComponentLatestVersion;
|
|
@@ -455,14 +503,17 @@ export interface Component {
|
|
|
455
503
|
*/
|
|
456
504
|
export interface ComponentCandidate {
|
|
457
505
|
/**
|
|
506
|
+
* @public
|
|
458
507
|
* <p>The name of the component.</p>
|
|
459
508
|
*/
|
|
460
509
|
componentName?: string;
|
|
461
510
|
/**
|
|
511
|
+
* @public
|
|
462
512
|
* <p>The version of the component.</p>
|
|
463
513
|
*/
|
|
464
514
|
componentVersion?: string;
|
|
465
515
|
/**
|
|
516
|
+
* @public
|
|
466
517
|
* <p>The version requirements for the component's dependencies. Greengrass core devices get the
|
|
467
518
|
* version requirements from component recipes.</p>
|
|
468
519
|
* <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href="https://semver.org/">Semantic Versioning</a>.</p>
|
|
@@ -477,6 +528,7 @@ export interface ComponentCandidate {
|
|
|
477
528
|
*/
|
|
478
529
|
export interface ComponentConfigurationUpdate {
|
|
479
530
|
/**
|
|
531
|
+
* @public
|
|
480
532
|
* <p>A serialized JSON string that contains the configuration object to merge to target
|
|
481
533
|
* devices. The core device merges this configuration with the component's existing
|
|
482
534
|
* configuration. If this is the first time a component deploys on a device, the core device
|
|
@@ -487,6 +539,7 @@ export interface ComponentConfigurationUpdate {
|
|
|
487
539
|
*/
|
|
488
540
|
merge?: string;
|
|
489
541
|
/**
|
|
542
|
+
* @public
|
|
490
543
|
* <p>The list of configuration nodes to reset to default values on target devices. Use JSON
|
|
491
544
|
* pointers to specify each node to reset. JSON pointers start with a forward slash
|
|
492
545
|
* (<code>/</code>) and use forward slashes to separate the key for each level in the object.
|
|
@@ -514,11 +567,13 @@ export type ComponentDependencyType = (typeof ComponentDependencyType)[keyof typ
|
|
|
514
567
|
*/
|
|
515
568
|
export interface ComponentDependencyRequirement {
|
|
516
569
|
/**
|
|
570
|
+
* @public
|
|
517
571
|
* <p>The component version requirement for the component dependency.</p>
|
|
518
572
|
* <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href="https://semver.org/">Semantic Versioning</a>.</p>
|
|
519
573
|
*/
|
|
520
574
|
versionRequirement?: string;
|
|
521
575
|
/**
|
|
576
|
+
* @public
|
|
522
577
|
* <p>The type of this dependency. Choose from the following options:</p>
|
|
523
578
|
* <ul>
|
|
524
579
|
* <li>
|
|
@@ -544,11 +599,13 @@ export interface ComponentDependencyRequirement {
|
|
|
544
599
|
*/
|
|
545
600
|
export interface SystemResourceLimits {
|
|
546
601
|
/**
|
|
602
|
+
* @public
|
|
547
603
|
* <p>The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on
|
|
548
604
|
* the core device.</p>
|
|
549
605
|
*/
|
|
550
606
|
memory?: number;
|
|
551
607
|
/**
|
|
608
|
+
* @public
|
|
552
609
|
* <p>The maximum amount of CPU time that a component's processes can use on the core device. A
|
|
553
610
|
* core device's total CPU time is equivalent to the device's number of CPU cores. For example,
|
|
554
611
|
* on a core device with 4 CPU cores, you can set this value to <code>2</code> to limit the
|
|
@@ -567,6 +624,7 @@ export interface SystemResourceLimits {
|
|
|
567
624
|
*/
|
|
568
625
|
export interface ComponentRunWith {
|
|
569
626
|
/**
|
|
627
|
+
* @public
|
|
570
628
|
* <p>The POSIX system user and, optionally, group to use to run this component on Linux core
|
|
571
629
|
* devices. The user, and group if specified, must exist on each Linux core device. Specify the
|
|
572
630
|
* user and group separated by a colon (<code>:</code>) in the following format:
|
|
@@ -577,6 +635,7 @@ export interface ComponentRunWith {
|
|
|
577
635
|
*/
|
|
578
636
|
posixUser?: string;
|
|
579
637
|
/**
|
|
638
|
+
* @public
|
|
580
639
|
* <p>The system resource limits to apply to this component's process on the core device. IoT Greengrass
|
|
581
640
|
* currently supports this feature on only Linux core devices.</p>
|
|
582
641
|
* <p>If you omit this parameter, the IoT Greengrass Core software uses the default system resource limits
|
|
@@ -584,6 +643,7 @@ export interface ComponentRunWith {
|
|
|
584
643
|
*/
|
|
585
644
|
systemResourceLimits?: SystemResourceLimits;
|
|
586
645
|
/**
|
|
646
|
+
* @public
|
|
587
647
|
* <p>The Windows user to use to run this component on Windows core devices. The user must exist
|
|
588
648
|
* on each Windows core device, and its name and password must be in the LocalSystem account's
|
|
589
649
|
* Credentials Manager instance.</p>
|
|
@@ -598,10 +658,12 @@ export interface ComponentRunWith {
|
|
|
598
658
|
*/
|
|
599
659
|
export interface ComponentDeploymentSpecification {
|
|
600
660
|
/**
|
|
661
|
+
* @public
|
|
601
662
|
* <p>The version of the component.</p>
|
|
602
663
|
*/
|
|
603
664
|
componentVersion?: string;
|
|
604
665
|
/**
|
|
666
|
+
* @public
|
|
605
667
|
* <p>The configuration updates to deploy for the component. You can define
|
|
606
668
|
* <i>reset</i> updates and <i>merge</i> updates. A reset updates
|
|
607
669
|
* the keys that you specify to the default configuration for the component. A merge updates the
|
|
@@ -612,6 +674,7 @@ export interface ComponentDeploymentSpecification {
|
|
|
612
674
|
*/
|
|
613
675
|
configurationUpdate?: ComponentConfigurationUpdate;
|
|
614
676
|
/**
|
|
677
|
+
* @public
|
|
615
678
|
* <p>The system user and group that the IoT Greengrass Core software uses to run component processes on the
|
|
616
679
|
* core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group
|
|
617
680
|
* that you configure for the core device. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer
|
|
@@ -625,14 +688,17 @@ export interface ComponentDeploymentSpecification {
|
|
|
625
688
|
*/
|
|
626
689
|
export interface ComponentVersionListItem {
|
|
627
690
|
/**
|
|
691
|
+
* @public
|
|
628
692
|
* <p>The name of the component.</p>
|
|
629
693
|
*/
|
|
630
694
|
componentName?: string;
|
|
631
695
|
/**
|
|
696
|
+
* @public
|
|
632
697
|
* <p>The version of the component.</p>
|
|
633
698
|
*/
|
|
634
699
|
componentVersion?: string;
|
|
635
700
|
/**
|
|
701
|
+
* @public
|
|
636
702
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
637
703
|
*/
|
|
638
704
|
arn?: string;
|
|
@@ -656,20 +722,24 @@ export type ComponentVisibilityScope = (typeof ComponentVisibilityScope)[keyof t
|
|
|
656
722
|
*/
|
|
657
723
|
export interface ConnectivityInfo {
|
|
658
724
|
/**
|
|
725
|
+
* @public
|
|
659
726
|
* <p>An ID for the connectivity information.</p>
|
|
660
727
|
*/
|
|
661
728
|
id?: string;
|
|
662
729
|
/**
|
|
730
|
+
* @public
|
|
663
731
|
* <p>The IP address or DNS address where client devices can connect to an MQTT broker on the
|
|
664
732
|
* Greengrass core device.</p>
|
|
665
733
|
*/
|
|
666
734
|
hostAddress?: string;
|
|
667
735
|
/**
|
|
736
|
+
* @public
|
|
668
737
|
* <p>The port where the MQTT broker operates on the core device. This port is typically 8883,
|
|
669
738
|
* which is the default port for the MQTT broker component that runs on core devices.</p>
|
|
670
739
|
*/
|
|
671
740
|
portNumber?: number;
|
|
672
741
|
/**
|
|
742
|
+
* @public
|
|
673
743
|
* <p>Additional metadata to provide to client devices that connect to this core device.</p>
|
|
674
744
|
*/
|
|
675
745
|
metadata?: string;
|
|
@@ -693,10 +763,12 @@ export type CoreDeviceStatus = (typeof CoreDeviceStatus)[keyof typeof CoreDevice
|
|
|
693
763
|
*/
|
|
694
764
|
export interface CoreDevice {
|
|
695
765
|
/**
|
|
766
|
+
* @public
|
|
696
767
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
697
768
|
*/
|
|
698
769
|
coreDeviceThingName?: string;
|
|
699
770
|
/**
|
|
771
|
+
* @public
|
|
700
772
|
* <p>The status of the core device. Core devices can have the following
|
|
701
773
|
* statuses:</p>
|
|
702
774
|
* <ul>
|
|
@@ -713,6 +785,7 @@ export interface CoreDevice {
|
|
|
713
785
|
*/
|
|
714
786
|
status?: CoreDeviceStatus | string;
|
|
715
787
|
/**
|
|
788
|
+
* @public
|
|
716
789
|
* <p>The time at which the core device's status last updated, expressed in ISO 8601
|
|
717
790
|
* format.</p>
|
|
718
791
|
*/
|
|
@@ -738,10 +811,12 @@ export type LambdaEventSourceType = (typeof LambdaEventSourceType)[keyof typeof
|
|
|
738
811
|
*/
|
|
739
812
|
export interface LambdaEventSource {
|
|
740
813
|
/**
|
|
814
|
+
* @public
|
|
741
815
|
* <p>The topic to which to subscribe to receive event messages.</p>
|
|
742
816
|
*/
|
|
743
817
|
topic: string | undefined;
|
|
744
818
|
/**
|
|
819
|
+
* @public
|
|
745
820
|
* <p>The type of event source. Choose from the following options:</p>
|
|
746
821
|
* <ul>
|
|
747
822
|
* <li>
|
|
@@ -790,10 +865,12 @@ export type LambdaFilesystemPermission = (typeof LambdaFilesystemPermission)[key
|
|
|
790
865
|
*/
|
|
791
866
|
export interface LambdaDeviceMount {
|
|
792
867
|
/**
|
|
868
|
+
* @public
|
|
793
869
|
* <p>The mount path for the device in the file system.</p>
|
|
794
870
|
*/
|
|
795
871
|
path: string | undefined;
|
|
796
872
|
/**
|
|
873
|
+
* @public
|
|
797
874
|
* <p>The permission to access the device: read/only (<code>ro</code>) or read/write
|
|
798
875
|
* (<code>rw</code>).</p>
|
|
799
876
|
* <p>Default: <code>ro</code>
|
|
@@ -801,6 +878,7 @@ export interface LambdaDeviceMount {
|
|
|
801
878
|
*/
|
|
802
879
|
permission?: LambdaFilesystemPermission | string;
|
|
803
880
|
/**
|
|
881
|
+
* @public
|
|
804
882
|
* <p>Whether or not to add the component's system user as an owner of the device.</p>
|
|
805
883
|
* <p>Default: <code>false</code>
|
|
806
884
|
* </p>
|
|
@@ -815,14 +893,17 @@ export interface LambdaDeviceMount {
|
|
|
815
893
|
*/
|
|
816
894
|
export interface LambdaVolumeMount {
|
|
817
895
|
/**
|
|
896
|
+
* @public
|
|
818
897
|
* <p>The path to the physical volume in the file system.</p>
|
|
819
898
|
*/
|
|
820
899
|
sourcePath: string | undefined;
|
|
821
900
|
/**
|
|
901
|
+
* @public
|
|
822
902
|
* <p>The path to the logical volume in the file system.</p>
|
|
823
903
|
*/
|
|
824
904
|
destinationPath: string | undefined;
|
|
825
905
|
/**
|
|
906
|
+
* @public
|
|
826
907
|
* <p>The permission to access the volume: read/only (<code>ro</code>) or read/write
|
|
827
908
|
* (<code>rw</code>).</p>
|
|
828
909
|
* <p>Default: <code>ro</code>
|
|
@@ -830,6 +911,7 @@ export interface LambdaVolumeMount {
|
|
|
830
911
|
*/
|
|
831
912
|
permission?: LambdaFilesystemPermission | string;
|
|
832
913
|
/**
|
|
914
|
+
* @public
|
|
833
915
|
* <p>Whether or not to add the IoT Greengrass user group as an owner of the volume.</p>
|
|
834
916
|
* <p>Default: <code>false</code>
|
|
835
917
|
* </p>
|
|
@@ -843,11 +925,13 @@ export interface LambdaVolumeMount {
|
|
|
843
925
|
*/
|
|
844
926
|
export interface LambdaContainerParams {
|
|
845
927
|
/**
|
|
928
|
+
* @public
|
|
846
929
|
* <p>The memory size of the container, expressed in kilobytes.</p>
|
|
847
930
|
* <p>Default: <code>16384</code> (16 MB)</p>
|
|
848
931
|
*/
|
|
849
932
|
memorySizeInKB?: number;
|
|
850
933
|
/**
|
|
934
|
+
* @public
|
|
851
935
|
* <p>Whether or not the container can read information from the device's <code>/sys</code>
|
|
852
936
|
* folder.</p>
|
|
853
937
|
* <p>Default: <code>false</code>
|
|
@@ -855,10 +939,12 @@ export interface LambdaContainerParams {
|
|
|
855
939
|
*/
|
|
856
940
|
mountROSysfs?: boolean;
|
|
857
941
|
/**
|
|
942
|
+
* @public
|
|
858
943
|
* <p>The list of volumes that the container can access.</p>
|
|
859
944
|
*/
|
|
860
945
|
volumes?: LambdaVolumeMount[];
|
|
861
946
|
/**
|
|
947
|
+
* @public
|
|
862
948
|
* <p>The list of system devices that the container can access.</p>
|
|
863
949
|
*/
|
|
864
950
|
devices?: LambdaDeviceMount[];
|
|
@@ -881,6 +967,7 @@ export type LambdaIsolationMode = (typeof LambdaIsolationMode)[keyof typeof Lamb
|
|
|
881
967
|
*/
|
|
882
968
|
export interface LambdaLinuxProcessParams {
|
|
883
969
|
/**
|
|
970
|
+
* @public
|
|
884
971
|
* <p>The isolation mode for the process that contains the Lambda function. The process can run
|
|
885
972
|
* in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside
|
|
886
973
|
* any container.</p>
|
|
@@ -889,6 +976,7 @@ export interface LambdaLinuxProcessParams {
|
|
|
889
976
|
*/
|
|
890
977
|
isolationMode?: LambdaIsolationMode | string;
|
|
891
978
|
/**
|
|
979
|
+
* @public
|
|
892
980
|
* <p>The parameters for the container in which the Lambda function runs.</p>
|
|
893
981
|
*/
|
|
894
982
|
containerParams?: LambdaContainerParams;
|
|
@@ -899,38 +987,45 @@ export interface LambdaLinuxProcessParams {
|
|
|
899
987
|
*/
|
|
900
988
|
export interface LambdaExecutionParameters {
|
|
901
989
|
/**
|
|
990
|
+
* @public
|
|
902
991
|
* <p>The list of event sources to which to subscribe to receive work messages. The Lambda
|
|
903
992
|
* function runs when it receives a message from an event source. You can subscribe this function
|
|
904
993
|
* to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.</p>
|
|
905
994
|
*/
|
|
906
995
|
eventSources?: LambdaEventSource[];
|
|
907
996
|
/**
|
|
997
|
+
* @public
|
|
908
998
|
* <p>The maximum size of the message queue for the Lambda function component. The IoT Greengrass core
|
|
909
999
|
* stores messages in a FIFO (first-in-first-out) queue until it can run the Lambda function to
|
|
910
1000
|
* consume each message.</p>
|
|
911
1001
|
*/
|
|
912
1002
|
maxQueueSize?: number;
|
|
913
1003
|
/**
|
|
1004
|
+
* @public
|
|
914
1005
|
* <p>The maximum number of instances that a non-pinned Lambda function can run at the same
|
|
915
1006
|
* time.</p>
|
|
916
1007
|
*/
|
|
917
1008
|
maxInstancesCount?: number;
|
|
918
1009
|
/**
|
|
1010
|
+
* @public
|
|
919
1011
|
* <p>The maximum amount of time in seconds that a non-pinned Lambda function can idle before the
|
|
920
1012
|
* IoT Greengrass Core software stops its process.</p>
|
|
921
1013
|
*/
|
|
922
1014
|
maxIdleTimeInSeconds?: number;
|
|
923
1015
|
/**
|
|
1016
|
+
* @public
|
|
924
1017
|
* <p>The maximum amount of time in seconds that the Lambda function can process a work
|
|
925
1018
|
* item.</p>
|
|
926
1019
|
*/
|
|
927
1020
|
timeoutInSeconds?: number;
|
|
928
1021
|
/**
|
|
1022
|
+
* @public
|
|
929
1023
|
* <p>The interval in seconds at which a pinned (also known as long-lived) Lambda function
|
|
930
1024
|
* component sends status updates to the Lambda manager component.</p>
|
|
931
1025
|
*/
|
|
932
1026
|
statusTimeoutInSeconds?: number;
|
|
933
1027
|
/**
|
|
1028
|
+
* @public
|
|
934
1029
|
* <p>Whether or not the Lambda function is pinned, or long-lived.</p>
|
|
935
1030
|
* <ul>
|
|
936
1031
|
* <li>
|
|
@@ -948,21 +1043,25 @@ export interface LambdaExecutionParameters {
|
|
|
948
1043
|
*/
|
|
949
1044
|
pinned?: boolean;
|
|
950
1045
|
/**
|
|
1046
|
+
* @public
|
|
951
1047
|
* <p>The encoding type that the Lambda function supports.</p>
|
|
952
1048
|
* <p>Default: <code>json</code>
|
|
953
1049
|
* </p>
|
|
954
1050
|
*/
|
|
955
1051
|
inputPayloadEncodingType?: LambdaInputPayloadEncodingType | string;
|
|
956
1052
|
/**
|
|
1053
|
+
* @public
|
|
957
1054
|
* <p>The list of arguments to pass to the Lambda function when it runs.</p>
|
|
958
1055
|
*/
|
|
959
1056
|
execArgs?: string[];
|
|
960
1057
|
/**
|
|
1058
|
+
* @public
|
|
961
1059
|
* <p>The map of environment variables that are available to the Lambda function when it
|
|
962
1060
|
* runs.</p>
|
|
963
1061
|
*/
|
|
964
1062
|
environmentVariables?: Record<string, string>;
|
|
965
1063
|
/**
|
|
1064
|
+
* @public
|
|
966
1065
|
* <p>The parameters for the Linux process that contains the Lambda function.</p>
|
|
967
1066
|
*/
|
|
968
1067
|
linuxProcessParams?: LambdaLinuxProcessParams;
|
|
@@ -973,30 +1072,36 @@ export interface LambdaExecutionParameters {
|
|
|
973
1072
|
*/
|
|
974
1073
|
export interface LambdaFunctionRecipeSource {
|
|
975
1074
|
/**
|
|
1075
|
+
* @public
|
|
976
1076
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Lambda function. The ARN must include the version of the function to
|
|
977
1077
|
* import. You can't use version aliases like <code>$LATEST</code>.</p>
|
|
978
1078
|
*/
|
|
979
1079
|
lambdaArn: string | undefined;
|
|
980
1080
|
/**
|
|
1081
|
+
* @public
|
|
981
1082
|
* <p>The name of the component.</p>
|
|
982
1083
|
* <p>Defaults to the name of the Lambda function.</p>
|
|
983
1084
|
*/
|
|
984
1085
|
componentName?: string;
|
|
985
1086
|
/**
|
|
1087
|
+
* @public
|
|
986
1088
|
* <p>The version of the component.</p>
|
|
987
1089
|
* <p>Defaults to the version of the Lambda function as a semantic version. For example, if your
|
|
988
1090
|
* function version is <code>3</code>, the component version becomes <code>3.0.0</code>.</p>
|
|
989
1091
|
*/
|
|
990
1092
|
componentVersion?: string;
|
|
991
1093
|
/**
|
|
1094
|
+
* @public
|
|
992
1095
|
* <p>The platforms that the component version supports.</p>
|
|
993
1096
|
*/
|
|
994
1097
|
componentPlatforms?: ComponentPlatform[];
|
|
995
1098
|
/**
|
|
1099
|
+
* @public
|
|
996
1100
|
* <p>The component versions on which this Lambda function component depends.</p>
|
|
997
1101
|
*/
|
|
998
1102
|
componentDependencies?: Record<string, ComponentDependencyRequirement>;
|
|
999
1103
|
/**
|
|
1104
|
+
* @public
|
|
1000
1105
|
* <p>The system and runtime parameters for the Lambda function as it runs on the Greengrass core
|
|
1001
1106
|
* device.</p>
|
|
1002
1107
|
*/
|
|
@@ -1007,23 +1112,27 @@ export interface LambdaFunctionRecipeSource {
|
|
|
1007
1112
|
*/
|
|
1008
1113
|
export interface CreateComponentVersionRequest {
|
|
1009
1114
|
/**
|
|
1115
|
+
* @public
|
|
1010
1116
|
* <p>The recipe to use to create the component. The recipe defines the component's metadata,
|
|
1011
1117
|
* parameters, dependencies, lifecycle, artifacts, and platform compatibility.</p>
|
|
1012
1118
|
* <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>
|
|
1013
1119
|
*/
|
|
1014
1120
|
inlineRecipe?: Uint8Array;
|
|
1015
1121
|
/**
|
|
1122
|
+
* @public
|
|
1016
1123
|
* <p>The parameters to create a component from a Lambda function.</p>
|
|
1017
1124
|
* <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>
|
|
1018
1125
|
*/
|
|
1019
1126
|
lambdaFunction?: LambdaFunctionRecipeSource;
|
|
1020
1127
|
/**
|
|
1128
|
+
* @public
|
|
1021
1129
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1022
1130
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1023
1131
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1024
1132
|
*/
|
|
1025
1133
|
tags?: Record<string, string>;
|
|
1026
1134
|
/**
|
|
1135
|
+
* @public
|
|
1027
1136
|
* <p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
|
|
1028
1137
|
* Idempotency means that the request is successfully processed only once, even if you send the request multiple times.
|
|
1029
1138
|
* When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service
|
|
@@ -1037,22 +1146,27 @@ export interface CreateComponentVersionRequest {
|
|
|
1037
1146
|
*/
|
|
1038
1147
|
export interface CreateComponentVersionResponse {
|
|
1039
1148
|
/**
|
|
1149
|
+
* @public
|
|
1040
1150
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1041
1151
|
*/
|
|
1042
1152
|
arn?: string;
|
|
1043
1153
|
/**
|
|
1154
|
+
* @public
|
|
1044
1155
|
* <p>The name of the component.</p>
|
|
1045
1156
|
*/
|
|
1046
1157
|
componentName: string | undefined;
|
|
1047
1158
|
/**
|
|
1159
|
+
* @public
|
|
1048
1160
|
* <p>The version of the component.</p>
|
|
1049
1161
|
*/
|
|
1050
1162
|
componentVersion: string | undefined;
|
|
1051
1163
|
/**
|
|
1164
|
+
* @public
|
|
1052
1165
|
* <p>The time at which the component was created, expressed in ISO 8601 format.</p>
|
|
1053
1166
|
*/
|
|
1054
1167
|
creationTimestamp: Date | undefined;
|
|
1055
1168
|
/**
|
|
1169
|
+
* @public
|
|
1056
1170
|
* <p>The status of the component version in IoT Greengrass V2. This status
|
|
1057
1171
|
* is different from the status of the component on a core device.</p>
|
|
1058
1172
|
*/
|
|
@@ -1081,18 +1195,22 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
1081
1195
|
readonly name: "ServiceQuotaExceededException";
|
|
1082
1196
|
readonly $fault: "client";
|
|
1083
1197
|
/**
|
|
1198
|
+
* @public
|
|
1084
1199
|
* <p>The ID of the resource that exceeds the service quota.</p>
|
|
1085
1200
|
*/
|
|
1086
1201
|
resourceId?: string;
|
|
1087
1202
|
/**
|
|
1203
|
+
* @public
|
|
1088
1204
|
* <p>The type of the resource that exceeds the service quota.</p>
|
|
1089
1205
|
*/
|
|
1090
1206
|
resourceType?: string;
|
|
1091
1207
|
/**
|
|
1208
|
+
* @public
|
|
1092
1209
|
* <p>The code for the quota in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
1093
1210
|
*/
|
|
1094
1211
|
quotaCode: string | undefined;
|
|
1095
1212
|
/**
|
|
1213
|
+
* @public
|
|
1096
1214
|
* <p>The code for the service in <a href="https://docs.aws.amazon.com/servicequotas/latest/userguide/intro.html">Service Quotas</a>.</p>
|
|
1097
1215
|
*/
|
|
1098
1216
|
serviceCode: string | undefined;
|
|
@@ -1125,6 +1243,7 @@ export type DeploymentComponentUpdatePolicyAction = (typeof DeploymentComponentU
|
|
|
1125
1243
|
*/
|
|
1126
1244
|
export interface DeploymentComponentUpdatePolicy {
|
|
1127
1245
|
/**
|
|
1246
|
+
* @public
|
|
1128
1247
|
* <p>The amount of time in seconds that each component on a device has to report that it's safe
|
|
1129
1248
|
* to update. If the component waits for longer than this timeout, then the deployment proceeds
|
|
1130
1249
|
* on the device.</p>
|
|
@@ -1133,6 +1252,7 @@ export interface DeploymentComponentUpdatePolicy {
|
|
|
1133
1252
|
*/
|
|
1134
1253
|
timeoutInSeconds?: number;
|
|
1135
1254
|
/**
|
|
1255
|
+
* @public
|
|
1136
1256
|
* <p>Whether or not to notify components and wait for components to become safe to update.
|
|
1137
1257
|
* Choose from the following options:</p>
|
|
1138
1258
|
* <ul>
|
|
@@ -1163,6 +1283,7 @@ export interface DeploymentComponentUpdatePolicy {
|
|
|
1163
1283
|
*/
|
|
1164
1284
|
export interface DeploymentConfigurationValidationPolicy {
|
|
1165
1285
|
/**
|
|
1286
|
+
* @public
|
|
1166
1287
|
* <p>The amount of time in seconds that a component can validate its configuration updates. If
|
|
1167
1288
|
* the validation time exceeds this timeout, then the deployment proceeds for the device.</p>
|
|
1168
1289
|
* <p>Default: <code>30</code>
|
|
@@ -1189,6 +1310,7 @@ export type DeploymentFailureHandlingPolicy = (typeof DeploymentFailureHandlingP
|
|
|
1189
1310
|
*/
|
|
1190
1311
|
export interface DeploymentPolicies {
|
|
1191
1312
|
/**
|
|
1313
|
+
* @public
|
|
1192
1314
|
* <p>The failure handling policy for the configuration deployment. This policy defines what to
|
|
1193
1315
|
* do if the deployment fails.</p>
|
|
1194
1316
|
* <p>Default: <code>ROLLBACK</code>
|
|
@@ -1196,11 +1318,13 @@ export interface DeploymentPolicies {
|
|
|
1196
1318
|
*/
|
|
1197
1319
|
failureHandlingPolicy?: DeploymentFailureHandlingPolicy | string;
|
|
1198
1320
|
/**
|
|
1321
|
+
* @public
|
|
1199
1322
|
* <p>The component update policy for the configuration deployment. This policy defines when
|
|
1200
1323
|
* it's safe to deploy the configuration to devices.</p>
|
|
1201
1324
|
*/
|
|
1202
1325
|
componentUpdatePolicy?: DeploymentComponentUpdatePolicy;
|
|
1203
1326
|
/**
|
|
1327
|
+
* @public
|
|
1204
1328
|
* <p>The configuration validation policy for the configuration deployment. This policy defines
|
|
1205
1329
|
* how long each component has to validate its configure updates.</p>
|
|
1206
1330
|
*/
|
|
@@ -1248,14 +1372,17 @@ export type IoTJobExecutionFailureType = (typeof IoTJobExecutionFailureType)[key
|
|
|
1248
1372
|
*/
|
|
1249
1373
|
export interface IoTJobAbortCriteria {
|
|
1250
1374
|
/**
|
|
1375
|
+
* @public
|
|
1251
1376
|
* <p>The type of job deployment failure that can cancel a job.</p>
|
|
1252
1377
|
*/
|
|
1253
1378
|
failureType: IoTJobExecutionFailureType | string | undefined;
|
|
1254
1379
|
/**
|
|
1380
|
+
* @public
|
|
1255
1381
|
* <p>The action to perform when the criteria are met.</p>
|
|
1256
1382
|
*/
|
|
1257
1383
|
action: IoTJobAbortAction | string | undefined;
|
|
1258
1384
|
/**
|
|
1385
|
+
* @public
|
|
1259
1386
|
* <p>The minimum percentage of <code>failureType</code> failures that occur before the job can
|
|
1260
1387
|
* cancel.</p>
|
|
1261
1388
|
* <p>This parameter supports up to two digits after the decimal (for example, you can specify
|
|
@@ -1263,6 +1390,7 @@ export interface IoTJobAbortCriteria {
|
|
|
1263
1390
|
*/
|
|
1264
1391
|
thresholdPercentage: number | undefined;
|
|
1265
1392
|
/**
|
|
1393
|
+
* @public
|
|
1266
1394
|
* <p>The minimum number of things that receive the configuration before the job can
|
|
1267
1395
|
* cancel.</p>
|
|
1268
1396
|
*/
|
|
@@ -1275,6 +1403,7 @@ export interface IoTJobAbortCriteria {
|
|
|
1275
1403
|
*/
|
|
1276
1404
|
export interface IoTJobAbortConfig {
|
|
1277
1405
|
/**
|
|
1406
|
+
* @public
|
|
1278
1407
|
* <p>The list of criteria that define when and how to cancel the configuration
|
|
1279
1408
|
* deployment.</p>
|
|
1280
1409
|
*/
|
|
@@ -1288,11 +1417,13 @@ export interface IoTJobAbortConfig {
|
|
|
1288
1417
|
*/
|
|
1289
1418
|
export interface IoTJobRateIncreaseCriteria {
|
|
1290
1419
|
/**
|
|
1420
|
+
* @public
|
|
1291
1421
|
* <p>The number of devices to receive the job notification before the rollout rate
|
|
1292
1422
|
* increases.</p>
|
|
1293
1423
|
*/
|
|
1294
1424
|
numberOfNotifiedThings?: number;
|
|
1295
1425
|
/**
|
|
1426
|
+
* @public
|
|
1296
1427
|
* <p>The number of devices to successfully run the configuration job before the rollout rate
|
|
1297
1428
|
* increases.</p>
|
|
1298
1429
|
*/
|
|
@@ -1305,17 +1436,20 @@ export interface IoTJobRateIncreaseCriteria {
|
|
|
1305
1436
|
*/
|
|
1306
1437
|
export interface IoTJobExponentialRolloutRate {
|
|
1307
1438
|
/**
|
|
1439
|
+
* @public
|
|
1308
1440
|
* <p>The minimum number of devices that receive a pending job notification, per minute, when
|
|
1309
1441
|
* the job starts. This parameter defines the initial rollout rate of the job.</p>
|
|
1310
1442
|
*/
|
|
1311
1443
|
baseRatePerMinute: number | undefined;
|
|
1312
1444
|
/**
|
|
1445
|
+
* @public
|
|
1313
1446
|
* <p>The exponential factor to increase the rollout rate for the job.</p>
|
|
1314
1447
|
* <p>This parameter supports up to one digit after the decimal (for example, you can specify
|
|
1315
1448
|
* <code>1.5</code>, but not <code>1.55</code>).</p>
|
|
1316
1449
|
*/
|
|
1317
1450
|
incrementFactor: number | undefined;
|
|
1318
1451
|
/**
|
|
1452
|
+
* @public
|
|
1319
1453
|
* <p>The criteria to increase the rollout rate for the job.</p>
|
|
1320
1454
|
*/
|
|
1321
1455
|
rateIncreaseCriteria: IoTJobRateIncreaseCriteria | undefined;
|
|
@@ -1327,10 +1461,12 @@ export interface IoTJobExponentialRolloutRate {
|
|
|
1327
1461
|
*/
|
|
1328
1462
|
export interface IoTJobExecutionsRolloutConfig {
|
|
1329
1463
|
/**
|
|
1464
|
+
* @public
|
|
1330
1465
|
* <p>The exponential rate to increase the job rollout rate.</p>
|
|
1331
1466
|
*/
|
|
1332
1467
|
exponentialRate?: IoTJobExponentialRolloutRate;
|
|
1333
1468
|
/**
|
|
1469
|
+
* @public
|
|
1334
1470
|
* <p>The maximum number of devices that receive a pending job notification, per minute.</p>
|
|
1335
1471
|
*/
|
|
1336
1472
|
maximumPerMinute?: number;
|
|
@@ -1341,6 +1477,7 @@ export interface IoTJobExecutionsRolloutConfig {
|
|
|
1341
1477
|
*/
|
|
1342
1478
|
export interface IoTJobTimeoutConfig {
|
|
1343
1479
|
/**
|
|
1480
|
+
* @public
|
|
1344
1481
|
* <p>The amount of time, in minutes, that devices have to complete the job. The timer starts
|
|
1345
1482
|
* when the job status is set to <code>IN_PROGRESS</code>. If the job status doesn't change to a
|
|
1346
1483
|
* terminal state before the time expires, then the job status is set to
|
|
@@ -1355,16 +1492,19 @@ export interface IoTJobTimeoutConfig {
|
|
|
1355
1492
|
*/
|
|
1356
1493
|
export interface DeploymentIoTJobConfiguration {
|
|
1357
1494
|
/**
|
|
1495
|
+
* @public
|
|
1358
1496
|
* <p>The rollout configuration for the job. This configuration defines the rate at which the
|
|
1359
1497
|
* job rolls out to the fleet of target devices.</p>
|
|
1360
1498
|
*/
|
|
1361
1499
|
jobExecutionsRolloutConfig?: IoTJobExecutionsRolloutConfig;
|
|
1362
1500
|
/**
|
|
1501
|
+
* @public
|
|
1363
1502
|
* <p>The stop configuration for the job. This configuration defines when and how to stop a job
|
|
1364
1503
|
* rollout.</p>
|
|
1365
1504
|
*/
|
|
1366
1505
|
abortConfig?: IoTJobAbortConfig;
|
|
1367
1506
|
/**
|
|
1507
|
+
* @public
|
|
1368
1508
|
* <p>The timeout configuration for the job. This configuration defines the amount of time each
|
|
1369
1509
|
* device has to complete the job.</p>
|
|
1370
1510
|
*/
|
|
@@ -1375,39 +1515,47 @@ export interface DeploymentIoTJobConfiguration {
|
|
|
1375
1515
|
*/
|
|
1376
1516
|
export interface CreateDeploymentRequest {
|
|
1377
1517
|
/**
|
|
1518
|
+
* @public
|
|
1378
1519
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.</p>
|
|
1379
1520
|
*/
|
|
1380
1521
|
targetArn: string | undefined;
|
|
1381
1522
|
/**
|
|
1523
|
+
* @public
|
|
1382
1524
|
* <p>The name of the deployment.</p>
|
|
1383
1525
|
*/
|
|
1384
1526
|
deploymentName?: string;
|
|
1385
1527
|
/**
|
|
1528
|
+
* @public
|
|
1386
1529
|
* <p>The components to deploy. This is a dictionary, where each key is the name of a component,
|
|
1387
1530
|
* and each key's value is the version and configuration to deploy for that component.</p>
|
|
1388
1531
|
*/
|
|
1389
1532
|
components?: Record<string, ComponentDeploymentSpecification>;
|
|
1390
1533
|
/**
|
|
1534
|
+
* @public
|
|
1391
1535
|
* <p>The job configuration for the deployment configuration. The job configuration specifies
|
|
1392
1536
|
* the rollout, timeout, and stop configurations for the deployment configuration.</p>
|
|
1393
1537
|
*/
|
|
1394
1538
|
iotJobConfiguration?: DeploymentIoTJobConfiguration;
|
|
1395
1539
|
/**
|
|
1540
|
+
* @public
|
|
1396
1541
|
* <p>The deployment policies for the deployment. These policies define how the deployment
|
|
1397
1542
|
* updates components and handles failure.</p>
|
|
1398
1543
|
*/
|
|
1399
1544
|
deploymentPolicies?: DeploymentPolicies;
|
|
1400
1545
|
/**
|
|
1546
|
+
* @public
|
|
1401
1547
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
1402
1548
|
*/
|
|
1403
1549
|
parentTargetArn?: string;
|
|
1404
1550
|
/**
|
|
1551
|
+
* @public
|
|
1405
1552
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1406
1553
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1407
1554
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
1408
1555
|
*/
|
|
1409
1556
|
tags?: Record<string, string>;
|
|
1410
1557
|
/**
|
|
1558
|
+
* @public
|
|
1411
1559
|
* <p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent.
|
|
1412
1560
|
* Idempotency means that the request is successfully processed only once, even if you send the request multiple times.
|
|
1413
1561
|
* When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service
|
|
@@ -1421,14 +1569,17 @@ export interface CreateDeploymentRequest {
|
|
|
1421
1569
|
*/
|
|
1422
1570
|
export interface CreateDeploymentResponse {
|
|
1423
1571
|
/**
|
|
1572
|
+
* @public
|
|
1424
1573
|
* <p>The ID of the deployment.</p>
|
|
1425
1574
|
*/
|
|
1426
1575
|
deploymentId?: string;
|
|
1427
1576
|
/**
|
|
1577
|
+
* @public
|
|
1428
1578
|
* <p>The ID of the IoT job that applies the deployment to target devices.</p>
|
|
1429
1579
|
*/
|
|
1430
1580
|
iotJobId?: string;
|
|
1431
1581
|
/**
|
|
1582
|
+
* @public
|
|
1432
1583
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
|
|
1433
1584
|
*/
|
|
1434
1585
|
iotJobArn?: string;
|
|
@@ -1438,6 +1589,7 @@ export interface CreateDeploymentResponse {
|
|
|
1438
1589
|
*/
|
|
1439
1590
|
export interface DeleteComponentRequest {
|
|
1440
1591
|
/**
|
|
1592
|
+
* @public
|
|
1441
1593
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1442
1594
|
*/
|
|
1443
1595
|
arn: string | undefined;
|
|
@@ -1447,6 +1599,7 @@ export interface DeleteComponentRequest {
|
|
|
1447
1599
|
*/
|
|
1448
1600
|
export interface DeleteCoreDeviceRequest {
|
|
1449
1601
|
/**
|
|
1602
|
+
* @public
|
|
1450
1603
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
1451
1604
|
*/
|
|
1452
1605
|
coreDeviceThingName: string | undefined;
|
|
@@ -1456,6 +1609,7 @@ export interface DeleteCoreDeviceRequest {
|
|
|
1456
1609
|
*/
|
|
1457
1610
|
export interface DeleteDeploymentRequest {
|
|
1458
1611
|
/**
|
|
1612
|
+
* @public
|
|
1459
1613
|
* <p>The ID of the deployment.</p>
|
|
1460
1614
|
*/
|
|
1461
1615
|
deploymentId: string | undefined;
|
|
@@ -1481,34 +1635,42 @@ export type DeploymentStatus = (typeof DeploymentStatus)[keyof typeof Deployment
|
|
|
1481
1635
|
*/
|
|
1482
1636
|
export interface Deployment {
|
|
1483
1637
|
/**
|
|
1638
|
+
* @public
|
|
1484
1639
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.</p>
|
|
1485
1640
|
*/
|
|
1486
1641
|
targetArn?: string;
|
|
1487
1642
|
/**
|
|
1643
|
+
* @public
|
|
1488
1644
|
* <p>The revision number of the deployment.</p>
|
|
1489
1645
|
*/
|
|
1490
1646
|
revisionId?: string;
|
|
1491
1647
|
/**
|
|
1648
|
+
* @public
|
|
1492
1649
|
* <p>The ID of the deployment.</p>
|
|
1493
1650
|
*/
|
|
1494
1651
|
deploymentId?: string;
|
|
1495
1652
|
/**
|
|
1653
|
+
* @public
|
|
1496
1654
|
* <p>The name of the deployment.</p>
|
|
1497
1655
|
*/
|
|
1498
1656
|
deploymentName?: string;
|
|
1499
1657
|
/**
|
|
1658
|
+
* @public
|
|
1500
1659
|
* <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
|
|
1501
1660
|
*/
|
|
1502
1661
|
creationTimestamp?: Date;
|
|
1503
1662
|
/**
|
|
1663
|
+
* @public
|
|
1504
1664
|
* <p>The status of the deployment.</p>
|
|
1505
1665
|
*/
|
|
1506
1666
|
deploymentStatus?: DeploymentStatus | string;
|
|
1507
1667
|
/**
|
|
1668
|
+
* @public
|
|
1508
1669
|
* <p>Whether or not the deployment is the latest revision for its target.</p>
|
|
1509
1670
|
*/
|
|
1510
1671
|
isLatestForTarget?: boolean;
|
|
1511
1672
|
/**
|
|
1673
|
+
* @public
|
|
1512
1674
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
1513
1675
|
*/
|
|
1514
1676
|
parentTargetArn?: string;
|
|
@@ -1530,6 +1692,7 @@ export type DeploymentHistoryFilter = (typeof DeploymentHistoryFilter)[keyof typ
|
|
|
1530
1692
|
*/
|
|
1531
1693
|
export interface DescribeComponentRequest {
|
|
1532
1694
|
/**
|
|
1695
|
+
* @public
|
|
1533
1696
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1534
1697
|
*/
|
|
1535
1698
|
arn: string | undefined;
|
|
@@ -1539,39 +1702,48 @@ export interface DescribeComponentRequest {
|
|
|
1539
1702
|
*/
|
|
1540
1703
|
export interface DescribeComponentResponse {
|
|
1541
1704
|
/**
|
|
1705
|
+
* @public
|
|
1542
1706
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1543
1707
|
*/
|
|
1544
1708
|
arn?: string;
|
|
1545
1709
|
/**
|
|
1710
|
+
* @public
|
|
1546
1711
|
* <p>The name of the component.</p>
|
|
1547
1712
|
*/
|
|
1548
1713
|
componentName?: string;
|
|
1549
1714
|
/**
|
|
1715
|
+
* @public
|
|
1550
1716
|
* <p>The version of the component.</p>
|
|
1551
1717
|
*/
|
|
1552
1718
|
componentVersion?: string;
|
|
1553
1719
|
/**
|
|
1720
|
+
* @public
|
|
1554
1721
|
* <p>The time at which the component was created, expressed in ISO 8601 format.</p>
|
|
1555
1722
|
*/
|
|
1556
1723
|
creationTimestamp?: Date;
|
|
1557
1724
|
/**
|
|
1725
|
+
* @public
|
|
1558
1726
|
* <p>The publisher of the component version.</p>
|
|
1559
1727
|
*/
|
|
1560
1728
|
publisher?: string;
|
|
1561
1729
|
/**
|
|
1730
|
+
* @public
|
|
1562
1731
|
* <p>The description of the component version.</p>
|
|
1563
1732
|
*/
|
|
1564
1733
|
description?: string;
|
|
1565
1734
|
/**
|
|
1735
|
+
* @public
|
|
1566
1736
|
* <p>The status of the component version in IoT Greengrass V2. This status
|
|
1567
1737
|
* is different from the status of the component on a core device.</p>
|
|
1568
1738
|
*/
|
|
1569
1739
|
status?: CloudComponentStatus;
|
|
1570
1740
|
/**
|
|
1741
|
+
* @public
|
|
1571
1742
|
* <p>The platforms that the component version supports.</p>
|
|
1572
1743
|
*/
|
|
1573
1744
|
platforms?: ComponentPlatform[];
|
|
1574
1745
|
/**
|
|
1746
|
+
* @public
|
|
1575
1747
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1576
1748
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1577
1749
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
@@ -1588,6 +1760,7 @@ export interface DisassociateServiceRoleFromAccountRequest {
|
|
|
1588
1760
|
*/
|
|
1589
1761
|
export interface DisassociateServiceRoleFromAccountResponse {
|
|
1590
1762
|
/**
|
|
1763
|
+
* @public
|
|
1591
1764
|
* <p>The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this
|
|
1592
1765
|
* Amazon Web Services Region.</p>
|
|
1593
1766
|
*/
|
|
@@ -1623,6 +1796,7 @@ export type EffectiveDeploymentExecutionStatus = (typeof EffectiveDeploymentExec
|
|
|
1623
1796
|
*/
|
|
1624
1797
|
export interface EffectiveDeploymentStatusDetails {
|
|
1625
1798
|
/**
|
|
1799
|
+
* @public
|
|
1626
1800
|
* <p>Contains an ordered list of short error codes that range from the most generic error to
|
|
1627
1801
|
* the most specific one. The error codes describe the reason for failure whenever the
|
|
1628
1802
|
* <code>coreDeviceExecutionStatus</code> is in a failed state. The response will be an empty
|
|
@@ -1630,6 +1804,7 @@ export interface EffectiveDeploymentStatusDetails {
|
|
|
1630
1804
|
*/
|
|
1631
1805
|
errorStack?: string[];
|
|
1632
1806
|
/**
|
|
1807
|
+
* @public
|
|
1633
1808
|
* <p>Contains tags which describe the error. You can use the error types to classify errors to
|
|
1634
1809
|
* assist with remediating the failure. The response will be an empty list if there is no
|
|
1635
1810
|
* error.</p>
|
|
@@ -1642,30 +1817,37 @@ export interface EffectiveDeploymentStatusDetails {
|
|
|
1642
1817
|
*/
|
|
1643
1818
|
export interface EffectiveDeployment {
|
|
1644
1819
|
/**
|
|
1820
|
+
* @public
|
|
1645
1821
|
* <p>The ID of the deployment.</p>
|
|
1646
1822
|
*/
|
|
1647
1823
|
deploymentId: string | undefined;
|
|
1648
1824
|
/**
|
|
1825
|
+
* @public
|
|
1649
1826
|
* <p>The name of the deployment.</p>
|
|
1650
1827
|
*/
|
|
1651
1828
|
deploymentName: string | undefined;
|
|
1652
1829
|
/**
|
|
1830
|
+
* @public
|
|
1653
1831
|
* <p>The ID of the IoT job that applies the deployment to target devices.</p>
|
|
1654
1832
|
*/
|
|
1655
1833
|
iotJobId?: string;
|
|
1656
1834
|
/**
|
|
1835
|
+
* @public
|
|
1657
1836
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
|
|
1658
1837
|
*/
|
|
1659
1838
|
iotJobArn?: string;
|
|
1660
1839
|
/**
|
|
1840
|
+
* @public
|
|
1661
1841
|
* <p>The description of the deployment job.</p>
|
|
1662
1842
|
*/
|
|
1663
1843
|
description?: string;
|
|
1664
1844
|
/**
|
|
1845
|
+
* @public
|
|
1665
1846
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
|
|
1666
1847
|
*/
|
|
1667
1848
|
targetArn: string | undefined;
|
|
1668
1849
|
/**
|
|
1850
|
+
* @public
|
|
1669
1851
|
* <p>The status of the deployment job on the Greengrass core device.</p>
|
|
1670
1852
|
* <ul>
|
|
1671
1853
|
* <li>
|
|
@@ -1710,19 +1892,23 @@ export interface EffectiveDeployment {
|
|
|
1710
1892
|
*/
|
|
1711
1893
|
coreDeviceExecutionStatus: EffectiveDeploymentExecutionStatus | string | undefined;
|
|
1712
1894
|
/**
|
|
1895
|
+
* @public
|
|
1713
1896
|
* <p>The reason code for the update, if the job was updated.</p>
|
|
1714
1897
|
*/
|
|
1715
1898
|
reason?: string;
|
|
1716
1899
|
/**
|
|
1900
|
+
* @public
|
|
1717
1901
|
* <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
|
|
1718
1902
|
*/
|
|
1719
1903
|
creationTimestamp: Date | undefined;
|
|
1720
1904
|
/**
|
|
1905
|
+
* @public
|
|
1721
1906
|
* <p>The time at which the deployment job was last modified, expressed in ISO 8601
|
|
1722
1907
|
* format.</p>
|
|
1723
1908
|
*/
|
|
1724
1909
|
modifiedTimestamp: Date | undefined;
|
|
1725
1910
|
/**
|
|
1911
|
+
* @public
|
|
1726
1912
|
* <p>The status details that explain why a deployment has an error. This response will be null
|
|
1727
1913
|
* if the deployment is in a success state.</p>
|
|
1728
1914
|
*/
|
|
@@ -1745,10 +1931,12 @@ export type RecipeOutputFormat = (typeof RecipeOutputFormat)[keyof typeof Recipe
|
|
|
1745
1931
|
*/
|
|
1746
1932
|
export interface GetComponentRequest {
|
|
1747
1933
|
/**
|
|
1934
|
+
* @public
|
|
1748
1935
|
* <p>The format of the recipe.</p>
|
|
1749
1936
|
*/
|
|
1750
1937
|
recipeOutputFormat?: RecipeOutputFormat | string;
|
|
1751
1938
|
/**
|
|
1939
|
+
* @public
|
|
1752
1940
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
1753
1941
|
*/
|
|
1754
1942
|
arn: string | undefined;
|
|
@@ -1758,14 +1946,17 @@ export interface GetComponentRequest {
|
|
|
1758
1946
|
*/
|
|
1759
1947
|
export interface GetComponentResponse {
|
|
1760
1948
|
/**
|
|
1949
|
+
* @public
|
|
1761
1950
|
* <p>The format of the recipe.</p>
|
|
1762
1951
|
*/
|
|
1763
1952
|
recipeOutputFormat: RecipeOutputFormat | string | undefined;
|
|
1764
1953
|
/**
|
|
1954
|
+
* @public
|
|
1765
1955
|
* <p>The recipe of the component version.</p>
|
|
1766
1956
|
*/
|
|
1767
1957
|
recipe: Uint8Array | undefined;
|
|
1768
1958
|
/**
|
|
1959
|
+
* @public
|
|
1769
1960
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1770
1961
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1771
1962
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
@@ -1777,10 +1968,12 @@ export interface GetComponentResponse {
|
|
|
1777
1968
|
*/
|
|
1778
1969
|
export interface GetComponentVersionArtifactRequest {
|
|
1779
1970
|
/**
|
|
1971
|
+
* @public
|
|
1780
1972
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version. Specify the ARN of a public or a Lambda component version.</p>
|
|
1781
1973
|
*/
|
|
1782
1974
|
arn: string | undefined;
|
|
1783
1975
|
/**
|
|
1976
|
+
* @public
|
|
1784
1977
|
* <p>The name of the artifact.</p>
|
|
1785
1978
|
* <p>You can use the <a href="https://docs.aws.amazon.com/greengrass/v2/APIReference/API_GetComponent.html">GetComponent</a> operation to
|
|
1786
1979
|
* download the component recipe, which includes the URI of the artifact. The artifact name is
|
|
@@ -1795,6 +1988,7 @@ export interface GetComponentVersionArtifactRequest {
|
|
|
1795
1988
|
*/
|
|
1796
1989
|
export interface GetComponentVersionArtifactResponse {
|
|
1797
1990
|
/**
|
|
1991
|
+
* @public
|
|
1798
1992
|
* <p>The URL of the artifact.</p>
|
|
1799
1993
|
*/
|
|
1800
1994
|
preSignedUrl: string | undefined;
|
|
@@ -1804,6 +1998,7 @@ export interface GetComponentVersionArtifactResponse {
|
|
|
1804
1998
|
*/
|
|
1805
1999
|
export interface GetConnectivityInfoRequest {
|
|
1806
2000
|
/**
|
|
2001
|
+
* @public
|
|
1807
2002
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
1808
2003
|
*/
|
|
1809
2004
|
thingName: string | undefined;
|
|
@@ -1813,10 +2008,12 @@ export interface GetConnectivityInfoRequest {
|
|
|
1813
2008
|
*/
|
|
1814
2009
|
export interface GetConnectivityInfoResponse {
|
|
1815
2010
|
/**
|
|
2011
|
+
* @public
|
|
1816
2012
|
* <p>The connectivity information for the core device.</p>
|
|
1817
2013
|
*/
|
|
1818
2014
|
connectivityInfo?: ConnectivityInfo[];
|
|
1819
2015
|
/**
|
|
2016
|
+
* @public
|
|
1820
2017
|
* <p>A message about the connectivity information request.</p>
|
|
1821
2018
|
*/
|
|
1822
2019
|
message?: string;
|
|
@@ -1826,6 +2023,7 @@ export interface GetConnectivityInfoResponse {
|
|
|
1826
2023
|
*/
|
|
1827
2024
|
export interface GetCoreDeviceRequest {
|
|
1828
2025
|
/**
|
|
2026
|
+
* @public
|
|
1829
2027
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
1830
2028
|
*/
|
|
1831
2029
|
coreDeviceThingName: string | undefined;
|
|
@@ -1835,10 +2033,12 @@ export interface GetCoreDeviceRequest {
|
|
|
1835
2033
|
*/
|
|
1836
2034
|
export interface GetCoreDeviceResponse {
|
|
1837
2035
|
/**
|
|
2036
|
+
* @public
|
|
1838
2037
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
1839
2038
|
*/
|
|
1840
2039
|
coreDeviceThingName?: string;
|
|
1841
2040
|
/**
|
|
2041
|
+
* @public
|
|
1842
2042
|
* <p>The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to
|
|
1843
2043
|
* the version of the Greengrass nucleus component that runs on the core device. For more information,
|
|
1844
2044
|
* see the <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html">Greengrass nucleus
|
|
@@ -1846,14 +2046,17 @@ export interface GetCoreDeviceResponse {
|
|
|
1846
2046
|
*/
|
|
1847
2047
|
coreVersion?: string;
|
|
1848
2048
|
/**
|
|
2049
|
+
* @public
|
|
1849
2050
|
* <p>The operating system platform that the core device runs.</p>
|
|
1850
2051
|
*/
|
|
1851
2052
|
platform?: string;
|
|
1852
2053
|
/**
|
|
2054
|
+
* @public
|
|
1853
2055
|
* <p>The computer architecture of the core device.</p>
|
|
1854
2056
|
*/
|
|
1855
2057
|
architecture?: string;
|
|
1856
2058
|
/**
|
|
2059
|
+
* @public
|
|
1857
2060
|
* <p>The status of the core device. The core device status can be:</p>
|
|
1858
2061
|
* <ul>
|
|
1859
2062
|
* <li>
|
|
@@ -1869,11 +2072,13 @@ export interface GetCoreDeviceResponse {
|
|
|
1869
2072
|
*/
|
|
1870
2073
|
status?: CoreDeviceStatus | string;
|
|
1871
2074
|
/**
|
|
2075
|
+
* @public
|
|
1872
2076
|
* <p>The time at which the core device's status last updated, expressed in ISO 8601
|
|
1873
2077
|
* format.</p>
|
|
1874
2078
|
*/
|
|
1875
2079
|
lastStatusUpdateTimestamp?: Date;
|
|
1876
2080
|
/**
|
|
2081
|
+
* @public
|
|
1877
2082
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1878
2083
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1879
2084
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
@@ -1885,6 +2090,7 @@ export interface GetCoreDeviceResponse {
|
|
|
1885
2090
|
*/
|
|
1886
2091
|
export interface GetDeploymentRequest {
|
|
1887
2092
|
/**
|
|
2093
|
+
* @public
|
|
1888
2094
|
* <p>The ID of the deployment.</p>
|
|
1889
2095
|
*/
|
|
1890
2096
|
deploymentId: string | undefined;
|
|
@@ -1894,61 +2100,75 @@ export interface GetDeploymentRequest {
|
|
|
1894
2100
|
*/
|
|
1895
2101
|
export interface GetDeploymentResponse {
|
|
1896
2102
|
/**
|
|
2103
|
+
* @public
|
|
1897
2104
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
|
|
1898
2105
|
*/
|
|
1899
2106
|
targetArn?: string;
|
|
1900
2107
|
/**
|
|
2108
|
+
* @public
|
|
1901
2109
|
* <p>The revision number of the deployment.</p>
|
|
1902
2110
|
*/
|
|
1903
2111
|
revisionId?: string;
|
|
1904
2112
|
/**
|
|
2113
|
+
* @public
|
|
1905
2114
|
* <p>The ID of the deployment.</p>
|
|
1906
2115
|
*/
|
|
1907
2116
|
deploymentId?: string;
|
|
1908
2117
|
/**
|
|
2118
|
+
* @public
|
|
1909
2119
|
* <p>The name of the deployment.</p>
|
|
1910
2120
|
*/
|
|
1911
2121
|
deploymentName?: string;
|
|
1912
2122
|
/**
|
|
2123
|
+
* @public
|
|
1913
2124
|
* <p>The status of the deployment.</p>
|
|
1914
2125
|
*/
|
|
1915
2126
|
deploymentStatus?: DeploymentStatus | string;
|
|
1916
2127
|
/**
|
|
2128
|
+
* @public
|
|
1917
2129
|
* <p>The ID of the IoT job that applies the deployment to target devices.</p>
|
|
1918
2130
|
*/
|
|
1919
2131
|
iotJobId?: string;
|
|
1920
2132
|
/**
|
|
2133
|
+
* @public
|
|
1921
2134
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT job that applies the deployment to target devices.</p>
|
|
1922
2135
|
*/
|
|
1923
2136
|
iotJobArn?: string;
|
|
1924
2137
|
/**
|
|
2138
|
+
* @public
|
|
1925
2139
|
* <p>The components to deploy. This is a dictionary, where each key is the name of a component,
|
|
1926
2140
|
* and each key's value is the version and configuration to deploy for that component.</p>
|
|
1927
2141
|
*/
|
|
1928
2142
|
components?: Record<string, ComponentDeploymentSpecification>;
|
|
1929
2143
|
/**
|
|
2144
|
+
* @public
|
|
1930
2145
|
* <p>The deployment policies for the deployment. These policies define how the deployment
|
|
1931
2146
|
* updates components and handles failure.</p>
|
|
1932
2147
|
*/
|
|
1933
2148
|
deploymentPolicies?: DeploymentPolicies;
|
|
1934
2149
|
/**
|
|
2150
|
+
* @public
|
|
1935
2151
|
* <p>The job configuration for the deployment configuration. The job configuration specifies
|
|
1936
2152
|
* the rollout, timeout, and stop configurations for the deployment configuration.</p>
|
|
1937
2153
|
*/
|
|
1938
2154
|
iotJobConfiguration?: DeploymentIoTJobConfiguration;
|
|
1939
2155
|
/**
|
|
2156
|
+
* @public
|
|
1940
2157
|
* <p>The time at which the deployment was created, expressed in ISO 8601 format.</p>
|
|
1941
2158
|
*/
|
|
1942
2159
|
creationTimestamp?: Date;
|
|
1943
2160
|
/**
|
|
2161
|
+
* @public
|
|
1944
2162
|
* <p>Whether or not the deployment is the latest revision for its target.</p>
|
|
1945
2163
|
*/
|
|
1946
2164
|
isLatestForTarget?: boolean;
|
|
1947
2165
|
/**
|
|
2166
|
+
* @public
|
|
1948
2167
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
1949
2168
|
*/
|
|
1950
2169
|
parentTargetArn?: string;
|
|
1951
2170
|
/**
|
|
2171
|
+
* @public
|
|
1952
2172
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
1953
2173
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
1954
2174
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
@@ -1965,11 +2185,13 @@ export interface GetServiceRoleForAccountRequest {
|
|
|
1965
2185
|
*/
|
|
1966
2186
|
export interface GetServiceRoleForAccountResponse {
|
|
1967
2187
|
/**
|
|
2188
|
+
* @public
|
|
1968
2189
|
* <p>The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this
|
|
1969
2190
|
* Amazon Web Services Region.</p>
|
|
1970
2191
|
*/
|
|
1971
2192
|
associatedAt?: string;
|
|
1972
2193
|
/**
|
|
2194
|
+
* @public
|
|
1973
2195
|
* <p>The ARN of the service role that is associated with IoT Greengrass for your Amazon Web Services account in this
|
|
1974
2196
|
* Amazon Web Services Region.</p>
|
|
1975
2197
|
*/
|
|
@@ -1980,14 +2202,17 @@ export interface GetServiceRoleForAccountResponse {
|
|
|
1980
2202
|
*/
|
|
1981
2203
|
export interface ListClientDevicesAssociatedWithCoreDeviceRequest {
|
|
1982
2204
|
/**
|
|
2205
|
+
* @public
|
|
1983
2206
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
1984
2207
|
*/
|
|
1985
2208
|
coreDeviceThingName: string | undefined;
|
|
1986
2209
|
/**
|
|
2210
|
+
* @public
|
|
1987
2211
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
1988
2212
|
*/
|
|
1989
2213
|
maxResults?: number;
|
|
1990
2214
|
/**
|
|
2215
|
+
* @public
|
|
1991
2216
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
1992
2217
|
*/
|
|
1993
2218
|
nextToken?: string;
|
|
@@ -1997,10 +2222,12 @@ export interface ListClientDevicesAssociatedWithCoreDeviceRequest {
|
|
|
1997
2222
|
*/
|
|
1998
2223
|
export interface ListClientDevicesAssociatedWithCoreDeviceResponse {
|
|
1999
2224
|
/**
|
|
2225
|
+
* @public
|
|
2000
2226
|
* <p>A list that describes the client devices that are associated with the core device.</p>
|
|
2001
2227
|
*/
|
|
2002
2228
|
associatedClientDevices?: AssociatedClientDevice[];
|
|
2003
2229
|
/**
|
|
2230
|
+
* @public
|
|
2004
2231
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2005
2232
|
*/
|
|
2006
2233
|
nextToken?: string;
|
|
@@ -2010,16 +2237,19 @@ export interface ListClientDevicesAssociatedWithCoreDeviceResponse {
|
|
|
2010
2237
|
*/
|
|
2011
2238
|
export interface ListComponentsRequest {
|
|
2012
2239
|
/**
|
|
2240
|
+
* @public
|
|
2013
2241
|
* <p>The scope of the components to list.</p>
|
|
2014
2242
|
* <p>Default: <code>PRIVATE</code>
|
|
2015
2243
|
* </p>
|
|
2016
2244
|
*/
|
|
2017
2245
|
scope?: ComponentVisibilityScope | string;
|
|
2018
2246
|
/**
|
|
2247
|
+
* @public
|
|
2019
2248
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2020
2249
|
*/
|
|
2021
2250
|
maxResults?: number;
|
|
2022
2251
|
/**
|
|
2252
|
+
* @public
|
|
2023
2253
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2024
2254
|
*/
|
|
2025
2255
|
nextToken?: string;
|
|
@@ -2029,10 +2259,12 @@ export interface ListComponentsRequest {
|
|
|
2029
2259
|
*/
|
|
2030
2260
|
export interface ListComponentsResponse {
|
|
2031
2261
|
/**
|
|
2262
|
+
* @public
|
|
2032
2263
|
* <p>A list that summarizes each component.</p>
|
|
2033
2264
|
*/
|
|
2034
2265
|
components?: Component[];
|
|
2035
2266
|
/**
|
|
2267
|
+
* @public
|
|
2036
2268
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2037
2269
|
*/
|
|
2038
2270
|
nextToken?: string;
|
|
@@ -2042,14 +2274,17 @@ export interface ListComponentsResponse {
|
|
|
2042
2274
|
*/
|
|
2043
2275
|
export interface ListComponentVersionsRequest {
|
|
2044
2276
|
/**
|
|
2277
|
+
* @public
|
|
2045
2278
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component.</p>
|
|
2046
2279
|
*/
|
|
2047
2280
|
arn: string | undefined;
|
|
2048
2281
|
/**
|
|
2282
|
+
* @public
|
|
2049
2283
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2050
2284
|
*/
|
|
2051
2285
|
maxResults?: number;
|
|
2052
2286
|
/**
|
|
2287
|
+
* @public
|
|
2053
2288
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2054
2289
|
*/
|
|
2055
2290
|
nextToken?: string;
|
|
@@ -2059,10 +2294,12 @@ export interface ListComponentVersionsRequest {
|
|
|
2059
2294
|
*/
|
|
2060
2295
|
export interface ListComponentVersionsResponse {
|
|
2061
2296
|
/**
|
|
2297
|
+
* @public
|
|
2062
2298
|
* <p>A list of versions that exist for the component.</p>
|
|
2063
2299
|
*/
|
|
2064
2300
|
componentVersions?: ComponentVersionListItem[];
|
|
2065
2301
|
/**
|
|
2302
|
+
* @public
|
|
2066
2303
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2067
2304
|
*/
|
|
2068
2305
|
nextToken?: string;
|
|
@@ -2072,6 +2309,7 @@ export interface ListComponentVersionsResponse {
|
|
|
2072
2309
|
*/
|
|
2073
2310
|
export interface ListCoreDevicesRequest {
|
|
2074
2311
|
/**
|
|
2312
|
+
* @public
|
|
2075
2313
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the IoT thing group by which to filter. If you specify this parameter,
|
|
2076
2314
|
* the list includes only core devices that have successfully deployed a deployment that targets
|
|
2077
2315
|
* the thing group. When you remove a core device from a thing group, the list continues to
|
|
@@ -2079,6 +2317,7 @@ export interface ListCoreDevicesRequest {
|
|
|
2079
2317
|
*/
|
|
2080
2318
|
thingGroupArn?: string;
|
|
2081
2319
|
/**
|
|
2320
|
+
* @public
|
|
2082
2321
|
* <p>The core device status by which to filter. If you specify this parameter, the list
|
|
2083
2322
|
* includes only core devices that have this status. Choose one of the following options:</p>
|
|
2084
2323
|
* <ul>
|
|
@@ -2095,10 +2334,12 @@ export interface ListCoreDevicesRequest {
|
|
|
2095
2334
|
*/
|
|
2096
2335
|
status?: CoreDeviceStatus | string;
|
|
2097
2336
|
/**
|
|
2337
|
+
* @public
|
|
2098
2338
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2099
2339
|
*/
|
|
2100
2340
|
maxResults?: number;
|
|
2101
2341
|
/**
|
|
2342
|
+
* @public
|
|
2102
2343
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2103
2344
|
*/
|
|
2104
2345
|
nextToken?: string;
|
|
@@ -2108,10 +2349,12 @@ export interface ListCoreDevicesRequest {
|
|
|
2108
2349
|
*/
|
|
2109
2350
|
export interface ListCoreDevicesResponse {
|
|
2110
2351
|
/**
|
|
2352
|
+
* @public
|
|
2111
2353
|
* <p>A list that summarizes each core device.</p>
|
|
2112
2354
|
*/
|
|
2113
2355
|
coreDevices?: CoreDevice[];
|
|
2114
2356
|
/**
|
|
2357
|
+
* @public
|
|
2115
2358
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2116
2359
|
*/
|
|
2117
2360
|
nextToken?: string;
|
|
@@ -2121,10 +2364,12 @@ export interface ListCoreDevicesResponse {
|
|
|
2121
2364
|
*/
|
|
2122
2365
|
export interface ListDeploymentsRequest {
|
|
2123
2366
|
/**
|
|
2367
|
+
* @public
|
|
2124
2368
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the target IoT thing or thing group.</p>
|
|
2125
2369
|
*/
|
|
2126
2370
|
targetArn?: string;
|
|
2127
2371
|
/**
|
|
2372
|
+
* @public
|
|
2128
2373
|
* <p>The filter for the list of deployments. Choose one of the following options:</p>
|
|
2129
2374
|
* <ul>
|
|
2130
2375
|
* <li>
|
|
@@ -2142,14 +2387,17 @@ export interface ListDeploymentsRequest {
|
|
|
2142
2387
|
*/
|
|
2143
2388
|
historyFilter?: DeploymentHistoryFilter | string;
|
|
2144
2389
|
/**
|
|
2390
|
+
* @public
|
|
2145
2391
|
* <p>The parent deployment's target <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> within a subdeployment.</p>
|
|
2146
2392
|
*/
|
|
2147
2393
|
parentTargetArn?: string;
|
|
2148
2394
|
/**
|
|
2395
|
+
* @public
|
|
2149
2396
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2150
2397
|
*/
|
|
2151
2398
|
maxResults?: number;
|
|
2152
2399
|
/**
|
|
2400
|
+
* @public
|
|
2153
2401
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2154
2402
|
*/
|
|
2155
2403
|
nextToken?: string;
|
|
@@ -2159,10 +2407,12 @@ export interface ListDeploymentsRequest {
|
|
|
2159
2407
|
*/
|
|
2160
2408
|
export interface ListDeploymentsResponse {
|
|
2161
2409
|
/**
|
|
2410
|
+
* @public
|
|
2162
2411
|
* <p>A list that summarizes each deployment.</p>
|
|
2163
2412
|
*/
|
|
2164
2413
|
deployments?: Deployment[];
|
|
2165
2414
|
/**
|
|
2415
|
+
* @public
|
|
2166
2416
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2167
2417
|
*/
|
|
2168
2418
|
nextToken?: string;
|
|
@@ -2172,14 +2422,17 @@ export interface ListDeploymentsResponse {
|
|
|
2172
2422
|
*/
|
|
2173
2423
|
export interface ListEffectiveDeploymentsRequest {
|
|
2174
2424
|
/**
|
|
2425
|
+
* @public
|
|
2175
2426
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2176
2427
|
*/
|
|
2177
2428
|
coreDeviceThingName: string | undefined;
|
|
2178
2429
|
/**
|
|
2430
|
+
* @public
|
|
2179
2431
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2180
2432
|
*/
|
|
2181
2433
|
maxResults?: number;
|
|
2182
2434
|
/**
|
|
2435
|
+
* @public
|
|
2183
2436
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2184
2437
|
*/
|
|
2185
2438
|
nextToken?: string;
|
|
@@ -2189,10 +2442,12 @@ export interface ListEffectiveDeploymentsRequest {
|
|
|
2189
2442
|
*/
|
|
2190
2443
|
export interface ListEffectiveDeploymentsResponse {
|
|
2191
2444
|
/**
|
|
2445
|
+
* @public
|
|
2192
2446
|
* <p>A list that summarizes each deployment on the core device.</p>
|
|
2193
2447
|
*/
|
|
2194
2448
|
effectiveDeployments?: EffectiveDeployment[];
|
|
2195
2449
|
/**
|
|
2450
|
+
* @public
|
|
2196
2451
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2197
2452
|
*/
|
|
2198
2453
|
nextToken?: string;
|
|
@@ -2214,18 +2469,22 @@ export type InstalledComponentTopologyFilter = (typeof InstalledComponentTopolog
|
|
|
2214
2469
|
*/
|
|
2215
2470
|
export interface ListInstalledComponentsRequest {
|
|
2216
2471
|
/**
|
|
2472
|
+
* @public
|
|
2217
2473
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2218
2474
|
*/
|
|
2219
2475
|
coreDeviceThingName: string | undefined;
|
|
2220
2476
|
/**
|
|
2477
|
+
* @public
|
|
2221
2478
|
* <p>The maximum number of results to be returned per paginated request.</p>
|
|
2222
2479
|
*/
|
|
2223
2480
|
maxResults?: number;
|
|
2224
2481
|
/**
|
|
2482
|
+
* @public
|
|
2225
2483
|
* <p>The token to be used for the next set of paginated results.</p>
|
|
2226
2484
|
*/
|
|
2227
2485
|
nextToken?: string;
|
|
2228
2486
|
/**
|
|
2487
|
+
* @public
|
|
2229
2488
|
* <p>The filter for the list of components. Choose from the following options:</p>
|
|
2230
2489
|
* <ul>
|
|
2231
2490
|
* <li>
|
|
@@ -2270,27 +2529,33 @@ export type InstalledComponentLifecycleState = (typeof InstalledComponentLifecyc
|
|
|
2270
2529
|
*/
|
|
2271
2530
|
export interface InstalledComponent {
|
|
2272
2531
|
/**
|
|
2532
|
+
* @public
|
|
2273
2533
|
* <p>The name of the component.</p>
|
|
2274
2534
|
*/
|
|
2275
2535
|
componentName?: string;
|
|
2276
2536
|
/**
|
|
2537
|
+
* @public
|
|
2277
2538
|
* <p>The version of the component.</p>
|
|
2278
2539
|
*/
|
|
2279
2540
|
componentVersion?: string;
|
|
2280
2541
|
/**
|
|
2542
|
+
* @public
|
|
2281
2543
|
* <p>The lifecycle state of the component.</p>
|
|
2282
2544
|
*/
|
|
2283
2545
|
lifecycleState?: InstalledComponentLifecycleState | string;
|
|
2284
2546
|
/**
|
|
2547
|
+
* @public
|
|
2285
2548
|
* <p>A detailed response about the lifecycle state of the component that explains the reason
|
|
2286
2549
|
* why a component has an error or is broken.</p>
|
|
2287
2550
|
*/
|
|
2288
2551
|
lifecycleStateDetails?: string;
|
|
2289
2552
|
/**
|
|
2553
|
+
* @public
|
|
2290
2554
|
* <p>Whether or not the component is a root component.</p>
|
|
2291
2555
|
*/
|
|
2292
2556
|
isRoot?: boolean;
|
|
2293
2557
|
/**
|
|
2558
|
+
* @public
|
|
2294
2559
|
* <p>The status of how current the data is.</p>
|
|
2295
2560
|
* <p>This response is based off of component state changes. The status reflects component
|
|
2296
2561
|
* disruptions and deployments. If a component only sees a configuration update during a
|
|
@@ -2298,12 +2563,14 @@ export interface InstalledComponent {
|
|
|
2298
2563
|
*/
|
|
2299
2564
|
lastStatusChangeTimestamp?: Date;
|
|
2300
2565
|
/**
|
|
2566
|
+
* @public
|
|
2301
2567
|
* <p>The last time the Greengrass core device sent a message containing a component's state to the
|
|
2302
2568
|
* Amazon Web Services Cloud.</p>
|
|
2303
2569
|
* <p>A component does not need to see a state change for this field to update.</p>
|
|
2304
2570
|
*/
|
|
2305
2571
|
lastReportedTimestamp?: Date;
|
|
2306
2572
|
/**
|
|
2573
|
+
* @public
|
|
2307
2574
|
* <p>The most recent deployment source that brought the component to the Greengrass core device. For
|
|
2308
2575
|
* a thing group deployment or thing deployment, the source will be the The ID of the deployment. and for
|
|
2309
2576
|
* local deployments it will be <code>LOCAL</code>.</p>
|
|
@@ -2314,6 +2581,7 @@ export interface InstalledComponent {
|
|
|
2314
2581
|
*/
|
|
2315
2582
|
lastInstallationSource?: string;
|
|
2316
2583
|
/**
|
|
2584
|
+
* @public
|
|
2317
2585
|
* <p>The status codes that indicate the reason for failure whenever the
|
|
2318
2586
|
* <code>lifecycleState</code> has an error or is in a broken state.</p>
|
|
2319
2587
|
* <note>
|
|
@@ -2329,6 +2597,7 @@ export interface InstalledComponent {
|
|
|
2329
2597
|
*/
|
|
2330
2598
|
export interface ListInstalledComponentsResponse {
|
|
2331
2599
|
/**
|
|
2600
|
+
* @public
|
|
2332
2601
|
* <p>A list that summarizes each component on the core device.</p>
|
|
2333
2602
|
* <note>
|
|
2334
2603
|
* <p>Greengrass nucleus v2.7.0 or later is required to get an accurate
|
|
@@ -2343,6 +2612,7 @@ export interface ListInstalledComponentsResponse {
|
|
|
2343
2612
|
*/
|
|
2344
2613
|
installedComponents?: InstalledComponent[];
|
|
2345
2614
|
/**
|
|
2615
|
+
* @public
|
|
2346
2616
|
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2347
2617
|
*/
|
|
2348
2618
|
nextToken?: string;
|
|
@@ -2352,6 +2622,7 @@ export interface ListInstalledComponentsResponse {
|
|
|
2352
2622
|
*/
|
|
2353
2623
|
export interface ListTagsForResourceRequest {
|
|
2354
2624
|
/**
|
|
2625
|
+
* @public
|
|
2355
2626
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource.</p>
|
|
2356
2627
|
*/
|
|
2357
2628
|
resourceArn: string | undefined;
|
|
@@ -2361,6 +2632,7 @@ export interface ListTagsForResourceRequest {
|
|
|
2361
2632
|
*/
|
|
2362
2633
|
export interface ListTagsForResourceResponse {
|
|
2363
2634
|
/**
|
|
2635
|
+
* @public
|
|
2364
2636
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
2365
2637
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
2366
2638
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
@@ -2372,10 +2644,12 @@ export interface ListTagsForResourceResponse {
|
|
|
2372
2644
|
*/
|
|
2373
2645
|
export interface ResolveComponentCandidatesRequest {
|
|
2374
2646
|
/**
|
|
2647
|
+
* @public
|
|
2375
2648
|
* <p>The platform to use to resolve compatible components.</p>
|
|
2376
2649
|
*/
|
|
2377
2650
|
platform?: ComponentPlatform;
|
|
2378
2651
|
/**
|
|
2652
|
+
* @public
|
|
2379
2653
|
* <p>The list of components to resolve.</p>
|
|
2380
2654
|
*/
|
|
2381
2655
|
componentCandidates?: ComponentCandidate[];
|
|
@@ -2387,22 +2661,27 @@ export interface ResolveComponentCandidatesRequest {
|
|
|
2387
2661
|
*/
|
|
2388
2662
|
export interface ResolvedComponentVersion {
|
|
2389
2663
|
/**
|
|
2664
|
+
* @public
|
|
2390
2665
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the component version.</p>
|
|
2391
2666
|
*/
|
|
2392
2667
|
arn?: string;
|
|
2393
2668
|
/**
|
|
2669
|
+
* @public
|
|
2394
2670
|
* <p>The name of the component.</p>
|
|
2395
2671
|
*/
|
|
2396
2672
|
componentName?: string;
|
|
2397
2673
|
/**
|
|
2674
|
+
* @public
|
|
2398
2675
|
* <p>The version of the component.</p>
|
|
2399
2676
|
*/
|
|
2400
2677
|
componentVersion?: string;
|
|
2401
2678
|
/**
|
|
2679
|
+
* @public
|
|
2402
2680
|
* <p>The recipe of the component version.</p>
|
|
2403
2681
|
*/
|
|
2404
2682
|
recipe?: Uint8Array;
|
|
2405
2683
|
/**
|
|
2684
|
+
* @public
|
|
2406
2685
|
* <p>The vendor guidance state for the component version. This state indicates whether
|
|
2407
2686
|
* the component version has any issues that you should consider before you deploy it. The vendor guidance state can be:</p>
|
|
2408
2687
|
* <ul>
|
|
@@ -2424,6 +2703,7 @@ export interface ResolvedComponentVersion {
|
|
|
2424
2703
|
*/
|
|
2425
2704
|
vendorGuidance?: VendorGuidance | string;
|
|
2426
2705
|
/**
|
|
2706
|
+
* @public
|
|
2427
2707
|
* <p>A message that communicates details about the vendor guidance state
|
|
2428
2708
|
* of the component version. This message communicates why a component version is discontinued or deleted.</p>
|
|
2429
2709
|
*/
|
|
@@ -2434,6 +2714,7 @@ export interface ResolvedComponentVersion {
|
|
|
2434
2714
|
*/
|
|
2435
2715
|
export interface ResolveComponentCandidatesResponse {
|
|
2436
2716
|
/**
|
|
2717
|
+
* @public
|
|
2437
2718
|
* <p>A list of components that meet the requirements that you specify in the request. This list
|
|
2438
2719
|
* includes each component's recipe that you can use to install the component.</p>
|
|
2439
2720
|
*/
|
|
@@ -2444,10 +2725,12 @@ export interface ResolveComponentCandidatesResponse {
|
|
|
2444
2725
|
*/
|
|
2445
2726
|
export interface TagResourceRequest {
|
|
2446
2727
|
/**
|
|
2728
|
+
* @public
|
|
2447
2729
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to tag.</p>
|
|
2448
2730
|
*/
|
|
2449
2731
|
resourceArn: string | undefined;
|
|
2450
2732
|
/**
|
|
2733
|
+
* @public
|
|
2451
2734
|
* <p>A list of key-value pairs that contain metadata for the resource. For more
|
|
2452
2735
|
* information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html">Tag your
|
|
2453
2736
|
* resources</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>
|
|
@@ -2464,10 +2747,12 @@ export interface TagResourceResponse {
|
|
|
2464
2747
|
*/
|
|
2465
2748
|
export interface UntagResourceRequest {
|
|
2466
2749
|
/**
|
|
2750
|
+
* @public
|
|
2467
2751
|
* <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the resource to untag.</p>
|
|
2468
2752
|
*/
|
|
2469
2753
|
resourceArn: string | undefined;
|
|
2470
2754
|
/**
|
|
2755
|
+
* @public
|
|
2471
2756
|
* <p>A list of keys for tags to remove from the resource.</p>
|
|
2472
2757
|
*/
|
|
2473
2758
|
tagKeys: string[] | undefined;
|
|
@@ -2482,10 +2767,12 @@ export interface UntagResourceResponse {
|
|
|
2482
2767
|
*/
|
|
2483
2768
|
export interface UpdateConnectivityInfoRequest {
|
|
2484
2769
|
/**
|
|
2770
|
+
* @public
|
|
2485
2771
|
* <p>The name of the core device. This is also the name of the IoT thing.</p>
|
|
2486
2772
|
*/
|
|
2487
2773
|
thingName: string | undefined;
|
|
2488
2774
|
/**
|
|
2775
|
+
* @public
|
|
2489
2776
|
* <p>The connectivity information for the core device.</p>
|
|
2490
2777
|
*/
|
|
2491
2778
|
connectivityInfo: ConnectivityInfo[] | undefined;
|
|
@@ -2495,10 +2782,12 @@ export interface UpdateConnectivityInfoRequest {
|
|
|
2495
2782
|
*/
|
|
2496
2783
|
export interface UpdateConnectivityInfoResponse {
|
|
2497
2784
|
/**
|
|
2785
|
+
* @public
|
|
2498
2786
|
* <p>The new version of the connectivity information for the core device.</p>
|
|
2499
2787
|
*/
|
|
2500
2788
|
version?: string;
|
|
2501
2789
|
/**
|
|
2790
|
+
* @public
|
|
2502
2791
|
* <p>A message about the connectivity information update request.</p>
|
|
2503
2792
|
*/
|
|
2504
2793
|
message?: string;
|