/
docs-2.json
1275 lines (1275 loc) · 80.7 KB
/
docs-2.json
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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>IoT Greengrass brings local compute, messaging, data management, sync, and ML inference capabilities to edge devices. This enables devices to collect and analyze data closer to the source of information, react autonomously to local events, and communicate securely with each other on local networks. Local devices can also communicate securely with Amazon Web Services IoT Core and export IoT data to the Amazon Web Services Cloud. IoT Greengrass developers can use Lambda functions and components to create and deploy applications to fleets of edge devices for local operation.</p> <p>IoT Greengrass Version 2 provides a new major version of the IoT Greengrass Core software, new APIs, and a new console. Use this API reference to learn how to use the IoT Greengrass V2 API operations to manage components, manage deployments, and core devices.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/what-is-iot-greengrass.html\">What is IoT Greengrass?</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>",
"operations": {
"BatchAssociateClientDeviceWithCoreDevice": "<p>Associate a list of client devices with a core device. Use this API operation to specify which client devices can discover a core device through cloud discovery. With cloud discovery, client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information and certificates. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-cloud-discovery.html\">Configure cloud discovery</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p> <note> <p>Client devices are local IoT devices that connect to and communicate with an IoT Greengrass core device over MQTT. You can connect client devices to a core device to sync MQTT messages and data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html\">Interact with local IoT devices</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p> </note>",
"BatchDisassociateClientDeviceFromCoreDevice": "<p>Disassociate a list of client devices from a core device. After you disassociate a client device from a core device, the client device won't be able to use cloud discovery to retrieve the core device's connectivity information and certificates.</p>",
"CancelDeployment": "<p>Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.</p>",
"CreateComponentVersion": "<p>Creates a component. Components are software that run on Greengrass core devices. After you develop and test a component on your core device, you can use this operation to upload your component to IoT Greengrass. Then, you can deploy the component to other core devices.</p> <p>You can use this operation to do the following:</p> <ul> <li> <p> <b>Create components from recipes</b> </p> <p>Create a component from a recipe, which is a file that defines the component's metadata, parameters, dependencies, lifecycle, artifacts, and platform capability. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/component-recipe-reference.html\">IoT Greengrass component recipe reference</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p> <p>To create a component from a recipe, specify <code>inlineRecipe</code> when you call this operation.</p> </li> <li> <p> <b>Create components from Lambda functions</b> </p> <p>Create a component from an Lambda function that runs on IoT Greengrass. This creates a recipe and artifacts from the Lambda function's deployment package. You can use this operation to migrate Lambda functions from IoT Greengrass V1 to IoT Greengrass V2.</p> <p>This function only accepts Lambda functions that use the following runtimes:</p> <ul> <li> <p>Python 2.7 – <code>python2.7</code> </p> </li> <li> <p>Python 3.7 – <code>python3.7</code> </p> </li> <li> <p>Python 3.8 – <code>python3.8</code> </p> </li> <li> <p>Java 8 – <code>java8</code> </p> </li> <li> <p>Node.js 10 – <code>nodejs10.x</code> </p> </li> <li> <p>Node.js 12 – <code>nodejs12.x</code> </p> </li> </ul> <p>To create a component from a Lambda function, specify <code>lambdaFunction</code> when you call this operation.</p> </li> </ul>",
"CreateDeployment": "<p>Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.</p> <p>You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.</p> <p>Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment. This operation returns the revision number of the new deployment when you create it.</p> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html\">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>",
"DeleteComponent": "<p>Deletes a version of a component from IoT Greengrass.</p> <note> <p>This operation deletes the component's recipe and artifacts. As a result, deployments that refer to this component version will fail. If you have deployments that use this component version, you can remove the component from the deployment or update the deployment to use a valid version.</p> </note>",
"DeleteCoreDevice": "<p>Deletes a Greengrass core device, which is an IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the IoT thing. For more information about how to delete the IoT thing, see <a href=\"https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteThing.html\">DeleteThing</a> in the <i>IoT API Reference</i>.</p>",
"DescribeComponent": "<p>Retrieves metadata for a version of a component.</p>",
"GetComponent": "<p>Gets the recipe for a version of a component. Core devices can call this operation to identify the artifacts and requirements to install a component.</p>",
"GetComponentVersionArtifact": "<p>Gets the pre-signed URL to download a public component artifact. Core devices call this operation to identify the URL that they can use to download an artifact to install.</p>",
"GetCoreDevice": "<p>Retrieves metadata for a Greengrass core device.</p>",
"GetDeployment": "<p>Gets a deployment. Deployments define the components that run on Greengrass core devices.</p>",
"ListClientDevicesAssociatedWithCoreDevice": "<p>Retrieves a paginated list of client devices that are associated with a core device.</p>",
"ListComponentVersions": "<p>Retrieves a paginated list of all versions for a component. Greater versions are listed first.</p>",
"ListComponents": "<p>Retrieves a paginated list of component summaries. This list includes components that you have permission to view.</p>",
"ListCoreDevices": "<p>Retrieves a paginated list of Greengrass core devices.</p>",
"ListDeployments": "<p>Retrieves a paginated list of deployments.</p>",
"ListEffectiveDeployments": "<p>Retrieves a paginated list of deployment jobs that IoT Greengrass sends to Greengrass core devices.</p>",
"ListInstalledComponents": "<p>Retrieves a paginated list of the components that a Greengrass core device runs.</p>",
"ListTagsForResource": "<p>Retrieves the list of tags for an IoT Greengrass resource.</p>",
"ResolveComponentCandidates": "<p>Retrieves a list of components that meet the component, version, and platform requirements of a deployment. Greengrass core devices call this operation when they receive a deployment to identify the components to install.</p> <p>This operation identifies components that meet all dependency requirements for a deployment. If the requirements conflict, then this operation returns an error and the deployment fails. For example, this occurs if component <code>A</code> requires version <code>>2.0.0</code> and component <code>B</code> requires version <code><2.0.0</code> of a component dependency.</p> <p>When you specify the component candidates to resolve, IoT Greengrass compares each component's digest from the core device with the component's digest in the Amazon Web Services Cloud. If the digests don't match, then IoT Greengrass specifies to use the version from the Amazon Web Services Cloud.</p> <important> <p>To use this operation, you must use the data plane API endpoint and authenticate with an IoT device certificate. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/greengrass.html\">IoT Greengrass endpoints and quotas</a>.</p> </important>",
"TagResource": "<p>Adds tags to an IoT Greengrass resource. If a tag already exists for the resource, this operation updates the tag's value.</p>",
"UntagResource": "<p>Removes a tag from an IoT Greengrass resource.</p>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>You don't have permission to perform the action.</p>",
"refs": {
}
},
"AssociateClientDeviceWithCoreDeviceEntry": {
"base": "<p>Contains a request to associate a client device with a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html\">BatchAssociateClientDeviceWithCoreDevice</a> operation consumes a list of these requests.</p>",
"refs": {
"AssociateClientDeviceWithCoreDeviceEntryList$member": null
}
},
"AssociateClientDeviceWithCoreDeviceEntryList": {
"base": null,
"refs": {
"BatchAssociateClientDeviceWithCoreDeviceRequest$entries": "<p>The list of client devices to associate.</p>"
}
},
"AssociateClientDeviceWithCoreDeviceErrorEntry": {
"base": "<p>Contains an error that occurs from a request to associate a client device with a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchAssociateClientDeviceWithCoreDevice.html\">BatchAssociateClientDeviceWithCoreDevice</a> operation returns a list of these errors.</p>",
"refs": {
"AssociateClientDeviceWithCoreDeviceErrorList$member": null
}
},
"AssociateClientDeviceWithCoreDeviceErrorList": {
"base": null,
"refs": {
"BatchAssociateClientDeviceWithCoreDeviceResponse$errorEntries": "<p>The list of any errors for the entries in the request. Each error entry contains the name of the IoT thing that failed to associate.</p>"
}
},
"AssociatedClientDevice": {
"base": "<p>Contains information about a client device that is associated to a core device for cloud discovery.</p>",
"refs": {
"AssociatedClientDeviceList$member": null
}
},
"AssociatedClientDeviceList": {
"base": null,
"refs": {
"ListClientDevicesAssociatedWithCoreDeviceResponse$associatedClientDevices": "<p>A list that describes the client devices that are associated with the core device.</p>"
}
},
"BatchAssociateClientDeviceWithCoreDeviceRequest": {
"base": null,
"refs": {
}
},
"BatchAssociateClientDeviceWithCoreDeviceResponse": {
"base": null,
"refs": {
}
},
"BatchDisassociateClientDeviceFromCoreDeviceRequest": {
"base": null,
"refs": {
}
},
"BatchDisassociateClientDeviceFromCoreDeviceResponse": {
"base": null,
"refs": {
}
},
"CPU": {
"base": null,
"refs": {
"SystemResourceLimits$cpus": "<p>The maximum amount of CPU time that a component's processes can use on the core device. A core device's total CPU time is equivalent to the device's number of CPU cores. For example, on a core device with 4 CPU cores, you can set this value to <code>2</code> to limit the component's processes to 50 percent usage of each CPU core. On a device with 1 CPU core, you can set this value to <code>0.25</code> to limit the component's processes to 25 percent usage of the CPU. If you set this value to a number greater than the number of CPU cores, the IoT Greengrass Core software doesn't limit the component's CPU usage.</p>"
}
},
"CancelDeploymentRequest": {
"base": null,
"refs": {
}
},
"CancelDeploymentResponse": {
"base": null,
"refs": {
}
},
"ClientTokenString": {
"base": null,
"refs": {
"CreateComponentVersionRequest$clientToken": "<p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.</p>",
"CreateDeploymentRequest$clientToken": "<p>A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.</p>"
}
},
"CloudComponentState": {
"base": null,
"refs": {
"CloudComponentStatus$componentState": "<p>The state of the component.</p>"
}
},
"CloudComponentStatus": {
"base": "<p>Contains the status of a component in the IoT Greengrass service.</p>",
"refs": {
"CreateComponentVersionResponse$status": "<p>The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.</p>",
"DescribeComponentResponse$status": "<p>The status of the component version in IoT Greengrass V2. This status is different from the status of the component on a core device.</p>"
}
},
"Component": {
"base": "<p>Contains information about a component.</p>",
"refs": {
"ComponentList$member": null
}
},
"ComponentARN": {
"base": null,
"refs": {
"Component$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"ListComponentVersionsRequest$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>"
}
},
"ComponentCandidate": {
"base": "<p>Contains information about a component that is a candidate to deploy to a Greengrass core device.</p>",
"refs": {
"ComponentCandidateList$member": null
}
},
"ComponentCandidateList": {
"base": null,
"refs": {
"ResolveComponentCandidatesRequest$componentCandidates": "<p>The list of components to resolve.</p>"
}
},
"ComponentConfigurationPath": {
"base": null,
"refs": {
"ComponentConfigurationPathList$member": null
}
},
"ComponentConfigurationPathList": {
"base": null,
"refs": {
"ComponentConfigurationUpdate$reset": "<p>The list of configuration nodes to reset to default values on target devices. Use JSON pointers to specify each node to reset. JSON pointers start with a forward slash (<code>/</code>) and use forward slashes to separate the key for each level in the object. For more information, see the <a href=\"https://tools.ietf.org/html/rfc6901\">JSON pointer specification</a> and <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#reset-configuration-update\">Reset configuration updates</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"
}
},
"ComponentConfigurationString": {
"base": null,
"refs": {
"ComponentConfigurationUpdate$merge": "<p>A serialized JSON string that contains the configuration object to merge to target devices. The core device merges this configuration with the component's existing configuration. If this is the first time a component deploys on a device, the core device merges this configuration with the component's default configuration. This means that the core device keeps it's existing configuration for keys and values that you don't specify in this object. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html#merge-configuration-update\">Merge configuration updates</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"
}
},
"ComponentConfigurationUpdate": {
"base": "<p>Contains information about a deployment's update to a component's configuration on Greengrass core devices. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html\">Update component configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>",
"refs": {
"ComponentDeploymentSpecification$configurationUpdate": "<p>The configuration updates to deploy for the component. You can define <i>reset</i> updates and <i>merge</i> updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html\">Update component configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"
}
},
"ComponentDependencyMap": {
"base": null,
"refs": {
"LambdaFunctionRecipeSource$componentDependencies": "<p>The component versions on which this Lambda function component depends.</p>"
}
},
"ComponentDependencyRequirement": {
"base": "<p>Contains information about a component dependency for a Lambda function component.</p>",
"refs": {
"ComponentDependencyMap$value": null
}
},
"ComponentDependencyType": {
"base": null,
"refs": {
"ComponentDependencyRequirement$dependencyType": "<p>The type of this dependency. Choose from the following options:</p> <ul> <li> <p> <code>SOFT</code> – The component doesn't restart if the dependency changes state.</p> </li> <li> <p> <code>HARD</code> – The component restarts if the dependency changes state.</p> </li> </ul> <p>Default: <code>HARD</code> </p>"
}
},
"ComponentDeploymentSpecification": {
"base": "<p>Contains information about a component to deploy.</p>",
"refs": {
"ComponentDeploymentSpecifications$value": null
}
},
"ComponentDeploymentSpecifications": {
"base": null,
"refs": {
"CreateDeploymentRequest$components": "<p>The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.</p>",
"GetDeploymentResponse$components": "<p>The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.</p>"
}
},
"ComponentLatestVersion": {
"base": "<p>Contains information about the latest version of a component.</p>",
"refs": {
"Component$latestVersion": "<p>The latest version of the component and its details.</p>"
}
},
"ComponentList": {
"base": null,
"refs": {
"ListComponentsResponse$components": "<p>A list that summarizes each component.</p>"
}
},
"ComponentNameString": {
"base": null,
"refs": {
"Component$componentName": "<p>The name of the component.</p>",
"ComponentCandidate$componentName": "<p>The name of the component.</p>",
"ComponentVersionListItem$componentName": "<p>The name of the component.</p>",
"CreateComponentVersionResponse$componentName": "<p>The name of the component.</p>",
"DescribeComponentResponse$componentName": "<p>The name of the component.</p>",
"InstalledComponent$componentName": "<p>The name of the component.</p>",
"LambdaFunctionRecipeSource$componentName": "<p>The name of the component.</p> <p>Defaults to the name of the Lambda function.</p>",
"ResolvedComponentVersion$componentName": "<p>The name of the component.</p>"
}
},
"ComponentPlatform": {
"base": "<p>Contains information about a platform that a component supports.</p>",
"refs": {
"ComponentPlatformList$member": null,
"ResolveComponentCandidatesRequest$platform": "<p>The platform to use to resolve compatible components.</p>"
}
},
"ComponentPlatformList": {
"base": null,
"refs": {
"ComponentLatestVersion$platforms": "<p>The platforms that the component version supports.</p>",
"DescribeComponentResponse$platforms": "<p>The platforms that the component version supports.</p>",
"LambdaFunctionRecipeSource$componentPlatforms": "<p>The platforms that the component version supports.</p>"
}
},
"ComponentRunWith": {
"base": "<p>Contains information system user and group that the IoT Greengrass Core software uses to run component processes on 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 Guide</i>.</p>",
"refs": {
"ComponentDeploymentSpecification$runWith": "<p>The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group 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 Guide</i>.</p>"
}
},
"ComponentVersionARN": {
"base": null,
"refs": {
"ComponentLatestVersion$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"CreateComponentVersionResponse$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"DeleteComponentRequest$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"DescribeComponentRequest$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"DescribeComponentResponse$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"GetComponentRequest$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"GetComponentVersionArtifactRequest$arn": "<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 component version.</p>",
"ResolvedComponentVersion$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>"
}
},
"ComponentVersionList": {
"base": null,
"refs": {
"ListComponentVersionsResponse$componentVersions": "<p>A list of versions that exist for the component.</p>"
}
},
"ComponentVersionListItem": {
"base": "<p>Contains information about a component version in a list.</p>",
"refs": {
"ComponentVersionList$member": null
}
},
"ComponentVersionRequirementMap": {
"base": null,
"refs": {
"ComponentCandidate$versionRequirements": "<p>The version requirements for the component's dependencies. Greengrass core devices get the version requirements from component recipes.</p> <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href=\"https://semver.org/\">Semantic Versioning</a>.</p>"
}
},
"ComponentVersionString": {
"base": null,
"refs": {
"ComponentCandidate$componentVersion": "<p>The version of the component.</p>",
"ComponentDeploymentSpecification$componentVersion": "<p>The version of the component.</p>",
"ComponentLatestVersion$componentVersion": "<p>The version of the component.</p>",
"ComponentVersionListItem$componentVersion": "<p>The version of the component.</p>",
"CreateComponentVersionResponse$componentVersion": "<p>The version of the component.</p>",
"DescribeComponentResponse$componentVersion": "<p>The version of the component.</p>",
"InstalledComponent$componentVersion": "<p>The version of the component.</p>",
"LambdaFunctionRecipeSource$componentVersion": "<p>The version of the component.</p> <p>Defaults to the version of the Lambda function as a semantic version. For example, if your function version is <code>3</code>, the component version becomes <code>3.0.0</code>.</p>",
"ResolvedComponentVersion$componentVersion": "<p>The version of the component.</p>"
}
},
"ComponentVisibilityScope": {
"base": null,
"refs": {
"ListComponentsRequest$scope": "<p>The scope of the components to list.</p> <p>Default: <code>PRIVATE</code> </p>"
}
},
"ConflictException": {
"base": "<p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>",
"refs": {
}
},
"CoreDevice": {
"base": "<p>Contains information about a Greengrass core device, which is an IoT thing that runs the IoT Greengrass Core software.</p>",
"refs": {
"CoreDevicesList$member": null
}
},
"CoreDeviceArchitectureString": {
"base": null,
"refs": {
"GetCoreDeviceResponse$architecture": "<p>The computer architecture of the core device.</p>"
}
},
"CoreDevicePlatformString": {
"base": null,
"refs": {
"GetCoreDeviceResponse$platform": "<p>The operating system platform that the core device runs.</p>"
}
},
"CoreDeviceStatus": {
"base": null,
"refs": {
"CoreDevice$status": "<p>The status of the core device. Core devices can have the following statuses:</p> <ul> <li> <p> <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p> </li> <li> <p> <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state on the core device.</p> </li> </ul>",
"GetCoreDeviceResponse$status": "<p>The status of the core device. The core device status can be:</p> <ul> <li> <p> <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p> </li> <li> <p> <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state on the core device.</p> </li> </ul>",
"ListCoreDevicesRequest$status": "<p>The core device status by which to filter. If you specify this parameter, the list includes only core devices that have this status. Choose one of the following options:</p> <ul> <li> <p> <code>HEALTHY</code> – The IoT Greengrass Core software and all components run on the core device without issue.</p> </li> <li> <p> <code>UNHEALTHY</code> – The IoT Greengrass Core software or a component is in a failed state on the core device.</p> </li> </ul>"
}
},
"CoreDeviceThingName": {
"base": null,
"refs": {
"CoreDevice$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"DeleteCoreDeviceRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"GetCoreDeviceRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"GetCoreDeviceResponse$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"ListEffectiveDeploymentsRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"ListInstalledComponentsRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>"
}
},
"CoreDevicesList": {
"base": null,
"refs": {
"ListCoreDevicesResponse$coreDevices": "<p>A list that summarizes each core device.</p>"
}
},
"CreateComponentVersionRequest": {
"base": null,
"refs": {
}
},
"CreateComponentVersionResponse": {
"base": null,
"refs": {
}
},
"CreateDeploymentRequest": {
"base": null,
"refs": {
}
},
"CreateDeploymentResponse": {
"base": null,
"refs": {
}
},
"DefaultMaxResults": {
"base": null,
"refs": {
"ListClientDevicesAssociatedWithCoreDeviceRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>",
"ListComponentVersionsRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>",
"ListComponentsRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>",
"ListCoreDevicesRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>",
"ListDeploymentsRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>",
"ListEffectiveDeploymentsRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>",
"ListInstalledComponentsRequest$maxResults": "<p>The maximum number of results to be returned per paginated request.</p>"
}
},
"DeleteComponentRequest": {
"base": null,
"refs": {
}
},
"DeleteCoreDeviceRequest": {
"base": null,
"refs": {
}
},
"Deployment": {
"base": "<p>Contains information about a deployment.</p>",
"refs": {
"DeploymentList$member": null
}
},
"DeploymentComponentUpdatePolicy": {
"base": "<p>Contains information about a deployment's policy that defines when components are safe to update.</p> <p>Each component on a device can report whether or not it's ready to update. After a component and its dependencies are ready, they can apply the update in the deployment. You can configure whether or not the deployment notifies components of an update and waits for a response. You specify the amount of time each component has to respond to the update notification.</p>",
"refs": {
"DeploymentPolicies$componentUpdatePolicy": "<p>The component update policy for the configuration deployment. This policy defines when it's safe to deploy the configuration to devices.</p>"
}
},
"DeploymentComponentUpdatePolicyAction": {
"base": null,
"refs": {
"DeploymentComponentUpdatePolicy$action": "<p>Whether or not to notify components and wait for components to become safe to update. Choose from the following options:</p> <ul> <li> <p> <code>NOTIFY_COMPONENTS</code> – The deployment notifies each component before it stops and updates that component. Components can use the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetocomponentupdates\">SubscribeToComponentUpdates</a> IPC operation to receive these notifications. Then, components can respond with the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-defercomponentupdate\">DeferComponentUpdate</a> IPC operation. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html\">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p> </li> <li> <p> <code>SKIP_NOTIFY_COMPONENTS</code> – The deployment doesn't notify components or wait for them to be safe to update.</p> </li> </ul> <p>Default: <code>NOTIFY_COMPONENTS</code> </p>"
}
},
"DeploymentConfigurationValidationPolicy": {
"base": "<p>Contains information about how long a component on a core device can validate its configuration updates before it times out. Components can use the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-subscribetovalidateconfigurationupdates\">SubscribeToValidateConfigurationUpdates</a> IPC operation to receive notifications when a deployment specifies a configuration update. Then, components can respond with the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/interprocess-communication.html#ipc-operation-sendconfigurationvalidityreport\">SendConfigurationValidityReport</a> IPC operation. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html\">Create deployments</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>",
"refs": {
"DeploymentPolicies$configurationValidationPolicy": "<p>The configuration validation policy for the configuration deployment. This policy defines how long each component has to validate its configure updates.</p>"
}
},
"DeploymentFailureHandlingPolicy": {
"base": null,
"refs": {
"DeploymentPolicies$failureHandlingPolicy": "<p>The failure handling policy for the configuration deployment. This policy defines what to do if the deployment fails.</p> <p>Default: <code>ROLLBACK</code> </p>"
}
},
"DeploymentHistoryFilter": {
"base": null,
"refs": {
"ListDeploymentsRequest$historyFilter": "<p>The filter for the list of deployments. Choose one of the following options:</p> <ul> <li> <p> <code>ALL</code> – The list includes all deployments.</p> </li> <li> <p> <code>LATEST_ONLY</code> – The list includes only the latest revision of each deployment.</p> </li> </ul> <p>Default: <code>LATEST_ONLY</code> </p>"
}
},
"DeploymentID": {
"base": null,
"refs": {
"EffectiveDeployment$deploymentId": "<p>The ID of the deployment.</p>"
}
},
"DeploymentIoTJobConfiguration": {
"base": "<p>Contains information about an IoT job configuration.</p>",
"refs": {
"CreateDeploymentRequest$iotJobConfiguration": "<p>The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.</p>",
"GetDeploymentResponse$iotJobConfiguration": "<p>The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.</p>"
}
},
"DeploymentList": {
"base": null,
"refs": {
"ListDeploymentsResponse$deployments": "<p>A list that summarizes each deployment.</p>"
}
},
"DeploymentName": {
"base": null,
"refs": {
"EffectiveDeployment$deploymentName": "<p>The name of the deployment.</p>"
}
},
"DeploymentPolicies": {
"base": "<p>Contains information about policies that define how a deployment updates components and handles failure.</p>",
"refs": {
"CreateDeploymentRequest$deploymentPolicies": "<p>The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.</p>",
"GetDeploymentResponse$deploymentPolicies": "<p>The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.</p>"
}
},
"DeploymentStatus": {
"base": null,
"refs": {
"Deployment$deploymentStatus": "<p>The status of the deployment.</p>",
"GetDeploymentResponse$deploymentStatus": "<p>The status of the deployment.</p>"
}
},
"DescribeComponentRequest": {
"base": null,
"refs": {
}
},
"DescribeComponentResponse": {
"base": null,
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"EffectiveDeployment$description": "<p>The description of the deployment job.</p>"
}
},
"DescriptionString": {
"base": null,
"refs": {
"DescribeComponentResponse$description": "<p>The description of the component version.</p>"
}
},
"DisassociateClientDeviceFromCoreDeviceEntry": {
"base": "<p>Contains a request to disassociate a client device from a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html\">BatchDisassociateClientDeviceWithCoreDevice</a> operation consumes a list of these requests.</p>",
"refs": {
"DisassociateClientDeviceFromCoreDeviceEntryList$member": null
}
},
"DisassociateClientDeviceFromCoreDeviceEntryList": {
"base": null,
"refs": {
"BatchDisassociateClientDeviceFromCoreDeviceRequest$entries": "<p>The list of client devices to disassociate.</p>"
}
},
"DisassociateClientDeviceFromCoreDeviceErrorEntry": {
"base": "<p>Contains an error that occurs from a request to disassociate a client device from a core device. The <a href=\"https://docs.aws.amazon.com/greengrass/v2/APIReference/API_BatchDisassociateClientDeviceWithCoreDevice.html\">BatchDisassociateClientDeviceWithCoreDevice</a> operation returns a list of these errors.</p>",
"refs": {
"DisassociateClientDeviceFromCoreDeviceErrorList$member": null
}
},
"DisassociateClientDeviceFromCoreDeviceErrorList": {
"base": null,
"refs": {
"BatchDisassociateClientDeviceFromCoreDeviceResponse$errorEntries": "<p>The list of errors (if any) for the entries in the request. Each error entry contains the name of the IoT thing that failed to disassociate.</p>"
}
},
"EffectiveDeployment": {
"base": "<p>Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.</p>",
"refs": {
"EffectiveDeploymentsList$member": null
}
},
"EffectiveDeploymentExecutionStatus": {
"base": null,
"refs": {
"EffectiveDeployment$coreDeviceExecutionStatus": "<p>The status of the deployment job on the Greengrass core device.</p>"
}
},
"EffectiveDeploymentsList": {
"base": null,
"refs": {
"ListEffectiveDeploymentsResponse$effectiveDeployments": "<p>A list that summarizes each deployment on the core device.</p>"
}
},
"FileSystemPath": {
"base": null,
"refs": {
"LambdaDeviceMount$path": "<p>The mount path for the device in the file system.</p>",
"LambdaVolumeMount$sourcePath": "<p>The path to the physical volume in the file system.</p>",
"LambdaVolumeMount$destinationPath": "<p>The path to the logical volume in the file system.</p>"
}
},
"GGCVersion": {
"base": null,
"refs": {
"GetCoreDeviceResponse$coreVersion": "<p>The version of the IoT Greengrass Core software that the core device runs. This version is equivalent to the version of the Greengrass nucleus component that runs on the core device. For more information, see the <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-nucleus-component.html\">Greengrass nucleus component</a> in the <i>IoT Greengrass V2 Developer Guide</i>.</p>"
}
},
"GenericV2ARN": {
"base": null,
"refs": {
"ListTagsForResourceRequest$resourceArn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the resource.</p>",
"TagResourceRequest$resourceArn": "<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>",
"UntagResourceRequest$resourceArn": "<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>"
}
},
"GetComponentRequest": {
"base": null,
"refs": {
}
},
"GetComponentResponse": {
"base": null,
"refs": {
}
},
"GetComponentVersionArtifactRequest": {
"base": null,
"refs": {
}
},
"GetComponentVersionArtifactResponse": {
"base": null,
"refs": {
}
},
"GetCoreDeviceRequest": {
"base": null,
"refs": {
}
},
"GetCoreDeviceResponse": {
"base": null,
"refs": {
}
},
"GetDeploymentRequest": {
"base": null,
"refs": {
}
},
"GetDeploymentResponse": {
"base": null,
"refs": {
}
},
"InstalledComponent": {
"base": "<p>Contains information about a component on a Greengrass core device.</p>",
"refs": {
"InstalledComponentList$member": null
}
},
"InstalledComponentLifecycleState": {
"base": null,
"refs": {
"InstalledComponent$lifecycleState": "<p>The lifecycle state of the component.</p>"
}
},
"InstalledComponentList": {
"base": null,
"refs": {
"ListInstalledComponentsResponse$installedComponents": "<p>A list that summarizes each component on the core device.</p>"
}
},
"InternalServerException": {
"base": "<p>IoT Greengrass can't process your request right now. Try again later.</p>",
"refs": {
}
},
"IoTJobARN": {
"base": null,
"refs": {
"CreateDeploymentResponse$iotJobArn": "<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>",
"EffectiveDeployment$iotJobArn": "<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>",
"GetDeploymentResponse$iotJobArn": "<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>"
}
},
"IoTJobAbortAction": {
"base": null,
"refs": {
"IoTJobAbortCriteria$action": "<p>The action to perform when the criteria are met.</p>"
}
},
"IoTJobAbortConfig": {
"base": "<p>Contains a list of criteria that define when and how to cancel a configuration deployment.</p>",
"refs": {
"DeploymentIoTJobConfiguration$abortConfig": "<p>The stop configuration for the job. This configuration defines when and how to stop a job rollout.</p>"
}
},
"IoTJobAbortCriteria": {
"base": "<p>Contains criteria that define when and how to cancel a job.</p> <p>The deployment stops if the following conditions are true:</p> <ol> <li> <p>The number of things that receive the deployment exceeds the <code>minNumberOfExecutedThings</code>.</p> </li> <li> <p>The percentage of failures with type <code>failureType</code> exceeds the <code>thresholdPercentage</code>.</p> </li> </ol>",
"refs": {
"IoTJobAbortCriteriaList$member": null
}
},
"IoTJobAbortCriteriaList": {
"base": null,
"refs": {
"IoTJobAbortConfig$criteriaList": "<p>The list of criteria that define when and how to cancel the configuration deployment.</p>"
}
},
"IoTJobAbortThresholdPercentage": {
"base": null,
"refs": {
"IoTJobAbortCriteria$thresholdPercentage": "<p>The minimum percentage of <code>failureType</code> failures that occur before the job can cancel.</p> <p>This parameter supports up to two digits after the decimal (for example, you can specify <code>10.9</code> or <code>10.99</code>, but not <code>10.999</code>).</p>"
}
},
"IoTJobExecutionFailureType": {
"base": null,
"refs": {
"IoTJobAbortCriteria$failureType": "<p>The type of job deployment failure that can cancel a job.</p>"
}
},
"IoTJobExecutionsRolloutConfig": {
"base": "<p>Contains information about the rollout configuration for a job. This configuration defines the rate at which the job deploys a configuration to a fleet of target devices.</p>",
"refs": {
"DeploymentIoTJobConfiguration$jobExecutionsRolloutConfig": "<p>The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.</p>"
}
},
"IoTJobExponentialRolloutRate": {
"base": "<p>Contains information about an exponential rollout rate for a configuration deployment job.</p>",
"refs": {
"IoTJobExecutionsRolloutConfig$exponentialRate": "<p>The exponential rate to increase the job rollout rate.</p>"
}
},
"IoTJobId": {
"base": null,
"refs": {
"EffectiveDeployment$iotJobId": "<p>The ID of the IoT job that applies the deployment to target devices.</p>"
}
},
"IoTJobInProgressTimeoutInMinutes": {
"base": null,
"refs": {
"IoTJobTimeoutConfig$inProgressTimeoutInMinutes": "<p>The amount of time, in minutes, that devices have to complete the job. The timer starts when the job status is set to <code>IN_PROGRESS</code>. If the job status doesn't change to a terminal state before the time expires, then the job status is set to <code>TIMED_OUT</code>.</p> <p>The timeout interval must be between 1 minute and 7 days (10080 minutes).</p>"
}
},
"IoTJobMaxExecutionsPerMin": {
"base": null,
"refs": {
"IoTJobExecutionsRolloutConfig$maximumPerMinute": "<p>The maximum number of devices that receive a pending job notification, per minute.</p>"
}
},
"IoTJobMinimumNumberOfExecutedThings": {
"base": null,
"refs": {
"IoTJobAbortCriteria$minNumberOfExecutedThings": "<p>The minimum number of things that receive the configuration before the job can cancel.</p>"
}
},
"IoTJobNumberOfThings": {
"base": null,
"refs": {
"IoTJobRateIncreaseCriteria$numberOfNotifiedThings": "<p>The number of devices to receive the job notification before the rollout rate increases.</p>",
"IoTJobRateIncreaseCriteria$numberOfSucceededThings": "<p>The number of devices to successfully run the configuration job before the rollout rate increases.</p>"
}
},
"IoTJobRateIncreaseCriteria": {
"base": "<p>Contains information about criteria to meet before a job increases its rollout rate. Specify either <code>numberOfNotifiedThings</code> or <code>numberOfSucceededThings</code>.</p>",
"refs": {
"IoTJobExponentialRolloutRate$rateIncreaseCriteria": "<p>The criteria to increase the rollout rate for the job.</p>"
}
},
"IoTJobRolloutBaseRatePerMinute": {
"base": null,
"refs": {
"IoTJobExponentialRolloutRate$baseRatePerMinute": "<p>The minimum number of devices that receive a pending job notification, per minute, when the job starts. This parameter defines the initial rollout rate of the job.</p>"
}
},
"IoTJobRolloutIncrementFactor": {
"base": null,
"refs": {
"IoTJobExponentialRolloutRate$incrementFactor": "<p>The exponential factor to increase the rollout rate for the job.</p> <p>This parameter supports up to one digit after the decimal (for example, you can specify <code>1.5</code>, but not <code>1.55</code>).</p>"
}
},
"IoTJobTimeoutConfig": {
"base": "<p>Contains information about the timeout configuration for a job.</p>",
"refs": {
"DeploymentIoTJobConfiguration$timeoutConfig": "<p>The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.</p>"
}
},
"IoTThingName": {
"base": null,
"refs": {
"AssociateClientDeviceWithCoreDeviceEntry$thingName": "<p>The name of the IoT thing that represents the client device to associate.</p>",
"AssociateClientDeviceWithCoreDeviceErrorEntry$thingName": "<p>The name of the IoT thing whose associate request failed.</p>",
"AssociatedClientDevice$thingName": "<p>The name of the IoT thing that represents the associated client device.</p>",
"BatchAssociateClientDeviceWithCoreDeviceRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"BatchDisassociateClientDeviceFromCoreDeviceRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>",
"DisassociateClientDeviceFromCoreDeviceEntry$thingName": "<p>The name of the IoT thing that represents the client device to disassociate.</p>",
"DisassociateClientDeviceFromCoreDeviceErrorEntry$thingName": "<p>The name of the IoT thing whose disassociate request failed.</p>",
"ListClientDevicesAssociatedWithCoreDeviceRequest$coreDeviceThingName": "<p>The name of the core device. This is also the name of the IoT thing.</p>"
}
},
"IsLatestForTarget": {
"base": null,
"refs": {
"Deployment$isLatestForTarget": "<p>Whether or not the deployment is the latest revision for its target.</p>",
"GetDeploymentResponse$isLatestForTarget": "<p>Whether or not the deployment is the latest revision for its target.</p>"
}
},
"IsRoot": {
"base": null,
"refs": {
"InstalledComponent$isRoot": "<p>Whether or not the component is a root component.</p>"
}
},
"LambdaContainerParams": {
"base": "<p>Contains information about a container in which Lambda functions run on Greengrass core devices.</p>",
"refs": {
"LambdaLinuxProcessParams$containerParams": "<p>The parameters for the container in which the Lambda function runs.</p>"
}
},
"LambdaDeviceList": {
"base": null,
"refs": {
"LambdaContainerParams$devices": "<p>The list of system devices that the container can access.</p>"
}
},
"LambdaDeviceMount": {
"base": "<p>Contains information about a device that Linux processes in a container can access.</p>",
"refs": {
"LambdaDeviceList$member": null
}
},
"LambdaEnvironmentVariables": {
"base": null,
"refs": {
"LambdaExecutionParameters$environmentVariables": "<p>The map of environment variables that are available to the Lambda function when it runs.</p>"
}
},
"LambdaEventSource": {
"base": "<p>Contains information about an event source for an Lambda function. The event source defines the topics on which this Lambda function subscribes to receive messages that run the function.</p>",
"refs": {
"LambdaEventSourceList$member": null
}
},
"LambdaEventSourceList": {
"base": null,
"refs": {
"LambdaExecutionParameters$eventSources": "<p>The list of event sources to which to subscribe to receive work messages. The Lambda function runs when it receives a message from an event source. You can subscribe this function to local publish/subscribe messages and Amazon Web Services IoT Core MQTT messages.</p>"
}
},
"LambdaEventSourceType": {
"base": null,
"refs": {
"LambdaEventSource$type": "<p>The type of event source. Choose from the following options:</p> <ul> <li> <p> <code>PUB_SUB</code> – Subscribe to local publish/subscribe messages. This event source type doesn't support MQTT wildcards (<code>+</code> and <code>#</code>) in the event source topic.</p> </li> <li> <p> <code>IOT_CORE</code> – Subscribe to Amazon Web Services IoT Core MQTT messages. This event source type supports MQTT wildcards (<code>+</code> and <code>#</code>) in the event source topic.</p> </li> </ul>"
}
},
"LambdaExecArg": {
"base": null,
"refs": {
"LambdaExecArgsList$member": null
}
},
"LambdaExecArgsList": {
"base": null,
"refs": {
"LambdaExecutionParameters$execArgs": "<p>The list of arguments to pass to the Lambda function when it runs.</p>"
}
},
"LambdaExecutionParameters": {
"base": "<p>Contains parameters for a Lambda function that runs on IoT Greengrass.</p>",
"refs": {
"LambdaFunctionRecipeSource$componentLambdaParameters": "<p>The system and runtime parameters for the Lambda function as it runs on the Greengrass core device.</p>"
}
},
"LambdaFilesystemPermission": {
"base": null,
"refs": {
"LambdaDeviceMount$permission": "<p>The permission to access the device: read/only (<code>ro</code>) or read/write (<code>rw</code>).</p> <p>Default: <code>ro</code> </p>",
"LambdaVolumeMount$permission": "<p>The permission to access the volume: read/only (<code>ro</code>) or read/write (<code>rw</code>).</p> <p>Default: <code>ro</code> </p>"
}
},
"LambdaFunctionARNWithVersionNumber": {
"base": null,
"refs": {
"LambdaFunctionRecipeSource$lambdaArn": "<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 import. You can't use version aliases like <code>$LATEST</code>.</p>"
}
},
"LambdaFunctionRecipeSource": {
"base": "<p>Contains information about an Lambda function to import to create a component.</p>",
"refs": {
"CreateComponentVersionRequest$lambdaFunction": "<p>The parameters to create a component from a Lambda function.</p> <p>You must specify either <code>inlineRecipe</code> or <code>lambdaFunction</code>.</p>"
}
},
"LambdaInputPayloadEncodingType": {
"base": null,
"refs": {
"LambdaExecutionParameters$inputPayloadEncodingType": "<p>The encoding type that the Lambda function supports.</p> <p>Default: <code>json</code> </p>"
}
},
"LambdaIsolationMode": {
"base": null,
"refs": {
"LambdaLinuxProcessParams$isolationMode": "<p>The isolation mode for the process that contains the Lambda function. The process can run in an isolated runtime environment inside the IoT Greengrass container, or as a regular process outside any container.</p> <p>Default: <code>GreengrassContainer</code> </p>"
}
},
"LambdaLinuxProcessParams": {
"base": "<p>Contains parameters for a Linux process that contains an Lambda function.</p>",
"refs": {
"LambdaExecutionParameters$linuxProcessParams": "<p>The parameters for the Linux process that contains the Lambda function.</p>"
}
},
"LambdaVolumeList": {
"base": null,
"refs": {
"LambdaContainerParams$volumes": "<p>The list of volumes that the container can access.</p>"
}
},
"LambdaVolumeMount": {
"base": "<p>Contains information about a volume that Linux processes in a container can access. When you define a volume, the IoT Greengrass Core software mounts the source files to the destination inside the container.</p>",
"refs": {
"LambdaVolumeList$member": null
}
},
"LifecycleStateDetails": {
"base": null,
"refs": {
"InstalledComponent$lifecycleStateDetails": "<p>The details about the lifecycle state of the component.</p>"
}
},
"ListClientDevicesAssociatedWithCoreDeviceRequest": {
"base": null,
"refs": {
}
},
"ListClientDevicesAssociatedWithCoreDeviceResponse": {
"base": null,
"refs": {
}
},
"ListComponentVersionsRequest": {
"base": null,
"refs": {
}
},
"ListComponentVersionsResponse": {
"base": null,
"refs": {
}
},
"ListComponentsRequest": {
"base": null,
"refs": {
}
},
"ListComponentsResponse": {
"base": null,
"refs": {
}
},
"ListCoreDevicesRequest": {
"base": null,
"refs": {
}
},
"ListCoreDevicesResponse": {
"base": null,
"refs": {
}
},
"ListDeploymentsRequest": {
"base": null,
"refs": {
}
},
"ListDeploymentsResponse": {
"base": null,
"refs": {
}
},
"ListEffectiveDeploymentsRequest": {
"base": null,
"refs": {
}
},
"ListEffectiveDeploymentsResponse": {
"base": null,
"refs": {
}
},
"ListInstalledComponentsRequest": {
"base": null,
"refs": {
}
},
"ListInstalledComponentsResponse": {
"base": null,
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"Memory": {
"base": null,
"refs": {
"SystemResourceLimits$memory": "<p>The maximum amount of RAM, expressed in kilobytes, that a component's processes can use on the core device.</p>"
}
},
"NextTokenString": {
"base": null,
"refs": {
"ListClientDevicesAssociatedWithCoreDeviceRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListClientDevicesAssociatedWithCoreDeviceResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>",
"ListComponentVersionsRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListComponentVersionsResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>",
"ListComponentsRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListComponentsResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>",
"ListCoreDevicesRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListCoreDevicesResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>",
"ListDeploymentsRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListDeploymentsResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>",
"ListEffectiveDeploymentsRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListEffectiveDeploymentsResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>",
"ListInstalledComponentsRequest$nextToken": "<p>The token to be used for the next set of paginated results.</p>",
"ListInstalledComponentsResponse$nextToken": "<p>The token for the next set of results, or null if there are no additional results.</p>"
}
},
"NonEmptyString": {
"base": null,
"refs": {
"AssociateClientDeviceWithCoreDeviceErrorEntry$code": "<p>The error code for the request.</p>",
"AssociateClientDeviceWithCoreDeviceErrorEntry$message": "<p>A message that provides additional information about the error.</p>",
"CancelDeploymentRequest$deploymentId": "<p>The ID of the deployment.</p>",
"CancelDeploymentResponse$message": "<p>A message that communicates if the cancel was successful.</p>",
"CloudComponentStatus$message": "<p>A message that communicates details, such as errors, about the status of the component.</p>",
"ComponentDependencyMap$key": null,
"ComponentDependencyRequirement$versionRequirement": "<p>The component version requirement for the component dependency.</p> <p>IoT Greengrass V2 uses semantic version constraints. For more information, see <a href=\"https://semver.org/\">Semantic Versioning</a>.</p>",
"ComponentDeploymentSpecifications$key": null,
"ComponentLatestVersion$description": "<p>The description of the component version.</p>",
"ComponentLatestVersion$publisher": "<p>The publisher of the component version.</p>",
"ComponentPlatform$name": "<p>The friendly name of the platform. This name helps you identify the platform.</p> <p>If you omit this parameter, IoT Greengrass creates a friendly name from the <code>os</code> and <code>architecture</code> of the platform.</p>",
"ComponentRunWith$posixUser": "<p>The POSIX system user and (optional) group to use to run this component. Specify the user and group separated by a colon (<code>:</code>) in the following format: <code>user:group</code>. The group is optional. If you don't specify a group, the IoT Greengrass Core software uses the primary user for the group.</p> <p>If you omit this parameter, the IoT Greengrass Core software uses the default system user and group that you configure on the Greengrass nucleus component. 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>.</p>",
"ComponentVersionListItem$arn": "<p>The <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">ARN</a> of the component version.</p>",
"ComponentVersionRequirementMap$key": null,
"ComponentVersionRequirementMap$value": null,
"CreateDeploymentRequest$deploymentName": "<p>The name of the deployment.</p>",
"CreateDeploymentResponse$deploymentId": "<p>The ID of the deployment.</p>",
"CreateDeploymentResponse$iotJobId": "<p>The ID of the IoT job that applies the deployment to target devices.</p>",
"Deployment$revisionId": "<p>The revision number of the deployment.</p>",
"Deployment$deploymentId": "<p>The ID of the deployment.</p>",
"Deployment$deploymentName": "<p>The name of the deployment.</p>",
"DisassociateClientDeviceFromCoreDeviceErrorEntry$code": "<p>The error code for the request.</p>",
"DisassociateClientDeviceFromCoreDeviceErrorEntry$message": "<p>A message that provides additional information about the error.</p>",