@aws-sdk/client-iotfleetwise 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 +498 -0
  2. package/package.json +5 -5
package/dist-types/models/models_0.d.ts CHANGED
@@ -60,45 +60,55 @@ export type NodeDataType = (typeof NodeDataType)[keyof typeof NodeDataType];
60
60
  */
61
61
  export interface Actuator {
62
62
  /**
63
+ * @public
63
64
  * <p>The fully qualified name of the actuator. For example, the fully qualified name of an
64
65
  * actuator might be <code>Vehicle.Front.Left.Door.Lock</code>.</p>
65
66
  */
66
67
  fullyQualifiedName: string | undefined;
67
68
  /**
69
+ * @public
68
70
  * <p>The specified data type of the actuator. </p>
69
71
  */
70
72
  dataType: NodeDataType | string | undefined;
71
73
  /**
74
+ * @public
72
75
  * <p>A brief description of the actuator.</p>
73
76
  */
74
77
  description?: string;
75
78
  /**
79
+ * @public
76
80
  * <p>The scientific unit for the actuator.</p>
77
81
  */
78
82
  unit?: string;
79
83
  /**
84
+ * @public
80
85
  * <p>A list of possible values an actuator can take.</p>
81
86
  */
82
87
  allowedValues?: string[];
83
88
  /**
89
+ * @public
84
90
  * <p>The specified possible minimum value of an actuator.</p>
85
91
  */
86
92
  min?: number;
87
93
  /**
94
+ * @public
88
95
  * <p>The specified possible maximum value of an actuator.</p>
89
96
  */
90
97
  max?: number;
91
98
  /**
99
+ * @public
92
100
  * @deprecated
93
101
  *
94
102
  * <p>A specified value for the actuator.</p>
95
103
  */
96
104
  assignedValue?: string;
97
105
  /**
106
+ * @public
98
107
  * <p>The deprecation message for the node or the branch that was moved or deleted.</p>
99
108
  */
100
109
  deprecationMessage?: string;
101
110
  /**
111
+ * @public
102
112
  * <p>A comment in addition to the description.</p>
103
113
  */
104
114
  comment?: string;
@@ -108,10 +118,12 @@ export interface Actuator {
108
118
  */
109
119
  export interface AssociateVehicleFleetRequest {
110
120
  /**
121
+ * @public
111
122
  * <p> The unique ID of the vehicle to associate with the fleet. </p>
112
123
  */
113
124
  vehicleName: string | undefined;
114
125
  /**
126
+ * @public
115
127
  * <p> The ID of a fleet. </p>
116
128
  */
117
129
  fleetId: string | undefined;
@@ -129,6 +141,7 @@ export declare class InternalServerException extends __BaseException {
129
141
  readonly name: "InternalServerException";
130
142
  readonly $fault: "server";
131
143
  /**
144
+ * @public
132
145
  * <p>The number of seconds to wait before retrying the command.</p>
133
146
  */
134
147
  retryAfterSeconds?: number;
@@ -145,10 +158,12 @@ export declare class ResourceNotFoundException extends __BaseException {
145
158
  readonly name: "ResourceNotFoundException";
146
159
  readonly $fault: "client";
147
160
  /**
161
+ * @public
148
162
  * <p>The identifier of the resource that wasn't found.</p>
149
163
  */
150
164
  resourceId: string | undefined;
151
165
  /**
166
+ * @public
152
167
  * <p>The type of resource that wasn't found.</p>
153
168
  */
154
169
  resourceType: string | undefined;
@@ -165,14 +180,17 @@ export declare class ThrottlingException extends __BaseException {
165
180
  readonly name: "ThrottlingException";
166
181
  readonly $fault: "client";
167
182
  /**
183
+ * @public
168
184
  * <p>The quota identifier of the applied throttling rules for this request.</p>
169
185
  */
170
186
  quotaCode?: string;
171
187
  /**
188
+ * @public
172
189
  * <p>The code for the service that couldn't be completed due to throttling.</p>
173
190
  */
174
191
  serviceCode?: string;
175
192
  /**
193
+ * @public
176
194
  * <p>The number of seconds to wait before retrying the command.</p>
177
195
  */
178
196
  retryAfterSeconds?: number;
@@ -188,10 +206,12 @@ export declare class ThrottlingException extends __BaseException {
188
206
  */
189
207
  export interface ValidationExceptionField {
190
208
  /**
209
+ * @public
191
210
  * <p>The name of the parameter field with the validation error.</p>
192
211
  */
193
212
  name: string | undefined;
194
213
  /**
214
+ * @public
195
215
  * <p>A message about the validation error.</p>
196
216
  */
197
217
  message: string | undefined;
@@ -218,10 +238,12 @@ export declare class ValidationException extends __BaseException {
218
238
  readonly name: "ValidationException";
219
239
  readonly $fault: "client";
220
240
  /**
241
+ * @public
221
242
  * <p>The reason the input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
222
243
  */
223
244
  reason?: ValidationExceptionReason | string;
224
245
  /**
246
+ * @public
225
247
  * <p>The list of fields that fail to satisfy the constraints specified by an Amazon Web Services service.</p>
226
248
  */
227
249
  fieldList?: ValidationExceptionField[];
@@ -237,49 +259,60 @@ export declare class ValidationException extends __BaseException {
237
259
  */
238
260
  export interface Attribute {
239
261
  /**
262
+ * @public
240
263
  * <p>The fully qualified name of the attribute. For example, the fully qualified name of an
241
264
  * attribute might be <code>Vehicle.Body.Engine.Type</code>.</p>
242
265
  */
243
266
  fullyQualifiedName: string | undefined;
244
267
  /**
268
+ * @public
245
269
  * <p>The specified data type of the attribute. </p>
246
270
  */
247
271
  dataType: NodeDataType | string | undefined;
248
272
  /**
273
+ * @public
249
274
  * <p>A brief description of the attribute.</p>
250
275
  */
251
276
  description?: string;
252
277
  /**
278
+ * @public
253
279
  * <p>The scientific unit for the attribute.</p>
254
280
  */
255
281
  unit?: string;
256
282
  /**
283
+ * @public
257
284
  * <p>A list of possible values an attribute can be assigned.</p>
258
285
  */
259
286
  allowedValues?: string[];
260
287
  /**
288
+ * @public
261
289
  * <p>The specified possible minimum value of the attribute.</p>
262
290
  */
263
291
  min?: number;
264
292
  /**
293
+ * @public
265
294
  * <p>The specified possible maximum value of the attribute.</p>
266
295
  */
267
296
  max?: number;
268
297
  /**
298
+ * @public
269
299
  * @deprecated
270
300
  *
271
301
  * <p>A specified value for the attribute.</p>
272
302
  */
273
303
  assignedValue?: string;
274
304
  /**
305
+ * @public
275
306
  * <p>The default value of the attribute.</p>
276
307
  */
277
308
  defaultValue?: string;
278
309
  /**
310
+ * @public
279
311
  * <p>The deprecation message for the node or the branch that was moved or deleted.</p>
280
312
  */
281
313
  deprecationMessage?: string;
282
314
  /**
315
+ * @public
283
316
  * <p>A comment in addition to the description.</p>
284
317
  */
285
318
  comment?: string;
@@ -302,10 +335,12 @@ export type VehicleAssociationBehavior = (typeof VehicleAssociationBehavior)[key
302
335
  */
303
336
  export interface Tag {
304
337
  /**
338
+ * @public
305
339
  * <p>The tag's key.</p>
306
340
  */
307
341
  Key: string | undefined;
308
342
  /**
343
+ * @public
309
344
  * <p>The tag's value.</p>
310
345
  */
311
346
  Value: string | undefined;
@@ -316,30 +351,36 @@ export interface Tag {
316
351
  */
317
352
  export interface CreateVehicleRequestItem {
318
353
  /**
354
+ * @public
319
355
  * <p>The unique ID of the vehicle to create.</p>
320
356
  */
321
357
  vehicleName: string | undefined;
322
358
  /**
359
+ * @public
323
360
  * <p>The ARN of the vehicle model (model manifest) to create the vehicle from.</p>
324
361
  */
325
362
  modelManifestArn: string | undefined;
326
363
  /**
364
+ * @public
327
365
  * <p>The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
328
366
  * </p>
329
367
  */
330
368
  decoderManifestArn: string | undefined;
331
369
  /**
370
+ * @public
332
371
  * <p>Static information about a vehicle in a key-value pair. For example: <code>"engine
333
372
  * Type"</code> : <code>"v6"</code>
334
373
  * </p>
335
374
  */
336
375
  attributes?: Record<string, string>;
337
376
  /**
377
+ * @public
338
378
  * <p>An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
339
379
  * existing thing as a vehicle.</p>
340
380
  */
341
381
  associationBehavior?: VehicleAssociationBehavior | string;
342
382
  /**
383
+ * @public
343
384
  * <p>Metadata which can be used to manage the vehicle.</p>
344
385
  */
345
386
  tags?: Tag[];
@@ -349,6 +390,7 @@ export interface CreateVehicleRequestItem {
349
390
  */
350
391
  export interface BatchCreateVehicleRequest {
351
392
  /**
393
+ * @public
352
394
  * <p> A list of information about each vehicle to create. For more information, see the
353
395
  * API data type.</p>
354
396
  */
@@ -360,14 +402,17 @@ export interface BatchCreateVehicleRequest {
360
402
  */
361
403
  export interface CreateVehicleError {
362
404
  /**
405
+ * @public
363
406
  * <p>The ID of the vehicle with the error.</p>
364
407
  */
365
408
  vehicleName?: string;
366
409
  /**
410
+ * @public
367
411
  * <p>An HTTP error code.</p>
368
412
  */
369
413
  code?: string;
370
414
  /**
415
+ * @public
371
416
  * <p>A description of the HTTP error.</p>
372
417
  */
373
418
  message?: string;
@@ -378,14 +423,17 @@ export interface CreateVehicleError {
378
423
  */
379
424
  export interface CreateVehicleResponseItem {
380
425
  /**
426
+ * @public
381
427
  * <p>The unique ID of the vehicle to create.</p>
382
428
  */
383
429
  vehicleName?: string;
384
430
  /**
431
+ * @public
385
432
  * <p>The ARN of the created vehicle.</p>
386
433
  */
387
434
  arn?: string;
388
435
  /**
436
+ * @public
389
437
  * <p>The ARN of a created or validated Amazon Web Services IoT thing.</p>
390
438
  */
391
439
  thingArn?: string;
@@ -395,11 +443,13 @@ export interface CreateVehicleResponseItem {
395
443
  */
396
444
  export interface BatchCreateVehicleResponse {
397
445
  /**
446
+ * @public
398
447
  * <p> A list of information about a batch of created vehicles. For more information, see
399
448
  * the API data type.</p>
400
449
  */
401
450
  vehicles?: CreateVehicleResponseItem[];
402
451
  /**
452
+ * @public
403
453
  * <p>A list of information about creation errors, or an empty list if there aren't any
404
454
  * errors. </p>
405
455
  */
@@ -413,10 +463,12 @@ export declare class LimitExceededException extends __BaseException {
413
463
  readonly name: "LimitExceededException";
414
464
  readonly $fault: "client";
415
465
  /**
466
+ * @public
416
467
  * <p>The identifier of the resource that was exceeded.</p>
417
468
  */
418
469
  resourceId: string | undefined;
419
470
  /**
471
+ * @public
420
472
  * <p>The type of resource that was exceeded.</p>
421
473
  */
422
474
  resourceType: string | undefined;
@@ -443,18 +495,22 @@ export type UpdateMode = (typeof UpdateMode)[keyof typeof UpdateMode];
443
495
  */
444
496
  export interface UpdateVehicleRequestItem {
445
497
  /**
498
+ * @public
446
499
  * <p>The unique ID of the vehicle to update.</p>
447
500
  */
448
501
  vehicleName: string | undefined;
449
502
  /**
503
+ * @public
450
504
  * <p>The ARN of the vehicle model (model manifest) associated with the vehicle to update.</p>
451
505
  */
452
506
  modelManifestArn?: string;
453
507
  /**
508
+ * @public
454
509
  * <p>The ARN of the signal decoder manifest associated with the vehicle to update.</p>
455
510
  */
456
511
  decoderManifestArn?: string;
457
512
  /**
513
+ * @public
458
514
  * <p>Static information about a vehicle in a key-value pair. For example:</p>
459
515
  * <p>
460
516
  * <code>"engineType"</code> : <code>"1.3 L R2"</code>
@@ -462,6 +518,7 @@ export interface UpdateVehicleRequestItem {
462
518
  */
463
519
  attributes?: Record<string, string>;
464
520
  /**
521
+ * @public
465
522
  * <p>The method the specified attributes will update the existing attributes on the
466
523
  * vehicle. Use<code>Overwite</code> to replace the vehicle attributes with the specified
467
524
  * attributes. Or use <code>Merge</code> to combine all attributes.</p>
@@ -474,6 +531,7 @@ export interface UpdateVehicleRequestItem {
474
531
  */
475
532
  export interface BatchUpdateVehicleRequest {
476
533
  /**
534
+ * @public
477
535
  * <p> A list of information about the vehicles to update. For more information, see the
478
536
  * API data type.</p>
479
537
  */
@@ -485,14 +543,17 @@ export interface BatchUpdateVehicleRequest {
485
543
  */
486
544
  export interface UpdateVehicleError {
487
545
  /**
546
+ * @public
488
547
  * <p>The ID of the vehicle with the error.</p>
489
548
  */
490
549
  vehicleName?: string;
491
550
  /**
551
+ * @public
492
552
  * <p>The relevant HTTP error code (400+).</p>
493
553
  */
494
554
  code?: number;
495
555
  /**
556
+ * @public
496
557
  * <p>A message associated with the error.</p>
497
558
  */
498
559
  message?: string;
@@ -503,10 +564,12 @@ export interface UpdateVehicleError {
503
564
  */
504
565
  export interface UpdateVehicleResponseItem {
505
566
  /**
567
+ * @public
506
568
  * <p>The unique ID of the updated vehicle.</p>
507
569
  */
508
570
  vehicleName?: string;
509
571
  /**
572
+ * @public
510
573
  * <p>The Amazon Resource Name (ARN) of the updated vehicle.</p>
511
574
  */
512
575
  arn?: string;
@@ -516,6 +579,7 @@ export interface UpdateVehicleResponseItem {
516
579
  */
517
580
  export interface BatchUpdateVehicleResponse {
518
581
  /**
582
+ * @public
519
583
  * <p> A list of information about the batch of updated vehicles. </p>
520
584
  * <note>
521
585
  * <p>This list contains only unique IDs for the vehicles that were updated.</p>
@@ -523,6 +587,7 @@ export interface BatchUpdateVehicleResponse {
523
587
  */
524
588
  vehicles?: UpdateVehicleResponseItem[];
525
589
  /**
590
+ * @public
526
591
  * <p>A list of information about errors returned while updating a batch of vehicles, or, if
527
592
  * there aren't any errors, an empty list.</p>
528
593
  */
@@ -534,19 +599,23 @@ export interface BatchUpdateVehicleResponse {
534
599
  */
535
600
  export interface Branch {
536
601
  /**
602
+ * @public
537
603
  * <p>The fully qualified name of the branch. For example, the fully qualified name of a
538
604
  * branch might be <code>Vehicle.Body.Engine</code>.</p>
539
605
  */
540
606
  fullyQualifiedName: string | undefined;
541
607
  /**
608
+ * @public
542
609
  * <p>A brief description of the branch.</p>
543
610
  */
544
611
  description?: string;
545
612
  /**
613
+ * @public
546
614
  * <p>The deprecation message for the node or the branch that was moved or deleted.</p>
547
615
  */
548
616
  deprecationMessage?: string;
549
617
  /**
618
+ * @public
550
619
  * <p>A comment in addition to the description.</p>
551
620
  */
552
621
  comment?: string;
@@ -560,10 +629,12 @@ export declare class ConflictException extends __BaseException {
560
629
  readonly name: "ConflictException";
561
630
  readonly $fault: "client";
562
631
  /**
632
+ * @public
563
633
  * <p>The resource on which there are conflicting operations.</p>
564
634
  */
565
635
  resource: string | undefined;
566
636
  /**
637
+ * @public
567
638
  * <p>The type of resource on which there are conflicting operations..</p>
568
639
  */
569
640
  resourceType: string | undefined;
@@ -591,11 +662,13 @@ export type TriggerMode = (typeof TriggerMode)[keyof typeof TriggerMode];
591
662
  */
592
663
  export interface ConditionBasedCollectionScheme {
593
664
  /**
665
+ * @public
594
666
  * <p>The logical expression used to recognize what data to collect. For example,
595
667
  * <code>$variable.Vehicle.OutsideAirTemperature &gt;= 105.0</code>.</p>
596
668
  */
597
669
  expression: string | undefined;
598
670
  /**
671
+ * @public
599
672
  * <p>The minimum duration of time between two triggering events to collect data, in
600
673
  * milliseconds.</p>
601
674
  * <note>
@@ -604,6 +677,7 @@ export interface ConditionBasedCollectionScheme {
604
677
  */
605
678
  minimumTriggerIntervalMs?: number;
606
679
  /**
680
+ * @public
607
681
  * <p>Whether to collect data for all triggering events (<code>ALWAYS</code>). Specify
608
682
  * (<code>RISING_EDGE</code>), or specify only when the condition first evaluates to
609
683
  * false. For example, triggering on "AirbagDeployed"; Users aren't interested on
@@ -612,6 +686,7 @@ export interface ConditionBasedCollectionScheme {
612
686
  */
613
687
  triggerMode?: TriggerMode | string;
614
688
  /**
689
+ * @public
615
690
  * <p>Specifies the version of the conditional expression language.</p>
616
691
  */
617
692
  conditionLanguageVersion?: number;
@@ -623,6 +698,7 @@ export interface ConditionBasedCollectionScheme {
623
698
  */
624
699
  export interface TimeBasedCollectionScheme {
625
700
  /**
701
+ * @public
626
702
  * <p>The time period (in milliseconds) to decide how often to collect data. For example,
627
703
  * if the time period is <code>60000</code>, the Edge Agent software collects data once
628
704
  * every minute.</p>
@@ -639,6 +715,7 @@ export type CollectionScheme = CollectionScheme.ConditionBasedCollectionSchemeMe
639
715
  */
640
716
  export declare namespace CollectionScheme {
641
717
  /**
718
+ * @public
642
719
  * <p>Information about a collection scheme that uses a time period to decide how often to
643
720
  * collect data.</p>
644
721
  */
@@ -648,6 +725,7 @@ export declare namespace CollectionScheme {
648
725
  $unknown?: never;
649
726
  }
650
727
  /**
728
+ * @public
651
729
  * <p>Information about a collection scheme that uses a simple logical expression to
652
730
  * recognize what data to collect.</p>
653
731
  */
@@ -656,6 +734,9 @@ export declare namespace CollectionScheme {
656
734
  conditionBasedCollectionScheme: ConditionBasedCollectionScheme;
657
735
  $unknown?: never;
658
736
  }
737
+ /**
738
+ * @public
739
+ */
659
740
  interface $UnknownMember {
660
741
  timeBasedCollectionScheme?: never;
661
742
  conditionBasedCollectionScheme?: never;
@@ -710,10 +791,12 @@ export type StorageCompressionFormat = (typeof StorageCompressionFormat)[keyof t
710
791
  */
711
792
  export interface S3Config {
712
793
  /**
794
+ * @public
713
795
  * <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket.</p>
714
796
  */
715
797
  bucketArn: string | undefined;
716
798
  /**
799
+ * @public
717
800
  * <p>Specify the format that files are saved in the Amazon S3 bucket. You can save files in an Apache Parquet or JSON format.</p>
718
801
  * <ul>
719
802
  * <li>
@@ -728,11 +811,13 @@ export interface S3Config {
728
811
  */
729
812
  dataFormat?: DataFormat | string;
730
813
  /**
814
+ * @public
731
815
  * <p>By default, stored data is compressed as a .gzip file. Compressed files have a reduced
732
816
  * file size, which can optimize the cost of data storage.</p>
733
817
  */
734
818
  storageCompressionFormat?: StorageCompressionFormat | string;
735
819
  /**
820
+ * @public
736
821
  * <p>(Optional) Enter an S3 bucket prefix. The prefix is the string of characters after the bucket name and before the object name. You can use the prefix to organize data stored in Amazon S3 buckets. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html">Organizing objects using prefixes</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
737
822
  * <p>By default, Amazon Web Services IoT FleetWise sets the prefix <code>processed-data/year=YY/month=MM/date=DD/hour=HH/</code> (in UTC) to data it delivers to Amazon S3. You can enter a prefix to append it to this default prefix. For example, if you enter the prefix <code>vehicles</code>, the prefix will be <code>vehicles/processed-data/year=YY/month=MM/date=DD/hour=HH/</code>.</p>
738
823
  */
@@ -744,10 +829,12 @@ export interface S3Config {
744
829
  */
745
830
  export interface TimestreamConfig {
746
831
  /**
832
+ * @public
747
833
  * <p>The Amazon Resource Name (ARN) of the Amazon Timestream table.</p>
748
834
  */
749
835
  timestreamTableArn: string | undefined;
750
836
  /**
837
+ * @public
751
838
  * <p>The Amazon Resource Name (ARN) of the task execution role that grants Amazon Web Services IoT FleetWise permission to deliver data to the Amazon Timestream table.</p>
752
839
  */
753
840
  executionRoleArn: string | undefined;
@@ -762,6 +849,7 @@ export type DataDestinationConfig = DataDestinationConfig.S3ConfigMember | DataD
762
849
  */
763
850
  export declare namespace DataDestinationConfig {
764
851
  /**
852
+ * @public
765
853
  * <p>The Amazon S3 bucket where the Amazon Web Services IoT FleetWise campaign sends data.</p>
766
854
  */
767
855
  interface S3ConfigMember {
@@ -770,6 +858,7 @@ export declare namespace DataDestinationConfig {
770
858
  $unknown?: never;
771
859
  }
772
860
  /**
861
+ * @public
773
862
  * <p>The Amazon Timestream table where the campaign sends data.</p>
774
863
  */
775
864
  interface TimestreamConfigMember {
@@ -777,6 +866,9 @@ export declare namespace DataDestinationConfig {
777
866
  timestreamConfig: TimestreamConfig;
778
867
  $unknown?: never;
779
868
  }
869
+ /**
870
+ * @public
871
+ */
780
872
  interface $UnknownMember {
781
873
  s3Config?: never;
782
874
  timestreamConfig?: never;
@@ -807,14 +899,17 @@ export type DiagnosticsMode = (typeof DiagnosticsMode)[keyof typeof DiagnosticsM
807
899
  */
808
900
  export interface SignalInformation {
809
901
  /**
902
+ * @public
810
903
  * <p>The name of the signal.</p>
811
904
  */
812
905
  name: string | undefined;
813
906
  /**
907
+ * @public
814
908
  * <p>The maximum number of samples to collect.</p>
815
909
  */
816
910
  maxSampleCount?: number;
817
911
  /**
912
+ * @public
818
913
  * <p>The minimum duration of time (in milliseconds) between two triggering events to
819
914
  * collect data.</p>
820
915
  * <note>
@@ -840,23 +935,28 @@ export type SpoolingMode = (typeof SpoolingMode)[keyof typeof SpoolingMode];
840
935
  */
841
936
  export interface CreateCampaignRequest {
842
937
  /**
938
+ * @public
843
939
  * <p> The name of the campaign to create. </p>
844
940
  */
845
941
  name: string | undefined;
846
942
  /**
943
+ * @public
847
944
  * <p>An optional description of the campaign to help identify its purpose.</p>
848
945
  */
849
946
  description?: string;
850
947
  /**
948
+ * @public
851
949
  * <p>(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
852
950
  * </p>
853
951
  */
854
952
  signalCatalogArn: string | undefined;
855
953
  /**
954
+ * @public
856
955
  * <p> The ARN of the vehicle or fleet to deploy a campaign to. </p>
857
956
  */
858
957
  targetArn: string | undefined;
859
958
  /**
959
+ * @public
860
960
  * <p>(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If
861
961
  * it's not specified, <code>0</code> is used.</p>
862
962
  * <p>Default: <code>0</code>
@@ -864,12 +964,14 @@ export interface CreateCampaignRequest {
864
964
  */
865
965
  startTime?: Date;
866
966
  /**
967
+ * @public
867
968
  * <p> (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at
868
969
  * midnight UTC time). Vehicle data isn't collected after the campaign expires. </p>
869
970
  * <p>Default: 253402214400 (December 31, 9999, 00:00:00 UTC)</p>
870
971
  */
871
972
  expiryTime?: Date;
872
973
  /**
974
+ * @public
873
975
  * <p> (Optional) How long (in milliseconds) to collect raw data after a triggering event
874
976
  * initiates the collection. If it's not specified, <code>0</code> is used.</p>
875
977
  * <p>Default: <code>0</code>
@@ -877,6 +979,7 @@ export interface CreateCampaignRequest {
877
979
  */
878
980
  postTriggerCollectionDuration?: number;
879
981
  /**
982
+ * @public
880
983
  * <p> (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you
881
984
  * want to send diagnostic trouble codes, use <code>SEND_ACTIVE_DTCS</code>. If it's not
882
985
  * specified, <code>OFF</code> is used.</p>
@@ -885,6 +988,7 @@ export interface CreateCampaignRequest {
885
988
  */
886
989
  diagnosticsMode?: DiagnosticsMode | string;
887
990
  /**
991
+ * @public
888
992
  * <p>(Optional) Whether to store collected data after a vehicle lost a connection with the
889
993
  * cloud. After a connection is re-established, the data is automatically forwarded to
890
994
  * Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the
@@ -894,6 +998,7 @@ export interface CreateCampaignRequest {
894
998
  */
895
999
  spoolingMode?: SpoolingMode | string;
896
1000
  /**
1001
+ * @public
897
1002
  * <p> (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you
898
1003
  * don't want to compress the signals, use <code>OFF</code>. If it's not specified,
899
1004
  * <code>SNAPPY</code> is used. </p>
@@ -902,6 +1007,7 @@ export interface CreateCampaignRequest {
902
1007
  */
903
1008
  compression?: Compression | string;
904
1009
  /**
1010
+ * @public
905
1011
  * <p>(Optional) A number indicating the priority of one campaign over another campaign for
906
1012
  * a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles
907
1013
  * before any other campaigns. If it's not specified, <code>0</code> is used. </p>
@@ -910,25 +1016,30 @@ export interface CreateCampaignRequest {
910
1016
  */
911
1017
  priority?: number;
912
1018
  /**
1019
+ * @public
913
1020
  * <p>(Optional) A list of information about signals to collect. </p>
914
1021
  */
915
1022
  signalsToCollect?: SignalInformation[];
916
1023
  /**
1024
+ * @public
917
1025
  * <p> The data collection scheme associated with the campaign. You can specify a scheme
918
1026
  * that collects data based on time or an event.</p>
919
1027
  */
920
1028
  collectionScheme: CollectionScheme | undefined;
921
1029
  /**
1030
+ * @public
922
1031
  * <p> (Optional) A list of vehicle attributes to associate with a campaign. </p>
923
1032
  * <p>Enrich the data with specified vehicle attributes. For example, add <code>make</code> and <code>model</code> to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against <code>make</code> and <code>model</code>.</p>
924
1033
  * <p>Default: An empty array</p>
925
1034
  */
926
1035
  dataExtraDimensions?: string[];
927
1036
  /**
1037
+ * @public
928
1038
  * <p>Metadata that can be used to manage the campaign.</p>
929
1039
  */
930
1040
  tags?: Tag[];
931
1041
  /**
1042
+ * @public
932
1043
  * <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
933
1044
  * <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. </p>
934
1045
  * <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query
@@ -941,10 +1052,12 @@ export interface CreateCampaignRequest {
941
1052
  */
942
1053
  export interface CreateCampaignResponse {
943
1054
  /**
1055
+ * @public
944
1056
  * <p>The name of the created campaign.</p>
945
1057
  */
946
1058
  name?: string;
947
1059
  /**
1060
+ * @public
948
1061
  * <p> The ARN of the created campaign. </p>
949
1062
  */
950
1063
  arn?: string;
@@ -954,6 +1067,7 @@ export interface CreateCampaignResponse {
954
1067
  */
955
1068
  export interface DeleteCampaignRequest {
956
1069
  /**
1070
+ * @public
957
1071
  * <p> The name of the campaign to delete. </p>
958
1072
  */
959
1073
  name: string | undefined;
@@ -963,10 +1077,12 @@ export interface DeleteCampaignRequest {
963
1077
  */
964
1078
  export interface DeleteCampaignResponse {
965
1079
  /**
1080
+ * @public
966
1081
  * <p>The name of the deleted campaign.</p>
967
1082
  */
968
1083
  name?: string;
969
1084
  /**
1085
+ * @public
970
1086
  * <p> The Amazon Resource Name (ARN) of the deleted campaign.</p>
971
1087
  * <note>
972
1088
  * <p>The ARN isn’t returned if a campaign doesn’t exist.</p>
@@ -979,6 +1095,7 @@ export interface DeleteCampaignResponse {
979
1095
  */
980
1096
  export interface GetCampaignRequest {
981
1097
  /**
1098
+ * @public
982
1099
  * <p> The name of the campaign to retrieve information about. </p>
983
1100
  */
984
1101
  name: string | undefined;
@@ -1002,89 +1119,108 @@ export type CampaignStatus = (typeof CampaignStatus)[keyof typeof CampaignStatus
1002
1119
  */
1003
1120
  export interface GetCampaignResponse {
1004
1121
  /**
1122
+ * @public
1005
1123
  * <p>The name of the campaign.</p>
1006
1124
  */
1007
1125
  name?: string;
1008
1126
  /**
1127
+ * @public
1009
1128
  * <p> The Amazon Resource Name (ARN) of the campaign. </p>
1010
1129
  */
1011
1130
  arn?: string;
1012
1131
  /**
1132
+ * @public
1013
1133
  * <p>The description of the campaign.</p>
1014
1134
  */
1015
1135
  description?: string;
1016
1136
  /**
1137
+ * @public
1017
1138
  * <p> The ARN of a signal catalog. </p>
1018
1139
  */
1019
1140
  signalCatalogArn?: string;
1020
1141
  /**
1142
+ * @public
1021
1143
  * <p> The ARN of the vehicle or the fleet targeted by the campaign. </p>
1022
1144
  */
1023
1145
  targetArn?: string;
1024
1146
  /**
1147
+ * @public
1025
1148
  * <p>The state of the campaign. The status can be one of: <code>CREATING</code>,
1026
1149
  * <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, and <code>SUSPENDED</code>.
1027
1150
  * </p>
1028
1151
  */
1029
1152
  status?: CampaignStatus | string;
1030
1153
  /**
1154
+ * @public
1031
1155
  * <p> The time, in milliseconds, to deliver a campaign after it was approved.</p>
1032
1156
  */
1033
1157
  startTime?: Date;
1034
1158
  /**
1159
+ * @public
1035
1160
  * <p> The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight
1036
1161
  * UTC time). Vehicle data won't be collected after the campaign expires.</p>
1037
1162
  */
1038
1163
  expiryTime?: Date;
1039
1164
  /**
1165
+ * @public
1040
1166
  * <p> How long (in seconds) to collect raw data after a triggering event initiates the
1041
1167
  * collection. </p>
1042
1168
  */
1043
1169
  postTriggerCollectionDuration?: number;
1044
1170
  /**
1171
+ * @public
1045
1172
  * <p> Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. </p>
1046
1173
  */
1047
1174
  diagnosticsMode?: DiagnosticsMode | string;
1048
1175
  /**
1176
+ * @public
1049
1177
  * <p> Whether to store collected data after a vehicle lost a connection with the cloud.
1050
1178
  * After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise.
1051
1179
  * </p>
1052
1180
  */
1053
1181
  spoolingMode?: SpoolingMode | string;
1054
1182
  /**
1183
+ * @public
1055
1184
  * <p> Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If
1056
1185
  * <code>OFF</code> is specified, the signals aren't compressed. If it's not specified,
1057
1186
  * <code>SNAPPY</code> is used. </p>
1058
1187
  */
1059
1188
  compression?: Compression | string;
1060
1189
  /**
1190
+ * @public
1061
1191
  * <p> A number indicating the priority of one campaign over another campaign for a certain
1062
1192
  * vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any
1063
1193
  * other campaigns.</p>
1064
1194
  */
1065
1195
  priority?: number;
1066
1196
  /**
1197
+ * @public
1067
1198
  * <p> Information about a list of signals to collect data on. </p>
1068
1199
  */
1069
1200
  signalsToCollect?: SignalInformation[];
1070
1201
  /**
1202
+ * @public
1071
1203
  * <p> Information about the data collection scheme associated with the campaign. </p>
1072
1204
  */
1073
1205
  collectionScheme?: CollectionScheme;
1074
1206
  /**
1207
+ * @public
1075
1208
  * <p> A list of vehicle attributes associated with the campaign. </p>
1076
1209
  */
1077
1210
  dataExtraDimensions?: string[];
1078
1211
  /**
1212
+ * @public
1079
1213
  * <p> The time the campaign was created in seconds since epoch (January 1, 1970 at midnight
1080
1214
  * UTC time). </p>
1081
1215
  */
1082
1216
  creationTime?: Date;
1083
1217
  /**
1218
+ * @public
1084
1219
  * <p>The last time the campaign was modified.</p>
1085
1220
  */
1086
1221
  lastModificationTime?: Date;
1087
1222
  /**
1223
+ * @public
1088
1224
  * <p>The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.</p>
1089
1225
  * <p>Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. </p>
1090
1226
  * <p>You can use Amazon Timestream to access and analyze time series data, and Timestream to query
@@ -1097,15 +1233,18 @@ export interface GetCampaignResponse {
1097
1233
  */
1098
1234
  export interface ListCampaignsRequest {
1099
1235
  /**
1236
+ * @public
1100
1237
  * <p>A pagination token for the next set of results.</p>
1101
1238
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
1102
1239
  */
1103
1240
  nextToken?: string;
1104
1241
  /**
1242
+ * @public
1105
1243
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
1106
1244
  */
1107
1245
  maxResults?: number;
1108
1246
  /**
1247
+ * @public
1109
1248
  * <p>Optional parameter to filter the results by the status of each created campaign in
1110
1249
  * your account. The status can be one of: <code>CREATING</code>,
1111
1250
  * <code>WAITING_FOR_APPROVAL</code>, <code>RUNNING</code>, or
@@ -1121,26 +1260,32 @@ export interface ListCampaignsRequest {
1121
1260
  */
1122
1261
  export interface CampaignSummary {
1123
1262
  /**
1263
+ * @public
1124
1264
  * <p>The Amazon Resource Name (ARN) of a campaign.</p>
1125
1265
  */
1126
1266
  arn?: string;
1127
1267
  /**
1268
+ * @public
1128
1269
  * <p>The name of a campaign.</p>
1129
1270
  */
1130
1271
  name?: string;
1131
1272
  /**
1273
+ * @public
1132
1274
  * <p>The description of the campaign.</p>
1133
1275
  */
1134
1276
  description?: string;
1135
1277
  /**
1278
+ * @public
1136
1279
  * <p>The ARN of the signal catalog associated with the campaign.</p>
1137
1280
  */
1138
1281
  signalCatalogArn?: string;
1139
1282
  /**
1283
+ * @public
1140
1284
  * <p>The ARN of a vehicle or fleet to which the campaign is deployed.</p>
1141
1285
  */
1142
1286
  targetArn?: string;
1143
1287
  /**
1288
+ * @public
1144
1289
  * <p>The state of a campaign. The status can be one of the following:</p>
1145
1290
  * <ul>
1146
1291
  * <li>
@@ -1168,10 +1313,12 @@ export interface CampaignSummary {
1168
1313
  */
1169
1314
  status?: CampaignStatus | string;
1170
1315
  /**
1316
+ * @public
1171
1317
  * <p>The time the campaign was created.</p>
1172
1318
  */
1173
1319
  creationTime: Date | undefined;
1174
1320
  /**
1321
+ * @public
1175
1322
  * <p>The last time the campaign was modified.</p>
1176
1323
  */
1177
1324
  lastModificationTime: Date | undefined;
@@ -1181,10 +1328,12 @@ export interface CampaignSummary {
1181
1328
  */
1182
1329
  export interface ListCampaignsResponse {
1183
1330
  /**
1331
+ * @public
1184
1332
  * <p> A summary of information about each campaign. </p>
1185
1333
  */
1186
1334
  campaignSummaries?: CampaignSummary[];
1187
1335
  /**
1336
+ * @public
1188
1337
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
1189
1338
  */
1190
1339
  nextToken?: string;
@@ -1208,19 +1357,23 @@ export type UpdateCampaignAction = (typeof UpdateCampaignAction)[keyof typeof Up
1208
1357
  */
1209
1358
  export interface UpdateCampaignRequest {
1210
1359
  /**
1360
+ * @public
1211
1361
  * <p> The name of the campaign to update. </p>
1212
1362
  */
1213
1363
  name: string | undefined;
1214
1364
  /**
1365
+ * @public
1215
1366
  * <p>The description of the campaign.</p>
1216
1367
  */
1217
1368
  description?: string;
1218
1369
  /**
1370
+ * @public
1219
1371
  * <p> A list of vehicle attributes to associate with a signal. </p>
1220
1372
  * <p>Default: An empty array</p>
1221
1373
  */
1222
1374
  dataExtraDimensions?: string[];
1223
1375
  /**
1376
+ * @public
1224
1377
  * <p> Specifies how to update a campaign. The action can be one of the following:</p>
1225
1378
  * <ul>
1226
1379
  * <li>
@@ -1249,14 +1402,17 @@ export interface UpdateCampaignRequest {
1249
1402
  */
1250
1403
  export interface UpdateCampaignResponse {
1251
1404
  /**
1405
+ * @public
1252
1406
  * <p> The Amazon Resource Name (ARN) of the campaign. </p>
1253
1407
  */
1254
1408
  arn?: string;
1255
1409
  /**
1410
+ * @public
1256
1411
  * <p>The name of the updated campaign.</p>
1257
1412
  */
1258
1413
  name?: string;
1259
1414
  /**
1415
+ * @public
1260
1416
  * <p>The state of a campaign. The status can be one of:</p>
1261
1417
  * <ul>
1262
1418
  * <li>
@@ -1290,15 +1446,18 @@ export interface UpdateCampaignResponse {
1290
1446
  */
1291
1447
  export interface CanDbcDefinition {
1292
1448
  /**
1449
+ * @public
1293
1450
  * <p>Contains information about a network interface.</p>
1294
1451
  */
1295
1452
  networkInterface: string | undefined;
1296
1453
  /**
1454
+ * @public
1297
1455
  * <p>A list of DBC files. You can upload only one DBC file for each network interface and
1298
1456
  * specify up to five (inclusive) files in the list.</p>
1299
1457
  */
1300
1458
  canDbcFiles: Uint8Array[] | undefined;
1301
1459
  /**
1460
+ * @public
1302
1461
  * <p>Pairs every signal specified in your vehicle model with a signal decoder.</p>
1303
1462
  */
1304
1463
  signalsMap?: Record<string, string>;
@@ -1309,14 +1468,17 @@ export interface CanDbcDefinition {
1309
1468
  */
1310
1469
  export interface CanInterface {
1311
1470
  /**
1471
+ * @public
1312
1472
  * <p>The unique name of the interface.</p>
1313
1473
  */
1314
1474
  name: string | undefined;
1315
1475
  /**
1476
+ * @public
1316
1477
  * <p>The name of the communication protocol for the interface.</p>
1317
1478
  */
1318
1479
  protocolName?: string;
1319
1480
  /**
1481
+ * @public
1320
1482
  * <p>The version of the communication protocol for the interface.</p>
1321
1483
  */
1322
1484
  protocolVersion?: string;
@@ -1328,18 +1490,22 @@ export interface CanInterface {
1328
1490
  */
1329
1491
  export interface CanSignal {
1330
1492
  /**
1493
+ * @public
1331
1494
  * <p>The ID of the message.</p>
1332
1495
  */
1333
1496
  messageId: number | undefined;
1334
1497
  /**
1498
+ * @public
1335
1499
  * <p>Whether the byte ordering of a CAN message is big-endian.</p>
1336
1500
  */
1337
1501
  isBigEndian: boolean | undefined;
1338
1502
  /**
1503
+ * @public
1339
1504
  * <p>Whether the message data is specified as a signed value.</p>
1340
1505
  */
1341
1506
  isSigned: boolean | undefined;
1342
1507
  /**
1508
+ * @public
1343
1509
  * <p>Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).</p>
1344
1510
  * <p>This value might be different from the value in a DBC file. For little endian signals,
1345
1511
  * <code>startBit</code> is the same value as in the DBC file. For big endian signals
@@ -1348,18 +1514,22 @@ export interface CanSignal {
1348
1514
  */
1349
1515
  startBit: number | undefined;
1350
1516
  /**
1517
+ * @public
1351
1518
  * <p>The offset used to calculate the signal value. Combined with factor, the calculation is <code>value = raw_value * factor + offset</code>.</p>
1352
1519
  */
1353
1520
  offset: number | undefined;
1354
1521
  /**
1522
+ * @public
1355
1523
  * <p>A multiplier used to decode the CAN message.</p>
1356
1524
  */
1357
1525
  factor: number | undefined;
1358
1526
  /**
1527
+ * @public
1359
1528
  * <p>How many bytes of data are in the message.</p>
1360
1529
  */
1361
1530
  length: number | undefined;
1362
1531
  /**
1532
+ * @public
1363
1533
  * <p>The name of the signal.</p>
1364
1534
  */
1365
1535
  name?: string;
@@ -1382,10 +1552,12 @@ export type LogType = (typeof LogType)[keyof typeof LogType];
1382
1552
  */
1383
1553
  export interface CloudWatchLogDeliveryOptions {
1384
1554
  /**
1555
+ * @public
1385
1556
  * <p>The type of log to send data to Amazon CloudWatch Logs.</p>
1386
1557
  */
1387
1558
  logType: LogType | string | undefined;
1388
1559
  /**
1560
+ * @public
1389
1561
  * <p>The Amazon CloudWatch Logs group the operation sends data to.</p>
1390
1562
  */
1391
1563
  logGroupName?: string;
@@ -1396,30 +1568,37 @@ export interface CloudWatchLogDeliveryOptions {
1396
1568
  */
1397
1569
  export interface ObdInterface {
1398
1570
  /**
1571
+ * @public
1399
1572
  * <p>The name of the interface.</p>
1400
1573
  */
1401
1574
  name: string | undefined;
1402
1575
  /**
1576
+ * @public
1403
1577
  * <p>The ID of the message requesting vehicle data.</p>
1404
1578
  */
1405
1579
  requestMessageId: number | undefined;
1406
1580
  /**
1581
+ * @public
1407
1582
  * <p>The standard OBD II PID.</p>
1408
1583
  */
1409
1584
  obdStandard?: string;
1410
1585
  /**
1586
+ * @public
1411
1587
  * <p>The maximum number message requests per second.</p>
1412
1588
  */
1413
1589
  pidRequestIntervalSeconds?: number;
1414
1590
  /**
1591
+ * @public
1415
1592
  * <p>The maximum number message requests per diagnostic trouble code per second.</p>
1416
1593
  */
1417
1594
  dtcRequestIntervalSeconds?: number;
1418
1595
  /**
1596
+ * @public
1419
1597
  * <p>Whether to use extended IDs in the message.</p>
1420
1598
  */
1421
1599
  useExtendedIds?: boolean;
1422
1600
  /**
1601
+ * @public
1423
1602
  * <p>Whether the vehicle has a transmission control module (TCM).</p>
1424
1603
  */
1425
1604
  hasTransmissionEcu?: boolean;
@@ -1446,10 +1625,12 @@ export type NetworkInterfaceType = (typeof NetworkInterfaceType)[keyof typeof Ne
1446
1625
  */
1447
1626
  export interface NetworkInterface {
1448
1627
  /**
1628
+ * @public
1449
1629
  * <p>The ID of the network interface.</p>
1450
1630
  */
1451
1631
  interfaceId: string | undefined;
1452
1632
  /**
1633
+ * @public
1453
1634
  * <p>The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies
1454
1635
  * a protocol that defines how data is communicated between electronic control units
1455
1636
  * (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic
@@ -1457,11 +1638,13 @@ export interface NetworkInterface {
1457
1638
  */
1458
1639
  type: NetworkInterfaceType | string | undefined;
1459
1640
  /**
1641
+ * @public
1460
1642
  * <p>Information about a network interface specified by the Controller Area Network (CAN)
1461
1643
  * protocol.</p>
1462
1644
  */
1463
1645
  canInterface?: CanInterface;
1464
1646
  /**
1647
+ * @public
1465
1648
  * <p>Information about a network interface specified by the On-board diagnostic (OBD) II
1466
1649
  * protocol.</p>
1467
1650
  */
@@ -1474,38 +1657,47 @@ export interface NetworkInterface {
1474
1657
  */
1475
1658
  export interface ObdSignal {
1476
1659
  /**
1660
+ * @public
1477
1661
  * <p>The length of the requested data.</p>
1478
1662
  */
1479
1663
  pidResponseLength: number | undefined;
1480
1664
  /**
1665
+ * @public
1481
1666
  * <p>The mode of operation (diagnostic service) in a message.</p>
1482
1667
  */
1483
1668
  serviceMode: number | undefined;
1484
1669
  /**
1670
+ * @public
1485
1671
  * <p>The diagnostic code used to request data from a vehicle for this signal.</p>
1486
1672
  */
1487
1673
  pid: number | undefined;
1488
1674
  /**
1675
+ * @public
1489
1676
  * <p>A multiplier used to decode the message.</p>
1490
1677
  */
1491
1678
  scaling: number | undefined;
1492
1679
  /**
1680
+ * @public
1493
1681
  * <p>The offset used to calculate the signal value. Combined with scaling, the calculation is <code>value = raw_value * scaling + offset</code>.</p>
1494
1682
  */
1495
1683
  offset: number | undefined;
1496
1684
  /**
1685
+ * @public
1497
1686
  * <p>Indicates the beginning of the message.</p>
1498
1687
  */
1499
1688
  startByte: number | undefined;
1500
1689
  /**
1690
+ * @public
1501
1691
  * <p>The length of a message.</p>
1502
1692
  */
1503
1693
  byteLength: number | undefined;
1504
1694
  /**
1695
+ * @public
1505
1696
  * <p>The number of positions to shift bits in the message.</p>
1506
1697
  */
1507
1698
  bitRightShift?: number;
1508
1699
  /**
1700
+ * @public
1509
1701
  * <p>The number of bits to mask in a message.</p>
1510
1702
  */
1511
1703
  bitMaskLength?: number;
@@ -1528,10 +1720,12 @@ export type SignalDecoderType = (typeof SignalDecoderType)[keyof typeof SignalDe
1528
1720
  */
1529
1721
  export interface SignalDecoder {
1530
1722
  /**
1723
+ * @public
1531
1724
  * <p>The fully qualified name of a signal decoder as defined in a vehicle model.</p>
1532
1725
  */
1533
1726
  fullyQualifiedName: string | undefined;
1534
1727
  /**
1728
+ * @public
1535
1729
  * <p>The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies
1536
1730
  * a protocol that defines how data is communicated between electronic control units
1537
1731
  * (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic
@@ -1539,14 +1733,17 @@ export interface SignalDecoder {
1539
1733
  */
1540
1734
  type: SignalDecoderType | string | undefined;
1541
1735
  /**
1736
+ * @public
1542
1737
  * <p>The ID of a network interface that specifies what network protocol a vehicle follows.</p>
1543
1738
  */
1544
1739
  interfaceId: string | undefined;
1545
1740
  /**
1741
+ * @public
1546
1742
  * <p>Information about signal decoder using the Controller Area Network (CAN) protocol.</p>
1547
1743
  */
1548
1744
  canSignal?: CanSignal;
1549
1745
  /**
1746
+ * @public
1550
1747
  * <p>Information about signal decoder using the On-board diagnostic (OBD) II protocol.</p>
1551
1748
  */
1552
1749
  obdSignal?: ObdSignal;
@@ -1556,26 +1753,32 @@ export interface SignalDecoder {
1556
1753
  */
1557
1754
  export interface CreateDecoderManifestRequest {
1558
1755
  /**
1756
+ * @public
1559
1757
  * <p> The unique name of the decoder manifest to create.</p>
1560
1758
  */
1561
1759
  name: string | undefined;
1562
1760
  /**
1761
+ * @public
1563
1762
  * <p> A brief description of the decoder manifest. </p>
1564
1763
  */
1565
1764
  description?: string;
1566
1765
  /**
1766
+ * @public
1567
1767
  * <p> The Amazon Resource Name (ARN) of the vehicle model (model manifest). </p>
1568
1768
  */
1569
1769
  modelManifestArn: string | undefined;
1570
1770
  /**
1771
+ * @public
1571
1772
  * <p> A list of information about signal decoders. </p>
1572
1773
  */
1573
1774
  signalDecoders?: SignalDecoder[];
1574
1775
  /**
1776
+ * @public
1575
1777
  * <p> A list of information about available network interfaces. </p>
1576
1778
  */
1577
1779
  networkInterfaces?: NetworkInterface[];
1578
1780
  /**
1781
+ * @public
1579
1782
  * <p>Metadata that can be used to manage the decoder manifest.</p>
1580
1783
  */
1581
1784
  tags?: Tag[];
@@ -1585,10 +1788,12 @@ export interface CreateDecoderManifestRequest {
1585
1788
  */
1586
1789
  export interface CreateDecoderManifestResponse {
1587
1790
  /**
1791
+ * @public
1588
1792
  * <p> The name of the created decoder manifest. </p>
1589
1793
  */
1590
1794
  name: string | undefined;
1591
1795
  /**
1796
+ * @public
1592
1797
  * <p> The ARN of the created decoder manifest. </p>
1593
1798
  */
1594
1799
  arn: string | undefined;
@@ -1615,10 +1820,12 @@ export type NetworkInterfaceFailureReason = (typeof NetworkInterfaceFailureReaso
1615
1820
  */
1616
1821
  export interface InvalidNetworkInterface {
1617
1822
  /**
1823
+ * @public
1618
1824
  * <p>The ID of the interface that isn't valid.</p>
1619
1825
  */
1620
1826
  interfaceId?: string;
1621
1827
  /**
1828
+ * @public
1622
1829
  * <p>A message about why the interface isn't valid. </p>
1623
1830
  */
1624
1831
  reason?: NetworkInterfaceFailureReason | string;
@@ -1648,10 +1855,12 @@ export type SignalDecoderFailureReason = (typeof SignalDecoderFailureReason)[key
1648
1855
  */
1649
1856
  export interface InvalidSignalDecoder {
1650
1857
  /**
1858
+ * @public
1651
1859
  * <p>The name of a signal decoder that isn't valid.</p>
1652
1860
  */
1653
1861
  name?: string;
1654
1862
  /**
1863
+ * @public
1655
1864
  * <p>A message about why the signal decoder isn't valid.</p>
1656
1865
  */
1657
1866
  reason?: SignalDecoderFailureReason | string;
@@ -1664,10 +1873,12 @@ export declare class DecoderManifestValidationException extends __BaseException
1664
1873
  readonly name: "DecoderManifestValidationException";
1665
1874
  readonly $fault: "client";
1666
1875
  /**
1876
+ * @public
1667
1877
  * <p>The request couldn't be completed because of invalid signals in the request.</p>
1668
1878
  */
1669
1879
  invalidSignals?: InvalidSignalDecoder[];
1670
1880
  /**
1881
+ * @public
1671
1882
  * <p>The request couldn't be completed because of invalid network interfaces in the request.</p>
1672
1883
  */
1673
1884
  invalidNetworkInterfaces?: InvalidNetworkInterface[];
@@ -1681,18 +1892,22 @@ export declare class DecoderManifestValidationException extends __BaseException
1681
1892
  */
1682
1893
  export interface CreateFleetRequest {
1683
1894
  /**
1895
+ * @public
1684
1896
  * <p> The unique ID of the fleet to create. </p>
1685
1897
  */
1686
1898
  fleetId: string | undefined;
1687
1899
  /**
1900
+ * @public
1688
1901
  * <p> A brief description of the fleet to create. </p>
1689
1902
  */
1690
1903
  description?: string;
1691
1904
  /**
1905
+ * @public
1692
1906
  * <p> The Amazon Resource Name (ARN) of a signal catalog. </p>
1693
1907
  */
1694
1908
  signalCatalogArn: string | undefined;
1695
1909
  /**
1910
+ * @public
1696
1911
  * <p>Metadata that can be used to manage the fleet.</p>
1697
1912
  */
1698
1913
  tags?: Tag[];
@@ -1702,10 +1917,12 @@ export interface CreateFleetRequest {
1702
1917
  */
1703
1918
  export interface CreateFleetResponse {
1704
1919
  /**
1920
+ * @public
1705
1921
  * <p> The ID of the created fleet. </p>
1706
1922
  */
1707
1923
  id: string | undefined;
1708
1924
  /**
1925
+ * @public
1709
1926
  * <p> The ARN of the created fleet. </p>
1710
1927
  */
1711
1928
  arn: string | undefined;
@@ -1715,22 +1932,27 @@ export interface CreateFleetResponse {
1715
1932
  */
1716
1933
  export interface CreateModelManifestRequest {
1717
1934
  /**
1935
+ * @public
1718
1936
  * <p> The name of the vehicle model to create.</p>
1719
1937
  */
1720
1938
  name: string | undefined;
1721
1939
  /**
1940
+ * @public
1722
1941
  * <p> A brief description of the vehicle model. </p>
1723
1942
  */
1724
1943
  description?: string;
1725
1944
  /**
1945
+ * @public
1726
1946
  * <p> A list of nodes, which are a general abstraction of signals. </p>
1727
1947
  */
1728
1948
  nodes: string[] | undefined;
1729
1949
  /**
1950
+ * @public
1730
1951
  * <p> The Amazon Resource Name (ARN) of a signal catalog. </p>
1731
1952
  */
1732
1953
  signalCatalogArn: string | undefined;
1733
1954
  /**
1955
+ * @public
1734
1956
  * <p>Metadata that can be used to manage the vehicle model.</p>
1735
1957
  */
1736
1958
  tags?: Tag[];
@@ -1740,10 +1962,12 @@ export interface CreateModelManifestRequest {
1740
1962
  */
1741
1963
  export interface CreateModelManifestResponse {
1742
1964
  /**
1965
+ * @public
1743
1966
  * <p> The name of the created vehicle model.</p>
1744
1967
  */
1745
1968
  name: string | undefined;
1746
1969
  /**
1970
+ * @public
1747
1971
  * <p> The ARN of the created vehicle model.</p>
1748
1972
  */
1749
1973
  arn: string | undefined;
@@ -1754,10 +1978,12 @@ export interface CreateModelManifestResponse {
1754
1978
  */
1755
1979
  export interface InvalidSignal {
1756
1980
  /**
1981
+ * @public
1757
1982
  * <p>The name of the signal that isn't valid.</p>
1758
1983
  */
1759
1984
  name?: string;
1760
1985
  /**
1986
+ * @public
1761
1987
  * <p>A message about why the signal isn't valid.</p>
1762
1988
  */
1763
1989
  reason?: string;
@@ -1770,6 +1996,7 @@ export declare class InvalidSignalsException extends __BaseException {
1770
1996
  readonly name: "InvalidSignalsException";
1771
1997
  readonly $fault: "client";
1772
1998
  /**
1999
+ * @public
1773
2000
  * <p>The signals which caused the exception.</p>
1774
2001
  */
1775
2002
  invalidSignals?: InvalidSignal[];
@@ -1788,39 +2015,48 @@ export declare class InvalidSignalsException extends __BaseException {
1788
2015
  */
1789
2016
  export interface Sensor {
1790
2017
  /**
2018
+ * @public
1791
2019
  * <p>The fully qualified name of the sensor. For example, the fully qualified name of a
1792
2020
  * sensor might be <code>Vehicle.Body.Engine.Battery</code>.</p>
1793
2021
  */
1794
2022
  fullyQualifiedName: string | undefined;
1795
2023
  /**
2024
+ * @public
1796
2025
  * <p>The specified data type of the sensor. </p>
1797
2026
  */
1798
2027
  dataType: NodeDataType | string | undefined;
1799
2028
  /**
2029
+ * @public
1800
2030
  * <p>A brief description of a sensor.</p>
1801
2031
  */
1802
2032
  description?: string;
1803
2033
  /**
2034
+ * @public
1804
2035
  * <p>The scientific unit of measurement for data collected by the sensor.</p>
1805
2036
  */
1806
2037
  unit?: string;
1807
2038
  /**
2039
+ * @public
1808
2040
  * <p>A list of possible values a sensor can take.</p>
1809
2041
  */
1810
2042
  allowedValues?: string[];
1811
2043
  /**
2044
+ * @public
1812
2045
  * <p>The specified possible minimum value of the sensor.</p>
1813
2046
  */
1814
2047
  min?: number;
1815
2048
  /**
2049
+ * @public
1816
2050
  * <p>The specified possible maximum value of the sensor.</p>
1817
2051
  */
1818
2052
  max?: number;
1819
2053
  /**
2054
+ * @public
1820
2055
  * <p>The deprecation message for the node or the branch that was moved or deleted.</p>
1821
2056
  */
1822
2057
  deprecationMessage?: string;
1823
2058
  /**
2059
+ * @public
1824
2060
  * <p>A comment in addition to the description.</p>
1825
2061
  */
1826
2062
  comment?: string;
@@ -1836,6 +2072,7 @@ export type Node = Node.ActuatorMember | Node.AttributeMember | Node.BranchMembe
1836
2072
  */
1837
2073
  export declare namespace Node {
1838
2074
  /**
2075
+ * @public
1839
2076
  * <p>Information about a node specified as a branch.</p>
1840
2077
  * <note>
1841
2078
  * <p>A group of signals that are defined in a hierarchical structure.</p>
@@ -1849,6 +2086,7 @@ export declare namespace Node {
1849
2086
  $unknown?: never;
1850
2087
  }
1851
2088
  /**
2089
+ * @public
1852
2090
  * <p>An input component that reports the environmental condition of a vehicle.</p>
1853
2091
  * <note>
1854
2092
  * <p>You can collect data about fluid levels, temperatures, vibrations, or battery
@@ -1863,6 +2101,7 @@ export declare namespace Node {
1863
2101
  $unknown?: never;
1864
2102
  }
1865
2103
  /**
2104
+ * @public
1866
2105
  * <p>Information about a node specified as an actuator.</p>
1867
2106
  * <note>
1868
2107
  * <p>An actuator is a digital representation of a vehicle device.</p>
@@ -1876,6 +2115,7 @@ export declare namespace Node {
1876
2115
  $unknown?: never;
1877
2116
  }
1878
2117
  /**
2118
+ * @public
1879
2119
  * <p>Information about a node specified as an attribute.</p>
1880
2120
  * <note>
1881
2121
  * <p>An attribute represents static information about a vehicle.</p>
@@ -1888,6 +2128,9 @@ export declare namespace Node {
1888
2128
  attribute: Attribute;
1889
2129
  $unknown?: never;
1890
2130
  }
2131
+ /**
2132
+ * @public
2133
+ */
1891
2134
  interface $UnknownMember {
1892
2135
  branch?: never;
1893
2136
  sensor?: never;
@@ -1909,19 +2152,23 @@ export declare namespace Node {
1909
2152
  */
1910
2153
  export interface CreateSignalCatalogRequest {
1911
2154
  /**
2155
+ * @public
1912
2156
  * <p> The name of the signal catalog to create. </p>
1913
2157
  */
1914
2158
  name: string | undefined;
1915
2159
  /**
2160
+ * @public
1916
2161
  * <p>A brief description of the signal catalog.</p>
1917
2162
  */
1918
2163
  description?: string;
1919
2164
  /**
2165
+ * @public
1920
2166
  * <p> A list of information about nodes, which are a general abstraction of signals. For
1921
2167
  * more information, see the API data type.</p>
1922
2168
  */
1923
2169
  nodes?: Node[];
1924
2170
  /**
2171
+ * @public
1925
2172
  * <p>Metadata that can be used to manage the signal catalog.</p>
1926
2173
  */
1927
2174
  tags?: Tag[];
@@ -1931,10 +2178,12 @@ export interface CreateSignalCatalogRequest {
1931
2178
  */
1932
2179
  export interface CreateSignalCatalogResponse {
1933
2180
  /**
2181
+ * @public
1934
2182
  * <p> The name of the created signal catalog. </p>
1935
2183
  */
1936
2184
  name: string | undefined;
1937
2185
  /**
2186
+ * @public
1938
2187
  * <p> The ARN of the created signal catalog. </p>
1939
2188
  */
1940
2189
  arn: string | undefined;
@@ -1948,10 +2197,12 @@ export declare class InvalidNodeException extends __BaseException {
1948
2197
  readonly name: "InvalidNodeException";
1949
2198
  readonly $fault: "client";
1950
2199
  /**
2200
+ * @public
1951
2201
  * <p>The specified node type isn't valid.</p>
1952
2202
  */
1953
2203
  invalidNodes?: Node[];
1954
2204
  /**
2205
+ * @public
1955
2206
  * <p>The reason the node validation failed.</p>
1956
2207
  */
1957
2208
  reason?: string;
@@ -1965,18 +2216,22 @@ export declare class InvalidNodeException extends __BaseException {
1965
2216
  */
1966
2217
  export interface CreateVehicleRequest {
1967
2218
  /**
2219
+ * @public
1968
2220
  * <p> The unique ID of the vehicle to create. </p>
1969
2221
  */
1970
2222
  vehicleName: string | undefined;
1971
2223
  /**
2224
+ * @public
1972
2225
  * <p> The Amazon Resource Name ARN of a vehicle model. </p>
1973
2226
  */
1974
2227
  modelManifestArn: string | undefined;
1975
2228
  /**
2229
+ * @public
1976
2230
  * <p> The ARN of a decoder manifest. </p>
1977
2231
  */
1978
2232
  decoderManifestArn: string | undefined;
1979
2233
  /**
2234
+ * @public
1980
2235
  * <p>Static information about a vehicle in a key-value pair. For example:
1981
2236
  * <code>"engineType"</code> : <code>"1.3 L R2"</code>
1982
2237
  * </p>
@@ -1984,6 +2239,7 @@ export interface CreateVehicleRequest {
1984
2239
  */
1985
2240
  attributes?: Record<string, string>;
1986
2241
  /**
2242
+ * @public
1987
2243
  * <p> An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an
1988
2244
  * existing Amazon Web Services IoT thing as a vehicle. </p>
1989
2245
  * <p>Default: <code/>
@@ -1991,6 +2247,7 @@ export interface CreateVehicleRequest {
1991
2247
  */
1992
2248
  associationBehavior?: VehicleAssociationBehavior | string;
1993
2249
  /**
2250
+ * @public
1994
2251
  * <p>Metadata that can be used to manage the vehicle.</p>
1995
2252
  */
1996
2253
  tags?: Tag[];
@@ -2000,14 +2257,17 @@ export interface CreateVehicleRequest {
2000
2257
  */
2001
2258
  export interface CreateVehicleResponse {
2002
2259
  /**
2260
+ * @public
2003
2261
  * <p>The unique ID of the created vehicle.</p>
2004
2262
  */
2005
2263
  vehicleName?: string;
2006
2264
  /**
2265
+ * @public
2007
2266
  * <p> The ARN of the created vehicle. </p>
2008
2267
  */
2009
2268
  arn?: string;
2010
2269
  /**
2270
+ * @public
2011
2271
  * <p> The ARN of a created or validated Amazon Web Services IoT thing. </p>
2012
2272
  */
2013
2273
  thingArn?: string;
@@ -2017,6 +2277,7 @@ export interface CreateVehicleResponse {
2017
2277
  */
2018
2278
  export interface DeleteDecoderManifestRequest {
2019
2279
  /**
2280
+ * @public
2020
2281
  * <p> The name of the decoder manifest to delete. </p>
2021
2282
  */
2022
2283
  name: string | undefined;
@@ -2026,10 +2287,12 @@ export interface DeleteDecoderManifestRequest {
2026
2287
  */
2027
2288
  export interface DeleteDecoderManifestResponse {
2028
2289
  /**
2290
+ * @public
2029
2291
  * <p>The name of the deleted decoder manifest.</p>
2030
2292
  */
2031
2293
  name: string | undefined;
2032
2294
  /**
2295
+ * @public
2033
2296
  * <p>The Amazon Resource Name (ARN) of the deleted decoder manifest.</p>
2034
2297
  */
2035
2298
  arn: string | undefined;
@@ -2039,6 +2302,7 @@ export interface DeleteDecoderManifestResponse {
2039
2302
  */
2040
2303
  export interface GetDecoderManifestRequest {
2041
2304
  /**
2305
+ * @public
2042
2306
  * <p> The name of the decoder manifest to retrieve information about. </p>
2043
2307
  */
2044
2308
  name: string | undefined;
@@ -2060,33 +2324,40 @@ export type ManifestStatus = (typeof ManifestStatus)[keyof typeof ManifestStatus
2060
2324
  */
2061
2325
  export interface GetDecoderManifestResponse {
2062
2326
  /**
2327
+ * @public
2063
2328
  * <p> The name of the decoder manifest. </p>
2064
2329
  */
2065
2330
  name: string | undefined;
2066
2331
  /**
2332
+ * @public
2067
2333
  * <p> The Amazon Resource Name (ARN) of the decoder manifest. </p>
2068
2334
  */
2069
2335
  arn: string | undefined;
2070
2336
  /**
2337
+ * @public
2071
2338
  * <p> A brief description of the decoder manifest.</p>
2072
2339
  */
2073
2340
  description?: string;
2074
2341
  /**
2342
+ * @public
2075
2343
  * <p> The ARN of a vehicle model (model manifest) associated with the decoder
2076
2344
  * manifest.</p>
2077
2345
  */
2078
2346
  modelManifestArn?: string;
2079
2347
  /**
2348
+ * @public
2080
2349
  * <p> The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder
2081
2350
  * manifest can't be edited. If the status is marked <code>DRAFT</code>, you can edit the
2082
2351
  * decoder manifest.</p>
2083
2352
  */
2084
2353
  status?: ManifestStatus | string;
2085
2354
  /**
2355
+ * @public
2086
2356
  * <p> The time the decoder manifest was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
2087
2357
  */
2088
2358
  creationTime: Date | undefined;
2089
2359
  /**
2360
+ * @public
2090
2361
  * <p> The time the decoder manifest was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
2091
2362
  */
2092
2363
  lastModificationTime: Date | undefined;
@@ -2101,6 +2372,7 @@ export type NetworkFileDefinition = NetworkFileDefinition.CanDbcMember | Network
2101
2372
  */
2102
2373
  export declare namespace NetworkFileDefinition {
2103
2374
  /**
2375
+ * @public
2104
2376
  * <p>Information, including CAN DBC files, about the configurations used to create a
2105
2377
  * decoder manifest.</p>
2106
2378
  */
@@ -2108,6 +2380,9 @@ export declare namespace NetworkFileDefinition {
2108
2380
  canDbc: CanDbcDefinition;
2109
2381
  $unknown?: never;
2110
2382
  }
2383
+ /**
2384
+ * @public
2385
+ */
2111
2386
  interface $UnknownMember {
2112
2387
  canDbc?: never;
2113
2388
  $unknown: [string, any];
@@ -2123,10 +2398,12 @@ export declare namespace NetworkFileDefinition {
2123
2398
  */
2124
2399
  export interface ImportDecoderManifestRequest {
2125
2400
  /**
2401
+ * @public
2126
2402
  * <p> The name of the decoder manifest to import. </p>
2127
2403
  */
2128
2404
  name: string | undefined;
2129
2405
  /**
2406
+ * @public
2130
2407
  * <p> The file to load into an Amazon Web Services account. </p>
2131
2408
  */
2132
2409
  networkFileDefinitions: NetworkFileDefinition[] | undefined;
@@ -2136,10 +2413,12 @@ export interface ImportDecoderManifestRequest {
2136
2413
  */
2137
2414
  export interface ImportDecoderManifestResponse {
2138
2415
  /**
2416
+ * @public
2139
2417
  * <p> The name of the imported decoder manifest. </p>
2140
2418
  */
2141
2419
  name: string | undefined;
2142
2420
  /**
2421
+ * @public
2143
2422
  * <p> The Amazon Resource Name (ARN) of the decoder manifest that was imported. </p>
2144
2423
  */
2145
2424
  arn: string | undefined;
@@ -2149,15 +2428,18 @@ export interface ImportDecoderManifestResponse {
2149
2428
  */
2150
2429
  export interface ListDecoderManifestNetworkInterfacesRequest {
2151
2430
  /**
2431
+ * @public
2152
2432
  * <p> The name of the decoder manifest to list information about. </p>
2153
2433
  */
2154
2434
  name: string | undefined;
2155
2435
  /**
2436
+ * @public
2156
2437
  * <p>A pagination token for the next set of results.</p>
2157
2438
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2158
2439
  */
2159
2440
  nextToken?: string;
2160
2441
  /**
2442
+ * @public
2161
2443
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2162
2444
  */
2163
2445
  maxResults?: number;
@@ -2167,10 +2449,12 @@ export interface ListDecoderManifestNetworkInterfacesRequest {
2167
2449
  */
2168
2450
  export interface ListDecoderManifestNetworkInterfacesResponse {
2169
2451
  /**
2452
+ * @public
2170
2453
  * <p> A list of information about network interfaces. </p>
2171
2454
  */
2172
2455
  networkInterfaces?: NetworkInterface[];
2173
2456
  /**
2457
+ * @public
2174
2458
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
2175
2459
  */
2176
2460
  nextToken?: string;
@@ -2180,16 +2464,19 @@ export interface ListDecoderManifestNetworkInterfacesResponse {
2180
2464
  */
2181
2465
  export interface ListDecoderManifestsRequest {
2182
2466
  /**
2467
+ * @public
2183
2468
  * <p> The Amazon Resource Name (ARN) of a vehicle model (model manifest) associated with
2184
2469
  * the decoder manifest. </p>
2185
2470
  */
2186
2471
  modelManifestArn?: string;
2187
2472
  /**
2473
+ * @public
2188
2474
  * <p>A pagination token for the next set of results.</p>
2189
2475
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2190
2476
  */
2191
2477
  nextToken?: string;
2192
2478
  /**
2479
+ * @public
2193
2480
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2194
2481
  */
2195
2482
  maxResults?: number;
@@ -2201,35 +2488,42 @@ export interface ListDecoderManifestsRequest {
2201
2488
  */
2202
2489
  export interface DecoderManifestSummary {
2203
2490
  /**
2491
+ * @public
2204
2492
  * <p>The name of the decoder manifest.</p>
2205
2493
  */
2206
2494
  name?: string;
2207
2495
  /**
2496
+ * @public
2208
2497
  * <p>The ARN of a vehicle model (model manifest) associated with the decoder manifest.
2209
2498
  * </p>
2210
2499
  */
2211
2500
  arn?: string;
2212
2501
  /**
2502
+ * @public
2213
2503
  * <p>The ARN of a vehicle model (model manifest) associated with the decoder
2214
2504
  * manifest.</p>
2215
2505
  */
2216
2506
  modelManifestArn?: string;
2217
2507
  /**
2508
+ * @public
2218
2509
  * <p>A brief description of the decoder manifest.</p>
2219
2510
  */
2220
2511
  description?: string;
2221
2512
  /**
2513
+ * @public
2222
2514
  * <p>The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder
2223
2515
  * manifest can't be edited. If the status is marked <code>DRAFT</code>, you can edit the
2224
2516
  * decoder manifest.</p>
2225
2517
  */
2226
2518
  status?: ManifestStatus | string;
2227
2519
  /**
2520
+ * @public
2228
2521
  * <p>The time the decoder manifest was created in seconds since epoch (January 1, 1970 at
2229
2522
  * midnight UTC time).</p>
2230
2523
  */
2231
2524
  creationTime: Date | undefined;
2232
2525
  /**
2526
+ * @public
2233
2527
  * <p>The time the decoder manifest was last updated in seconds since epoch (January 1,
2234
2528
  * 1970 at midnight UTC time).</p>
2235
2529
  */
@@ -2240,10 +2534,12 @@ export interface DecoderManifestSummary {
2240
2534
  */
2241
2535
  export interface ListDecoderManifestsResponse {
2242
2536
  /**
2537
+ * @public
2243
2538
  * <p> A list of information about each decoder manifest. </p>
2244
2539
  */
2245
2540
  summaries?: DecoderManifestSummary[];
2246
2541
  /**
2542
+ * @public
2247
2543
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
2248
2544
  */
2249
2545
  nextToken?: string;
@@ -2253,15 +2549,18 @@ export interface ListDecoderManifestsResponse {
2253
2549
  */
2254
2550
  export interface ListDecoderManifestSignalsRequest {
2255
2551
  /**
2552
+ * @public
2256
2553
  * <p> The name of the decoder manifest to list information about. </p>
2257
2554
  */
2258
2555
  name: string | undefined;
2259
2556
  /**
2557
+ * @public
2260
2558
  * <p>A pagination token for the next set of results.</p>
2261
2559
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2262
2560
  */
2263
2561
  nextToken?: string;
2264
2562
  /**
2563
+ * @public
2265
2564
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2266
2565
  */
2267
2566
  maxResults?: number;
@@ -2271,10 +2570,12 @@ export interface ListDecoderManifestSignalsRequest {
2271
2570
  */
2272
2571
  export interface ListDecoderManifestSignalsResponse {
2273
2572
  /**
2573
+ * @public
2274
2574
  * <p> Information about a list of signals to decode. </p>
2275
2575
  */
2276
2576
  signalDecoders?: SignalDecoder[];
2277
2577
  /**
2578
+ * @public
2278
2579
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
2279
2580
  */
2280
2581
  nextToken?: string;
@@ -2284,42 +2585,51 @@ export interface ListDecoderManifestSignalsResponse {
2284
2585
  */
2285
2586
  export interface UpdateDecoderManifestRequest {
2286
2587
  /**
2588
+ * @public
2287
2589
  * <p> The name of the decoder manifest to update.</p>
2288
2590
  */
2289
2591
  name: string | undefined;
2290
2592
  /**
2593
+ * @public
2291
2594
  * <p> A brief description of the decoder manifest to update. </p>
2292
2595
  */
2293
2596
  description?: string;
2294
2597
  /**
2598
+ * @public
2295
2599
  * <p> A list of information about decoding additional signals to add to the decoder
2296
2600
  * manifest. </p>
2297
2601
  */
2298
2602
  signalDecodersToAdd?: SignalDecoder[];
2299
2603
  /**
2604
+ * @public
2300
2605
  * <p> A list of updated information about decoding signals to update in the decoder
2301
2606
  * manifest. </p>
2302
2607
  */
2303
2608
  signalDecodersToUpdate?: SignalDecoder[];
2304
2609
  /**
2610
+ * @public
2305
2611
  * <p> A list of signal decoders to remove from the decoder manifest. </p>
2306
2612
  */
2307
2613
  signalDecodersToRemove?: string[];
2308
2614
  /**
2615
+ * @public
2309
2616
  * <p> A list of information about the network interfaces to add to the decoder manifest.
2310
2617
  * </p>
2311
2618
  */
2312
2619
  networkInterfacesToAdd?: NetworkInterface[];
2313
2620
  /**
2621
+ * @public
2314
2622
  * <p> A list of information about the network interfaces to update in the decoder manifest.
2315
2623
  * </p>
2316
2624
  */
2317
2625
  networkInterfacesToUpdate?: NetworkInterface[];
2318
2626
  /**
2627
+ * @public
2319
2628
  * <p> A list of network interfaces to remove from the decoder manifest.</p>
2320
2629
  */
2321
2630
  networkInterfacesToRemove?: string[];
2322
2631
  /**
2632
+ * @public
2323
2633
  * <p> The state of the decoder manifest. If the status is <code>ACTIVE</code>, the decoder
2324
2634
  * manifest can't be edited. If the status is <code>DRAFT</code>, you can edit the decoder
2325
2635
  * manifest. </p>
@@ -2331,10 +2641,12 @@ export interface UpdateDecoderManifestRequest {
2331
2641
  */
2332
2642
  export interface UpdateDecoderManifestResponse {
2333
2643
  /**
2644
+ * @public
2334
2645
  * <p> The name of the updated decoder manifest. </p>
2335
2646
  */
2336
2647
  name: string | undefined;
2337
2648
  /**
2649
+ * @public
2338
2650
  * <p> The Amazon Resource Name (ARN) of the updated decoder manifest. </p>
2339
2651
  */
2340
2652
  arn: string | undefined;
@@ -2344,6 +2656,7 @@ export interface UpdateDecoderManifestResponse {
2344
2656
  */
2345
2657
  export interface DeleteFleetRequest {
2346
2658
  /**
2659
+ * @public
2347
2660
  * <p> The ID of the fleet to delete. </p>
2348
2661
  */
2349
2662
  fleetId: string | undefined;
@@ -2353,10 +2666,12 @@ export interface DeleteFleetRequest {
2353
2666
  */
2354
2667
  export interface DeleteFleetResponse {
2355
2668
  /**
2669
+ * @public
2356
2670
  * <p>The ID of the deleted fleet.</p>
2357
2671
  */
2358
2672
  id?: string;
2359
2673
  /**
2674
+ * @public
2360
2675
  * <p>The Amazon Resource Name (ARN) of the deleted fleet.</p>
2361
2676
  */
2362
2677
  arn?: string;
@@ -2366,6 +2681,7 @@ export interface DeleteFleetResponse {
2366
2681
  */
2367
2682
  export interface DeleteModelManifestRequest {
2368
2683
  /**
2684
+ * @public
2369
2685
  * <p> The name of the model manifest to delete. </p>
2370
2686
  */
2371
2687
  name: string | undefined;
@@ -2375,10 +2691,12 @@ export interface DeleteModelManifestRequest {
2375
2691
  */
2376
2692
  export interface DeleteModelManifestResponse {
2377
2693
  /**
2694
+ * @public
2378
2695
  * <p>The name of the deleted model manifest.</p>
2379
2696
  */
2380
2697
  name: string | undefined;
2381
2698
  /**
2699
+ * @public
2382
2700
  * <p>The Amazon Resource Name (ARN) of the deleted model manifest.</p>
2383
2701
  */
2384
2702
  arn: string | undefined;
@@ -2388,6 +2706,7 @@ export interface DeleteModelManifestResponse {
2388
2706
  */
2389
2707
  export interface DeleteSignalCatalogRequest {
2390
2708
  /**
2709
+ * @public
2391
2710
  * <p> The name of the signal catalog to delete. </p>
2392
2711
  */
2393
2712
  name: string | undefined;
@@ -2397,10 +2716,12 @@ export interface DeleteSignalCatalogRequest {
2397
2716
  */
2398
2717
  export interface DeleteSignalCatalogResponse {
2399
2718
  /**
2719
+ * @public
2400
2720
  * <p>The name of the deleted signal catalog.</p>
2401
2721
  */
2402
2722
  name: string | undefined;
2403
2723
  /**
2724
+ * @public
2404
2725
  * <p>The Amazon Resource Name (ARN) of the deleted signal catalog.</p>
2405
2726
  */
2406
2727
  arn: string | undefined;
@@ -2410,6 +2731,7 @@ export interface DeleteSignalCatalogResponse {
2410
2731
  */
2411
2732
  export interface DeleteVehicleRequest {
2412
2733
  /**
2734
+ * @public
2413
2735
  * <p>The ID of the vehicle to delete. </p>
2414
2736
  */
2415
2737
  vehicleName: string | undefined;
@@ -2419,10 +2741,12 @@ export interface DeleteVehicleRequest {
2419
2741
  */
2420
2742
  export interface DeleteVehicleResponse {
2421
2743
  /**
2744
+ * @public
2422
2745
  * <p>The ID of the deleted vehicle.</p>
2423
2746
  */
2424
2747
  vehicleName: string | undefined;
2425
2748
  /**
2749
+ * @public
2426
2750
  * <p>The Amazon Resource Name (ARN) of the deleted vehicle.</p>
2427
2751
  */
2428
2752
  arn: string | undefined;
@@ -2432,10 +2756,12 @@ export interface DeleteVehicleResponse {
2432
2756
  */
2433
2757
  export interface DisassociateVehicleFleetRequest {
2434
2758
  /**
2759
+ * @public
2435
2760
  * <p> The unique ID of the vehicle to disassociate from the fleet.</p>
2436
2761
  */
2437
2762
  vehicleName: string | undefined;
2438
2763
  /**
2764
+ * @public
2439
2765
  * <p> The unique ID of a fleet. </p>
2440
2766
  */
2441
2767
  fleetId: string | undefined;
@@ -2450,15 +2776,18 @@ export interface DisassociateVehicleFleetResponse {
2450
2776
  */
2451
2777
  export interface ListFleetsForVehicleRequest {
2452
2778
  /**
2779
+ * @public
2453
2780
  * <p> The ID of the vehicle to retrieve information about. </p>
2454
2781
  */
2455
2782
  vehicleName: string | undefined;
2456
2783
  /**
2784
+ * @public
2457
2785
  * <p>A pagination token for the next set of results.</p>
2458
2786
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2459
2787
  */
2460
2788
  nextToken?: string;
2461
2789
  /**
2790
+ * @public
2462
2791
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2463
2792
  */
2464
2793
  maxResults?: number;
@@ -2468,10 +2797,12 @@ export interface ListFleetsForVehicleRequest {
2468
2797
  */
2469
2798
  export interface ListFleetsForVehicleResponse {
2470
2799
  /**
2800
+ * @public
2471
2801
  * <p> A list of fleet IDs that the vehicle is associated with. </p>
2472
2802
  */
2473
2803
  fleets?: string[];
2474
2804
  /**
2805
+ * @public
2475
2806
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
2476
2807
  */
2477
2808
  nextToken?: string;
@@ -2481,6 +2812,7 @@ export interface ListFleetsForVehicleResponse {
2481
2812
  */
2482
2813
  export interface GetFleetRequest {
2483
2814
  /**
2815
+ * @public
2484
2816
  * <p> The ID of the fleet to retrieve information about. </p>
2485
2817
  */
2486
2818
  fleetId: string | undefined;
@@ -2490,27 +2822,33 @@ export interface GetFleetRequest {
2490
2822
  */
2491
2823
  export interface GetFleetResponse {
2492
2824
  /**
2825
+ * @public
2493
2826
  * <p> The ID of the fleet.</p>
2494
2827
  */
2495
2828
  id: string | undefined;
2496
2829
  /**
2830
+ * @public
2497
2831
  * <p> The Amazon Resource Name (ARN) of the fleet. </p>
2498
2832
  */
2499
2833
  arn: string | undefined;
2500
2834
  /**
2835
+ * @public
2501
2836
  * <p> A brief description of the fleet. </p>
2502
2837
  */
2503
2838
  description?: string;
2504
2839
  /**
2840
+ * @public
2505
2841
  * <p> The ARN of a signal catalog associated with the fleet. </p>
2506
2842
  */
2507
2843
  signalCatalogArn: string | undefined;
2508
2844
  /**
2845
+ * @public
2509
2846
  * <p> The time the fleet was created in seconds since epoch (January 1, 1970 at midnight
2510
2847
  * UTC time). </p>
2511
2848
  */
2512
2849
  creationTime: Date | undefined;
2513
2850
  /**
2851
+ * @public
2514
2852
  * <p> The time the fleet was last updated, in seconds since epoch (January 1, 1970 at
2515
2853
  * midnight UTC time). </p>
2516
2854
  */
@@ -2521,11 +2859,13 @@ export interface GetFleetResponse {
2521
2859
  */
2522
2860
  export interface ListFleetsRequest {
2523
2861
  /**
2862
+ * @public
2524
2863
  * <p>A pagination token for the next set of results.</p>
2525
2864
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2526
2865
  */
2527
2866
  nextToken?: string;
2528
2867
  /**
2868
+ * @public
2529
2869
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2530
2870
  */
2531
2871
  maxResults?: number;
@@ -2538,27 +2878,33 @@ export interface ListFleetsRequest {
2538
2878
  */
2539
2879
  export interface FleetSummary {
2540
2880
  /**
2881
+ * @public
2541
2882
  * <p>The unique ID of the fleet.</p>
2542
2883
  */
2543
2884
  id: string | undefined;
2544
2885
  /**
2886
+ * @public
2545
2887
  * <p>The Amazon Resource Name (ARN) of the fleet.</p>
2546
2888
  */
2547
2889
  arn: string | undefined;
2548
2890
  /**
2891
+ * @public
2549
2892
  * <p>A brief description of the fleet.</p>
2550
2893
  */
2551
2894
  description?: string;
2552
2895
  /**
2896
+ * @public
2553
2897
  * <p>The ARN of the signal catalog associated with the fleet.</p>
2554
2898
  */
2555
2899
  signalCatalogArn: string | undefined;
2556
2900
  /**
2901
+ * @public
2557
2902
  * <p>The time the fleet was created, in seconds since epoch (January 1, 1970 at midnight
2558
2903
  * UTC time).</p>
2559
2904
  */
2560
2905
  creationTime: Date | undefined;
2561
2906
  /**
2907
+ * @public
2562
2908
  * <p>The time the fleet was last updated in seconds since epoch (January 1, 1970 at
2563
2909
  * midnight UTC time).</p>
2564
2910
  */
@@ -2569,10 +2915,12 @@ export interface FleetSummary {
2569
2915
  */
2570
2916
  export interface ListFleetsResponse {
2571
2917
  /**
2918
+ * @public
2572
2919
  * <p> A list of information for each fleet. </p>
2573
2920
  */
2574
2921
  fleetSummaries?: FleetSummary[];
2575
2922
  /**
2923
+ * @public
2576
2924
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
2577
2925
  */
2578
2926
  nextToken?: string;
@@ -2582,10 +2930,12 @@ export interface ListFleetsResponse {
2582
2930
  */
2583
2931
  export interface UpdateFleetRequest {
2584
2932
  /**
2933
+ * @public
2585
2934
  * <p> The ID of the fleet to update. </p>
2586
2935
  */
2587
2936
  fleetId: string | undefined;
2588
2937
  /**
2938
+ * @public
2589
2939
  * <p> An updated description of the fleet. </p>
2590
2940
  */
2591
2941
  description?: string;
@@ -2595,10 +2945,12 @@ export interface UpdateFleetRequest {
2595
2945
  */
2596
2946
  export interface UpdateFleetResponse {
2597
2947
  /**
2948
+ * @public
2598
2949
  * <p>The ID of the updated fleet.</p>
2599
2950
  */
2600
2951
  id?: string;
2601
2952
  /**
2953
+ * @public
2602
2954
  * <p>The Amazon Resource Name (ARN) of the updated fleet.</p>
2603
2955
  */
2604
2956
  arn?: string;
@@ -2608,15 +2960,18 @@ export interface UpdateFleetResponse {
2608
2960
  */
2609
2961
  export interface ListVehiclesInFleetRequest {
2610
2962
  /**
2963
+ * @public
2611
2964
  * <p> The ID of a fleet. </p>
2612
2965
  */
2613
2966
  fleetId: string | undefined;
2614
2967
  /**
2968
+ * @public
2615
2969
  * <p>A pagination token for the next set of results.</p>
2616
2970
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2617
2971
  */
2618
2972
  nextToken?: string;
2619
2973
  /**
2974
+ * @public
2620
2975
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2621
2976
  */
2622
2977
  maxResults?: number;
@@ -2626,10 +2981,12 @@ export interface ListVehiclesInFleetRequest {
2626
2981
  */
2627
2982
  export interface ListVehiclesInFleetResponse {
2628
2983
  /**
2984
+ * @public
2629
2985
  * <p> A list of vehicles associated with the fleet. </p>
2630
2986
  */
2631
2987
  vehicles?: string[];
2632
2988
  /**
2989
+ * @public
2633
2990
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
2634
2991
  */
2635
2992
  nextToken?: string;
@@ -2647,12 +3004,16 @@ export type FormattedVss = FormattedVss.VssJsonMember | FormattedVss.$UnknownMem
2647
3004
  */
2648
3005
  export declare namespace FormattedVss {
2649
3006
  /**
3007
+ * @public
2650
3008
  * <p>Provides the VSS in JSON format.</p>
2651
3009
  */
2652
3010
  interface VssJsonMember {
2653
3011
  vssJson: string;
2654
3012
  $unknown?: never;
2655
3013
  }
3014
+ /**
3015
+ * @public
3016
+ */
2656
3017
  interface $UnknownMember {
2657
3018
  vssJson?: never;
2658
3019
  $unknown: [string, any];
@@ -2673,6 +3034,7 @@ export interface GetLoggingOptionsRequest {
2673
3034
  */
2674
3035
  export interface GetLoggingOptionsResponse {
2675
3036
  /**
3037
+ * @public
2676
3038
  * <p>Returns information about log delivery to Amazon CloudWatch Logs.</p>
2677
3039
  */
2678
3040
  cloudWatchLogDelivery: CloudWatchLogDeliveryOptions | undefined;
@@ -2682,6 +3044,7 @@ export interface GetLoggingOptionsResponse {
2682
3044
  */
2683
3045
  export interface GetModelManifestRequest {
2684
3046
  /**
3047
+ * @public
2685
3048
  * <p> The name of the vehicle model to retrieve information about. </p>
2686
3049
  */
2687
3050
  name: string | undefined;
@@ -2691,33 +3054,40 @@ export interface GetModelManifestRequest {
2691
3054
  */
2692
3055
  export interface GetModelManifestResponse {
2693
3056
  /**
3057
+ * @public
2694
3058
  * <p> The name of the vehicle model. </p>
2695
3059
  */
2696
3060
  name: string | undefined;
2697
3061
  /**
3062
+ * @public
2698
3063
  * <p> The Amazon Resource Name (ARN) of the vehicle model. </p>
2699
3064
  */
2700
3065
  arn: string | undefined;
2701
3066
  /**
3067
+ * @public
2702
3068
  * <p> A brief description of the vehicle model. </p>
2703
3069
  */
2704
3070
  description?: string;
2705
3071
  /**
3072
+ * @public
2706
3073
  * <p> The ARN of the signal catalog associated with the vehicle model. </p>
2707
3074
  */
2708
3075
  signalCatalogArn?: string;
2709
3076
  /**
3077
+ * @public
2710
3078
  * <p> The state of the vehicle model. If the status is <code>ACTIVE</code>, the vehicle
2711
3079
  * model can't be edited. You can edit the vehicle model if the status is marked
2712
3080
  * <code>DRAFT</code>.</p>
2713
3081
  */
2714
3082
  status?: ManifestStatus | string;
2715
3083
  /**
3084
+ * @public
2716
3085
  * <p>The time the vehicle model was created, in seconds since epoch (January 1, 1970 at
2717
3086
  * midnight UTC time).</p>
2718
3087
  */
2719
3088
  creationTime: Date | undefined;
2720
3089
  /**
3090
+ * @public
2721
3091
  * <p>The last time the vehicle model was modified.</p>
2722
3092
  */
2723
3093
  lastModificationTime: Date | undefined;
@@ -2747,16 +3117,19 @@ export type RegistrationStatus = (typeof RegistrationStatus)[keyof typeof Regist
2747
3117
  */
2748
3118
  export interface IamRegistrationResponse {
2749
3119
  /**
3120
+ * @public
2750
3121
  * <p>The Amazon Resource Name (ARN) of the IAM role to register.</p>
2751
3122
  */
2752
3123
  roleArn: string | undefined;
2753
3124
  /**
3125
+ * @public
2754
3126
  * <p>The status of registering your IAM resource. The status can be one of
2755
3127
  * <code>REGISTRATION_SUCCESS</code>, <code>REGISTRATION_PENDING</code>,
2756
3128
  * <code>REGISTRATION_FAILURE</code>.</p>
2757
3129
  */
2758
3130
  registrationStatus: RegistrationStatus | string | undefined;
2759
3131
  /**
3132
+ * @public
2760
3133
  * <p>A message associated with a registration error.</p>
2761
3134
  */
2762
3135
  errorMessage?: string;
@@ -2767,28 +3140,34 @@ export interface IamRegistrationResponse {
2767
3140
  */
2768
3141
  export interface TimestreamRegistrationResponse {
2769
3142
  /**
3143
+ * @public
2770
3144
  * <p>The name of the Timestream database.</p>
2771
3145
  */
2772
3146
  timestreamDatabaseName: string | undefined;
2773
3147
  /**
3148
+ * @public
2774
3149
  * <p>The name of the Timestream database table.</p>
2775
3150
  */
2776
3151
  timestreamTableName: string | undefined;
2777
3152
  /**
3153
+ * @public
2778
3154
  * <p>The Amazon Resource Name (ARN) of the Timestream database.</p>
2779
3155
  */
2780
3156
  timestreamDatabaseArn?: string;
2781
3157
  /**
3158
+ * @public
2782
3159
  * <p>The ARN of the Timestream database table.</p>
2783
3160
  */
2784
3161
  timestreamTableArn?: string;
2785
3162
  /**
3163
+ * @public
2786
3164
  * <p>The status of registering your Amazon Timestream resources. The status can be one of
2787
3165
  * <code>REGISTRATION_SUCCESS</code>, <code>REGISTRATION_PENDING</code>,
2788
3166
  * <code>REGISTRATION_FAILURE</code>.</p>
2789
3167
  */
2790
3168
  registrationStatus: RegistrationStatus | string | undefined;
2791
3169
  /**
3170
+ * @public
2792
3171
  * <p>A message associated with a registration error.</p>
2793
3172
  */
2794
3173
  errorMessage?: string;
@@ -2798,10 +3177,12 @@ export interface TimestreamRegistrationResponse {
2798
3177
  */
2799
3178
  export interface GetRegisterAccountStatusResponse {
2800
3179
  /**
3180
+ * @public
2801
3181
  * <p> The unique ID of the Amazon Web Services account, provided at account creation. </p>
2802
3182
  */
2803
3183
  customerAccountId: string | undefined;
2804
3184
  /**
3185
+ * @public
2805
3186
  * <p> The status of registering your account and resources. The status can be one
2806
3187
  * of:</p>
2807
3188
  * <ul>
@@ -2824,19 +3205,23 @@ export interface GetRegisterAccountStatusResponse {
2824
3205
  */
2825
3206
  accountStatus: RegistrationStatus | string | undefined;
2826
3207
  /**
3208
+ * @public
2827
3209
  * <p> Information about the registered Amazon Timestream resources or errors, if any.</p>
2828
3210
  */
2829
3211
  timestreamRegistrationResponse?: TimestreamRegistrationResponse;
2830
3212
  /**
3213
+ * @public
2831
3214
  * <p> Information about the registered IAM resources or errors, if any. </p>
2832
3215
  */
2833
3216
  iamRegistrationResponse: IamRegistrationResponse | undefined;
2834
3217
  /**
3218
+ * @public
2835
3219
  * <p> The time the account was registered, in seconds since epoch (January 1, 1970 at
2836
3220
  * midnight UTC time). </p>
2837
3221
  */
2838
3222
  creationTime: Date | undefined;
2839
3223
  /**
3224
+ * @public
2840
3225
  * <p> The time this registration was last updated, in seconds since epoch (January 1, 1970
2841
3226
  * at midnight UTC time). </p>
2842
3227
  */
@@ -2847,6 +3232,7 @@ export interface GetRegisterAccountStatusResponse {
2847
3232
  */
2848
3233
  export interface GetSignalCatalogRequest {
2849
3234
  /**
3235
+ * @public
2850
3236
  * <p> The name of the signal catalog to retrieve information about. </p>
2851
3237
  */
2852
3238
  name: string | undefined;
@@ -2857,22 +3243,27 @@ export interface GetSignalCatalogRequest {
2857
3243
  */
2858
3244
  export interface NodeCounts {
2859
3245
  /**
3246
+ * @public
2860
3247
  * <p>The total number of nodes in a vehicle network.</p>
2861
3248
  */
2862
3249
  totalNodes?: number;
2863
3250
  /**
3251
+ * @public
2864
3252
  * <p>The total number of nodes in a vehicle network that represent branches.</p>
2865
3253
  */
2866
3254
  totalBranches?: number;
2867
3255
  /**
3256
+ * @public
2868
3257
  * <p>The total number of nodes in a vehicle network that represent sensors.</p>
2869
3258
  */
2870
3259
  totalSensors?: number;
2871
3260
  /**
3261
+ * @public
2872
3262
  * <p>The total number of nodes in a vehicle network that represent attributes.</p>
2873
3263
  */
2874
3264
  totalAttributes?: number;
2875
3265
  /**
3266
+ * @public
2876
3267
  * <p>The total number of nodes in a vehicle network that represent actuators.</p>
2877
3268
  */
2878
3269
  totalActuators?: number;
@@ -2882,26 +3273,32 @@ export interface NodeCounts {
2882
3273
  */
2883
3274
  export interface GetSignalCatalogResponse {
2884
3275
  /**
3276
+ * @public
2885
3277
  * <p> The name of the signal catalog. </p>
2886
3278
  */
2887
3279
  name: string | undefined;
2888
3280
  /**
3281
+ * @public
2889
3282
  * <p> The Amazon Resource Name (ARN) of the signal catalog. </p>
2890
3283
  */
2891
3284
  arn: string | undefined;
2892
3285
  /**
3286
+ * @public
2893
3287
  * <p> A brief description of the signal catalog. </p>
2894
3288
  */
2895
3289
  description?: string;
2896
3290
  /**
3291
+ * @public
2897
3292
  * <p> The total number of network nodes specified in a signal catalog. </p>
2898
3293
  */
2899
3294
  nodeCounts?: NodeCounts;
2900
3295
  /**
3296
+ * @public
2901
3297
  * <p> The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
2902
3298
  */
2903
3299
  creationTime: Date | undefined;
2904
3300
  /**
3301
+ * @public
2905
3302
  * <p>The last time the signal catalog was modified.</p>
2906
3303
  */
2907
3304
  lastModificationTime: Date | undefined;
@@ -2911,6 +3308,7 @@ export interface GetSignalCatalogResponse {
2911
3308
  */
2912
3309
  export interface GetVehicleRequest {
2913
3310
  /**
3311
+ * @public
2914
3312
  * <p> The ID of the vehicle to retrieve information about. </p>
2915
3313
  */
2916
3314
  vehicleName: string | undefined;
@@ -2920,22 +3318,27 @@ export interface GetVehicleRequest {
2920
3318
  */
2921
3319
  export interface GetVehicleResponse {
2922
3320
  /**
3321
+ * @public
2923
3322
  * <p>The ID of the vehicle.</p>
2924
3323
  */
2925
3324
  vehicleName?: string;
2926
3325
  /**
3326
+ * @public
2927
3327
  * <p> The Amazon Resource Name (ARN) of the vehicle to retrieve information about. </p>
2928
3328
  */
2929
3329
  arn?: string;
2930
3330
  /**
3331
+ * @public
2931
3332
  * <p> The ARN of a vehicle model (model manifest) associated with the vehicle. </p>
2932
3333
  */
2933
3334
  modelManifestArn?: string;
2934
3335
  /**
3336
+ * @public
2935
3337
  * <p> The ARN of a decoder manifest associated with the vehicle. </p>
2936
3338
  */
2937
3339
  decoderManifestArn?: string;
2938
3340
  /**
3341
+ * @public
2939
3342
  * <p>Static information about a vehicle in a key-value pair. For example:</p>
2940
3343
  * <p>
2941
3344
  * <code>"engineType"</code> : <code>"1.3 L R2"</code>
@@ -2943,10 +3346,12 @@ export interface GetVehicleResponse {
2943
3346
  */
2944
3347
  attributes?: Record<string, string>;
2945
3348
  /**
3349
+ * @public
2946
3350
  * <p> The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
2947
3351
  */
2948
3352
  creationTime?: Date;
2949
3353
  /**
3354
+ * @public
2950
3355
  * <p> The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
2951
3356
  */
2952
3357
  lastModificationTime?: Date;
@@ -2956,15 +3361,18 @@ export interface GetVehicleResponse {
2956
3361
  */
2957
3362
  export interface GetVehicleStatusRequest {
2958
3363
  /**
3364
+ * @public
2959
3365
  * <p>A pagination token for the next set of results.</p>
2960
3366
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
2961
3367
  */
2962
3368
  nextToken?: string;
2963
3369
  /**
3370
+ * @public
2964
3371
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
2965
3372
  */
2966
3373
  maxResults?: number;
2967
3374
  /**
3375
+ * @public
2968
3376
  * <p> The ID of the vehicle to retrieve information about. </p>
2969
3377
  */
2970
3378
  vehicleName: string | undefined;
@@ -2991,14 +3399,17 @@ export type VehicleState = (typeof VehicleState)[keyof typeof VehicleState];
2991
3399
  */
2992
3400
  export interface VehicleStatus {
2993
3401
  /**
3402
+ * @public
2994
3403
  * <p>The name of a campaign.</p>
2995
3404
  */
2996
3405
  campaignName?: string;
2997
3406
  /**
3407
+ * @public
2998
3408
  * <p>The unique ID of the vehicle.</p>
2999
3409
  */
3000
3410
  vehicleName?: string;
3001
3411
  /**
3412
+ * @public
3002
3413
  * <p>The state of a vehicle, which can be one of the following:</p>
3003
3414
  * <ul>
3004
3415
  * <li>
@@ -3034,10 +3445,12 @@ export interface VehicleStatus {
3034
3445
  */
3035
3446
  export interface GetVehicleStatusResponse {
3036
3447
  /**
3448
+ * @public
3037
3449
  * <p> Lists information about the state of the vehicle with deployed campaigns. </p>
3038
3450
  */
3039
3451
  campaigns?: VehicleStatus[];
3040
3452
  /**
3453
+ * @public
3041
3454
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
3042
3455
  */
3043
3456
  nextToken?: string;
@@ -3051,6 +3464,7 @@ export interface GetVehicleStatusResponse {
3051
3464
  */
3052
3465
  export interface IamResources {
3053
3466
  /**
3467
+ * @public
3054
3468
  * <p>The Amazon Resource Name (ARN) of the IAM resource that allows Amazon Web Services IoT FleetWise to send data to
3055
3469
  * Amazon Timestream. For example, <code>arn:aws:iam::123456789012:role/SERVICE-ROLE-ARN</code>.
3056
3470
  * </p>
@@ -3062,19 +3476,23 @@ export interface IamResources {
3062
3476
  */
3063
3477
  export interface ImportSignalCatalogRequest {
3064
3478
  /**
3479
+ * @public
3065
3480
  * <p>The name of the signal catalog to import.</p>
3066
3481
  */
3067
3482
  name: string | undefined;
3068
3483
  /**
3484
+ * @public
3069
3485
  * <p> A brief description of the signal catalog. </p>
3070
3486
  */
3071
3487
  description?: string;
3072
3488
  /**
3489
+ * @public
3073
3490
  * <p>The contents of the Vehicle Signal Specification (VSS) configuration. VSS is a precise
3074
3491
  * language used to describe and model signals in vehicle networks.</p>
3075
3492
  */
3076
3493
  vss?: FormattedVss;
3077
3494
  /**
3495
+ * @public
3078
3496
  * <p>Metadata that can be used to manage the signal catalog.</p>
3079
3497
  */
3080
3498
  tags?: Tag[];
@@ -3084,10 +3502,12 @@ export interface ImportSignalCatalogRequest {
3084
3502
  */
3085
3503
  export interface ImportSignalCatalogResponse {
3086
3504
  /**
3505
+ * @public
3087
3506
  * <p> The name of the imported signal catalog. </p>
3088
3507
  */
3089
3508
  name: string | undefined;
3090
3509
  /**
3510
+ * @public
3091
3511
  * <p> The Amazon Resource Name (ARN) of the imported signal catalog.</p>
3092
3512
  */
3093
3513
  arn: string | undefined;
@@ -3097,6 +3517,7 @@ export interface ImportSignalCatalogResponse {
3097
3517
  */
3098
3518
  export interface ListTagsForResourceRequest {
3099
3519
  /**
3520
+ * @public
3100
3521
  * <p>The ARN of the resource.</p>
3101
3522
  */
3102
3523
  ResourceARN: string | undefined;
@@ -3106,6 +3527,7 @@ export interface ListTagsForResourceRequest {
3106
3527
  */
3107
3528
  export interface ListTagsForResourceResponse {
3108
3529
  /**
3530
+ * @public
3109
3531
  * <p>The list of tags assigned to the resource.</p>
3110
3532
  */
3111
3533
  Tags?: Tag[];
@@ -3115,15 +3537,18 @@ export interface ListTagsForResourceResponse {
3115
3537
  */
3116
3538
  export interface ListModelManifestNodesRequest {
3117
3539
  /**
3540
+ * @public
3118
3541
  * <p> The name of the vehicle model to list information about. </p>
3119
3542
  */
3120
3543
  name: string | undefined;
3121
3544
  /**
3545
+ * @public
3122
3546
  * <p>A pagination token for the next set of results.</p>
3123
3547
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
3124
3548
  */
3125
3549
  nextToken?: string;
3126
3550
  /**
3551
+ * @public
3127
3552
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
3128
3553
  */
3129
3554
  maxResults?: number;
@@ -3133,10 +3558,12 @@ export interface ListModelManifestNodesRequest {
3133
3558
  */
3134
3559
  export interface ListModelManifestNodesResponse {
3135
3560
  /**
3561
+ * @public
3136
3562
  * <p> A list of information about nodes. </p>
3137
3563
  */
3138
3564
  nodes?: Node[];
3139
3565
  /**
3566
+ * @public
3140
3567
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
3141
3568
  */
3142
3569
  nextToken?: string;
@@ -3146,16 +3573,19 @@ export interface ListModelManifestNodesResponse {
3146
3573
  */
3147
3574
  export interface ListModelManifestsRequest {
3148
3575
  /**
3576
+ * @public
3149
3577
  * <p> The ARN of a signal catalog. If you specify a signal catalog, only the vehicle models
3150
3578
  * associated with it are returned.</p>
3151
3579
  */
3152
3580
  signalCatalogArn?: string;
3153
3581
  /**
3582
+ * @public
3154
3583
  * <p>A pagination token for the next set of results.</p>
3155
3584
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
3156
3585
  */
3157
3586
  nextToken?: string;
3158
3587
  /**
3588
+ * @public
3159
3589
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
3160
3590
  */
3161
3591
  maxResults?: number;
@@ -3167,33 +3597,40 @@ export interface ListModelManifestsRequest {
3167
3597
  */
3168
3598
  export interface ModelManifestSummary {
3169
3599
  /**
3600
+ * @public
3170
3601
  * <p>The name of the vehicle model.</p>
3171
3602
  */
3172
3603
  name?: string;
3173
3604
  /**
3605
+ * @public
3174
3606
  * <p>The Amazon Resource Name (ARN) of the vehicle model.</p>
3175
3607
  */
3176
3608
  arn?: string;
3177
3609
  /**
3610
+ * @public
3178
3611
  * <p>The ARN of the signal catalog associated with the vehicle model.</p>
3179
3612
  */
3180
3613
  signalCatalogArn?: string;
3181
3614
  /**
3615
+ * @public
3182
3616
  * <p>A brief description of the vehicle model.</p>
3183
3617
  */
3184
3618
  description?: string;
3185
3619
  /**
3620
+ * @public
3186
3621
  * <p>The state of the vehicle model. If the status is <code>ACTIVE</code>, the vehicle
3187
3622
  * model can't be edited. If the status is <code>DRAFT</code>, you can edit the vehicle
3188
3623
  * model.</p>
3189
3624
  */
3190
3625
  status?: ManifestStatus | string;
3191
3626
  /**
3627
+ * @public
3192
3628
  * <p>The time the vehicle model was created, in seconds since epoch (January 1, 1970 at
3193
3629
  * midnight UTC time).</p>
3194
3630
  */
3195
3631
  creationTime: Date | undefined;
3196
3632
  /**
3633
+ * @public
3197
3634
  * <p>The time the vehicle model was last updated, in seconds since epoch (January 1, 1970
3198
3635
  * at midnight UTC time).</p>
3199
3636
  */
@@ -3204,10 +3641,12 @@ export interface ModelManifestSummary {
3204
3641
  */
3205
3642
  export interface ListModelManifestsResponse {
3206
3643
  /**
3644
+ * @public
3207
3645
  * <p> A list of information about vehicle models.</p>
3208
3646
  */
3209
3647
  summaries?: ModelManifestSummary[];
3210
3648
  /**
3649
+ * @public
3211
3650
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
3212
3651
  */
3213
3652
  nextToken?: string;
@@ -3217,24 +3656,29 @@ export interface ListModelManifestsResponse {
3217
3656
  */
3218
3657
  export interface UpdateModelManifestRequest {
3219
3658
  /**
3659
+ * @public
3220
3660
  * <p> The name of the vehicle model to update. </p>
3221
3661
  */
3222
3662
  name: string | undefined;
3223
3663
  /**
3664
+ * @public
3224
3665
  * <p> A brief description of the vehicle model. </p>
3225
3666
  */
3226
3667
  description?: string;
3227
3668
  /**
3669
+ * @public
3228
3670
  * <p> A list of <code>fullyQualifiedName</code> of nodes, which are a general abstraction
3229
3671
  * of signals, to add to the vehicle model. </p>
3230
3672
  */
3231
3673
  nodesToAdd?: string[];
3232
3674
  /**
3675
+ * @public
3233
3676
  * <p> A list of <code>fullyQualifiedName</code> of nodes, which are a general abstraction
3234
3677
  * of signals, to remove from the vehicle model. </p>
3235
3678
  */
3236
3679
  nodesToRemove?: string[];
3237
3680
  /**
3681
+ * @public
3238
3682
  * <p> The state of the vehicle model. If the status is <code>ACTIVE</code>, the vehicle
3239
3683
  * model can't be edited. If the status is <code>DRAFT</code>, you can edit the vehicle
3240
3684
  * model. </p>
@@ -3246,10 +3690,12 @@ export interface UpdateModelManifestRequest {
3246
3690
  */
3247
3691
  export interface UpdateModelManifestResponse {
3248
3692
  /**
3693
+ * @public
3249
3694
  * <p> The name of the updated vehicle model. </p>
3250
3695
  */
3251
3696
  name: string | undefined;
3252
3697
  /**
3698
+ * @public
3253
3699
  * <p> The Amazon Resource Name (ARN) of the updated vehicle model. </p>
3254
3700
  */
3255
3701
  arn: string | undefined;
@@ -3259,6 +3705,7 @@ export interface UpdateModelManifestResponse {
3259
3705
  */
3260
3706
  export interface PutLoggingOptionsRequest {
3261
3707
  /**
3708
+ * @public
3262
3709
  * <p>Creates or updates the log delivery option to Amazon CloudWatch Logs.</p>
3263
3710
  */
3264
3711
  cloudWatchLogDelivery: CloudWatchLogDeliveryOptions | undefined;
@@ -3275,10 +3722,12 @@ export interface PutLoggingOptionsResponse {
3275
3722
  */
3276
3723
  export interface TimestreamResources {
3277
3724
  /**
3725
+ * @public
3278
3726
  * <p>The name of the registered Amazon Timestream database.</p>
3279
3727
  */
3280
3728
  timestreamDatabaseName: string | undefined;
3281
3729
  /**
3730
+ * @public
3282
3731
  * <p>The name of the registered Amazon Timestream database table.</p>
3283
3732
  */
3284
3733
  timestreamTableName: string | undefined;
@@ -3288,6 +3737,7 @@ export interface TimestreamResources {
3288
3737
  */
3289
3738
  export interface RegisterAccountRequest {
3290
3739
  /**
3740
+ * @public
3291
3741
  * @deprecated
3292
3742
  *
3293
3743
  * <p>The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer
@@ -3295,6 +3745,7 @@ export interface RegisterAccountRequest {
3295
3745
  */
3296
3746
  timestreamResources?: TimestreamResources;
3297
3747
  /**
3748
+ * @public
3298
3749
  * @deprecated
3299
3750
  *
3300
3751
  * <p>The IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream.</p>
@@ -3306,25 +3757,30 @@ export interface RegisterAccountRequest {
3306
3757
  */
3307
3758
  export interface RegisterAccountResponse {
3308
3759
  /**
3760
+ * @public
3309
3761
  * <p> The status of registering your Amazon Web Services account, IAM role, and Timestream resources.
3310
3762
  * </p>
3311
3763
  */
3312
3764
  registerAccountStatus: RegistrationStatus | string | undefined;
3313
3765
  /**
3766
+ * @public
3314
3767
  * <p>The registered Amazon Timestream resources that Amazon Web Services IoT FleetWise edge agent software can transfer
3315
3768
  * your vehicle data to.</p>
3316
3769
  */
3317
3770
  timestreamResources?: TimestreamResources;
3318
3771
  /**
3772
+ * @public
3319
3773
  * <p> The registered IAM resource that allows Amazon Web Services IoT FleetWise to send data to Amazon Timestream. </p>
3320
3774
  */
3321
3775
  iamResources: IamResources | undefined;
3322
3776
  /**
3777
+ * @public
3323
3778
  * <p> The time the account was registered, in seconds since epoch (January 1, 1970 at
3324
3779
  * midnight UTC time). </p>
3325
3780
  */
3326
3781
  creationTime: Date | undefined;
3327
3782
  /**
3783
+ * @public
3328
3784
  * <p> The time this registration was last updated, in seconds since epoch (January 1, 1970
3329
3785
  * at midnight UTC time). </p>
3330
3786
  */
@@ -3335,15 +3791,18 @@ export interface RegisterAccountResponse {
3335
3791
  */
3336
3792
  export interface ListSignalCatalogNodesRequest {
3337
3793
  /**
3794
+ * @public
3338
3795
  * <p> The name of the signal catalog to list information about. </p>
3339
3796
  */
3340
3797
  name: string | undefined;
3341
3798
  /**
3799
+ * @public
3342
3800
  * <p>A pagination token for the next set of results.</p>
3343
3801
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
3344
3802
  */
3345
3803
  nextToken?: string;
3346
3804
  /**
3805
+ * @public
3347
3806
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
3348
3807
  */
3349
3808
  maxResults?: number;
@@ -3353,10 +3812,12 @@ export interface ListSignalCatalogNodesRequest {
3353
3812
  */
3354
3813
  export interface ListSignalCatalogNodesResponse {
3355
3814
  /**
3815
+ * @public
3356
3816
  * <p> A list of information about nodes. </p>
3357
3817
  */
3358
3818
  nodes?: Node[];
3359
3819
  /**
3820
+ * @public
3360
3821
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
3361
3822
  */
3362
3823
  nextToken?: string;
@@ -3366,11 +3827,13 @@ export interface ListSignalCatalogNodesResponse {
3366
3827
  */
3367
3828
  export interface ListSignalCatalogsRequest {
3368
3829
  /**
3830
+ * @public
3369
3831
  * <p>A pagination token for the next set of results.</p>
3370
3832
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
3371
3833
  */
3372
3834
  nextToken?: string;
3373
3835
  /**
3836
+ * @public
3374
3837
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
3375
3838
  */
3376
3839
  maxResults?: number;
@@ -3382,18 +3845,22 @@ export interface ListSignalCatalogsRequest {
3382
3845
  */
3383
3846
  export interface SignalCatalogSummary {
3384
3847
  /**
3848
+ * @public
3385
3849
  * <p>The name of the signal catalog.</p>
3386
3850
  */
3387
3851
  name?: string;
3388
3852
  /**
3853
+ * @public
3389
3854
  * <p>The Amazon Resource Name (ARN) of the signal catalog.</p>
3390
3855
  */
3391
3856
  arn?: string;
3392
3857
  /**
3858
+ * @public
3393
3859
  * <p>The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
3394
3860
  */
3395
3861
  creationTime?: Date;
3396
3862
  /**
3863
+ * @public
3397
3864
  * <p>The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
3398
3865
  */
3399
3866
  lastModificationTime?: Date;
@@ -3403,10 +3870,12 @@ export interface SignalCatalogSummary {
3403
3870
  */
3404
3871
  export interface ListSignalCatalogsResponse {
3405
3872
  /**
3873
+ * @public
3406
3874
  * <p> A list of information about each signal catalog. </p>
3407
3875
  */
3408
3876
  summaries?: SignalCatalogSummary[];
3409
3877
  /**
3878
+ * @public
3410
3879
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
3411
3880
  */
3412
3881
  nextToken?: string;
@@ -3416,22 +3885,27 @@ export interface ListSignalCatalogsResponse {
3416
3885
  */
3417
3886
  export interface UpdateSignalCatalogRequest {
3418
3887
  /**
3888
+ * @public
3419
3889
  * <p> The name of the signal catalog to update. </p>
3420
3890
  */
3421
3891
  name: string | undefined;
3422
3892
  /**
3893
+ * @public
3423
3894
  * <p> A brief description of the signal catalog to update.</p>
3424
3895
  */
3425
3896
  description?: string;
3426
3897
  /**
3898
+ * @public
3427
3899
  * <p> A list of information about nodes to add to the signal catalog. </p>
3428
3900
  */
3429
3901
  nodesToAdd?: Node[];
3430
3902
  /**
3903
+ * @public
3431
3904
  * <p> A list of information about nodes to update in the signal catalog. </p>
3432
3905
  */
3433
3906
  nodesToUpdate?: Node[];
3434
3907
  /**
3908
+ * @public
3435
3909
  * <p> A list of <code>fullyQualifiedName</code> of nodes to remove from the signal catalog.
3436
3910
  * </p>
3437
3911
  */
@@ -3442,10 +3916,12 @@ export interface UpdateSignalCatalogRequest {
3442
3916
  */
3443
3917
  export interface UpdateSignalCatalogResponse {
3444
3918
  /**
3919
+ * @public
3445
3920
  * <p> The name of the updated signal catalog. </p>
3446
3921
  */
3447
3922
  name: string | undefined;
3448
3923
  /**
3924
+ * @public
3449
3925
  * <p> The ARN of the updated signal catalog. </p>
3450
3926
  */
3451
3927
  arn: string | undefined;
@@ -3455,10 +3931,12 @@ export interface UpdateSignalCatalogResponse {
3455
3931
  */
3456
3932
  export interface TagResourceRequest {
3457
3933
  /**
3934
+ * @public
3458
3935
  * <p>The ARN of the resource.</p>
3459
3936
  */
3460
3937
  ResourceARN: string | undefined;
3461
3938
  /**
3939
+ * @public
3462
3940
  * <p>The new or modified tags for the resource.</p>
3463
3941
  */
3464
3942
  Tags: Tag[] | undefined;
@@ -3473,10 +3951,12 @@ export interface TagResourceResponse {
3473
3951
  */
3474
3952
  export interface UntagResourceRequest {
3475
3953
  /**
3954
+ * @public
3476
3955
  * <p>The ARN of the resource.</p>
3477
3956
  */
3478
3957
  ResourceARN: string | undefined;
3479
3958
  /**
3959
+ * @public
3480
3960
  * <p>A list of the keys of the tags to be removed from the resource.</p>
3481
3961
  */
3482
3962
  TagKeys: string[] | undefined;
@@ -3491,16 +3971,19 @@ export interface UntagResourceResponse {
3491
3971
  */
3492
3972
  export interface ListVehiclesRequest {
3493
3973
  /**
3974
+ * @public
3494
3975
  * <p> The Amazon Resource Name (ARN) of a vehicle model (model manifest). You can use this optional
3495
3976
  * parameter to list only the vehicles created from a certain vehicle model. </p>
3496
3977
  */
3497
3978
  modelManifestArn?: string;
3498
3979
  /**
3980
+ * @public
3499
3981
  * <p>A pagination token for the next set of results.</p>
3500
3982
  * <p>If the results of a search are large, only a portion of the results are returned, and a <code>nextToken</code> pagination token is returned in the response. To retrieve the next set of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value. </p>
3501
3983
  */
3502
3984
  nextToken?: string;
3503
3985
  /**
3986
+ * @public
3504
3987
  * <p> The maximum number of items to return, between 1 and 100, inclusive. </p>
3505
3988
  */
3506
3989
  maxResults?: number;
@@ -3512,26 +3995,32 @@ export interface ListVehiclesRequest {
3512
3995
  */
3513
3996
  export interface VehicleSummary {
3514
3997
  /**
3998
+ * @public
3515
3999
  * <p>The unique ID of the vehicle.</p>
3516
4000
  */
3517
4001
  vehicleName: string | undefined;
3518
4002
  /**
4003
+ * @public
3519
4004
  * <p>The Amazon Resource Name (ARN) of the vehicle.</p>
3520
4005
  */
3521
4006
  arn: string | undefined;
3522
4007
  /**
4008
+ * @public
3523
4009
  * <p>The ARN of a vehicle model (model manifest) associated with the vehicle.</p>
3524
4010
  */
3525
4011
  modelManifestArn: string | undefined;
3526
4012
  /**
4013
+ * @public
3527
4014
  * <p>The ARN of a decoder manifest associated with the vehicle.</p>
3528
4015
  */
3529
4016
  decoderManifestArn: string | undefined;
3530
4017
  /**
4018
+ * @public
3531
4019
  * <p>The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).</p>
3532
4020
  */
3533
4021
  creationTime: Date | undefined;
3534
4022
  /**
4023
+ * @public
3535
4024
  * <p>The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time). </p>
3536
4025
  */
3537
4026
  lastModificationTime: Date | undefined;
@@ -3541,10 +4030,12 @@ export interface VehicleSummary {
3541
4030
  */
3542
4031
  export interface ListVehiclesResponse {
3543
4032
  /**
4033
+ * @public
3544
4034
  * <p> A list of vehicles and information about them. </p>
3545
4035
  */
3546
4036
  vehicleSummaries?: VehicleSummary[];
3547
4037
  /**
4038
+ * @public
3548
4039
  * <p> The token to retrieve the next set of results, or <code>null</code> if there are no more results. </p>
3549
4040
  */
3550
4041
  nextToken?: string;
@@ -3554,18 +4045,22 @@ export interface ListVehiclesResponse {
3554
4045
  */
3555
4046
  export interface UpdateVehicleRequest {
3556
4047
  /**
4048
+ * @public
3557
4049
  * <p>The unique ID of the vehicle to update.</p>
3558
4050
  */
3559
4051
  vehicleName: string | undefined;
3560
4052
  /**
4053
+ * @public
3561
4054
  * <p>The ARN of a vehicle model (model manifest) associated with the vehicle.</p>
3562
4055
  */
3563
4056
  modelManifestArn?: string;
3564
4057
  /**
4058
+ * @public
3565
4059
  * <p>The ARN of the decoder manifest associated with this vehicle.</p>
3566
4060
  */
3567
4061
  decoderManifestArn?: string;
3568
4062
  /**
4063
+ * @public
3569
4064
  * <p>Static information about a vehicle in a key-value pair. For example:</p>
3570
4065
  * <p>
3571
4066
  * <code>"engineType"</code> : <code>"1.3 L R2"</code>
@@ -3573,6 +4068,7 @@ export interface UpdateVehicleRequest {
3573
4068
  */
3574
4069
  attributes?: Record<string, string>;
3575
4070
  /**
4071
+ * @public
3576
4072
  * <p>The method the specified attributes will update the existing attributes on the
3577
4073
  * vehicle. Use<code>Overwite</code> to replace the vehicle attributes with the specified
3578
4074
  * attributes. Or use <code>Merge</code> to combine all attributes.</p>
@@ -3585,10 +4081,12 @@ export interface UpdateVehicleRequest {
3585
4081
  */
3586
4082
  export interface UpdateVehicleResponse {
3587
4083
  /**
4084
+ * @public
3588
4085
  * <p>The ID of the updated vehicle.</p>
3589
4086
  */
3590
4087
  vehicleName?: string;
3591
4088
  /**
4089
+ * @public
3592
4090
  * <p>The ARN of the updated vehicle.</p>
3593
4091
  */
3594
4092
  arn?: string;