@aws-sdk/client-greengrass 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.
Files changed (2) hide show
  1. package/dist-types/models/models_0.d.ts +629 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -6,18 +6,22 @@ import { GreengrassServiceException as __BaseException } from "./GreengrassServi
6
6
  */
7
7
  export interface ConnectivityInfo {
8
8
  /**
9
+ * @public
9
10
  * The endpoint for the Greengrass core. Can be an IP address or DNS.
10
11
  */
11
12
  HostAddress?: string;
12
13
  /**
14
+ * @public
13
15
  * The ID of the connectivity information.
14
16
  */
15
17
  Id?: string;
16
18
  /**
19
+ * @public
17
20
  * Metadata for this endpoint.
18
21
  */
19
22
  Metadata?: string;
20
23
  /**
24
+ * @public
21
25
  * The port of the Greengrass core. Usually 8883.
22
26
  */
23
27
  PortNumber?: number;
@@ -28,14 +32,17 @@ export interface ConnectivityInfo {
28
32
  */
29
33
  export interface Connector {
30
34
  /**
35
+ * @public
31
36
  * The ARN of the connector.
32
37
  */
33
38
  ConnectorArn: string | undefined;
34
39
  /**
40
+ * @public
35
41
  * A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.
36
42
  */
37
43
  Id: string | undefined;
38
44
  /**
45
+ * @public
39
46
  * The parameters or configuration that the connector uses.
40
47
  */
41
48
  Parameters?: Record<string, string>;
@@ -46,18 +53,22 @@ export interface Connector {
46
53
  */
47
54
  export interface Core {
48
55
  /**
56
+ * @public
49
57
  * The ARN of the certificate associated with the core.
50
58
  */
51
59
  CertificateArn: string | undefined;
52
60
  /**
61
+ * @public
53
62
  * A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
54
63
  */
55
64
  Id: string | undefined;
56
65
  /**
66
+ * @public
57
67
  * If true, the core's local shadow is automatically synced with the cloud.
58
68
  */
59
69
  SyncShadow?: boolean;
60
70
  /**
71
+ * @public
61
72
  * The ARN of the thing which is the core.
62
73
  */
63
74
  ThingArn: string | undefined;
@@ -68,34 +79,42 @@ export interface Core {
68
79
  */
69
80
  export interface DefinitionInformation {
70
81
  /**
82
+ * @public
71
83
  * The ARN of the definition.
72
84
  */
73
85
  Arn?: string;
74
86
  /**
87
+ * @public
75
88
  * The time, in milliseconds since the epoch, when the definition was created.
76
89
  */
77
90
  CreationTimestamp?: string;
78
91
  /**
92
+ * @public
79
93
  * The ID of the definition.
80
94
  */
81
95
  Id?: string;
82
96
  /**
97
+ * @public
83
98
  * The time, in milliseconds since the epoch, when the definition was last updated.
84
99
  */
85
100
  LastUpdatedTimestamp?: string;
86
101
  /**
102
+ * @public
87
103
  * The ID of the latest version associated with the definition.
88
104
  */
89
105
  LatestVersion?: string;
90
106
  /**
107
+ * @public
91
108
  * The ARN of the latest version associated with the definition.
92
109
  */
93
110
  LatestVersionArn?: string;
94
111
  /**
112
+ * @public
95
113
  * The name of the definition.
96
114
  */
97
115
  Name?: string;
98
116
  /**
117
+ * @public
99
118
  * Tag(s) attached to the resource arn.
100
119
  */
101
120
  Tags?: Record<string, string>;
@@ -106,18 +125,22 @@ export interface DefinitionInformation {
106
125
  */
107
126
  export interface Device {
108
127
  /**
128
+ * @public
109
129
  * The ARN of the certificate associated with the device.
110
130
  */
111
131
  CertificateArn: string | undefined;
112
132
  /**
133
+ * @public
113
134
  * A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
114
135
  */
115
136
  Id: string | undefined;
116
137
  /**
138
+ * @public
117
139
  * If true, the device's local shadow will be automatically synced with the cloud.
118
140
  */
119
141
  SyncShadow?: boolean;
120
142
  /**
143
+ * @public
121
144
  * The thing ARN of the device.
122
145
  */
123
146
  ThingArn: string | undefined;
@@ -152,10 +175,12 @@ export type FunctionIsolationMode = (typeof FunctionIsolationMode)[keyof typeof
152
175
  */
153
176
  export interface FunctionRunAsConfig {
154
177
  /**
178
+ * @public
155
179
  * The group ID whose permissions are used to run a Lambda function.
156
180
  */
157
181
  Gid?: number;
158
182
  /**
183
+ * @public
159
184
  * The user ID whose permissions are used to run a Lambda function.
160
185
  */
161
186
  Uid?: number;
@@ -166,10 +191,12 @@ export interface FunctionRunAsConfig {
166
191
  */
167
192
  export interface FunctionExecutionConfig {
168
193
  /**
194
+ * @public
169
195
  * Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
170
196
  */
171
197
  IsolationMode?: FunctionIsolationMode | string;
172
198
  /**
199
+ * @public
173
200
  * Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
174
201
  */
175
202
  RunAs?: FunctionRunAsConfig;
@@ -192,10 +219,12 @@ export type Permission = (typeof Permission)[keyof typeof Permission];
192
219
  */
193
220
  export interface ResourceAccessPolicy {
194
221
  /**
222
+ * @public
195
223
  * The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only).
196
224
  */
197
225
  Permission?: Permission | string;
198
226
  /**
227
+ * @public
199
228
  * The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
200
229
  */
201
230
  ResourceId: string | undefined;
@@ -206,18 +235,22 @@ export interface ResourceAccessPolicy {
206
235
  */
207
236
  export interface FunctionConfigurationEnvironment {
208
237
  /**
238
+ * @public
209
239
  * If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
210
240
  */
211
241
  AccessSysfs?: boolean;
212
242
  /**
243
+ * @public
213
244
  * Configuration related to executing the Lambda function
214
245
  */
215
246
  Execution?: FunctionExecutionConfig;
216
247
  /**
248
+ * @public
217
249
  * A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container.
218
250
  */
219
251
  ResourceAccessPolicies?: ResourceAccessPolicy[];
220
252
  /**
253
+ * @public
221
254
  * Environment variables for the Lambda function's configuration.
222
255
  */
223
256
  Variables?: Record<string, string>;
@@ -228,34 +261,42 @@ export interface FunctionConfigurationEnvironment {
228
261
  */
229
262
  export interface FunctionConfiguration {
230
263
  /**
264
+ * @public
231
265
  * The expected encoding type of the input payload for the function. The default is ''json''.
232
266
  */
233
267
  EncodingType?: EncodingType | string;
234
268
  /**
269
+ * @public
235
270
  * The environment configuration of the function.
236
271
  */
237
272
  Environment?: FunctionConfigurationEnvironment;
238
273
  /**
274
+ * @public
239
275
  * The execution arguments.
240
276
  */
241
277
  ExecArgs?: string;
242
278
  /**
279
+ * @public
243
280
  * The name of the function executable.
244
281
  */
245
282
  Executable?: string;
246
283
  /**
284
+ * @public
247
285
  * The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization.
248
286
  */
249
287
  MemorySize?: number;
250
288
  /**
289
+ * @public
251
290
  * True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
252
291
  */
253
292
  Pinned?: boolean;
254
293
  /**
294
+ * @public
255
295
  * The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
256
296
  */
257
297
  Timeout?: number;
258
298
  /**
299
+ * @public
259
300
  * The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
260
301
  */
261
302
  FunctionRuntimeOverride?: string;
@@ -266,14 +307,17 @@ export interface FunctionConfiguration {
266
307
  */
267
308
  export interface Function {
268
309
  /**
310
+ * @public
269
311
  * The ARN of the Lambda function.
270
312
  */
271
313
  FunctionArn?: string;
272
314
  /**
315
+ * @public
273
316
  * The configuration of the Lambda function.
274
317
  */
275
318
  FunctionConfiguration?: FunctionConfiguration;
276
319
  /**
320
+ * @public
277
321
  * A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
278
322
  */
279
323
  Id: string | undefined;
@@ -284,10 +328,12 @@ export interface Function {
284
328
  */
285
329
  export interface GroupCertificateAuthorityProperties {
286
330
  /**
331
+ * @public
287
332
  * The ARN of the certificate authority for the group.
288
333
  */
289
334
  GroupCertificateAuthorityArn?: string;
290
335
  /**
336
+ * @public
291
337
  * The ID of the certificate authority for the group.
292
338
  */
293
339
  GroupCertificateAuthorityId?: string;
@@ -298,30 +344,37 @@ export interface GroupCertificateAuthorityProperties {
298
344
  */
299
345
  export interface GroupInformation {
300
346
  /**
347
+ * @public
301
348
  * The ARN of the group.
302
349
  */
303
350
  Arn?: string;
304
351
  /**
352
+ * @public
305
353
  * The time, in milliseconds since the epoch, when the group was created.
306
354
  */
307
355
  CreationTimestamp?: string;
308
356
  /**
357
+ * @public
309
358
  * The ID of the group.
310
359
  */
311
360
  Id?: string;
312
361
  /**
362
+ * @public
313
363
  * The time, in milliseconds since the epoch, when the group was last updated.
314
364
  */
315
365
  LastUpdatedTimestamp?: string;
316
366
  /**
367
+ * @public
317
368
  * The ID of the latest version associated with the group.
318
369
  */
319
370
  LatestVersion?: string;
320
371
  /**
372
+ * @public
321
373
  * The ARN of the latest version associated with the group.
322
374
  */
323
375
  LatestVersionArn?: string;
324
376
  /**
377
+ * @public
325
378
  * The name of the group.
326
379
  */
327
380
  Name?: string;
@@ -371,22 +424,27 @@ export type LoggerType = (typeof LoggerType)[keyof typeof LoggerType];
371
424
  */
372
425
  export interface Logger {
373
426
  /**
427
+ * @public
374
428
  * The component that will be subject to logging.
375
429
  */
376
430
  Component: LoggerComponent | string | undefined;
377
431
  /**
432
+ * @public
378
433
  * A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
379
434
  */
380
435
  Id: string | undefined;
381
436
  /**
437
+ * @public
382
438
  * The level of the logs.
383
439
  */
384
440
  Level: LoggerLevel | string | undefined;
385
441
  /**
442
+ * @public
386
443
  * The amount of file space, in KB, to use if the local file system is used for logging purposes.
387
444
  */
388
445
  Space?: number;
389
446
  /**
447
+ * @public
390
448
  * The type of log output which will be used.
391
449
  */
392
450
  Type: LoggerType | string | undefined;
@@ -397,10 +455,12 @@ export interface Logger {
397
455
  */
398
456
  export interface GroupOwnerSetting {
399
457
  /**
458
+ * @public
400
459
  * If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.
401
460
  */
402
461
  AutoAddGroupOwner?: boolean;
403
462
  /**
463
+ * @public
404
464
  * The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.
405
465
  */
406
466
  GroupOwner?: string;
@@ -411,10 +471,12 @@ export interface GroupOwnerSetting {
411
471
  */
412
472
  export interface LocalDeviceResourceData {
413
473
  /**
474
+ * @public
414
475
  * Group/owner related settings for local resources.
415
476
  */
416
477
  GroupOwnerSetting?: GroupOwnerSetting;
417
478
  /**
479
+ * @public
418
480
  * The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.
419
481
  */
420
482
  SourcePath?: string;
@@ -425,14 +487,17 @@ export interface LocalDeviceResourceData {
425
487
  */
426
488
  export interface LocalVolumeResourceData {
427
489
  /**
490
+ * @public
428
491
  * The absolute local path of the resource inside the Lambda environment.
429
492
  */
430
493
  DestinationPath?: string;
431
494
  /**
495
+ * @public
432
496
  * Allows you to configure additional group privileges for the Lambda process. This field is optional.
433
497
  */
434
498
  GroupOwnerSetting?: GroupOwnerSetting;
435
499
  /**
500
+ * @public
436
501
  * The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''.
437
502
  */
438
503
  SourcePath?: string;
@@ -443,10 +508,12 @@ export interface LocalVolumeResourceData {
443
508
  */
444
509
  export interface ResourceDownloadOwnerSetting {
445
510
  /**
511
+ * @public
446
512
  * The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The group's permissions are added to the Lambda process.
447
513
  */
448
514
  GroupOwner: string | undefined;
449
515
  /**
516
+ * @public
450
517
  * The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro'' (read-only).
451
518
  */
452
519
  GroupPermission: Permission | string | undefined;
@@ -457,14 +524,17 @@ export interface ResourceDownloadOwnerSetting {
457
524
  */
458
525
  export interface S3MachineLearningModelResourceData {
459
526
  /**
527
+ * @public
460
528
  * The absolute local path of the resource inside the Lambda environment.
461
529
  */
462
530
  DestinationPath?: string;
463
531
  /**
532
+ * @public
464
533
  * The owner setting for downloaded machine learning resources.
465
534
  */
466
535
  OwnerSetting?: ResourceDownloadOwnerSetting;
467
536
  /**
537
+ * @public
468
538
  * The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
469
539
  */
470
540
  S3Uri?: string;
@@ -475,14 +545,17 @@ export interface S3MachineLearningModelResourceData {
475
545
  */
476
546
  export interface SageMakerMachineLearningModelResourceData {
477
547
  /**
548
+ * @public
478
549
  * The absolute local path of the resource inside the Lambda environment.
479
550
  */
480
551
  DestinationPath?: string;
481
552
  /**
553
+ * @public
482
554
  * The owner setting for downloaded machine learning resources.
483
555
  */
484
556
  OwnerSetting?: ResourceDownloadOwnerSetting;
485
557
  /**
558
+ * @public
486
559
  * The ARN of the Amazon SageMaker training job that represents the source model.
487
560
  */
488
561
  SageMakerJobArn?: string;
@@ -493,10 +566,12 @@ export interface SageMakerMachineLearningModelResourceData {
493
566
  */
494
567
  export interface SecretsManagerSecretResourceData {
495
568
  /**
569
+ * @public
496
570
  * The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default.
497
571
  */
498
572
  ARN?: string;
499
573
  /**
574
+ * @public
500
575
  * Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.
501
576
  */
502
577
  AdditionalStagingLabelsToDownload?: string[];
@@ -507,22 +582,27 @@ export interface SecretsManagerSecretResourceData {
507
582
  */
508
583
  export interface ResourceDataContainer {
509
584
  /**
585
+ * @public
510
586
  * Attributes that define the local device resource.
511
587
  */
512
588
  LocalDeviceResourceData?: LocalDeviceResourceData;
513
589
  /**
590
+ * @public
514
591
  * Attributes that define the local volume resource.
515
592
  */
516
593
  LocalVolumeResourceData?: LocalVolumeResourceData;
517
594
  /**
595
+ * @public
518
596
  * Attributes that define an Amazon S3 machine learning resource.
519
597
  */
520
598
  S3MachineLearningModelResourceData?: S3MachineLearningModelResourceData;
521
599
  /**
600
+ * @public
522
601
  * Attributes that define an Amazon SageMaker machine learning resource.
523
602
  */
524
603
  SageMakerMachineLearningModelResourceData?: SageMakerMachineLearningModelResourceData;
525
604
  /**
605
+ * @public
526
606
  * Attributes that define a secret resource, which references a secret from AWS Secrets Manager.
527
607
  */
528
608
  SecretsManagerSecretResourceData?: SecretsManagerSecretResourceData;
@@ -533,14 +613,17 @@ export interface ResourceDataContainer {
533
613
  */
534
614
  export interface Resource {
535
615
  /**
616
+ * @public
536
617
  * The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
537
618
  */
538
619
  Id: string | undefined;
539
620
  /**
621
+ * @public
540
622
  * The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.
541
623
  */
542
624
  Name: string | undefined;
543
625
  /**
626
+ * @public
544
627
  * A container of data for all resource types.
545
628
  */
546
629
  ResourceDataContainer: ResourceDataContainer | undefined;
@@ -551,18 +634,22 @@ export interface Resource {
551
634
  */
552
635
  export interface Subscription {
553
636
  /**
637
+ * @public
554
638
  * A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.
555
639
  */
556
640
  Id: string | undefined;
557
641
  /**
642
+ * @public
558
643
  * The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
559
644
  */
560
645
  Source: string | undefined;
561
646
  /**
647
+ * @public
562
648
  * The MQTT topic used to route the message.
563
649
  */
564
650
  Subject: string | undefined;
565
651
  /**
652
+ * @public
566
653
  * Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.
567
654
  */
568
655
  Target: string | undefined;
@@ -573,18 +660,22 @@ export interface Subscription {
573
660
  */
574
661
  export interface VersionInformation {
575
662
  /**
663
+ * @public
576
664
  * The ARN of the version.
577
665
  */
578
666
  Arn?: string;
579
667
  /**
668
+ * @public
580
669
  * The time, in milliseconds since the epoch, when the version was created.
581
670
  */
582
671
  CreationTimestamp?: string;
583
672
  /**
673
+ * @public
584
674
  * The ID of the parent definition that the version is associated with.
585
675
  */
586
676
  Id?: string;
587
677
  /**
678
+ * @public
588
679
  * The ID of the version.
589
680
  */
590
681
  Version?: string;
@@ -594,10 +685,12 @@ export interface VersionInformation {
594
685
  */
595
686
  export interface AssociateRoleToGroupRequest {
596
687
  /**
688
+ * @public
597
689
  * The ID of the Greengrass group.
598
690
  */
599
691
  GroupId: string | undefined;
600
692
  /**
693
+ * @public
601
694
  * The ARN of the role you wish to associate with this group. The existence of the role is not validated.
602
695
  */
603
696
  RoleArn: string | undefined;
@@ -607,6 +700,7 @@ export interface AssociateRoleToGroupRequest {
607
700
  */
608
701
  export interface AssociateRoleToGroupResponse {
609
702
  /**
703
+ * @public
610
704
  * The time, in milliseconds since the epoch, when the role ARN was associated with the group.
611
705
  */
612
706
  AssociatedAt?: string;
@@ -617,10 +711,12 @@ export interface AssociateRoleToGroupResponse {
617
711
  */
618
712
  export interface ErrorDetail {
619
713
  /**
714
+ * @public
620
715
  * A detailed error code.
621
716
  */
622
717
  DetailedErrorCode?: string;
623
718
  /**
719
+ * @public
624
720
  * A detailed error message.
625
721
  */
626
722
  DetailedErrorMessage?: string;
@@ -633,10 +729,12 @@ export declare class BadRequestException extends __BaseException {
633
729
  readonly name: "BadRequestException";
634
730
  readonly $fault: "client";
635
731
  /**
732
+ * @public
636
733
  * Details about the error.
637
734
  */
638
735
  ErrorDetails?: ErrorDetail[];
639
736
  /**
737
+ * @public
640
738
  * A message containing information about the error.
641
739
  */
642
740
  Message?: string;
@@ -653,10 +751,12 @@ export declare class InternalServerErrorException extends __BaseException {
653
751
  readonly name: "InternalServerErrorException";
654
752
  readonly $fault: "server";
655
753
  /**
754
+ * @public
656
755
  * Details about the error.
657
756
  */
658
757
  ErrorDetails?: ErrorDetail[];
659
758
  /**
759
+ * @public
660
760
  * A message containing information about the error.
661
761
  */
662
762
  Message?: string;
@@ -670,6 +770,7 @@ export declare class InternalServerErrorException extends __BaseException {
670
770
  */
671
771
  export interface AssociateServiceRoleToAccountRequest {
672
772
  /**
773
+ * @public
673
774
  * The ARN of the service role you wish to associate with your account.
674
775
  */
675
776
  RoleArn: string | undefined;
@@ -679,6 +780,7 @@ export interface AssociateServiceRoleToAccountRequest {
679
780
  */
680
781
  export interface AssociateServiceRoleToAccountResponse {
681
782
  /**
783
+ * @public
682
784
  * The time when the service role was associated with the account.
683
785
  */
684
786
  AssociatedAt?: string;
@@ -689,14 +791,17 @@ export interface AssociateServiceRoleToAccountResponse {
689
791
  */
690
792
  export interface BulkDeployment {
691
793
  /**
794
+ * @public
692
795
  * The ARN of the bulk deployment.
693
796
  */
694
797
  BulkDeploymentArn?: string;
695
798
  /**
799
+ * @public
696
800
  * The ID of the bulk deployment.
697
801
  */
698
802
  BulkDeploymentId?: string;
699
803
  /**
804
+ * @public
700
805
  * The time, in ISO format, when the deployment was created.
701
806
  */
702
807
  CreatedAt?: string;
@@ -707,14 +812,17 @@ export interface BulkDeployment {
707
812
  */
708
813
  export interface BulkDeploymentMetrics {
709
814
  /**
815
+ * @public
710
816
  * The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version.
711
817
  */
712
818
  InvalidInputRecords?: number;
713
819
  /**
820
+ * @public
714
821
  * The total number of group records from the input file that have been processed so far, or attempted.
715
822
  */
716
823
  RecordsProcessed?: number;
717
824
  /**
825
+ * @public
718
826
  * The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times.
719
827
  */
720
828
  RetryAttempts?: number;
@@ -739,34 +847,42 @@ export type DeploymentType = (typeof DeploymentType)[keyof typeof DeploymentType
739
847
  */
740
848
  export interface BulkDeploymentResult {
741
849
  /**
850
+ * @public
742
851
  * The time, in ISO format, when the deployment was created.
743
852
  */
744
853
  CreatedAt?: string;
745
854
  /**
855
+ * @public
746
856
  * The ARN of the group deployment.
747
857
  */
748
858
  DeploymentArn?: string;
749
859
  /**
860
+ * @public
750
861
  * The ID of the group deployment.
751
862
  */
752
863
  DeploymentId?: string;
753
864
  /**
865
+ * @public
754
866
  * The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
755
867
  */
756
868
  DeploymentStatus?: string;
757
869
  /**
870
+ * @public
758
871
  * The type of the deployment.
759
872
  */
760
873
  DeploymentType?: DeploymentType | string;
761
874
  /**
875
+ * @public
762
876
  * Details about the error.
763
877
  */
764
878
  ErrorDetails?: ErrorDetail[];
765
879
  /**
880
+ * @public
766
881
  * The error message for a failed deployment
767
882
  */
768
883
  ErrorMessage?: string;
769
884
  /**
885
+ * @public
770
886
  * The ARN of the Greengrass group.
771
887
  */
772
888
  GroupArn?: string;
@@ -805,6 +921,7 @@ export type ConfigurationSyncStatus = (typeof ConfigurationSyncStatus)[keyof typ
805
921
  */
806
922
  export interface ConnectorDefinitionVersion {
807
923
  /**
924
+ * @public
808
925
  * A list of references to connectors in this version, with their corresponding configuration settings.
809
926
  */
810
927
  Connectors?: Connector[];
@@ -815,6 +932,7 @@ export interface ConnectorDefinitionVersion {
815
932
  */
816
933
  export interface CoreDefinitionVersion {
817
934
  /**
935
+ * @public
818
936
  * A list of cores in the core definition version.
819
937
  */
820
938
  Cores?: Core[];
@@ -824,18 +942,22 @@ export interface CoreDefinitionVersion {
824
942
  */
825
943
  export interface CreateConnectorDefinitionRequest {
826
944
  /**
945
+ * @public
827
946
  * A client token used to correlate requests and responses.
828
947
  */
829
948
  AmznClientToken?: string;
830
949
  /**
950
+ * @public
831
951
  * Information about the initial version of the connector definition.
832
952
  */
833
953
  InitialVersion?: ConnectorDefinitionVersion;
834
954
  /**
955
+ * @public
835
956
  * The name of the connector definition.
836
957
  */
837
958
  Name?: string;
838
959
  /**
960
+ * @public
839
961
  * Tag(s) to add to the new resource.
840
962
  */
841
963
  tags?: Record<string, string>;
@@ -845,30 +967,37 @@ export interface CreateConnectorDefinitionRequest {
845
967
  */
846
968
  export interface CreateConnectorDefinitionResponse {
847
969
  /**
970
+ * @public
848
971
  * The ARN of the definition.
849
972
  */
850
973
  Arn?: string;
851
974
  /**
975
+ * @public
852
976
  * The time, in milliseconds since the epoch, when the definition was created.
853
977
  */
854
978
  CreationTimestamp?: string;
855
979
  /**
980
+ * @public
856
981
  * The ID of the definition.
857
982
  */
858
983
  Id?: string;
859
984
  /**
985
+ * @public
860
986
  * The time, in milliseconds since the epoch, when the definition was last updated.
861
987
  */
862
988
  LastUpdatedTimestamp?: string;
863
989
  /**
990
+ * @public
864
991
  * The ID of the latest version associated with the definition.
865
992
  */
866
993
  LatestVersion?: string;
867
994
  /**
995
+ * @public
868
996
  * The ARN of the latest version associated with the definition.
869
997
  */
870
998
  LatestVersionArn?: string;
871
999
  /**
1000
+ * @public
872
1001
  * The name of the definition.
873
1002
  */
874
1003
  Name?: string;
@@ -878,14 +1007,17 @@ export interface CreateConnectorDefinitionResponse {
878
1007
  */
879
1008
  export interface CreateConnectorDefinitionVersionRequest {
880
1009
  /**
1010
+ * @public
881
1011
  * A client token used to correlate requests and responses.
882
1012
  */
883
1013
  AmznClientToken?: string;
884
1014
  /**
1015
+ * @public
885
1016
  * The ID of the connector definition.
886
1017
  */
887
1018
  ConnectorDefinitionId: string | undefined;
888
1019
  /**
1020
+ * @public
889
1021
  * A list of references to connectors in this version, with their corresponding configuration settings.
890
1022
  */
891
1023
  Connectors?: Connector[];
@@ -895,18 +1027,22 @@ export interface CreateConnectorDefinitionVersionRequest {
895
1027
  */
896
1028
  export interface CreateConnectorDefinitionVersionResponse {
897
1029
  /**
1030
+ * @public
898
1031
  * The ARN of the version.
899
1032
  */
900
1033
  Arn?: string;
901
1034
  /**
1035
+ * @public
902
1036
  * The time, in milliseconds since the epoch, when the version was created.
903
1037
  */
904
1038
  CreationTimestamp?: string;
905
1039
  /**
1040
+ * @public
906
1041
  * The ID of the parent definition that the version is associated with.
907
1042
  */
908
1043
  Id?: string;
909
1044
  /**
1045
+ * @public
910
1046
  * The ID of the version.
911
1047
  */
912
1048
  Version?: string;
@@ -917,18 +1053,22 @@ export interface CreateConnectorDefinitionVersionResponse {
917
1053
  */
918
1054
  export interface CreateCoreDefinitionRequest {
919
1055
  /**
1056
+ * @public
920
1057
  * A client token used to correlate requests and responses.
921
1058
  */
922
1059
  AmznClientToken?: string;
923
1060
  /**
1061
+ * @public
924
1062
  * Information about the initial version of the core definition.
925
1063
  */
926
1064
  InitialVersion?: CoreDefinitionVersion;
927
1065
  /**
1066
+ * @public
928
1067
  * The name of the core definition.
929
1068
  */
930
1069
  Name?: string;
931
1070
  /**
1071
+ * @public
932
1072
  * Tag(s) to add to the new resource.
933
1073
  */
934
1074
  tags?: Record<string, string>;
@@ -938,30 +1078,37 @@ export interface CreateCoreDefinitionRequest {
938
1078
  */
939
1079
  export interface CreateCoreDefinitionResponse {
940
1080
  /**
1081
+ * @public
941
1082
  * The ARN of the definition.
942
1083
  */
943
1084
  Arn?: string;
944
1085
  /**
1086
+ * @public
945
1087
  * The time, in milliseconds since the epoch, when the definition was created.
946
1088
  */
947
1089
  CreationTimestamp?: string;
948
1090
  /**
1091
+ * @public
949
1092
  * The ID of the definition.
950
1093
  */
951
1094
  Id?: string;
952
1095
  /**
1096
+ * @public
953
1097
  * The time, in milliseconds since the epoch, when the definition was last updated.
954
1098
  */
955
1099
  LastUpdatedTimestamp?: string;
956
1100
  /**
1101
+ * @public
957
1102
  * The ID of the latest version associated with the definition.
958
1103
  */
959
1104
  LatestVersion?: string;
960
1105
  /**
1106
+ * @public
961
1107
  * The ARN of the latest version associated with the definition.
962
1108
  */
963
1109
  LatestVersionArn?: string;
964
1110
  /**
1111
+ * @public
965
1112
  * The name of the definition.
966
1113
  */
967
1114
  Name?: string;
@@ -971,14 +1118,17 @@ export interface CreateCoreDefinitionResponse {
971
1118
  */
972
1119
  export interface CreateCoreDefinitionVersionRequest {
973
1120
  /**
1121
+ * @public
974
1122
  * A client token used to correlate requests and responses.
975
1123
  */
976
1124
  AmznClientToken?: string;
977
1125
  /**
1126
+ * @public
978
1127
  * The ID of the core definition.
979
1128
  */
980
1129
  CoreDefinitionId: string | undefined;
981
1130
  /**
1131
+ * @public
982
1132
  * A list of cores in the core definition version.
983
1133
  */
984
1134
  Cores?: Core[];
@@ -988,18 +1138,22 @@ export interface CreateCoreDefinitionVersionRequest {
988
1138
  */
989
1139
  export interface CreateCoreDefinitionVersionResponse {
990
1140
  /**
1141
+ * @public
991
1142
  * The ARN of the version.
992
1143
  */
993
1144
  Arn?: string;
994
1145
  /**
1146
+ * @public
995
1147
  * The time, in milliseconds since the epoch, when the version was created.
996
1148
  */
997
1149
  CreationTimestamp?: string;
998
1150
  /**
1151
+ * @public
999
1152
  * The ID of the parent definition that the version is associated with.
1000
1153
  */
1001
1154
  Id?: string;
1002
1155
  /**
1156
+ * @public
1003
1157
  * The ID of the version.
1004
1158
  */
1005
1159
  Version?: string;
@@ -1009,22 +1163,27 @@ export interface CreateCoreDefinitionVersionResponse {
1009
1163
  */
1010
1164
  export interface CreateDeploymentRequest {
1011
1165
  /**
1166
+ * @public
1012
1167
  * A client token used to correlate requests and responses.
1013
1168
  */
1014
1169
  AmznClientToken?: string;
1015
1170
  /**
1171
+ * @public
1016
1172
  * The ID of the deployment if you wish to redeploy a previous deployment.
1017
1173
  */
1018
1174
  DeploymentId?: string;
1019
1175
  /**
1176
+ * @public
1020
1177
  * The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.
1021
1178
  */
1022
1179
  DeploymentType: DeploymentType | string | undefined;
1023
1180
  /**
1181
+ * @public
1024
1182
  * The ID of the Greengrass group.
1025
1183
  */
1026
1184
  GroupId: string | undefined;
1027
1185
  /**
1186
+ * @public
1028
1187
  * The ID of the group version to be deployed.
1029
1188
  */
1030
1189
  GroupVersionId?: string;
@@ -1034,10 +1193,12 @@ export interface CreateDeploymentRequest {
1034
1193
  */
1035
1194
  export interface CreateDeploymentResponse {
1036
1195
  /**
1196
+ * @public
1037
1197
  * The ARN of the deployment.
1038
1198
  */
1039
1199
  DeploymentArn?: string;
1040
1200
  /**
1201
+ * @public
1041
1202
  * The ID of the deployment.
1042
1203
  */
1043
1204
  DeploymentId?: string;
@@ -1048,6 +1209,7 @@ export interface CreateDeploymentResponse {
1048
1209
  */
1049
1210
  export interface DeviceDefinitionVersion {
1050
1211
  /**
1212
+ * @public
1051
1213
  * A list of devices in the definition version.
1052
1214
  */
1053
1215
  Devices?: Device[];
@@ -1057,18 +1219,22 @@ export interface DeviceDefinitionVersion {
1057
1219
  */
1058
1220
  export interface CreateDeviceDefinitionRequest {
1059
1221
  /**
1222
+ * @public
1060
1223
  * A client token used to correlate requests and responses.
1061
1224
  */
1062
1225
  AmznClientToken?: string;
1063
1226
  /**
1227
+ * @public
1064
1228
  * Information about the initial version of the device definition.
1065
1229
  */
1066
1230
  InitialVersion?: DeviceDefinitionVersion;
1067
1231
  /**
1232
+ * @public
1068
1233
  * The name of the device definition.
1069
1234
  */
1070
1235
  Name?: string;
1071
1236
  /**
1237
+ * @public
1072
1238
  * Tag(s) to add to the new resource.
1073
1239
  */
1074
1240
  tags?: Record<string, string>;
@@ -1078,30 +1244,37 @@ export interface CreateDeviceDefinitionRequest {
1078
1244
  */
1079
1245
  export interface CreateDeviceDefinitionResponse {
1080
1246
  /**
1247
+ * @public
1081
1248
  * The ARN of the definition.
1082
1249
  */
1083
1250
  Arn?: string;
1084
1251
  /**
1252
+ * @public
1085
1253
  * The time, in milliseconds since the epoch, when the definition was created.
1086
1254
  */
1087
1255
  CreationTimestamp?: string;
1088
1256
  /**
1257
+ * @public
1089
1258
  * The ID of the definition.
1090
1259
  */
1091
1260
  Id?: string;
1092
1261
  /**
1262
+ * @public
1093
1263
  * The time, in milliseconds since the epoch, when the definition was last updated.
1094
1264
  */
1095
1265
  LastUpdatedTimestamp?: string;
1096
1266
  /**
1267
+ * @public
1097
1268
  * The ID of the latest version associated with the definition.
1098
1269
  */
1099
1270
  LatestVersion?: string;
1100
1271
  /**
1272
+ * @public
1101
1273
  * The ARN of the latest version associated with the definition.
1102
1274
  */
1103
1275
  LatestVersionArn?: string;
1104
1276
  /**
1277
+ * @public
1105
1278
  * The name of the definition.
1106
1279
  */
1107
1280
  Name?: string;
@@ -1111,14 +1284,17 @@ export interface CreateDeviceDefinitionResponse {
1111
1284
  */
1112
1285
  export interface CreateDeviceDefinitionVersionRequest {
1113
1286
  /**
1287
+ * @public
1114
1288
  * A client token used to correlate requests and responses.
1115
1289
  */
1116
1290
  AmznClientToken?: string;
1117
1291
  /**
1292
+ * @public
1118
1293
  * The ID of the device definition.
1119
1294
  */
1120
1295
  DeviceDefinitionId: string | undefined;
1121
1296
  /**
1297
+ * @public
1122
1298
  * A list of devices in the definition version.
1123
1299
  */
1124
1300
  Devices?: Device[];
@@ -1128,18 +1304,22 @@ export interface CreateDeviceDefinitionVersionRequest {
1128
1304
  */
1129
1305
  export interface CreateDeviceDefinitionVersionResponse {
1130
1306
  /**
1307
+ * @public
1131
1308
  * The ARN of the version.
1132
1309
  */
1133
1310
  Arn?: string;
1134
1311
  /**
1312
+ * @public
1135
1313
  * The time, in milliseconds since the epoch, when the version was created.
1136
1314
  */
1137
1315
  CreationTimestamp?: string;
1138
1316
  /**
1317
+ * @public
1139
1318
  * The ID of the parent definition that the version is associated with.
1140
1319
  */
1141
1320
  Id?: string;
1142
1321
  /**
1322
+ * @public
1143
1323
  * The ID of the version.
1144
1324
  */
1145
1325
  Version?: string;
@@ -1150,10 +1330,12 @@ export interface CreateDeviceDefinitionVersionResponse {
1150
1330
  */
1151
1331
  export interface FunctionDefaultExecutionConfig {
1152
1332
  /**
1333
+ * @public
1153
1334
  * Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
1154
1335
  */
1155
1336
  IsolationMode?: FunctionIsolationMode | string;
1156
1337
  /**
1338
+ * @public
1157
1339
  * Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''.
1158
1340
  */
1159
1341
  RunAs?: FunctionRunAsConfig;
@@ -1164,6 +1346,7 @@ export interface FunctionDefaultExecutionConfig {
1164
1346
  */
1165
1347
  export interface FunctionDefaultConfig {
1166
1348
  /**
1349
+ * @public
1167
1350
  * Configuration information that specifies how a Lambda function runs.
1168
1351
  */
1169
1352
  Execution?: FunctionDefaultExecutionConfig;
@@ -1174,10 +1357,12 @@ export interface FunctionDefaultConfig {
1174
1357
  */
1175
1358
  export interface FunctionDefinitionVersion {
1176
1359
  /**
1360
+ * @public
1177
1361
  * The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.
1178
1362
  */
1179
1363
  DefaultConfig?: FunctionDefaultConfig;
1180
1364
  /**
1365
+ * @public
1181
1366
  * A list of Lambda functions in this function definition version.
1182
1367
  */
1183
1368
  Functions?: Function[];
@@ -1187,18 +1372,22 @@ export interface FunctionDefinitionVersion {
1187
1372
  */
1188
1373
  export interface CreateFunctionDefinitionRequest {
1189
1374
  /**
1375
+ * @public
1190
1376
  * A client token used to correlate requests and responses.
1191
1377
  */
1192
1378
  AmznClientToken?: string;
1193
1379
  /**
1380
+ * @public
1194
1381
  * Information about the initial version of the function definition.
1195
1382
  */
1196
1383
  InitialVersion?: FunctionDefinitionVersion;
1197
1384
  /**
1385
+ * @public
1198
1386
  * The name of the function definition.
1199
1387
  */
1200
1388
  Name?: string;
1201
1389
  /**
1390
+ * @public
1202
1391
  * Tag(s) to add to the new resource.
1203
1392
  */
1204
1393
  tags?: Record<string, string>;
@@ -1208,30 +1397,37 @@ export interface CreateFunctionDefinitionRequest {
1208
1397
  */
1209
1398
  export interface CreateFunctionDefinitionResponse {
1210
1399
  /**
1400
+ * @public
1211
1401
  * The ARN of the definition.
1212
1402
  */
1213
1403
  Arn?: string;
1214
1404
  /**
1405
+ * @public
1215
1406
  * The time, in milliseconds since the epoch, when the definition was created.
1216
1407
  */
1217
1408
  CreationTimestamp?: string;
1218
1409
  /**
1410
+ * @public
1219
1411
  * The ID of the definition.
1220
1412
  */
1221
1413
  Id?: string;
1222
1414
  /**
1415
+ * @public
1223
1416
  * The time, in milliseconds since the epoch, when the definition was last updated.
1224
1417
  */
1225
1418
  LastUpdatedTimestamp?: string;
1226
1419
  /**
1420
+ * @public
1227
1421
  * The ID of the latest version associated with the definition.
1228
1422
  */
1229
1423
  LatestVersion?: string;
1230
1424
  /**
1425
+ * @public
1231
1426
  * The ARN of the latest version associated with the definition.
1232
1427
  */
1233
1428
  LatestVersionArn?: string;
1234
1429
  /**
1430
+ * @public
1235
1431
  * The name of the definition.
1236
1432
  */
1237
1433
  Name?: string;
@@ -1242,18 +1438,22 @@ export interface CreateFunctionDefinitionResponse {
1242
1438
  */
1243
1439
  export interface CreateFunctionDefinitionVersionRequest {
1244
1440
  /**
1441
+ * @public
1245
1442
  * A client token used to correlate requests and responses.
1246
1443
  */
1247
1444
  AmznClientToken?: string;
1248
1445
  /**
1446
+ * @public
1249
1447
  * The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings.
1250
1448
  */
1251
1449
  DefaultConfig?: FunctionDefaultConfig;
1252
1450
  /**
1451
+ * @public
1253
1452
  * The ID of the Lambda function definition.
1254
1453
  */
1255
1454
  FunctionDefinitionId: string | undefined;
1256
1455
  /**
1456
+ * @public
1257
1457
  * A list of Lambda functions in this function definition version.
1258
1458
  */
1259
1459
  Functions?: Function[];
@@ -1263,18 +1463,22 @@ export interface CreateFunctionDefinitionVersionRequest {
1263
1463
  */
1264
1464
  export interface CreateFunctionDefinitionVersionResponse {
1265
1465
  /**
1466
+ * @public
1266
1467
  * The ARN of the version.
1267
1468
  */
1268
1469
  Arn?: string;
1269
1470
  /**
1471
+ * @public
1270
1472
  * The time, in milliseconds since the epoch, when the version was created.
1271
1473
  */
1272
1474
  CreationTimestamp?: string;
1273
1475
  /**
1476
+ * @public
1274
1477
  * The ID of the parent definition that the version is associated with.
1275
1478
  */
1276
1479
  Id?: string;
1277
1480
  /**
1481
+ * @public
1278
1482
  * The ID of the version.
1279
1483
  */
1280
1484
  Version?: string;
@@ -1285,30 +1489,37 @@ export interface CreateFunctionDefinitionVersionResponse {
1285
1489
  */
1286
1490
  export interface GroupVersion {
1287
1491
  /**
1492
+ * @public
1288
1493
  * The ARN of the connector definition version for this group.
1289
1494
  */
1290
1495
  ConnectorDefinitionVersionArn?: string;
1291
1496
  /**
1497
+ * @public
1292
1498
  * The ARN of the core definition version for this group.
1293
1499
  */
1294
1500
  CoreDefinitionVersionArn?: string;
1295
1501
  /**
1502
+ * @public
1296
1503
  * The ARN of the device definition version for this group.
1297
1504
  */
1298
1505
  DeviceDefinitionVersionArn?: string;
1299
1506
  /**
1507
+ * @public
1300
1508
  * The ARN of the function definition version for this group.
1301
1509
  */
1302
1510
  FunctionDefinitionVersionArn?: string;
1303
1511
  /**
1512
+ * @public
1304
1513
  * The ARN of the logger definition version for this group.
1305
1514
  */
1306
1515
  LoggerDefinitionVersionArn?: string;
1307
1516
  /**
1517
+ * @public
1308
1518
  * The ARN of the resource definition version for this group.
1309
1519
  */
1310
1520
  ResourceDefinitionVersionArn?: string;
1311
1521
  /**
1522
+ * @public
1312
1523
  * The ARN of the subscription definition version for this group.
1313
1524
  */
1314
1525
  SubscriptionDefinitionVersionArn?: string;
@@ -1318,18 +1529,22 @@ export interface GroupVersion {
1318
1529
  */
1319
1530
  export interface CreateGroupRequest {
1320
1531
  /**
1532
+ * @public
1321
1533
  * A client token used to correlate requests and responses.
1322
1534
  */
1323
1535
  AmznClientToken?: string;
1324
1536
  /**
1537
+ * @public
1325
1538
  * Information about the initial version of the group.
1326
1539
  */
1327
1540
  InitialVersion?: GroupVersion;
1328
1541
  /**
1542
+ * @public
1329
1543
  * The name of the group.
1330
1544
  */
1331
1545
  Name: string | undefined;
1332
1546
  /**
1547
+ * @public
1333
1548
  * Tag(s) to add to the new resource.
1334
1549
  */
1335
1550
  tags?: Record<string, string>;
@@ -1339,30 +1554,37 @@ export interface CreateGroupRequest {
1339
1554
  */
1340
1555
  export interface CreateGroupResponse {
1341
1556
  /**
1557
+ * @public
1342
1558
  * The ARN of the definition.
1343
1559
  */
1344
1560
  Arn?: string;
1345
1561
  /**
1562
+ * @public
1346
1563
  * The time, in milliseconds since the epoch, when the definition was created.
1347
1564
  */
1348
1565
  CreationTimestamp?: string;
1349
1566
  /**
1567
+ * @public
1350
1568
  * The ID of the definition.
1351
1569
  */
1352
1570
  Id?: string;
1353
1571
  /**
1572
+ * @public
1354
1573
  * The time, in milliseconds since the epoch, when the definition was last updated.
1355
1574
  */
1356
1575
  LastUpdatedTimestamp?: string;
1357
1576
  /**
1577
+ * @public
1358
1578
  * The ID of the latest version associated with the definition.
1359
1579
  */
1360
1580
  LatestVersion?: string;
1361
1581
  /**
1582
+ * @public
1362
1583
  * The ARN of the latest version associated with the definition.
1363
1584
  */
1364
1585
  LatestVersionArn?: string;
1365
1586
  /**
1587
+ * @public
1366
1588
  * The name of the definition.
1367
1589
  */
1368
1590
  Name?: string;
@@ -1372,10 +1594,12 @@ export interface CreateGroupResponse {
1372
1594
  */
1373
1595
  export interface CreateGroupCertificateAuthorityRequest {
1374
1596
  /**
1597
+ * @public
1375
1598
  * A client token used to correlate requests and responses.
1376
1599
  */
1377
1600
  AmznClientToken?: string;
1378
1601
  /**
1602
+ * @public
1379
1603
  * The ID of the Greengrass group.
1380
1604
  */
1381
1605
  GroupId: string | undefined;
@@ -1385,6 +1609,7 @@ export interface CreateGroupCertificateAuthorityRequest {
1385
1609
  */
1386
1610
  export interface CreateGroupCertificateAuthorityResponse {
1387
1611
  /**
1612
+ * @public
1388
1613
  * The ARN of the group certificate authority.
1389
1614
  */
1390
1615
  GroupCertificateAuthorityArn?: string;
@@ -1394,38 +1619,47 @@ export interface CreateGroupCertificateAuthorityResponse {
1394
1619
  */
1395
1620
  export interface CreateGroupVersionRequest {
1396
1621
  /**
1622
+ * @public
1397
1623
  * A client token used to correlate requests and responses.
1398
1624
  */
1399
1625
  AmznClientToken?: string;
1400
1626
  /**
1627
+ * @public
1401
1628
  * The ARN of the connector definition version for this group.
1402
1629
  */
1403
1630
  ConnectorDefinitionVersionArn?: string;
1404
1631
  /**
1632
+ * @public
1405
1633
  * The ARN of the core definition version for this group.
1406
1634
  */
1407
1635
  CoreDefinitionVersionArn?: string;
1408
1636
  /**
1637
+ * @public
1409
1638
  * The ARN of the device definition version for this group.
1410
1639
  */
1411
1640
  DeviceDefinitionVersionArn?: string;
1412
1641
  /**
1642
+ * @public
1413
1643
  * The ARN of the function definition version for this group.
1414
1644
  */
1415
1645
  FunctionDefinitionVersionArn?: string;
1416
1646
  /**
1647
+ * @public
1417
1648
  * The ID of the Greengrass group.
1418
1649
  */
1419
1650
  GroupId: string | undefined;
1420
1651
  /**
1652
+ * @public
1421
1653
  * The ARN of the logger definition version for this group.
1422
1654
  */
1423
1655
  LoggerDefinitionVersionArn?: string;
1424
1656
  /**
1657
+ * @public
1425
1658
  * The ARN of the resource definition version for this group.
1426
1659
  */
1427
1660
  ResourceDefinitionVersionArn?: string;
1428
1661
  /**
1662
+ * @public
1429
1663
  * The ARN of the subscription definition version for this group.
1430
1664
  */
1431
1665
  SubscriptionDefinitionVersionArn?: string;
@@ -1435,18 +1669,22 @@ export interface CreateGroupVersionRequest {
1435
1669
  */
1436
1670
  export interface CreateGroupVersionResponse {
1437
1671
  /**
1672
+ * @public
1438
1673
  * The ARN of the version.
1439
1674
  */
1440
1675
  Arn?: string;
1441
1676
  /**
1677
+ * @public
1442
1678
  * The time, in milliseconds since the epoch, when the version was created.
1443
1679
  */
1444
1680
  CreationTimestamp?: string;
1445
1681
  /**
1682
+ * @public
1446
1683
  * The ID of the parent definition that the version is associated with.
1447
1684
  */
1448
1685
  Id?: string;
1449
1686
  /**
1687
+ * @public
1450
1688
  * The ID of the version.
1451
1689
  */
1452
1690
  Version?: string;
@@ -1457,6 +1695,7 @@ export interface CreateGroupVersionResponse {
1457
1695
  */
1458
1696
  export interface LoggerDefinitionVersion {
1459
1697
  /**
1698
+ * @public
1460
1699
  * A list of loggers.
1461
1700
  */
1462
1701
  Loggers?: Logger[];
@@ -1466,18 +1705,22 @@ export interface LoggerDefinitionVersion {
1466
1705
  */
1467
1706
  export interface CreateLoggerDefinitionRequest {
1468
1707
  /**
1708
+ * @public
1469
1709
  * A client token used to correlate requests and responses.
1470
1710
  */
1471
1711
  AmznClientToken?: string;
1472
1712
  /**
1713
+ * @public
1473
1714
  * Information about the initial version of the logger definition.
1474
1715
  */
1475
1716
  InitialVersion?: LoggerDefinitionVersion;
1476
1717
  /**
1718
+ * @public
1477
1719
  * The name of the logger definition.
1478
1720
  */
1479
1721
  Name?: string;
1480
1722
  /**
1723
+ * @public
1481
1724
  * Tag(s) to add to the new resource.
1482
1725
  */
1483
1726
  tags?: Record<string, string>;
@@ -1487,30 +1730,37 @@ export interface CreateLoggerDefinitionRequest {
1487
1730
  */
1488
1731
  export interface CreateLoggerDefinitionResponse {
1489
1732
  /**
1733
+ * @public
1490
1734
  * The ARN of the definition.
1491
1735
  */
1492
1736
  Arn?: string;
1493
1737
  /**
1738
+ * @public
1494
1739
  * The time, in milliseconds since the epoch, when the definition was created.
1495
1740
  */
1496
1741
  CreationTimestamp?: string;
1497
1742
  /**
1743
+ * @public
1498
1744
  * The ID of the definition.
1499
1745
  */
1500
1746
  Id?: string;
1501
1747
  /**
1748
+ * @public
1502
1749
  * The time, in milliseconds since the epoch, when the definition was last updated.
1503
1750
  */
1504
1751
  LastUpdatedTimestamp?: string;
1505
1752
  /**
1753
+ * @public
1506
1754
  * The ID of the latest version associated with the definition.
1507
1755
  */
1508
1756
  LatestVersion?: string;
1509
1757
  /**
1758
+ * @public
1510
1759
  * The ARN of the latest version associated with the definition.
1511
1760
  */
1512
1761
  LatestVersionArn?: string;
1513
1762
  /**
1763
+ * @public
1514
1764
  * The name of the definition.
1515
1765
  */
1516
1766
  Name?: string;
@@ -1520,14 +1770,17 @@ export interface CreateLoggerDefinitionResponse {
1520
1770
  */
1521
1771
  export interface CreateLoggerDefinitionVersionRequest {
1522
1772
  /**
1773
+ * @public
1523
1774
  * A client token used to correlate requests and responses.
1524
1775
  */
1525
1776
  AmznClientToken?: string;
1526
1777
  /**
1778
+ * @public
1527
1779
  * The ID of the logger definition.
1528
1780
  */
1529
1781
  LoggerDefinitionId: string | undefined;
1530
1782
  /**
1783
+ * @public
1531
1784
  * A list of loggers.
1532
1785
  */
1533
1786
  Loggers?: Logger[];
@@ -1537,18 +1790,22 @@ export interface CreateLoggerDefinitionVersionRequest {
1537
1790
  */
1538
1791
  export interface CreateLoggerDefinitionVersionResponse {
1539
1792
  /**
1793
+ * @public
1540
1794
  * The ARN of the version.
1541
1795
  */
1542
1796
  Arn?: string;
1543
1797
  /**
1798
+ * @public
1544
1799
  * The time, in milliseconds since the epoch, when the version was created.
1545
1800
  */
1546
1801
  CreationTimestamp?: string;
1547
1802
  /**
1803
+ * @public
1548
1804
  * The ID of the parent definition that the version is associated with.
1549
1805
  */
1550
1806
  Id?: string;
1551
1807
  /**
1808
+ * @public
1552
1809
  * The ID of the version.
1553
1810
  */
1554
1811
  Version?: string;
@@ -1559,6 +1816,7 @@ export interface CreateLoggerDefinitionVersionResponse {
1559
1816
  */
1560
1817
  export interface ResourceDefinitionVersion {
1561
1818
  /**
1819
+ * @public
1562
1820
  * A list of resources.
1563
1821
  */
1564
1822
  Resources?: Resource[];
@@ -1568,18 +1826,22 @@ export interface ResourceDefinitionVersion {
1568
1826
  */
1569
1827
  export interface CreateResourceDefinitionRequest {
1570
1828
  /**
1829
+ * @public
1571
1830
  * A client token used to correlate requests and responses.
1572
1831
  */
1573
1832
  AmznClientToken?: string;
1574
1833
  /**
1834
+ * @public
1575
1835
  * Information about the initial version of the resource definition.
1576
1836
  */
1577
1837
  InitialVersion?: ResourceDefinitionVersion;
1578
1838
  /**
1839
+ * @public
1579
1840
  * The name of the resource definition.
1580
1841
  */
1581
1842
  Name?: string;
1582
1843
  /**
1844
+ * @public
1583
1845
  * Tag(s) to add to the new resource.
1584
1846
  */
1585
1847
  tags?: Record<string, string>;
@@ -1589,30 +1851,37 @@ export interface CreateResourceDefinitionRequest {
1589
1851
  */
1590
1852
  export interface CreateResourceDefinitionResponse {
1591
1853
  /**
1854
+ * @public
1592
1855
  * The ARN of the definition.
1593
1856
  */
1594
1857
  Arn?: string;
1595
1858
  /**
1859
+ * @public
1596
1860
  * The time, in milliseconds since the epoch, when the definition was created.
1597
1861
  */
1598
1862
  CreationTimestamp?: string;
1599
1863
  /**
1864
+ * @public
1600
1865
  * The ID of the definition.
1601
1866
  */
1602
1867
  Id?: string;
1603
1868
  /**
1869
+ * @public
1604
1870
  * The time, in milliseconds since the epoch, when the definition was last updated.
1605
1871
  */
1606
1872
  LastUpdatedTimestamp?: string;
1607
1873
  /**
1874
+ * @public
1608
1875
  * The ID of the latest version associated with the definition.
1609
1876
  */
1610
1877
  LatestVersion?: string;
1611
1878
  /**
1879
+ * @public
1612
1880
  * The ARN of the latest version associated with the definition.
1613
1881
  */
1614
1882
  LatestVersionArn?: string;
1615
1883
  /**
1884
+ * @public
1616
1885
  * The name of the definition.
1617
1886
  */
1618
1887
  Name?: string;
@@ -1622,14 +1891,17 @@ export interface CreateResourceDefinitionResponse {
1622
1891
  */
1623
1892
  export interface CreateResourceDefinitionVersionRequest {
1624
1893
  /**
1894
+ * @public
1625
1895
  * A client token used to correlate requests and responses.
1626
1896
  */
1627
1897
  AmznClientToken?: string;
1628
1898
  /**
1899
+ * @public
1629
1900
  * The ID of the resource definition.
1630
1901
  */
1631
1902
  ResourceDefinitionId: string | undefined;
1632
1903
  /**
1904
+ * @public
1633
1905
  * A list of resources.
1634
1906
  */
1635
1907
  Resources?: Resource[];
@@ -1639,18 +1911,22 @@ export interface CreateResourceDefinitionVersionRequest {
1639
1911
  */
1640
1912
  export interface CreateResourceDefinitionVersionResponse {
1641
1913
  /**
1914
+ * @public
1642
1915
  * The ARN of the version.
1643
1916
  */
1644
1917
  Arn?: string;
1645
1918
  /**
1919
+ * @public
1646
1920
  * The time, in milliseconds since the epoch, when the version was created.
1647
1921
  */
1648
1922
  CreationTimestamp?: string;
1649
1923
  /**
1924
+ * @public
1650
1925
  * The ID of the parent definition that the version is associated with.
1651
1926
  */
1652
1927
  Id?: string;
1653
1928
  /**
1929
+ * @public
1654
1930
  * The ID of the version.
1655
1931
  */
1656
1932
  Version?: string;
@@ -1718,30 +1994,37 @@ export type UpdateTargetsOperatingSystem = (typeof UpdateTargetsOperatingSystem)
1718
1994
  */
1719
1995
  export interface CreateSoftwareUpdateJobRequest {
1720
1996
  /**
1997
+ * @public
1721
1998
  * A client token used to correlate requests and responses.
1722
1999
  */
1723
2000
  AmznClientToken?: string;
1724
2001
  /**
2002
+ * @public
1725
2003
  * The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact.
1726
2004
  */
1727
2005
  S3UrlSignerRole: string | undefined;
1728
2006
  /**
2007
+ * @public
1729
2008
  * The piece of software on the Greengrass core that will be updated.
1730
2009
  */
1731
2010
  SoftwareToUpdate: SoftwareToUpdate | string | undefined;
1732
2011
  /**
2012
+ * @public
1733
2013
  * The minimum level of log statements that should be logged by the OTA Agent during an update.
1734
2014
  */
1735
2015
  UpdateAgentLogLevel?: UpdateAgentLogLevel | string;
1736
2016
  /**
2017
+ * @public
1737
2018
  * The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.
1738
2019
  */
1739
2020
  UpdateTargets: string[] | undefined;
1740
2021
  /**
2022
+ * @public
1741
2023
  * The architecture of the cores which are the targets of an update.
1742
2024
  */
1743
2025
  UpdateTargetsArchitecture: UpdateTargetsArchitecture | string | undefined;
1744
2026
  /**
2027
+ * @public
1745
2028
  * The operating system of the cores which are the targets of an update.
1746
2029
  */
1747
2030
  UpdateTargetsOperatingSystem: UpdateTargetsOperatingSystem | string | undefined;
@@ -1751,14 +2034,17 @@ export interface CreateSoftwareUpdateJobRequest {
1751
2034
  */
1752
2035
  export interface CreateSoftwareUpdateJobResponse {
1753
2036
  /**
2037
+ * @public
1754
2038
  * The IoT Job ARN corresponding to this update.
1755
2039
  */
1756
2040
  IotJobArn?: string;
1757
2041
  /**
2042
+ * @public
1758
2043
  * The IoT Job Id corresponding to this update.
1759
2044
  */
1760
2045
  IotJobId?: string;
1761
2046
  /**
2047
+ * @public
1762
2048
  * The software version installed on the device or devices after the update.
1763
2049
  */
1764
2050
  PlatformSoftwareVersion?: string;
@@ -1769,6 +2055,7 @@ export interface CreateSoftwareUpdateJobResponse {
1769
2055
  */
1770
2056
  export interface SubscriptionDefinitionVersion {
1771
2057
  /**
2058
+ * @public
1772
2059
  * A list of subscriptions.
1773
2060
  */
1774
2061
  Subscriptions?: Subscription[];
@@ -1778,18 +2065,22 @@ export interface SubscriptionDefinitionVersion {
1778
2065
  */
1779
2066
  export interface CreateSubscriptionDefinitionRequest {
1780
2067
  /**
2068
+ * @public
1781
2069
  * A client token used to correlate requests and responses.
1782
2070
  */
1783
2071
  AmznClientToken?: string;
1784
2072
  /**
2073
+ * @public
1785
2074
  * Information about the initial version of the subscription definition.
1786
2075
  */
1787
2076
  InitialVersion?: SubscriptionDefinitionVersion;
1788
2077
  /**
2078
+ * @public
1789
2079
  * The name of the subscription definition.
1790
2080
  */
1791
2081
  Name?: string;
1792
2082
  /**
2083
+ * @public
1793
2084
  * Tag(s) to add to the new resource.
1794
2085
  */
1795
2086
  tags?: Record<string, string>;
@@ -1799,30 +2090,37 @@ export interface CreateSubscriptionDefinitionRequest {
1799
2090
  */
1800
2091
  export interface CreateSubscriptionDefinitionResponse {
1801
2092
  /**
2093
+ * @public
1802
2094
  * The ARN of the definition.
1803
2095
  */
1804
2096
  Arn?: string;
1805
2097
  /**
2098
+ * @public
1806
2099
  * The time, in milliseconds since the epoch, when the definition was created.
1807
2100
  */
1808
2101
  CreationTimestamp?: string;
1809
2102
  /**
2103
+ * @public
1810
2104
  * The ID of the definition.
1811
2105
  */
1812
2106
  Id?: string;
1813
2107
  /**
2108
+ * @public
1814
2109
  * The time, in milliseconds since the epoch, when the definition was last updated.
1815
2110
  */
1816
2111
  LastUpdatedTimestamp?: string;
1817
2112
  /**
2113
+ * @public
1818
2114
  * The ID of the latest version associated with the definition.
1819
2115
  */
1820
2116
  LatestVersion?: string;
1821
2117
  /**
2118
+ * @public
1822
2119
  * The ARN of the latest version associated with the definition.
1823
2120
  */
1824
2121
  LatestVersionArn?: string;
1825
2122
  /**
2123
+ * @public
1826
2124
  * The name of the definition.
1827
2125
  */
1828
2126
  Name?: string;
@@ -1832,14 +2130,17 @@ export interface CreateSubscriptionDefinitionResponse {
1832
2130
  */
1833
2131
  export interface CreateSubscriptionDefinitionVersionRequest {
1834
2132
  /**
2133
+ * @public
1835
2134
  * A client token used to correlate requests and responses.
1836
2135
  */
1837
2136
  AmznClientToken?: string;
1838
2137
  /**
2138
+ * @public
1839
2139
  * The ID of the subscription definition.
1840
2140
  */
1841
2141
  SubscriptionDefinitionId: string | undefined;
1842
2142
  /**
2143
+ * @public
1843
2144
  * A list of subscriptions.
1844
2145
  */
1845
2146
  Subscriptions?: Subscription[];
@@ -1849,18 +2150,22 @@ export interface CreateSubscriptionDefinitionVersionRequest {
1849
2150
  */
1850
2151
  export interface CreateSubscriptionDefinitionVersionResponse {
1851
2152
  /**
2153
+ * @public
1852
2154
  * The ARN of the version.
1853
2155
  */
1854
2156
  Arn?: string;
1855
2157
  /**
2158
+ * @public
1856
2159
  * The time, in milliseconds since the epoch, when the version was created.
1857
2160
  */
1858
2161
  CreationTimestamp?: string;
1859
2162
  /**
2163
+ * @public
1860
2164
  * The ID of the parent definition that the version is associated with.
1861
2165
  */
1862
2166
  Id?: string;
1863
2167
  /**
2168
+ * @public
1864
2169
  * The ID of the version.
1865
2170
  */
1866
2171
  Version?: string;
@@ -1870,6 +2175,7 @@ export interface CreateSubscriptionDefinitionVersionResponse {
1870
2175
  */
1871
2176
  export interface DeleteConnectorDefinitionRequest {
1872
2177
  /**
2178
+ * @public
1873
2179
  * The ID of the connector definition.
1874
2180
  */
1875
2181
  ConnectorDefinitionId: string | undefined;
@@ -1884,6 +2190,7 @@ export interface DeleteConnectorDefinitionResponse {
1884
2190
  */
1885
2191
  export interface DeleteCoreDefinitionRequest {
1886
2192
  /**
2193
+ * @public
1887
2194
  * The ID of the core definition.
1888
2195
  */
1889
2196
  CoreDefinitionId: string | undefined;
@@ -1898,6 +2205,7 @@ export interface DeleteCoreDefinitionResponse {
1898
2205
  */
1899
2206
  export interface DeleteDeviceDefinitionRequest {
1900
2207
  /**
2208
+ * @public
1901
2209
  * The ID of the device definition.
1902
2210
  */
1903
2211
  DeviceDefinitionId: string | undefined;
@@ -1912,6 +2220,7 @@ export interface DeleteDeviceDefinitionResponse {
1912
2220
  */
1913
2221
  export interface DeleteFunctionDefinitionRequest {
1914
2222
  /**
2223
+ * @public
1915
2224
  * The ID of the Lambda function definition.
1916
2225
  */
1917
2226
  FunctionDefinitionId: string | undefined;
@@ -1926,6 +2235,7 @@ export interface DeleteFunctionDefinitionResponse {
1926
2235
  */
1927
2236
  export interface DeleteGroupRequest {
1928
2237
  /**
2238
+ * @public
1929
2239
  * The ID of the Greengrass group.
1930
2240
  */
1931
2241
  GroupId: string | undefined;
@@ -1940,6 +2250,7 @@ export interface DeleteGroupResponse {
1940
2250
  */
1941
2251
  export interface DeleteLoggerDefinitionRequest {
1942
2252
  /**
2253
+ * @public
1943
2254
  * The ID of the logger definition.
1944
2255
  */
1945
2256
  LoggerDefinitionId: string | undefined;
@@ -1954,6 +2265,7 @@ export interface DeleteLoggerDefinitionResponse {
1954
2265
  */
1955
2266
  export interface DeleteResourceDefinitionRequest {
1956
2267
  /**
2268
+ * @public
1957
2269
  * The ID of the resource definition.
1958
2270
  */
1959
2271
  ResourceDefinitionId: string | undefined;
@@ -1968,6 +2280,7 @@ export interface DeleteResourceDefinitionResponse {
1968
2280
  */
1969
2281
  export interface DeleteSubscriptionDefinitionRequest {
1970
2282
  /**
2283
+ * @public
1971
2284
  * The ID of the subscription definition.
1972
2285
  */
1973
2286
  SubscriptionDefinitionId: string | undefined;
@@ -1983,22 +2296,27 @@ export interface DeleteSubscriptionDefinitionResponse {
1983
2296
  */
1984
2297
  export interface Deployment {
1985
2298
  /**
2299
+ * @public
1986
2300
  * The time, in milliseconds since the epoch, when the deployment was created.
1987
2301
  */
1988
2302
  CreatedAt?: string;
1989
2303
  /**
2304
+ * @public
1990
2305
  * The ARN of the deployment.
1991
2306
  */
1992
2307
  DeploymentArn?: string;
1993
2308
  /**
2309
+ * @public
1994
2310
  * The ID of the deployment.
1995
2311
  */
1996
2312
  DeploymentId?: string;
1997
2313
  /**
2314
+ * @public
1998
2315
  * The type of the deployment.
1999
2316
  */
2000
2317
  DeploymentType?: DeploymentType | string;
2001
2318
  /**
2319
+ * @public
2002
2320
  * The ARN of the group for this deployment.
2003
2321
  */
2004
2322
  GroupArn?: string;
@@ -2008,6 +2326,7 @@ export interface Deployment {
2008
2326
  */
2009
2327
  export interface DisassociateRoleFromGroupRequest {
2010
2328
  /**
2329
+ * @public
2011
2330
  * The ID of the Greengrass group.
2012
2331
  */
2013
2332
  GroupId: string | undefined;
@@ -2017,6 +2336,7 @@ export interface DisassociateRoleFromGroupRequest {
2017
2336
  */
2018
2337
  export interface DisassociateRoleFromGroupResponse {
2019
2338
  /**
2339
+ * @public
2020
2340
  * The time, in milliseconds since the epoch, when the role was disassociated from the group.
2021
2341
  */
2022
2342
  DisassociatedAt?: string;
@@ -2031,6 +2351,7 @@ export interface DisassociateServiceRoleFromAccountRequest {
2031
2351
  */
2032
2352
  export interface DisassociateServiceRoleFromAccountResponse {
2033
2353
  /**
2354
+ * @public
2034
2355
  * The time when the service role was disassociated from the account.
2035
2356
  */
2036
2357
  DisassociatedAt?: string;
@@ -2040,6 +2361,7 @@ export interface DisassociateServiceRoleFromAccountResponse {
2040
2361
  */
2041
2362
  export interface GetAssociatedRoleRequest {
2042
2363
  /**
2364
+ * @public
2043
2365
  * The ID of the Greengrass group.
2044
2366
  */
2045
2367
  GroupId: string | undefined;
@@ -2049,10 +2371,12 @@ export interface GetAssociatedRoleRequest {
2049
2371
  */
2050
2372
  export interface GetAssociatedRoleResponse {
2051
2373
  /**
2374
+ * @public
2052
2375
  * The time when the role was associated with the group.
2053
2376
  */
2054
2377
  AssociatedAt?: string;
2055
2378
  /**
2379
+ * @public
2056
2380
  * The ARN of the role that is associated with the group.
2057
2381
  */
2058
2382
  RoleArn?: string;
@@ -2062,6 +2386,7 @@ export interface GetAssociatedRoleResponse {
2062
2386
  */
2063
2387
  export interface GetBulkDeploymentStatusRequest {
2064
2388
  /**
2389
+ * @public
2065
2390
  * The ID of the bulk deployment.
2066
2391
  */
2067
2392
  BulkDeploymentId: string | undefined;
@@ -2071,26 +2396,32 @@ export interface GetBulkDeploymentStatusRequest {
2071
2396
  */
2072
2397
  export interface GetBulkDeploymentStatusResponse {
2073
2398
  /**
2399
+ * @public
2074
2400
  * Relevant metrics on input records processed during bulk deployment.
2075
2401
  */
2076
2402
  BulkDeploymentMetrics?: BulkDeploymentMetrics;
2077
2403
  /**
2404
+ * @public
2078
2405
  * The status of the bulk deployment.
2079
2406
  */
2080
2407
  BulkDeploymentStatus?: BulkDeploymentStatus | string;
2081
2408
  /**
2409
+ * @public
2082
2410
  * The time, in ISO format, when the deployment was created.
2083
2411
  */
2084
2412
  CreatedAt?: string;
2085
2413
  /**
2414
+ * @public
2086
2415
  * Error details
2087
2416
  */
2088
2417
  ErrorDetails?: ErrorDetail[];
2089
2418
  /**
2419
+ * @public
2090
2420
  * Error message
2091
2421
  */
2092
2422
  ErrorMessage?: string;
2093
2423
  /**
2424
+ * @public
2094
2425
  * Tag(s) attached to the resource arn.
2095
2426
  */
2096
2427
  tags?: Record<string, string>;
@@ -2100,6 +2431,7 @@ export interface GetBulkDeploymentStatusResponse {
2100
2431
  */
2101
2432
  export interface GetConnectivityInfoRequest {
2102
2433
  /**
2434
+ * @public
2103
2435
  * The thing name.
2104
2436
  */
2105
2437
  ThingName: string | undefined;
@@ -2109,10 +2441,12 @@ export interface GetConnectivityInfoRequest {
2109
2441
  */
2110
2442
  export interface GetConnectivityInfoResponse {
2111
2443
  /**
2444
+ * @public
2112
2445
  * Connectivity info list.
2113
2446
  */
2114
2447
  ConnectivityInfo?: ConnectivityInfo[];
2115
2448
  /**
2449
+ * @public
2116
2450
  * A message about the connectivity info request.
2117
2451
  */
2118
2452
  Message?: string;
@@ -2122,6 +2456,7 @@ export interface GetConnectivityInfoResponse {
2122
2456
  */
2123
2457
  export interface GetConnectorDefinitionRequest {
2124
2458
  /**
2459
+ * @public
2125
2460
  * The ID of the connector definition.
2126
2461
  */
2127
2462
  ConnectorDefinitionId: string | undefined;
@@ -2131,34 +2466,42 @@ export interface GetConnectorDefinitionRequest {
2131
2466
  */
2132
2467
  export interface GetConnectorDefinitionResponse {
2133
2468
  /**
2469
+ * @public
2134
2470
  * The ARN of the definition.
2135
2471
  */
2136
2472
  Arn?: string;
2137
2473
  /**
2474
+ * @public
2138
2475
  * The time, in milliseconds since the epoch, when the definition was created.
2139
2476
  */
2140
2477
  CreationTimestamp?: string;
2141
2478
  /**
2479
+ * @public
2142
2480
  * The ID of the definition.
2143
2481
  */
2144
2482
  Id?: string;
2145
2483
  /**
2484
+ * @public
2146
2485
  * The time, in milliseconds since the epoch, when the definition was last updated.
2147
2486
  */
2148
2487
  LastUpdatedTimestamp?: string;
2149
2488
  /**
2489
+ * @public
2150
2490
  * The ID of the latest version associated with the definition.
2151
2491
  */
2152
2492
  LatestVersion?: string;
2153
2493
  /**
2494
+ * @public
2154
2495
  * The ARN of the latest version associated with the definition.
2155
2496
  */
2156
2497
  LatestVersionArn?: string;
2157
2498
  /**
2499
+ * @public
2158
2500
  * The name of the definition.
2159
2501
  */
2160
2502
  Name?: string;
2161
2503
  /**
2504
+ * @public
2162
2505
  * Tag(s) attached to the resource arn.
2163
2506
  */
2164
2507
  tags?: Record<string, string>;
@@ -2168,14 +2511,17 @@ export interface GetConnectorDefinitionResponse {
2168
2511
  */
2169
2512
  export interface GetConnectorDefinitionVersionRequest {
2170
2513
  /**
2514
+ * @public
2171
2515
  * The ID of the connector definition.
2172
2516
  */
2173
2517
  ConnectorDefinitionId: string | undefined;
2174
2518
  /**
2519
+ * @public
2175
2520
  * The ID of the connector definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListConnectorDefinitionVersions'' requests. If the version is the last one that was associated with a connector definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2176
2521
  */
2177
2522
  ConnectorDefinitionVersionId: string | undefined;
2178
2523
  /**
2524
+ * @public
2179
2525
  * The token for the next set of results, or ''null'' if there are no additional results.
2180
2526
  */
2181
2527
  NextToken?: string;
@@ -2185,26 +2531,32 @@ export interface GetConnectorDefinitionVersionRequest {
2185
2531
  */
2186
2532
  export interface GetConnectorDefinitionVersionResponse {
2187
2533
  /**
2534
+ * @public
2188
2535
  * The ARN of the connector definition version.
2189
2536
  */
2190
2537
  Arn?: string;
2191
2538
  /**
2539
+ * @public
2192
2540
  * The time, in milliseconds since the epoch, when the connector definition version was created.
2193
2541
  */
2194
2542
  CreationTimestamp?: string;
2195
2543
  /**
2544
+ * @public
2196
2545
  * Information about the connector definition version.
2197
2546
  */
2198
2547
  Definition?: ConnectorDefinitionVersion;
2199
2548
  /**
2549
+ * @public
2200
2550
  * The ID of the connector definition version.
2201
2551
  */
2202
2552
  Id?: string;
2203
2553
  /**
2554
+ * @public
2204
2555
  * The token for the next set of results, or ''null'' if there are no additional results.
2205
2556
  */
2206
2557
  NextToken?: string;
2207
2558
  /**
2559
+ * @public
2208
2560
  * The version of the connector definition version.
2209
2561
  */
2210
2562
  Version?: string;
@@ -2214,6 +2566,7 @@ export interface GetConnectorDefinitionVersionResponse {
2214
2566
  */
2215
2567
  export interface GetCoreDefinitionRequest {
2216
2568
  /**
2569
+ * @public
2217
2570
  * The ID of the core definition.
2218
2571
  */
2219
2572
  CoreDefinitionId: string | undefined;
@@ -2223,34 +2576,42 @@ export interface GetCoreDefinitionRequest {
2223
2576
  */
2224
2577
  export interface GetCoreDefinitionResponse {
2225
2578
  /**
2579
+ * @public
2226
2580
  * The ARN of the definition.
2227
2581
  */
2228
2582
  Arn?: string;
2229
2583
  /**
2584
+ * @public
2230
2585
  * The time, in milliseconds since the epoch, when the definition was created.
2231
2586
  */
2232
2587
  CreationTimestamp?: string;
2233
2588
  /**
2589
+ * @public
2234
2590
  * The ID of the definition.
2235
2591
  */
2236
2592
  Id?: string;
2237
2593
  /**
2594
+ * @public
2238
2595
  * The time, in milliseconds since the epoch, when the definition was last updated.
2239
2596
  */
2240
2597
  LastUpdatedTimestamp?: string;
2241
2598
  /**
2599
+ * @public
2242
2600
  * The ID of the latest version associated with the definition.
2243
2601
  */
2244
2602
  LatestVersion?: string;
2245
2603
  /**
2604
+ * @public
2246
2605
  * The ARN of the latest version associated with the definition.
2247
2606
  */
2248
2607
  LatestVersionArn?: string;
2249
2608
  /**
2609
+ * @public
2250
2610
  * The name of the definition.
2251
2611
  */
2252
2612
  Name?: string;
2253
2613
  /**
2614
+ * @public
2254
2615
  * Tag(s) attached to the resource arn.
2255
2616
  */
2256
2617
  tags?: Record<string, string>;
@@ -2260,10 +2621,12 @@ export interface GetCoreDefinitionResponse {
2260
2621
  */
2261
2622
  export interface GetCoreDefinitionVersionRequest {
2262
2623
  /**
2624
+ * @public
2263
2625
  * The ID of the core definition.
2264
2626
  */
2265
2627
  CoreDefinitionId: string | undefined;
2266
2628
  /**
2629
+ * @public
2267
2630
  * The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2268
2631
  */
2269
2632
  CoreDefinitionVersionId: string | undefined;
@@ -2273,26 +2636,32 @@ export interface GetCoreDefinitionVersionRequest {
2273
2636
  */
2274
2637
  export interface GetCoreDefinitionVersionResponse {
2275
2638
  /**
2639
+ * @public
2276
2640
  * The ARN of the core definition version.
2277
2641
  */
2278
2642
  Arn?: string;
2279
2643
  /**
2644
+ * @public
2280
2645
  * The time, in milliseconds since the epoch, when the core definition version was created.
2281
2646
  */
2282
2647
  CreationTimestamp?: string;
2283
2648
  /**
2649
+ * @public
2284
2650
  * Information about the core definition version.
2285
2651
  */
2286
2652
  Definition?: CoreDefinitionVersion;
2287
2653
  /**
2654
+ * @public
2288
2655
  * The ID of the core definition version.
2289
2656
  */
2290
2657
  Id?: string;
2291
2658
  /**
2659
+ * @public
2292
2660
  * The token for the next set of results, or ''null'' if there are no additional results.
2293
2661
  */
2294
2662
  NextToken?: string;
2295
2663
  /**
2664
+ * @public
2296
2665
  * The version of the core definition version.
2297
2666
  */
2298
2667
  Version?: string;
@@ -2302,10 +2671,12 @@ export interface GetCoreDefinitionVersionResponse {
2302
2671
  */
2303
2672
  export interface GetDeploymentStatusRequest {
2304
2673
  /**
2674
+ * @public
2305
2675
  * The ID of the deployment.
2306
2676
  */
2307
2677
  DeploymentId: string | undefined;
2308
2678
  /**
2679
+ * @public
2309
2680
  * The ID of the Greengrass group.
2310
2681
  */
2311
2682
  GroupId: string | undefined;
@@ -2315,22 +2686,27 @@ export interface GetDeploymentStatusRequest {
2315
2686
  */
2316
2687
  export interface GetDeploymentStatusResponse {
2317
2688
  /**
2689
+ * @public
2318
2690
  * The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.
2319
2691
  */
2320
2692
  DeploymentStatus?: string;
2321
2693
  /**
2694
+ * @public
2322
2695
  * The type of the deployment.
2323
2696
  */
2324
2697
  DeploymentType?: DeploymentType | string;
2325
2698
  /**
2699
+ * @public
2326
2700
  * Error details
2327
2701
  */
2328
2702
  ErrorDetails?: ErrorDetail[];
2329
2703
  /**
2704
+ * @public
2330
2705
  * Error message
2331
2706
  */
2332
2707
  ErrorMessage?: string;
2333
2708
  /**
2709
+ * @public
2334
2710
  * The time, in milliseconds since the epoch, when the deployment status was updated.
2335
2711
  */
2336
2712
  UpdatedAt?: string;
@@ -2340,6 +2716,7 @@ export interface GetDeploymentStatusResponse {
2340
2716
  */
2341
2717
  export interface GetDeviceDefinitionRequest {
2342
2718
  /**
2719
+ * @public
2343
2720
  * The ID of the device definition.
2344
2721
  */
2345
2722
  DeviceDefinitionId: string | undefined;
@@ -2349,34 +2726,42 @@ export interface GetDeviceDefinitionRequest {
2349
2726
  */
2350
2727
  export interface GetDeviceDefinitionResponse {
2351
2728
  /**
2729
+ * @public
2352
2730
  * The ARN of the definition.
2353
2731
  */
2354
2732
  Arn?: string;
2355
2733
  /**
2734
+ * @public
2356
2735
  * The time, in milliseconds since the epoch, when the definition was created.
2357
2736
  */
2358
2737
  CreationTimestamp?: string;
2359
2738
  /**
2739
+ * @public
2360
2740
  * The ID of the definition.
2361
2741
  */
2362
2742
  Id?: string;
2363
2743
  /**
2744
+ * @public
2364
2745
  * The time, in milliseconds since the epoch, when the definition was last updated.
2365
2746
  */
2366
2747
  LastUpdatedTimestamp?: string;
2367
2748
  /**
2749
+ * @public
2368
2750
  * The ID of the latest version associated with the definition.
2369
2751
  */
2370
2752
  LatestVersion?: string;
2371
2753
  /**
2754
+ * @public
2372
2755
  * The ARN of the latest version associated with the definition.
2373
2756
  */
2374
2757
  LatestVersionArn?: string;
2375
2758
  /**
2759
+ * @public
2376
2760
  * The name of the definition.
2377
2761
  */
2378
2762
  Name?: string;
2379
2763
  /**
2764
+ * @public
2380
2765
  * Tag(s) attached to the resource arn.
2381
2766
  */
2382
2767
  tags?: Record<string, string>;
@@ -2386,14 +2771,17 @@ export interface GetDeviceDefinitionResponse {
2386
2771
  */
2387
2772
  export interface GetDeviceDefinitionVersionRequest {
2388
2773
  /**
2774
+ * @public
2389
2775
  * The ID of the device definition.
2390
2776
  */
2391
2777
  DeviceDefinitionId: string | undefined;
2392
2778
  /**
2779
+ * @public
2393
2780
  * The ID of the device definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2394
2781
  */
2395
2782
  DeviceDefinitionVersionId: string | undefined;
2396
2783
  /**
2784
+ * @public
2397
2785
  * The token for the next set of results, or ''null'' if there are no additional results.
2398
2786
  */
2399
2787
  NextToken?: string;
@@ -2403,26 +2791,32 @@ export interface GetDeviceDefinitionVersionRequest {
2403
2791
  */
2404
2792
  export interface GetDeviceDefinitionVersionResponse {
2405
2793
  /**
2794
+ * @public
2406
2795
  * The ARN of the device definition version.
2407
2796
  */
2408
2797
  Arn?: string;
2409
2798
  /**
2799
+ * @public
2410
2800
  * The time, in milliseconds since the epoch, when the device definition version was created.
2411
2801
  */
2412
2802
  CreationTimestamp?: string;
2413
2803
  /**
2804
+ * @public
2414
2805
  * Information about the device definition version.
2415
2806
  */
2416
2807
  Definition?: DeviceDefinitionVersion;
2417
2808
  /**
2809
+ * @public
2418
2810
  * The ID of the device definition version.
2419
2811
  */
2420
2812
  Id?: string;
2421
2813
  /**
2814
+ * @public
2422
2815
  * The token for the next set of results, or ''null'' if there are no additional results.
2423
2816
  */
2424
2817
  NextToken?: string;
2425
2818
  /**
2819
+ * @public
2426
2820
  * The version of the device definition version.
2427
2821
  */
2428
2822
  Version?: string;
@@ -2432,6 +2826,7 @@ export interface GetDeviceDefinitionVersionResponse {
2432
2826
  */
2433
2827
  export interface GetFunctionDefinitionRequest {
2434
2828
  /**
2829
+ * @public
2435
2830
  * The ID of the Lambda function definition.
2436
2831
  */
2437
2832
  FunctionDefinitionId: string | undefined;
@@ -2441,34 +2836,42 @@ export interface GetFunctionDefinitionRequest {
2441
2836
  */
2442
2837
  export interface GetFunctionDefinitionResponse {
2443
2838
  /**
2839
+ * @public
2444
2840
  * The ARN of the definition.
2445
2841
  */
2446
2842
  Arn?: string;
2447
2843
  /**
2844
+ * @public
2448
2845
  * The time, in milliseconds since the epoch, when the definition was created.
2449
2846
  */
2450
2847
  CreationTimestamp?: string;
2451
2848
  /**
2849
+ * @public
2452
2850
  * The ID of the definition.
2453
2851
  */
2454
2852
  Id?: string;
2455
2853
  /**
2854
+ * @public
2456
2855
  * The time, in milliseconds since the epoch, when the definition was last updated.
2457
2856
  */
2458
2857
  LastUpdatedTimestamp?: string;
2459
2858
  /**
2859
+ * @public
2460
2860
  * The ID of the latest version associated with the definition.
2461
2861
  */
2462
2862
  LatestVersion?: string;
2463
2863
  /**
2864
+ * @public
2464
2865
  * The ARN of the latest version associated with the definition.
2465
2866
  */
2466
2867
  LatestVersionArn?: string;
2467
2868
  /**
2869
+ * @public
2468
2870
  * The name of the definition.
2469
2871
  */
2470
2872
  Name?: string;
2471
2873
  /**
2874
+ * @public
2472
2875
  * Tag(s) attached to the resource arn.
2473
2876
  */
2474
2877
  tags?: Record<string, string>;
@@ -2478,14 +2881,17 @@ export interface GetFunctionDefinitionResponse {
2478
2881
  */
2479
2882
  export interface GetFunctionDefinitionVersionRequest {
2480
2883
  /**
2884
+ * @public
2481
2885
  * The ID of the Lambda function definition.
2482
2886
  */
2483
2887
  FunctionDefinitionId: string | undefined;
2484
2888
  /**
2889
+ * @public
2485
2890
  * The ID of the function definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListFunctionDefinitionVersions'' requests. If the version is the last one that was associated with a function definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2486
2891
  */
2487
2892
  FunctionDefinitionVersionId: string | undefined;
2488
2893
  /**
2894
+ * @public
2489
2895
  * The token for the next set of results, or ''null'' if there are no additional results.
2490
2896
  */
2491
2897
  NextToken?: string;
@@ -2495,26 +2901,32 @@ export interface GetFunctionDefinitionVersionRequest {
2495
2901
  */
2496
2902
  export interface GetFunctionDefinitionVersionResponse {
2497
2903
  /**
2904
+ * @public
2498
2905
  * The ARN of the function definition version.
2499
2906
  */
2500
2907
  Arn?: string;
2501
2908
  /**
2909
+ * @public
2502
2910
  * The time, in milliseconds since the epoch, when the function definition version was created.
2503
2911
  */
2504
2912
  CreationTimestamp?: string;
2505
2913
  /**
2914
+ * @public
2506
2915
  * Information on the definition.
2507
2916
  */
2508
2917
  Definition?: FunctionDefinitionVersion;
2509
2918
  /**
2919
+ * @public
2510
2920
  * The ID of the function definition version.
2511
2921
  */
2512
2922
  Id?: string;
2513
2923
  /**
2924
+ * @public
2514
2925
  * The token for the next set of results, or ''null'' if there are no additional results.
2515
2926
  */
2516
2927
  NextToken?: string;
2517
2928
  /**
2929
+ * @public
2518
2930
  * The version of the function definition version.
2519
2931
  */
2520
2932
  Version?: string;
@@ -2524,6 +2936,7 @@ export interface GetFunctionDefinitionVersionResponse {
2524
2936
  */
2525
2937
  export interface GetGroupRequest {
2526
2938
  /**
2939
+ * @public
2527
2940
  * The ID of the Greengrass group.
2528
2941
  */
2529
2942
  GroupId: string | undefined;
@@ -2533,34 +2946,42 @@ export interface GetGroupRequest {
2533
2946
  */
2534
2947
  export interface GetGroupResponse {
2535
2948
  /**
2949
+ * @public
2536
2950
  * The ARN of the definition.
2537
2951
  */
2538
2952
  Arn?: string;
2539
2953
  /**
2954
+ * @public
2540
2955
  * The time, in milliseconds since the epoch, when the definition was created.
2541
2956
  */
2542
2957
  CreationTimestamp?: string;
2543
2958
  /**
2959
+ * @public
2544
2960
  * The ID of the definition.
2545
2961
  */
2546
2962
  Id?: string;
2547
2963
  /**
2964
+ * @public
2548
2965
  * The time, in milliseconds since the epoch, when the definition was last updated.
2549
2966
  */
2550
2967
  LastUpdatedTimestamp?: string;
2551
2968
  /**
2969
+ * @public
2552
2970
  * The ID of the latest version associated with the definition.
2553
2971
  */
2554
2972
  LatestVersion?: string;
2555
2973
  /**
2974
+ * @public
2556
2975
  * The ARN of the latest version associated with the definition.
2557
2976
  */
2558
2977
  LatestVersionArn?: string;
2559
2978
  /**
2979
+ * @public
2560
2980
  * The name of the definition.
2561
2981
  */
2562
2982
  Name?: string;
2563
2983
  /**
2984
+ * @public
2564
2985
  * Tag(s) attached to the resource arn.
2565
2986
  */
2566
2987
  tags?: Record<string, string>;
@@ -2570,10 +2991,12 @@ export interface GetGroupResponse {
2570
2991
  */
2571
2992
  export interface GetGroupCertificateAuthorityRequest {
2572
2993
  /**
2994
+ * @public
2573
2995
  * The ID of the certificate authority.
2574
2996
  */
2575
2997
  CertificateAuthorityId: string | undefined;
2576
2998
  /**
2999
+ * @public
2577
3000
  * The ID of the Greengrass group.
2578
3001
  */
2579
3002
  GroupId: string | undefined;
@@ -2583,14 +3006,17 @@ export interface GetGroupCertificateAuthorityRequest {
2583
3006
  */
2584
3007
  export interface GetGroupCertificateAuthorityResponse {
2585
3008
  /**
3009
+ * @public
2586
3010
  * The ARN of the certificate authority for the group.
2587
3011
  */
2588
3012
  GroupCertificateAuthorityArn?: string;
2589
3013
  /**
3014
+ * @public
2590
3015
  * The ID of the certificate authority for the group.
2591
3016
  */
2592
3017
  GroupCertificateAuthorityId?: string;
2593
3018
  /**
3019
+ * @public
2594
3020
  * The PEM encoded certificate for the group.
2595
3021
  */
2596
3022
  PemEncodedCertificate?: string;
@@ -2600,6 +3026,7 @@ export interface GetGroupCertificateAuthorityResponse {
2600
3026
  */
2601
3027
  export interface GetGroupCertificateConfigurationRequest {
2602
3028
  /**
3029
+ * @public
2603
3030
  * The ID of the Greengrass group.
2604
3031
  */
2605
3032
  GroupId: string | undefined;
@@ -2609,14 +3036,17 @@ export interface GetGroupCertificateConfigurationRequest {
2609
3036
  */
2610
3037
  export interface GetGroupCertificateConfigurationResponse {
2611
3038
  /**
3039
+ * @public
2612
3040
  * The amount of time remaining before the certificate authority expires, in milliseconds.
2613
3041
  */
2614
3042
  CertificateAuthorityExpiryInMilliseconds?: string;
2615
3043
  /**
3044
+ * @public
2616
3045
  * The amount of time remaining before the certificate expires, in milliseconds.
2617
3046
  */
2618
3047
  CertificateExpiryInMilliseconds?: string;
2619
3048
  /**
3049
+ * @public
2620
3050
  * The ID of the group certificate configuration.
2621
3051
  */
2622
3052
  GroupId?: string;
@@ -2626,10 +3056,12 @@ export interface GetGroupCertificateConfigurationResponse {
2626
3056
  */
2627
3057
  export interface GetGroupVersionRequest {
2628
3058
  /**
3059
+ * @public
2629
3060
  * The ID of the Greengrass group.
2630
3061
  */
2631
3062
  GroupId: string | undefined;
2632
3063
  /**
3064
+ * @public
2633
3065
  * The ID of the group version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListGroupVersions'' requests. If the version is the last one that was associated with a group, the value also maps to the ''LatestVersion'' property of the corresponding ''GroupInformation'' object.
2634
3066
  */
2635
3067
  GroupVersionId: string | undefined;
@@ -2639,22 +3071,27 @@ export interface GetGroupVersionRequest {
2639
3071
  */
2640
3072
  export interface GetGroupVersionResponse {
2641
3073
  /**
3074
+ * @public
2642
3075
  * The ARN of the group version.
2643
3076
  */
2644
3077
  Arn?: string;
2645
3078
  /**
3079
+ * @public
2646
3080
  * The time, in milliseconds since the epoch, when the group version was created.
2647
3081
  */
2648
3082
  CreationTimestamp?: string;
2649
3083
  /**
3084
+ * @public
2650
3085
  * Information about the group version definition.
2651
3086
  */
2652
3087
  Definition?: GroupVersion;
2653
3088
  /**
3089
+ * @public
2654
3090
  * The ID of the group that the version is associated with.
2655
3091
  */
2656
3092
  Id?: string;
2657
3093
  /**
3094
+ * @public
2658
3095
  * The ID of the group version.
2659
3096
  */
2660
3097
  Version?: string;
@@ -2664,6 +3101,7 @@ export interface GetGroupVersionResponse {
2664
3101
  */
2665
3102
  export interface GetLoggerDefinitionRequest {
2666
3103
  /**
3104
+ * @public
2667
3105
  * The ID of the logger definition.
2668
3106
  */
2669
3107
  LoggerDefinitionId: string | undefined;
@@ -2673,34 +3111,42 @@ export interface GetLoggerDefinitionRequest {
2673
3111
  */
2674
3112
  export interface GetLoggerDefinitionResponse {
2675
3113
  /**
3114
+ * @public
2676
3115
  * The ARN of the definition.
2677
3116
  */
2678
3117
  Arn?: string;
2679
3118
  /**
3119
+ * @public
2680
3120
  * The time, in milliseconds since the epoch, when the definition was created.
2681
3121
  */
2682
3122
  CreationTimestamp?: string;
2683
3123
  /**
3124
+ * @public
2684
3125
  * The ID of the definition.
2685
3126
  */
2686
3127
  Id?: string;
2687
3128
  /**
3129
+ * @public
2688
3130
  * The time, in milliseconds since the epoch, when the definition was last updated.
2689
3131
  */
2690
3132
  LastUpdatedTimestamp?: string;
2691
3133
  /**
3134
+ * @public
2692
3135
  * The ID of the latest version associated with the definition.
2693
3136
  */
2694
3137
  LatestVersion?: string;
2695
3138
  /**
3139
+ * @public
2696
3140
  * The ARN of the latest version associated with the definition.
2697
3141
  */
2698
3142
  LatestVersionArn?: string;
2699
3143
  /**
3144
+ * @public
2700
3145
  * The name of the definition.
2701
3146
  */
2702
3147
  Name?: string;
2703
3148
  /**
3149
+ * @public
2704
3150
  * Tag(s) attached to the resource arn.
2705
3151
  */
2706
3152
  tags?: Record<string, string>;
@@ -2710,14 +3156,17 @@ export interface GetLoggerDefinitionResponse {
2710
3156
  */
2711
3157
  export interface GetLoggerDefinitionVersionRequest {
2712
3158
  /**
3159
+ * @public
2713
3160
  * The ID of the logger definition.
2714
3161
  */
2715
3162
  LoggerDefinitionId: string | undefined;
2716
3163
  /**
3164
+ * @public
2717
3165
  * The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2718
3166
  */
2719
3167
  LoggerDefinitionVersionId: string | undefined;
2720
3168
  /**
3169
+ * @public
2721
3170
  * The token for the next set of results, or ''null'' if there are no additional results.
2722
3171
  */
2723
3172
  NextToken?: string;
@@ -2727,22 +3176,27 @@ export interface GetLoggerDefinitionVersionRequest {
2727
3176
  */
2728
3177
  export interface GetLoggerDefinitionVersionResponse {
2729
3178
  /**
3179
+ * @public
2730
3180
  * The ARN of the logger definition version.
2731
3181
  */
2732
3182
  Arn?: string;
2733
3183
  /**
3184
+ * @public
2734
3185
  * The time, in milliseconds since the epoch, when the logger definition version was created.
2735
3186
  */
2736
3187
  CreationTimestamp?: string;
2737
3188
  /**
3189
+ * @public
2738
3190
  * Information about the logger definition version.
2739
3191
  */
2740
3192
  Definition?: LoggerDefinitionVersion;
2741
3193
  /**
3194
+ * @public
2742
3195
  * The ID of the logger definition version.
2743
3196
  */
2744
3197
  Id?: string;
2745
3198
  /**
3199
+ * @public
2746
3200
  * The version of the logger definition version.
2747
3201
  */
2748
3202
  Version?: string;
@@ -2752,6 +3206,7 @@ export interface GetLoggerDefinitionVersionResponse {
2752
3206
  */
2753
3207
  export interface GetResourceDefinitionRequest {
2754
3208
  /**
3209
+ * @public
2755
3210
  * The ID of the resource definition.
2756
3211
  */
2757
3212
  ResourceDefinitionId: string | undefined;
@@ -2761,34 +3216,42 @@ export interface GetResourceDefinitionRequest {
2761
3216
  */
2762
3217
  export interface GetResourceDefinitionResponse {
2763
3218
  /**
3219
+ * @public
2764
3220
  * The ARN of the definition.
2765
3221
  */
2766
3222
  Arn?: string;
2767
3223
  /**
3224
+ * @public
2768
3225
  * The time, in milliseconds since the epoch, when the definition was created.
2769
3226
  */
2770
3227
  CreationTimestamp?: string;
2771
3228
  /**
3229
+ * @public
2772
3230
  * The ID of the definition.
2773
3231
  */
2774
3232
  Id?: string;
2775
3233
  /**
3234
+ * @public
2776
3235
  * The time, in milliseconds since the epoch, when the definition was last updated.
2777
3236
  */
2778
3237
  LastUpdatedTimestamp?: string;
2779
3238
  /**
3239
+ * @public
2780
3240
  * The ID of the latest version associated with the definition.
2781
3241
  */
2782
3242
  LatestVersion?: string;
2783
3243
  /**
3244
+ * @public
2784
3245
  * The ARN of the latest version associated with the definition.
2785
3246
  */
2786
3247
  LatestVersionArn?: string;
2787
3248
  /**
3249
+ * @public
2788
3250
  * The name of the definition.
2789
3251
  */
2790
3252
  Name?: string;
2791
3253
  /**
3254
+ * @public
2792
3255
  * Tag(s) attached to the resource arn.
2793
3256
  */
2794
3257
  tags?: Record<string, string>;
@@ -2798,10 +3261,12 @@ export interface GetResourceDefinitionResponse {
2798
3261
  */
2799
3262
  export interface GetResourceDefinitionVersionRequest {
2800
3263
  /**
3264
+ * @public
2801
3265
  * The ID of the resource definition.
2802
3266
  */
2803
3267
  ResourceDefinitionId: string | undefined;
2804
3268
  /**
3269
+ * @public
2805
3270
  * The ID of the resource definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListResourceDefinitionVersions'' requests. If the version is the last one that was associated with a resource definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2806
3271
  */
2807
3272
  ResourceDefinitionVersionId: string | undefined;
@@ -2811,22 +3276,27 @@ export interface GetResourceDefinitionVersionRequest {
2811
3276
  */
2812
3277
  export interface GetResourceDefinitionVersionResponse {
2813
3278
  /**
3279
+ * @public
2814
3280
  * Arn of the resource definition version.
2815
3281
  */
2816
3282
  Arn?: string;
2817
3283
  /**
3284
+ * @public
2818
3285
  * The time, in milliseconds since the epoch, when the resource definition version was created.
2819
3286
  */
2820
3287
  CreationTimestamp?: string;
2821
3288
  /**
3289
+ * @public
2822
3290
  * Information about the definition.
2823
3291
  */
2824
3292
  Definition?: ResourceDefinitionVersion;
2825
3293
  /**
3294
+ * @public
2826
3295
  * The ID of the resource definition version.
2827
3296
  */
2828
3297
  Id?: string;
2829
3298
  /**
3299
+ * @public
2830
3300
  * The version of the resource definition version.
2831
3301
  */
2832
3302
  Version?: string;
@@ -2841,10 +3311,12 @@ export interface GetServiceRoleForAccountRequest {
2841
3311
  */
2842
3312
  export interface GetServiceRoleForAccountResponse {
2843
3313
  /**
3314
+ * @public
2844
3315
  * The time when the service role was associated with the account.
2845
3316
  */
2846
3317
  AssociatedAt?: string;
2847
3318
  /**
3319
+ * @public
2848
3320
  * The ARN of the role which is associated with the account.
2849
3321
  */
2850
3322
  RoleArn?: string;
@@ -2854,6 +3326,7 @@ export interface GetServiceRoleForAccountResponse {
2854
3326
  */
2855
3327
  export interface GetSubscriptionDefinitionRequest {
2856
3328
  /**
3329
+ * @public
2857
3330
  * The ID of the subscription definition.
2858
3331
  */
2859
3332
  SubscriptionDefinitionId: string | undefined;
@@ -2863,34 +3336,42 @@ export interface GetSubscriptionDefinitionRequest {
2863
3336
  */
2864
3337
  export interface GetSubscriptionDefinitionResponse {
2865
3338
  /**
3339
+ * @public
2866
3340
  * The ARN of the definition.
2867
3341
  */
2868
3342
  Arn?: string;
2869
3343
  /**
3344
+ * @public
2870
3345
  * The time, in milliseconds since the epoch, when the definition was created.
2871
3346
  */
2872
3347
  CreationTimestamp?: string;
2873
3348
  /**
3349
+ * @public
2874
3350
  * The ID of the definition.
2875
3351
  */
2876
3352
  Id?: string;
2877
3353
  /**
3354
+ * @public
2878
3355
  * The time, in milliseconds since the epoch, when the definition was last updated.
2879
3356
  */
2880
3357
  LastUpdatedTimestamp?: string;
2881
3358
  /**
3359
+ * @public
2882
3360
  * The ID of the latest version associated with the definition.
2883
3361
  */
2884
3362
  LatestVersion?: string;
2885
3363
  /**
3364
+ * @public
2886
3365
  * The ARN of the latest version associated with the definition.
2887
3366
  */
2888
3367
  LatestVersionArn?: string;
2889
3368
  /**
3369
+ * @public
2890
3370
  * The name of the definition.
2891
3371
  */
2892
3372
  Name?: string;
2893
3373
  /**
3374
+ * @public
2894
3375
  * Tag(s) attached to the resource arn.
2895
3376
  */
2896
3377
  tags?: Record<string, string>;
@@ -2900,14 +3381,17 @@ export interface GetSubscriptionDefinitionResponse {
2900
3381
  */
2901
3382
  export interface GetSubscriptionDefinitionVersionRequest {
2902
3383
  /**
3384
+ * @public
2903
3385
  * The token for the next set of results, or ''null'' if there are no additional results.
2904
3386
  */
2905
3387
  NextToken?: string;
2906
3388
  /**
3389
+ * @public
2907
3390
  * The ID of the subscription definition.
2908
3391
  */
2909
3392
  SubscriptionDefinitionId: string | undefined;
2910
3393
  /**
3394
+ * @public
2911
3395
  * The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.
2912
3396
  */
2913
3397
  SubscriptionDefinitionVersionId: string | undefined;
@@ -2917,26 +3401,32 @@ export interface GetSubscriptionDefinitionVersionRequest {
2917
3401
  */
2918
3402
  export interface GetSubscriptionDefinitionVersionResponse {
2919
3403
  /**
3404
+ * @public
2920
3405
  * The ARN of the subscription definition version.
2921
3406
  */
2922
3407
  Arn?: string;
2923
3408
  /**
3409
+ * @public
2924
3410
  * The time, in milliseconds since the epoch, when the subscription definition version was created.
2925
3411
  */
2926
3412
  CreationTimestamp?: string;
2927
3413
  /**
3414
+ * @public
2928
3415
  * Information about the subscription definition version.
2929
3416
  */
2930
3417
  Definition?: SubscriptionDefinitionVersion;
2931
3418
  /**
3419
+ * @public
2932
3420
  * The ID of the subscription definition version.
2933
3421
  */
2934
3422
  Id?: string;
2935
3423
  /**
3424
+ * @public
2936
3425
  * The token for the next set of results, or ''null'' if there are no additional results.
2937
3426
  */
2938
3427
  NextToken?: string;
2939
3428
  /**
3429
+ * @public
2940
3430
  * The version of the subscription definition version.
2941
3431
  */
2942
3432
  Version?: string;
@@ -2946,6 +3436,7 @@ export interface GetSubscriptionDefinitionVersionResponse {
2946
3436
  */
2947
3437
  export interface GetThingRuntimeConfigurationRequest {
2948
3438
  /**
3439
+ * @public
2949
3440
  * The thing name.
2950
3441
  */
2951
3442
  ThingName: string | undefined;
@@ -2968,10 +3459,12 @@ export type Telemetry = (typeof Telemetry)[keyof typeof Telemetry];
2968
3459
  */
2969
3460
  export interface TelemetryConfiguration {
2970
3461
  /**
3462
+ * @public
2971
3463
  * Synchronization status of the device reported configuration with the desired configuration.
2972
3464
  */
2973
3465
  ConfigurationSyncStatus?: ConfigurationSyncStatus | string;
2974
3466
  /**
3467
+ * @public
2975
3468
  * Configure telemetry to be on or off.
2976
3469
  */
2977
3470
  Telemetry: Telemetry | string | undefined;
@@ -2982,6 +3475,7 @@ export interface TelemetryConfiguration {
2982
3475
  */
2983
3476
  export interface RuntimeConfiguration {
2984
3477
  /**
3478
+ * @public
2985
3479
  * Configuration for telemetry service.
2986
3480
  */
2987
3481
  TelemetryConfiguration?: TelemetryConfiguration;
@@ -2991,6 +3485,7 @@ export interface RuntimeConfiguration {
2991
3485
  */
2992
3486
  export interface GetThingRuntimeConfigurationResponse {
2993
3487
  /**
3488
+ * @public
2994
3489
  * Runtime configuration for a thing.
2995
3490
  */
2996
3491
  RuntimeConfiguration?: RuntimeConfiguration;
@@ -3000,14 +3495,17 @@ export interface GetThingRuntimeConfigurationResponse {
3000
3495
  */
3001
3496
  export interface ListBulkDeploymentDetailedReportsRequest {
3002
3497
  /**
3498
+ * @public
3003
3499
  * The ID of the bulk deployment.
3004
3500
  */
3005
3501
  BulkDeploymentId: string | undefined;
3006
3502
  /**
3503
+ * @public
3007
3504
  * The maximum number of results to be returned per request.
3008
3505
  */
3009
3506
  MaxResults?: string;
3010
3507
  /**
3508
+ * @public
3011
3509
  * The token for the next set of results, or ''null'' if there are no additional results.
3012
3510
  */
3013
3511
  NextToken?: string;
@@ -3017,10 +3515,12 @@ export interface ListBulkDeploymentDetailedReportsRequest {
3017
3515
  */
3018
3516
  export interface ListBulkDeploymentDetailedReportsResponse {
3019
3517
  /**
3518
+ * @public
3020
3519
  * A list of the individual group deployments in the bulk deployment operation.
3021
3520
  */
3022
3521
  Deployments?: BulkDeploymentResult[];
3023
3522
  /**
3523
+ * @public
3024
3524
  * The token for the next set of results, or ''null'' if there are no additional results.
3025
3525
  */
3026
3526
  NextToken?: string;
@@ -3030,10 +3530,12 @@ export interface ListBulkDeploymentDetailedReportsResponse {
3030
3530
  */
3031
3531
  export interface ListBulkDeploymentsRequest {
3032
3532
  /**
3533
+ * @public
3033
3534
  * The maximum number of results to be returned per request.
3034
3535
  */
3035
3536
  MaxResults?: string;
3036
3537
  /**
3538
+ * @public
3037
3539
  * The token for the next set of results, or ''null'' if there are no additional results.
3038
3540
  */
3039
3541
  NextToken?: string;
@@ -3043,10 +3545,12 @@ export interface ListBulkDeploymentsRequest {
3043
3545
  */
3044
3546
  export interface ListBulkDeploymentsResponse {
3045
3547
  /**
3548
+ * @public
3046
3549
  * A list of bulk deployments.
3047
3550
  */
3048
3551
  BulkDeployments?: BulkDeployment[];
3049
3552
  /**
3553
+ * @public
3050
3554
  * The token for the next set of results, or ''null'' if there are no additional results.
3051
3555
  */
3052
3556
  NextToken?: string;
@@ -3056,10 +3560,12 @@ export interface ListBulkDeploymentsResponse {
3056
3560
  */
3057
3561
  export interface ListConnectorDefinitionsRequest {
3058
3562
  /**
3563
+ * @public
3059
3564
  * The maximum number of results to be returned per request.
3060
3565
  */
3061
3566
  MaxResults?: string;
3062
3567
  /**
3568
+ * @public
3063
3569
  * The token for the next set of results, or ''null'' if there are no additional results.
3064
3570
  */
3065
3571
  NextToken?: string;
@@ -3069,10 +3575,12 @@ export interface ListConnectorDefinitionsRequest {
3069
3575
  */
3070
3576
  export interface ListConnectorDefinitionsResponse {
3071
3577
  /**
3578
+ * @public
3072
3579
  * Information about a definition.
3073
3580
  */
3074
3581
  Definitions?: DefinitionInformation[];
3075
3582
  /**
3583
+ * @public
3076
3584
  * The token for the next set of results, or ''null'' if there are no additional results.
3077
3585
  */
3078
3586
  NextToken?: string;
@@ -3082,14 +3590,17 @@ export interface ListConnectorDefinitionsResponse {
3082
3590
  */
3083
3591
  export interface ListConnectorDefinitionVersionsRequest {
3084
3592
  /**
3593
+ * @public
3085
3594
  * The ID of the connector definition.
3086
3595
  */
3087
3596
  ConnectorDefinitionId: string | undefined;
3088
3597
  /**
3598
+ * @public
3089
3599
  * The maximum number of results to be returned per request.
3090
3600
  */
3091
3601
  MaxResults?: string;
3092
3602
  /**
3603
+ * @public
3093
3604
  * The token for the next set of results, or ''null'' if there are no additional results.
3094
3605
  */
3095
3606
  NextToken?: string;
@@ -3099,10 +3610,12 @@ export interface ListConnectorDefinitionVersionsRequest {
3099
3610
  */
3100
3611
  export interface ListConnectorDefinitionVersionsResponse {
3101
3612
  /**
3613
+ * @public
3102
3614
  * The token for the next set of results, or ''null'' if there are no additional results.
3103
3615
  */
3104
3616
  NextToken?: string;
3105
3617
  /**
3618
+ * @public
3106
3619
  * Information about a version.
3107
3620
  */
3108
3621
  Versions?: VersionInformation[];
@@ -3112,10 +3625,12 @@ export interface ListConnectorDefinitionVersionsResponse {
3112
3625
  */
3113
3626
  export interface ListCoreDefinitionsRequest {
3114
3627
  /**
3628
+ * @public
3115
3629
  * The maximum number of results to be returned per request.
3116
3630
  */
3117
3631
  MaxResults?: string;
3118
3632
  /**
3633
+ * @public
3119
3634
  * The token for the next set of results, or ''null'' if there are no additional results.
3120
3635
  */
3121
3636
  NextToken?: string;
@@ -3125,10 +3640,12 @@ export interface ListCoreDefinitionsRequest {
3125
3640
  */
3126
3641
  export interface ListCoreDefinitionsResponse {
3127
3642
  /**
3643
+ * @public
3128
3644
  * Information about a definition.
3129
3645
  */
3130
3646
  Definitions?: DefinitionInformation[];
3131
3647
  /**
3648
+ * @public
3132
3649
  * The token for the next set of results, or ''null'' if there are no additional results.
3133
3650
  */
3134
3651
  NextToken?: string;
@@ -3138,14 +3655,17 @@ export interface ListCoreDefinitionsResponse {
3138
3655
  */
3139
3656
  export interface ListCoreDefinitionVersionsRequest {
3140
3657
  /**
3658
+ * @public
3141
3659
  * The ID of the core definition.
3142
3660
  */
3143
3661
  CoreDefinitionId: string | undefined;
3144
3662
  /**
3663
+ * @public
3145
3664
  * The maximum number of results to be returned per request.
3146
3665
  */
3147
3666
  MaxResults?: string;
3148
3667
  /**
3668
+ * @public
3149
3669
  * The token for the next set of results, or ''null'' if there are no additional results.
3150
3670
  */
3151
3671
  NextToken?: string;
@@ -3155,10 +3675,12 @@ export interface ListCoreDefinitionVersionsRequest {
3155
3675
  */
3156
3676
  export interface ListCoreDefinitionVersionsResponse {
3157
3677
  /**
3678
+ * @public
3158
3679
  * The token for the next set of results, or ''null'' if there are no additional results.
3159
3680
  */
3160
3681
  NextToken?: string;
3161
3682
  /**
3683
+ * @public
3162
3684
  * Information about a version.
3163
3685
  */
3164
3686
  Versions?: VersionInformation[];
@@ -3168,14 +3690,17 @@ export interface ListCoreDefinitionVersionsResponse {
3168
3690
  */
3169
3691
  export interface ListDeploymentsRequest {
3170
3692
  /**
3693
+ * @public
3171
3694
  * The ID of the Greengrass group.
3172
3695
  */
3173
3696
  GroupId: string | undefined;
3174
3697
  /**
3698
+ * @public
3175
3699
  * The maximum number of results to be returned per request.
3176
3700
  */
3177
3701
  MaxResults?: string;
3178
3702
  /**
3703
+ * @public
3179
3704
  * The token for the next set of results, or ''null'' if there are no additional results.
3180
3705
  */
3181
3706
  NextToken?: string;
@@ -3185,10 +3710,12 @@ export interface ListDeploymentsRequest {
3185
3710
  */
3186
3711
  export interface ListDeploymentsResponse {
3187
3712
  /**
3713
+ * @public
3188
3714
  * A list of deployments for the requested groups.
3189
3715
  */
3190
3716
  Deployments?: Deployment[];
3191
3717
  /**
3718
+ * @public
3192
3719
  * The token for the next set of results, or ''null'' if there are no additional results.
3193
3720
  */
3194
3721
  NextToken?: string;
@@ -3198,10 +3725,12 @@ export interface ListDeploymentsResponse {
3198
3725
  */
3199
3726
  export interface ListDeviceDefinitionsRequest {
3200
3727
  /**
3728
+ * @public
3201
3729
  * The maximum number of results to be returned per request.
3202
3730
  */
3203
3731
  MaxResults?: string;
3204
3732
  /**
3733
+ * @public
3205
3734
  * The token for the next set of results, or ''null'' if there are no additional results.
3206
3735
  */
3207
3736
  NextToken?: string;
@@ -3211,10 +3740,12 @@ export interface ListDeviceDefinitionsRequest {
3211
3740
  */
3212
3741
  export interface ListDeviceDefinitionsResponse {
3213
3742
  /**
3743
+ * @public
3214
3744
  * Information about a definition.
3215
3745
  */
3216
3746
  Definitions?: DefinitionInformation[];
3217
3747
  /**
3748
+ * @public
3218
3749
  * The token for the next set of results, or ''null'' if there are no additional results.
3219
3750
  */
3220
3751
  NextToken?: string;
@@ -3224,14 +3755,17 @@ export interface ListDeviceDefinitionsResponse {
3224
3755
  */
3225
3756
  export interface ListDeviceDefinitionVersionsRequest {
3226
3757
  /**
3758
+ * @public
3227
3759
  * The ID of the device definition.
3228
3760
  */
3229
3761
  DeviceDefinitionId: string | undefined;
3230
3762
  /**
3763
+ * @public
3231
3764
  * The maximum number of results to be returned per request.
3232
3765
  */
3233
3766
  MaxResults?: string;
3234
3767
  /**
3768
+ * @public
3235
3769
  * The token for the next set of results, or ''null'' if there are no additional results.
3236
3770
  */
3237
3771
  NextToken?: string;
@@ -3241,10 +3775,12 @@ export interface ListDeviceDefinitionVersionsRequest {
3241
3775
  */
3242
3776
  export interface ListDeviceDefinitionVersionsResponse {
3243
3777
  /**
3778
+ * @public
3244
3779
  * The token for the next set of results, or ''null'' if there are no additional results.
3245
3780
  */
3246
3781
  NextToken?: string;
3247
3782
  /**
3783
+ * @public
3248
3784
  * Information about a version.
3249
3785
  */
3250
3786
  Versions?: VersionInformation[];
@@ -3254,10 +3790,12 @@ export interface ListDeviceDefinitionVersionsResponse {
3254
3790
  */
3255
3791
  export interface ListFunctionDefinitionsRequest {
3256
3792
  /**
3793
+ * @public
3257
3794
  * The maximum number of results to be returned per request.
3258
3795
  */
3259
3796
  MaxResults?: string;
3260
3797
  /**
3798
+ * @public
3261
3799
  * The token for the next set of results, or ''null'' if there are no additional results.
3262
3800
  */
3263
3801
  NextToken?: string;
@@ -3267,10 +3805,12 @@ export interface ListFunctionDefinitionsRequest {
3267
3805
  */
3268
3806
  export interface ListFunctionDefinitionsResponse {
3269
3807
  /**
3808
+ * @public
3270
3809
  * Information about a definition.
3271
3810
  */
3272
3811
  Definitions?: DefinitionInformation[];
3273
3812
  /**
3813
+ * @public
3274
3814
  * The token for the next set of results, or ''null'' if there are no additional results.
3275
3815
  */
3276
3816
  NextToken?: string;
@@ -3280,14 +3820,17 @@ export interface ListFunctionDefinitionsResponse {
3280
3820
  */
3281
3821
  export interface ListFunctionDefinitionVersionsRequest {
3282
3822
  /**
3823
+ * @public
3283
3824
  * The ID of the Lambda function definition.
3284
3825
  */
3285
3826
  FunctionDefinitionId: string | undefined;
3286
3827
  /**
3828
+ * @public
3287
3829
  * The maximum number of results to be returned per request.
3288
3830
  */
3289
3831
  MaxResults?: string;
3290
3832
  /**
3833
+ * @public
3291
3834
  * The token for the next set of results, or ''null'' if there are no additional results.
3292
3835
  */
3293
3836
  NextToken?: string;
@@ -3297,10 +3840,12 @@ export interface ListFunctionDefinitionVersionsRequest {
3297
3840
  */
3298
3841
  export interface ListFunctionDefinitionVersionsResponse {
3299
3842
  /**
3843
+ * @public
3300
3844
  * The token for the next set of results, or ''null'' if there are no additional results.
3301
3845
  */
3302
3846
  NextToken?: string;
3303
3847
  /**
3848
+ * @public
3304
3849
  * Information about a version.
3305
3850
  */
3306
3851
  Versions?: VersionInformation[];
@@ -3310,6 +3855,7 @@ export interface ListFunctionDefinitionVersionsResponse {
3310
3855
  */
3311
3856
  export interface ListGroupCertificateAuthoritiesRequest {
3312
3857
  /**
3858
+ * @public
3313
3859
  * The ID of the Greengrass group.
3314
3860
  */
3315
3861
  GroupId: string | undefined;
@@ -3319,6 +3865,7 @@ export interface ListGroupCertificateAuthoritiesRequest {
3319
3865
  */
3320
3866
  export interface ListGroupCertificateAuthoritiesResponse {
3321
3867
  /**
3868
+ * @public
3322
3869
  * A list of certificate authorities associated with the group.
3323
3870
  */
3324
3871
  GroupCertificateAuthorities?: GroupCertificateAuthorityProperties[];
@@ -3328,10 +3875,12 @@ export interface ListGroupCertificateAuthoritiesResponse {
3328
3875
  */
3329
3876
  export interface ListGroupsRequest {
3330
3877
  /**
3878
+ * @public
3331
3879
  * The maximum number of results to be returned per request.
3332
3880
  */
3333
3881
  MaxResults?: string;
3334
3882
  /**
3883
+ * @public
3335
3884
  * The token for the next set of results, or ''null'' if there are no additional results.
3336
3885
  */
3337
3886
  NextToken?: string;
@@ -3341,10 +3890,12 @@ export interface ListGroupsRequest {
3341
3890
  */
3342
3891
  export interface ListGroupsResponse {
3343
3892
  /**
3893
+ * @public
3344
3894
  * Information about a group.
3345
3895
  */
3346
3896
  Groups?: GroupInformation[];
3347
3897
  /**
3898
+ * @public
3348
3899
  * The token for the next set of results, or ''null'' if there are no additional results.
3349
3900
  */
3350
3901
  NextToken?: string;
@@ -3354,14 +3905,17 @@ export interface ListGroupsResponse {
3354
3905
  */
3355
3906
  export interface ListGroupVersionsRequest {
3356
3907
  /**
3908
+ * @public
3357
3909
  * The ID of the Greengrass group.
3358
3910
  */
3359
3911
  GroupId: string | undefined;
3360
3912
  /**
3913
+ * @public
3361
3914
  * The maximum number of results to be returned per request.
3362
3915
  */
3363
3916
  MaxResults?: string;
3364
3917
  /**
3918
+ * @public
3365
3919
  * The token for the next set of results, or ''null'' if there are no additional results.
3366
3920
  */
3367
3921
  NextToken?: string;
@@ -3371,10 +3925,12 @@ export interface ListGroupVersionsRequest {
3371
3925
  */
3372
3926
  export interface ListGroupVersionsResponse {
3373
3927
  /**
3928
+ * @public
3374
3929
  * The token for the next set of results, or ''null'' if there are no additional results.
3375
3930
  */
3376
3931
  NextToken?: string;
3377
3932
  /**
3933
+ * @public
3378
3934
  * Information about a version.
3379
3935
  */
3380
3936
  Versions?: VersionInformation[];
@@ -3384,10 +3940,12 @@ export interface ListGroupVersionsResponse {
3384
3940
  */
3385
3941
  export interface ListLoggerDefinitionsRequest {
3386
3942
  /**
3943
+ * @public
3387
3944
  * The maximum number of results to be returned per request.
3388
3945
  */
3389
3946
  MaxResults?: string;
3390
3947
  /**
3948
+ * @public
3391
3949
  * The token for the next set of results, or ''null'' if there are no additional results.
3392
3950
  */
3393
3951
  NextToken?: string;
@@ -3397,10 +3955,12 @@ export interface ListLoggerDefinitionsRequest {
3397
3955
  */
3398
3956
  export interface ListLoggerDefinitionsResponse {
3399
3957
  /**
3958
+ * @public
3400
3959
  * Information about a definition.
3401
3960
  */
3402
3961
  Definitions?: DefinitionInformation[];
3403
3962
  /**
3963
+ * @public
3404
3964
  * The token for the next set of results, or ''null'' if there are no additional results.
3405
3965
  */
3406
3966
  NextToken?: string;
@@ -3410,14 +3970,17 @@ export interface ListLoggerDefinitionsResponse {
3410
3970
  */
3411
3971
  export interface ListLoggerDefinitionVersionsRequest {
3412
3972
  /**
3973
+ * @public
3413
3974
  * The ID of the logger definition.
3414
3975
  */
3415
3976
  LoggerDefinitionId: string | undefined;
3416
3977
  /**
3978
+ * @public
3417
3979
  * The maximum number of results to be returned per request.
3418
3980
  */
3419
3981
  MaxResults?: string;
3420
3982
  /**
3983
+ * @public
3421
3984
  * The token for the next set of results, or ''null'' if there are no additional results.
3422
3985
  */
3423
3986
  NextToken?: string;
@@ -3427,10 +3990,12 @@ export interface ListLoggerDefinitionVersionsRequest {
3427
3990
  */
3428
3991
  export interface ListLoggerDefinitionVersionsResponse {
3429
3992
  /**
3993
+ * @public
3430
3994
  * The token for the next set of results, or ''null'' if there are no additional results.
3431
3995
  */
3432
3996
  NextToken?: string;
3433
3997
  /**
3998
+ * @public
3434
3999
  * Information about a version.
3435
4000
  */
3436
4001
  Versions?: VersionInformation[];
@@ -3440,10 +4005,12 @@ export interface ListLoggerDefinitionVersionsResponse {
3440
4005
  */
3441
4006
  export interface ListResourceDefinitionsRequest {
3442
4007
  /**
4008
+ * @public
3443
4009
  * The maximum number of results to be returned per request.
3444
4010
  */
3445
4011
  MaxResults?: string;
3446
4012
  /**
4013
+ * @public
3447
4014
  * The token for the next set of results, or ''null'' if there are no additional results.
3448
4015
  */
3449
4016
  NextToken?: string;
@@ -3453,10 +4020,12 @@ export interface ListResourceDefinitionsRequest {
3453
4020
  */
3454
4021
  export interface ListResourceDefinitionsResponse {
3455
4022
  /**
4023
+ * @public
3456
4024
  * Information about a definition.
3457
4025
  */
3458
4026
  Definitions?: DefinitionInformation[];
3459
4027
  /**
4028
+ * @public
3460
4029
  * The token for the next set of results, or ''null'' if there are no additional results.
3461
4030
  */
3462
4031
  NextToken?: string;
@@ -3466,14 +4035,17 @@ export interface ListResourceDefinitionsResponse {
3466
4035
  */
3467
4036
  export interface ListResourceDefinitionVersionsRequest {
3468
4037
  /**
4038
+ * @public
3469
4039
  * The maximum number of results to be returned per request.
3470
4040
  */
3471
4041
  MaxResults?: string;
3472
4042
  /**
4043
+ * @public
3473
4044
  * The token for the next set of results, or ''null'' if there are no additional results.
3474
4045
  */
3475
4046
  NextToken?: string;
3476
4047
  /**
4048
+ * @public
3477
4049
  * The ID of the resource definition.
3478
4050
  */
3479
4051
  ResourceDefinitionId: string | undefined;
@@ -3483,10 +4055,12 @@ export interface ListResourceDefinitionVersionsRequest {
3483
4055
  */
3484
4056
  export interface ListResourceDefinitionVersionsResponse {
3485
4057
  /**
4058
+ * @public
3486
4059
  * The token for the next set of results, or ''null'' if there are no additional results.
3487
4060
  */
3488
4061
  NextToken?: string;
3489
4062
  /**
4063
+ * @public
3490
4064
  * Information about a version.
3491
4065
  */
3492
4066
  Versions?: VersionInformation[];
@@ -3496,10 +4070,12 @@ export interface ListResourceDefinitionVersionsResponse {
3496
4070
  */
3497
4071
  export interface ListSubscriptionDefinitionsRequest {
3498
4072
  /**
4073
+ * @public
3499
4074
  * The maximum number of results to be returned per request.
3500
4075
  */
3501
4076
  MaxResults?: string;
3502
4077
  /**
4078
+ * @public
3503
4079
  * The token for the next set of results, or ''null'' if there are no additional results.
3504
4080
  */
3505
4081
  NextToken?: string;
@@ -3509,10 +4085,12 @@ export interface ListSubscriptionDefinitionsRequest {
3509
4085
  */
3510
4086
  export interface ListSubscriptionDefinitionsResponse {
3511
4087
  /**
4088
+ * @public
3512
4089
  * Information about a definition.
3513
4090
  */
3514
4091
  Definitions?: DefinitionInformation[];
3515
4092
  /**
4093
+ * @public
3516
4094
  * The token for the next set of results, or ''null'' if there are no additional results.
3517
4095
  */
3518
4096
  NextToken?: string;
@@ -3522,14 +4100,17 @@ export interface ListSubscriptionDefinitionsResponse {
3522
4100
  */
3523
4101
  export interface ListSubscriptionDefinitionVersionsRequest {
3524
4102
  /**
4103
+ * @public
3525
4104
  * The maximum number of results to be returned per request.
3526
4105
  */
3527
4106
  MaxResults?: string;
3528
4107
  /**
4108
+ * @public
3529
4109
  * The token for the next set of results, or ''null'' if there are no additional results.
3530
4110
  */
3531
4111
  NextToken?: string;
3532
4112
  /**
4113
+ * @public
3533
4114
  * The ID of the subscription definition.
3534
4115
  */
3535
4116
  SubscriptionDefinitionId: string | undefined;
@@ -3539,10 +4120,12 @@ export interface ListSubscriptionDefinitionVersionsRequest {
3539
4120
  */
3540
4121
  export interface ListSubscriptionDefinitionVersionsResponse {
3541
4122
  /**
4123
+ * @public
3542
4124
  * The token for the next set of results, or ''null'' if there are no additional results.
3543
4125
  */
3544
4126
  NextToken?: string;
3545
4127
  /**
4128
+ * @public
3546
4129
  * Information about a version.
3547
4130
  */
3548
4131
  Versions?: VersionInformation[];
@@ -3552,6 +4135,7 @@ export interface ListSubscriptionDefinitionVersionsResponse {
3552
4135
  */
3553
4136
  export interface ListTagsForResourceRequest {
3554
4137
  /**
4138
+ * @public
3555
4139
  * The Amazon Resource Name (ARN) of the resource.
3556
4140
  */
3557
4141
  ResourceArn: string | undefined;
@@ -3561,6 +4145,7 @@ export interface ListTagsForResourceRequest {
3561
4145
  */
3562
4146
  export interface ListTagsForResourceResponse {
3563
4147
  /**
4148
+ * @public
3564
4149
  * The key-value pair for the resource tag.
3565
4150
  */
3566
4151
  tags?: Record<string, string>;
@@ -3571,14 +4156,17 @@ export interface ListTagsForResourceResponse {
3571
4156
  */
3572
4157
  export interface ResetDeploymentsRequest {
3573
4158
  /**
4159
+ * @public
3574
4160
  * A client token used to correlate requests and responses.
3575
4161
  */
3576
4162
  AmznClientToken?: string;
3577
4163
  /**
4164
+ * @public
3578
4165
  * If true, performs a best-effort only core reset.
3579
4166
  */
3580
4167
  Force?: boolean;
3581
4168
  /**
4169
+ * @public
3582
4170
  * The ID of the Greengrass group.
3583
4171
  */
3584
4172
  GroupId: string | undefined;
@@ -3588,10 +4176,12 @@ export interface ResetDeploymentsRequest {
3588
4176
  */
3589
4177
  export interface ResetDeploymentsResponse {
3590
4178
  /**
4179
+ * @public
3591
4180
  * The ARN of the deployment.
3592
4181
  */
3593
4182
  DeploymentArn?: string;
3594
4183
  /**
4184
+ * @public
3595
4185
  * The ID of the deployment.
3596
4186
  */
3597
4187
  DeploymentId?: string;
@@ -3601,18 +4191,22 @@ export interface ResetDeploymentsResponse {
3601
4191
  */
3602
4192
  export interface StartBulkDeploymentRequest {
3603
4193
  /**
4194
+ * @public
3604
4195
  * A client token used to correlate requests and responses.
3605
4196
  */
3606
4197
  AmznClientToken?: string;
3607
4198
  /**
4199
+ * @public
3608
4200
  * The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file.
3609
4201
  */
3610
4202
  ExecutionRoleArn: string | undefined;
3611
4203
  /**
4204
+ * @public
3612
4205
  * The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.
3613
4206
  */
3614
4207
  InputFileUri: string | undefined;
3615
4208
  /**
4209
+ * @public
3616
4210
  * Tag(s) to add to the new resource.
3617
4211
  */
3618
4212
  tags?: Record<string, string>;
@@ -3622,10 +4216,12 @@ export interface StartBulkDeploymentRequest {
3622
4216
  */
3623
4217
  export interface StartBulkDeploymentResponse {
3624
4218
  /**
4219
+ * @public
3625
4220
  * The ARN of the bulk deployment.
3626
4221
  */
3627
4222
  BulkDeploymentArn?: string;
3628
4223
  /**
4224
+ * @public
3629
4225
  * The ID of the bulk deployment.
3630
4226
  */
3631
4227
  BulkDeploymentId?: string;
@@ -3635,6 +4231,7 @@ export interface StartBulkDeploymentResponse {
3635
4231
  */
3636
4232
  export interface StopBulkDeploymentRequest {
3637
4233
  /**
4234
+ * @public
3638
4235
  * The ID of the bulk deployment.
3639
4236
  */
3640
4237
  BulkDeploymentId: string | undefined;
@@ -3650,10 +4247,12 @@ export interface StopBulkDeploymentResponse {
3650
4247
  */
3651
4248
  export interface TagResourceRequest {
3652
4249
  /**
4250
+ * @public
3653
4251
  * The Amazon Resource Name (ARN) of the resource.
3654
4252
  */
3655
4253
  ResourceArn: string | undefined;
3656
4254
  /**
4255
+ * @public
3657
4256
  * The key-value pair for the resource tag.
3658
4257
  */
3659
4258
  tags?: Record<string, string>;
@@ -3663,10 +4262,12 @@ export interface TagResourceRequest {
3663
4262
  */
3664
4263
  export interface UntagResourceRequest {
3665
4264
  /**
4265
+ * @public
3666
4266
  * The Amazon Resource Name (ARN) of the resource.
3667
4267
  */
3668
4268
  ResourceArn: string | undefined;
3669
4269
  /**
4270
+ * @public
3670
4271
  * An array of tag keys to delete
3671
4272
  */
3672
4273
  TagKeys: string[] | undefined;
@@ -3677,10 +4278,12 @@ export interface UntagResourceRequest {
3677
4278
  */
3678
4279
  export interface UpdateConnectivityInfoRequest {
3679
4280
  /**
4281
+ * @public
3680
4282
  * A list of connectivity info.
3681
4283
  */
3682
4284
  ConnectivityInfo?: ConnectivityInfo[];
3683
4285
  /**
4286
+ * @public
3684
4287
  * The thing name.
3685
4288
  */
3686
4289
  ThingName: string | undefined;
@@ -3690,10 +4293,12 @@ export interface UpdateConnectivityInfoRequest {
3690
4293
  */
3691
4294
  export interface UpdateConnectivityInfoResponse {
3692
4295
  /**
4296
+ * @public
3693
4297
  * A message about the connectivity info update request.
3694
4298
  */
3695
4299
  Message?: string;
3696
4300
  /**
4301
+ * @public
3697
4302
  * The new version of the connectivity info.
3698
4303
  */
3699
4304
  Version?: string;
@@ -3703,10 +4308,12 @@ export interface UpdateConnectivityInfoResponse {
3703
4308
  */
3704
4309
  export interface UpdateConnectorDefinitionRequest {
3705
4310
  /**
4311
+ * @public
3706
4312
  * The ID of the connector definition.
3707
4313
  */
3708
4314
  ConnectorDefinitionId: string | undefined;
3709
4315
  /**
4316
+ * @public
3710
4317
  * The name of the definition.
3711
4318
  */
3712
4319
  Name?: string;
@@ -3721,10 +4328,12 @@ export interface UpdateConnectorDefinitionResponse {
3721
4328
  */
3722
4329
  export interface UpdateCoreDefinitionRequest {
3723
4330
  /**
4331
+ * @public
3724
4332
  * The ID of the core definition.
3725
4333
  */
3726
4334
  CoreDefinitionId: string | undefined;
3727
4335
  /**
4336
+ * @public
3728
4337
  * The name of the definition.
3729
4338
  */
3730
4339
  Name?: string;
@@ -3739,10 +4348,12 @@ export interface UpdateCoreDefinitionResponse {
3739
4348
  */
3740
4349
  export interface UpdateDeviceDefinitionRequest {
3741
4350
  /**
4351
+ * @public
3742
4352
  * The ID of the device definition.
3743
4353
  */
3744
4354
  DeviceDefinitionId: string | undefined;
3745
4355
  /**
4356
+ * @public
3746
4357
  * The name of the definition.
3747
4358
  */
3748
4359
  Name?: string;
@@ -3757,10 +4368,12 @@ export interface UpdateDeviceDefinitionResponse {
3757
4368
  */
3758
4369
  export interface UpdateFunctionDefinitionRequest {
3759
4370
  /**
4371
+ * @public
3760
4372
  * The ID of the Lambda function definition.
3761
4373
  */
3762
4374
  FunctionDefinitionId: string | undefined;
3763
4375
  /**
4376
+ * @public
3764
4377
  * The name of the definition.
3765
4378
  */
3766
4379
  Name?: string;
@@ -3775,10 +4388,12 @@ export interface UpdateFunctionDefinitionResponse {
3775
4388
  */
3776
4389
  export interface UpdateGroupRequest {
3777
4390
  /**
4391
+ * @public
3778
4392
  * The ID of the Greengrass group.
3779
4393
  */
3780
4394
  GroupId: string | undefined;
3781
4395
  /**
4396
+ * @public
3782
4397
  * The name of the definition.
3783
4398
  */
3784
4399
  Name?: string;
@@ -3793,10 +4408,12 @@ export interface UpdateGroupResponse {
3793
4408
  */
3794
4409
  export interface UpdateGroupCertificateConfigurationRequest {
3795
4410
  /**
4411
+ * @public
3796
4412
  * The amount of time remaining before the certificate expires, in milliseconds.
3797
4413
  */
3798
4414
  CertificateExpiryInMilliseconds?: string;
3799
4415
  /**
4416
+ * @public
3800
4417
  * The ID of the Greengrass group.
3801
4418
  */
3802
4419
  GroupId: string | undefined;
@@ -3806,14 +4423,17 @@ export interface UpdateGroupCertificateConfigurationRequest {
3806
4423
  */
3807
4424
  export interface UpdateGroupCertificateConfigurationResponse {
3808
4425
  /**
4426
+ * @public
3809
4427
  * The amount of time remaining before the certificate authority expires, in milliseconds.
3810
4428
  */
3811
4429
  CertificateAuthorityExpiryInMilliseconds?: string;
3812
4430
  /**
4431
+ * @public
3813
4432
  * The amount of time remaining before the certificate expires, in milliseconds.
3814
4433
  */
3815
4434
  CertificateExpiryInMilliseconds?: string;
3816
4435
  /**
4436
+ * @public
3817
4437
  * The ID of the group certificate configuration.
3818
4438
  */
3819
4439
  GroupId?: string;
@@ -3823,10 +4443,12 @@ export interface UpdateGroupCertificateConfigurationResponse {
3823
4443
  */
3824
4444
  export interface UpdateLoggerDefinitionRequest {
3825
4445
  /**
4446
+ * @public
3826
4447
  * The ID of the logger definition.
3827
4448
  */
3828
4449
  LoggerDefinitionId: string | undefined;
3829
4450
  /**
4451
+ * @public
3830
4452
  * The name of the definition.
3831
4453
  */
3832
4454
  Name?: string;
@@ -3841,10 +4463,12 @@ export interface UpdateLoggerDefinitionResponse {
3841
4463
  */
3842
4464
  export interface UpdateResourceDefinitionRequest {
3843
4465
  /**
4466
+ * @public
3844
4467
  * The name of the definition.
3845
4468
  */
3846
4469
  Name?: string;
3847
4470
  /**
4471
+ * @public
3848
4472
  * The ID of the resource definition.
3849
4473
  */
3850
4474
  ResourceDefinitionId: string | undefined;
@@ -3859,10 +4483,12 @@ export interface UpdateResourceDefinitionResponse {
3859
4483
  */
3860
4484
  export interface UpdateSubscriptionDefinitionRequest {
3861
4485
  /**
4486
+ * @public
3862
4487
  * The name of the definition.
3863
4488
  */
3864
4489
  Name?: string;
3865
4490
  /**
4491
+ * @public
3866
4492
  * The ID of the subscription definition.
3867
4493
  */
3868
4494
  SubscriptionDefinitionId: string | undefined;
@@ -3878,6 +4504,7 @@ export interface UpdateSubscriptionDefinitionResponse {
3878
4504
  */
3879
4505
  export interface TelemetryConfigurationUpdate {
3880
4506
  /**
4507
+ * @public
3881
4508
  * Configure telemetry to be on or off.
3882
4509
  */
3883
4510
  Telemetry: Telemetry | string | undefined;
@@ -3887,10 +4514,12 @@ export interface TelemetryConfigurationUpdate {
3887
4514
  */
3888
4515
  export interface UpdateThingRuntimeConfigurationRequest {
3889
4516
  /**
4517
+ * @public
3890
4518
  * Configuration for telemetry service.
3891
4519
  */
3892
4520
  TelemetryConfiguration?: TelemetryConfigurationUpdate;
3893
4521
  /**
4522
+ * @public
3894
4523
  * The thing name.
3895
4524
  */
3896
4525
  ThingName: string | undefined;