@aws-sdk/client-iotthingsgraph 3.379.1 → 3.382.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.
@@ -5,10 +5,12 @@ import { IoTThingsGraphServiceException as __BaseException } from "./IoTThingsGr
5
5
  */
6
6
  export interface AssociateEntityToThingRequest {
7
7
  /**
8
+ * @public
8
9
  * <p>The name of the thing to which the entity is to be associated.</p>
9
10
  */
10
11
  thingName: string | undefined;
11
12
  /**
13
+ * @public
12
14
  * <p>The ID of the device to be associated with the thing.</p>
13
15
  * <p>The ID should be in the following format.</p>
14
16
  * <p>
@@ -17,6 +19,7 @@ export interface AssociateEntityToThingRequest {
17
19
  */
18
20
  entityId: string | undefined;
19
21
  /**
22
+ * @public
20
23
  * <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
21
24
  */
22
25
  namespaceVersion?: number;
@@ -91,10 +94,12 @@ export type DefinitionLanguage = (typeof DefinitionLanguage)[keyof typeof Defini
91
94
  */
92
95
  export interface DefinitionDocument {
93
96
  /**
97
+ * @public
94
98
  * <p>The language used to define the entity. <code>GRAPHQL</code> is the only valid value.</p>
95
99
  */
96
100
  language: DefinitionLanguage | string | undefined;
97
101
  /**
102
+ * @public
98
103
  * <p>The GraphQL text that defines the entity.</p>
99
104
  */
100
105
  text: string | undefined;
@@ -104,10 +109,12 @@ export interface DefinitionDocument {
104
109
  */
105
110
  export interface CreateFlowTemplateRequest {
106
111
  /**
112
+ * @public
107
113
  * <p>The workflow <code>DefinitionDocument</code>.</p>
108
114
  */
109
115
  definition: DefinitionDocument | undefined;
110
116
  /**
117
+ * @public
111
118
  * <p>The namespace version in which the workflow is to be created.</p>
112
119
  * <p>If no value is specified, the latest version is used by default.</p>
113
120
  */
@@ -119,18 +126,22 @@ export interface CreateFlowTemplateRequest {
119
126
  */
120
127
  export interface FlowTemplateSummary {
121
128
  /**
129
+ * @public
122
130
  * <p>The ID of the workflow.</p>
123
131
  */
124
132
  id?: string;
125
133
  /**
134
+ * @public
126
135
  * <p>The ARN of the workflow.</p>
127
136
  */
128
137
  arn?: string;
129
138
  /**
139
+ * @public
130
140
  * <p>The revision number of the workflow.</p>
131
141
  */
132
142
  revisionNumber?: number;
133
143
  /**
144
+ * @public
134
145
  * <p>The date when the workflow was created.</p>
135
146
  */
136
147
  createdAt?: Date;
@@ -140,6 +151,7 @@ export interface FlowTemplateSummary {
140
151
  */
141
152
  export interface CreateFlowTemplateResponse {
142
153
  /**
154
+ * @public
143
155
  * <p>The summary object that describes the created workflow.</p>
144
156
  */
145
157
  summary?: FlowTemplateSummary;
@@ -174,10 +186,12 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
174
186
  */
175
187
  export interface MetricsConfiguration {
176
188
  /**
189
+ * @public
177
190
  * <p>A Boolean that specifies whether cloud metrics are collected.</p>
178
191
  */
179
192
  cloudMetricEnabled?: boolean;
180
193
  /**
194
+ * @public
181
195
  * <p>The ARN of the role that is used to collect cloud metrics.</p>
182
196
  */
183
197
  metricRuleRoleArn?: string;
@@ -188,10 +202,12 @@ export interface MetricsConfiguration {
188
202
  */
189
203
  export interface Tag {
190
204
  /**
205
+ * @public
191
206
  * <p>The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.</p>
192
207
  */
193
208
  key: string | undefined;
194
209
  /**
210
+ * @public
195
211
  * <p>The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.</p>
196
212
  */
197
213
  value: string | undefined;
@@ -213,32 +229,39 @@ export type DeploymentTarget = (typeof DeploymentTarget)[keyof typeof Deployment
213
229
  */
214
230
  export interface CreateSystemInstanceRequest {
215
231
  /**
232
+ * @public
216
233
  * <p>Metadata, consisting of key-value pairs, that can be used to categorize your system instances.</p>
217
234
  */
218
235
  tags?: Tag[];
219
236
  /**
237
+ * @public
220
238
  * <p>A document that defines an entity. </p>
221
239
  */
222
240
  definition: DefinitionDocument | undefined;
223
241
  /**
242
+ * @public
224
243
  * <p>The target type of the deployment. Valid values are <code>GREENGRASS</code> and <code>CLOUD</code>.</p>
225
244
  */
226
245
  target: DeploymentTarget | string | undefined;
227
246
  /**
247
+ * @public
228
248
  * <p>The name of the Greengrass group where the system instance will be deployed. This value is required if
229
249
  * the value of the <code>target</code> parameter is <code>GREENGRASS</code>.</p>
230
250
  */
231
251
  greengrassGroupName?: string;
232
252
  /**
253
+ * @public
233
254
  * <p>The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if
234
255
  * the value of the <code>target</code> parameter is <code>GREENGRASS</code>.</p>
235
256
  */
236
257
  s3BucketName?: string;
237
258
  /**
259
+ * @public
238
260
  * <p>An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.</p>
239
261
  */
240
262
  metricsConfiguration?: MetricsConfiguration;
241
263
  /**
264
+ * @public
242
265
  * <p>The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have
243
266
  * read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This
244
267
  * value is required if the value of the <code>target</code> parameter is <code>CLOUD</code>.</p>
@@ -269,40 +292,49 @@ export type SystemInstanceDeploymentStatus = (typeof SystemInstanceDeploymentSta
269
292
  */
270
293
  export interface SystemInstanceSummary {
271
294
  /**
295
+ * @public
272
296
  * <p>The ID of the system instance.</p>
273
297
  */
274
298
  id?: string;
275
299
  /**
300
+ * @public
276
301
  * <p>The ARN of the system instance.</p>
277
302
  */
278
303
  arn?: string;
279
304
  /**
305
+ * @public
280
306
  * <p>The status of the system instance.</p>
281
307
  */
282
308
  status?: SystemInstanceDeploymentStatus | string;
283
309
  /**
310
+ * @public
284
311
  * <p>The target of the system instance.</p>
285
312
  */
286
313
  target?: DeploymentTarget | string;
287
314
  /**
315
+ * @public
288
316
  * <p>The ID of the Greengrass group where the system instance is deployed.</p>
289
317
  */
290
318
  greengrassGroupName?: string;
291
319
  /**
320
+ * @public
292
321
  * <p>The date when the system instance was created.</p>
293
322
  */
294
323
  createdAt?: Date;
295
324
  /**
325
+ * @public
296
326
  * <p>
297
327
  *
298
328
  * The date and time when the system instance was last updated.</p>
299
329
  */
300
330
  updatedAt?: Date;
301
331
  /**
332
+ * @public
302
333
  * <p>The ID of the Greengrass group where the system instance is deployed.</p>
303
334
  */
304
335
  greengrassGroupId?: string;
305
336
  /**
337
+ * @public
306
338
  * <p>The version of the Greengrass group where the system instance is deployed.</p>
307
339
  */
308
340
  greengrassGroupVersionId?: string;
@@ -312,6 +344,7 @@ export interface SystemInstanceSummary {
312
344
  */
313
345
  export interface CreateSystemInstanceResponse {
314
346
  /**
347
+ * @public
315
348
  * <p>The summary object that describes the new system instance.</p>
316
349
  */
317
350
  summary?: SystemInstanceSummary;
@@ -321,10 +354,12 @@ export interface CreateSystemInstanceResponse {
321
354
  */
322
355
  export interface CreateSystemTemplateRequest {
323
356
  /**
357
+ * @public
324
358
  * <p>The <code>DefinitionDocument</code> used to create the system.</p>
325
359
  */
326
360
  definition: DefinitionDocument | undefined;
327
361
  /**
362
+ * @public
328
363
  * <p>The namespace version in which the system is to be created.</p>
329
364
  * <p>If no value is specified, the latest version is used by default.</p>
330
365
  */
@@ -336,18 +371,22 @@ export interface CreateSystemTemplateRequest {
336
371
  */
337
372
  export interface SystemTemplateSummary {
338
373
  /**
374
+ * @public
339
375
  * <p>The ID of the system.</p>
340
376
  */
341
377
  id?: string;
342
378
  /**
379
+ * @public
343
380
  * <p>The ARN of the system.</p>
344
381
  */
345
382
  arn?: string;
346
383
  /**
384
+ * @public
347
385
  * <p>The revision number of the system.</p>
348
386
  */
349
387
  revisionNumber?: number;
350
388
  /**
389
+ * @public
351
390
  * <p>The date when the system was created.</p>
352
391
  */
353
392
  createdAt?: Date;
@@ -357,6 +396,7 @@ export interface SystemTemplateSummary {
357
396
  */
358
397
  export interface CreateSystemTemplateResponse {
359
398
  /**
399
+ * @public
360
400
  * <p>The summary object that describes the created system.</p>
361
401
  */
362
402
  summary?: SystemTemplateSummary;
@@ -366,6 +406,7 @@ export interface CreateSystemTemplateResponse {
366
406
  */
367
407
  export interface DeleteFlowTemplateRequest {
368
408
  /**
409
+ * @public
369
410
  * <p>The ID of the workflow to be deleted.</p>
370
411
  * <p>The ID should be in the following format.</p>
371
412
  * <p>
@@ -401,10 +442,12 @@ export interface DeleteNamespaceRequest {
401
442
  */
402
443
  export interface DeleteNamespaceResponse {
403
444
  /**
445
+ * @public
404
446
  * <p>The ARN of the namespace to be deleted.</p>
405
447
  */
406
448
  namespaceArn?: string;
407
449
  /**
450
+ * @public
408
451
  * <p>The name of the namespace to be deleted.</p>
409
452
  */
410
453
  namespaceName?: string;
@@ -414,6 +457,7 @@ export interface DeleteNamespaceResponse {
414
457
  */
415
458
  export interface DeleteSystemInstanceRequest {
416
459
  /**
460
+ * @public
417
461
  * <p>The ID of the system instance to be deleted.</p>
418
462
  */
419
463
  id?: string;
@@ -428,6 +472,7 @@ export interface DeleteSystemInstanceResponse {
428
472
  */
429
473
  export interface DeleteSystemTemplateRequest {
430
474
  /**
475
+ * @public
431
476
  * <p>The ID of the system to be deleted.</p>
432
477
  * <p>The ID should be in the following format.</p>
433
478
  * <p>
@@ -447,10 +492,12 @@ export interface DeleteSystemTemplateResponse {
447
492
  */
448
493
  export interface DependencyRevision {
449
494
  /**
495
+ * @public
450
496
  * <p>The ID of the workflow or system.</p>
451
497
  */
452
498
  id?: string;
453
499
  /**
500
+ * @public
454
501
  * <p>The revision number of the workflow or system.</p>
455
502
  */
456
503
  revisionNumber?: number;
@@ -460,6 +507,7 @@ export interface DependencyRevision {
460
507
  */
461
508
  export interface DeploySystemInstanceRequest {
462
509
  /**
510
+ * @public
463
511
  * <p>The ID of the system instance. This value is returned by the <code>CreateSystemInstance</code> action.</p>
464
512
  * <p>The ID should be in the following format.</p>
465
513
  * <p>
@@ -473,10 +521,12 @@ export interface DeploySystemInstanceRequest {
473
521
  */
474
522
  export interface DeploySystemInstanceResponse {
475
523
  /**
524
+ * @public
476
525
  * <p>An object that contains summary information about a system instance that was deployed. </p>
477
526
  */
478
527
  summary: SystemInstanceSummary | undefined;
479
528
  /**
529
+ * @public
480
530
  * <p>The ID of the Greengrass deployment used to deploy the system instance.</p>
481
531
  */
482
532
  greengrassDeploymentId?: string;
@@ -486,6 +536,7 @@ export interface DeploySystemInstanceResponse {
486
536
  */
487
537
  export interface DeprecateFlowTemplateRequest {
488
538
  /**
539
+ * @public
489
540
  * <p>The ID of the workflow to be deleted.</p>
490
541
  * <p>The ID should be in the following format.</p>
491
542
  * <p>
@@ -504,6 +555,7 @@ export interface DeprecateFlowTemplateResponse {
504
555
  */
505
556
  export interface DeprecateSystemTemplateRequest {
506
557
  /**
558
+ * @public
507
559
  * <p>The ID of the system to delete.</p>
508
560
  * <p>The ID should be in the following format.</p>
509
561
  * <p>
@@ -522,6 +574,7 @@ export interface DeprecateSystemTemplateResponse {
522
574
  */
523
575
  export interface DescribeNamespaceRequest {
524
576
  /**
577
+ * @public
525
578
  * <p>The name of the user's namespace. Set this to <code>aws</code> to get the public namespace.</p>
526
579
  */
527
580
  namespaceName?: string;
@@ -531,22 +584,27 @@ export interface DescribeNamespaceRequest {
531
584
  */
532
585
  export interface DescribeNamespaceResponse {
533
586
  /**
587
+ * @public
534
588
  * <p>The ARN of the namespace.</p>
535
589
  */
536
590
  namespaceArn?: string;
537
591
  /**
592
+ * @public
538
593
  * <p>The name of the namespace.</p>
539
594
  */
540
595
  namespaceName?: string;
541
596
  /**
597
+ * @public
542
598
  * <p>The name of the public namespace that the latest namespace version is tracking.</p>
543
599
  */
544
600
  trackingNamespaceName?: string;
545
601
  /**
602
+ * @public
546
603
  * <p>The version of the public namespace that the latest version is tracking.</p>
547
604
  */
548
605
  trackingNamespaceVersion?: number;
549
606
  /**
607
+ * @public
550
608
  * <p>The version of the user's namespace to describe.</p>
551
609
  */
552
610
  namespaceVersion?: number;
@@ -576,10 +634,12 @@ export type EntityType = (typeof EntityType)[keyof typeof EntityType];
576
634
  */
577
635
  export interface DissociateEntityFromThingRequest {
578
636
  /**
637
+ * @public
579
638
  * <p>The name of the thing to disassociate.</p>
580
639
  */
581
640
  thingName: string | undefined;
582
641
  /**
642
+ * @public
583
643
  * <p>The entity type from which to disassociate the thing.</p>
584
644
  */
585
645
  entityType: EntityType | string | undefined;
@@ -595,22 +655,27 @@ export interface DissociateEntityFromThingResponse {
595
655
  */
596
656
  export interface EntityDescription {
597
657
  /**
658
+ * @public
598
659
  * <p>The entity ID.</p>
599
660
  */
600
661
  id?: string;
601
662
  /**
663
+ * @public
602
664
  * <p>The entity ARN.</p>
603
665
  */
604
666
  arn?: string;
605
667
  /**
668
+ * @public
606
669
  * <p>The entity type.</p>
607
670
  */
608
671
  type?: EntityType | string;
609
672
  /**
673
+ * @public
610
674
  * <p>The time at which the entity was created.</p>
611
675
  */
612
676
  createdAt?: Date;
613
677
  /**
678
+ * @public
614
679
  * <p>The definition document of the entity.</p>
615
680
  */
616
681
  definition?: DefinitionDocument;
@@ -637,11 +702,13 @@ export type EntityFilterName = (typeof EntityFilterName)[keyof typeof EntityFilt
637
702
  */
638
703
  export interface EntityFilter {
639
704
  /**
705
+ * @public
640
706
  * <p>The name of the entity search filter field. <code>REFERENCED_ENTITY_ID</code> filters on entities that are used by the entity in the result set. For example,
641
707
  * you can filter on the ID of a property that is used in a state.</p>
642
708
  */
643
709
  name?: EntityFilterName | string;
644
710
  /**
711
+ * @public
645
712
  * <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>
646
713
  */
647
714
  value?: string[];
@@ -679,18 +746,22 @@ export type FlowExecutionEventType = (typeof FlowExecutionEventType)[keyof typeo
679
746
  */
680
747
  export interface FlowExecutionMessage {
681
748
  /**
749
+ * @public
682
750
  * <p>The unique identifier of the message.</p>
683
751
  */
684
752
  messageId?: string;
685
753
  /**
754
+ * @public
686
755
  * <p>The type of flow event .</p>
687
756
  */
688
757
  eventType?: FlowExecutionEventType | string;
689
758
  /**
759
+ * @public
690
760
  * <p>The date and time when the message was last updated.</p>
691
761
  */
692
762
  timestamp?: Date;
693
763
  /**
764
+ * @public
694
765
  * <p>A string containing information about the flow event.</p>
695
766
  */
696
767
  payload?: string;
@@ -715,26 +786,32 @@ export type FlowExecutionStatus = (typeof FlowExecutionStatus)[keyof typeof Flow
715
786
  */
716
787
  export interface FlowExecutionSummary {
717
788
  /**
789
+ * @public
718
790
  * <p>The ID of the flow execution.</p>
719
791
  */
720
792
  flowExecutionId?: string;
721
793
  /**
794
+ * @public
722
795
  * <p>The current status of the flow execution.</p>
723
796
  */
724
797
  status?: FlowExecutionStatus | string;
725
798
  /**
799
+ * @public
726
800
  * <p>The ID of the system instance that contains the flow.</p>
727
801
  */
728
802
  systemInstanceId?: string;
729
803
  /**
804
+ * @public
730
805
  * <p>The ID of the flow.</p>
731
806
  */
732
807
  flowTemplateId?: string;
733
808
  /**
809
+ * @public
734
810
  * <p>The date and time when the flow execution summary was created.</p>
735
811
  */
736
812
  createdAt?: Date;
737
813
  /**
814
+ * @public
738
815
  * <p>The date and time when the flow execution summary was last updated.</p>
739
816
  */
740
817
  updatedAt?: Date;
@@ -745,14 +822,17 @@ export interface FlowExecutionSummary {
745
822
  */
746
823
  export interface FlowTemplateDescription {
747
824
  /**
825
+ * @public
748
826
  * <p>An object that contains summary information about a workflow.</p>
749
827
  */
750
828
  summary?: FlowTemplateSummary;
751
829
  /**
830
+ * @public
752
831
  * <p>A workflow's definition document.</p>
753
832
  */
754
833
  definition?: DefinitionDocument;
755
834
  /**
835
+ * @public
756
836
  * <p>The version of the user's namespace against which the workflow was validated. Use this value in your system instance.</p>
757
837
  */
758
838
  validatedNamespaceVersion?: number;
@@ -774,10 +854,12 @@ export type FlowTemplateFilterName = (typeof FlowTemplateFilterName)[keyof typeo
774
854
  */
775
855
  export interface FlowTemplateFilter {
776
856
  /**
857
+ * @public
777
858
  * <p>The name of the search filter field.</p>
778
859
  */
779
860
  name: FlowTemplateFilterName | string | undefined;
780
861
  /**
862
+ * @public
781
863
  * <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>
782
864
  */
783
865
  value: string[] | undefined;
@@ -787,6 +869,7 @@ export interface FlowTemplateFilter {
787
869
  */
788
870
  export interface GetEntitiesRequest {
789
871
  /**
872
+ * @public
790
873
  * <p>An array of entity IDs.</p>
791
874
  * <p>The IDs should be in the following format.</p>
792
875
  * <p>
@@ -795,6 +878,7 @@ export interface GetEntitiesRequest {
795
878
  */
796
879
  ids: string[] | undefined;
797
880
  /**
881
+ * @public
798
882
  * <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
799
883
  */
800
884
  namespaceVersion?: number;
@@ -804,6 +888,7 @@ export interface GetEntitiesRequest {
804
888
  */
805
889
  export interface GetEntitiesResponse {
806
890
  /**
891
+ * @public
807
892
  * <p>An array of descriptions for the specified entities.</p>
808
893
  */
809
894
  descriptions?: EntityDescription[];
@@ -813,6 +898,7 @@ export interface GetEntitiesResponse {
813
898
  */
814
899
  export interface GetFlowTemplateRequest {
815
900
  /**
901
+ * @public
816
902
  * <p>The ID of the workflow.</p>
817
903
  * <p>The ID should be in the following format.</p>
818
904
  * <p>
@@ -821,6 +907,7 @@ export interface GetFlowTemplateRequest {
821
907
  */
822
908
  id: string | undefined;
823
909
  /**
910
+ * @public
824
911
  * <p>The number of the workflow revision to retrieve.</p>
825
912
  */
826
913
  revisionNumber?: number;
@@ -830,6 +917,7 @@ export interface GetFlowTemplateRequest {
830
917
  */
831
918
  export interface GetFlowTemplateResponse {
832
919
  /**
920
+ * @public
833
921
  * <p>The object that describes the specified workflow.</p>
834
922
  */
835
923
  description?: FlowTemplateDescription;
@@ -839,6 +927,7 @@ export interface GetFlowTemplateResponse {
839
927
  */
840
928
  export interface GetFlowTemplateRevisionsRequest {
841
929
  /**
930
+ * @public
842
931
  * <p>The ID of the workflow.</p>
843
932
  * <p>The ID should be in the following format.</p>
844
933
  * <p>
@@ -847,10 +936,12 @@ export interface GetFlowTemplateRevisionsRequest {
847
936
  */
848
937
  id: string | undefined;
849
938
  /**
939
+ * @public
850
940
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
851
941
  */
852
942
  nextToken?: string;
853
943
  /**
944
+ * @public
854
945
  * <p>The maximum number of results to return in the response.</p>
855
946
  */
856
947
  maxResults?: number;
@@ -860,10 +951,12 @@ export interface GetFlowTemplateRevisionsRequest {
860
951
  */
861
952
  export interface GetFlowTemplateRevisionsResponse {
862
953
  /**
954
+ * @public
863
955
  * <p>An array of objects that provide summary data about each revision.</p>
864
956
  */
865
957
  summaries?: FlowTemplateSummary[];
866
958
  /**
959
+ * @public
867
960
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
868
961
  */
869
962
  nextToken?: string;
@@ -902,22 +995,27 @@ export type NamespaceDeletionStatus = (typeof NamespaceDeletionStatus)[keyof typ
902
995
  */
903
996
  export interface GetNamespaceDeletionStatusResponse {
904
997
  /**
998
+ * @public
905
999
  * <p>The ARN of the namespace that is being deleted.</p>
906
1000
  */
907
1001
  namespaceArn?: string;
908
1002
  /**
1003
+ * @public
909
1004
  * <p>The name of the namespace that is being deleted.</p>
910
1005
  */
911
1006
  namespaceName?: string;
912
1007
  /**
1008
+ * @public
913
1009
  * <p>The status of the deletion request.</p>
914
1010
  */
915
1011
  status?: NamespaceDeletionStatus | string;
916
1012
  /**
1013
+ * @public
917
1014
  * <p>An error code returned by the namespace deletion task.</p>
918
1015
  */
919
1016
  errorCode?: NamespaceDeletionStatusErrorCodes | string;
920
1017
  /**
1018
+ * @public
921
1019
  * <p>An error code returned by the namespace deletion task.</p>
922
1020
  */
923
1021
  errorMessage?: string;
@@ -927,6 +1025,7 @@ export interface GetNamespaceDeletionStatusResponse {
927
1025
  */
928
1026
  export interface GetSystemInstanceRequest {
929
1027
  /**
1028
+ * @public
930
1029
  * <p>The ID of the system deployment instance. This value is returned by <code>CreateSystemInstance</code>.</p>
931
1030
  * <p>The ID should be in the following format.</p>
932
1031
  * <p>
@@ -941,30 +1040,37 @@ export interface GetSystemInstanceRequest {
941
1040
  */
942
1041
  export interface SystemInstanceDescription {
943
1042
  /**
1043
+ * @public
944
1044
  * <p>An object that contains summary information about a system instance.</p>
945
1045
  */
946
1046
  summary?: SystemInstanceSummary;
947
1047
  /**
1048
+ * @public
948
1049
  * <p>A document that defines an entity. </p>
949
1050
  */
950
1051
  definition?: DefinitionDocument;
951
1052
  /**
1053
+ * @public
952
1054
  * <p>The Amazon Simple Storage Service bucket where information about a system instance is stored.</p>
953
1055
  */
954
1056
  s3BucketName?: string;
955
1057
  /**
1058
+ * @public
956
1059
  * <p>An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.</p>
957
1060
  */
958
1061
  metricsConfiguration?: MetricsConfiguration;
959
1062
  /**
1063
+ * @public
960
1064
  * <p>The version of the user's namespace against which the system instance was validated.</p>
961
1065
  */
962
1066
  validatedNamespaceVersion?: number;
963
1067
  /**
1068
+ * @public
964
1069
  * <p>A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.</p>
965
1070
  */
966
1071
  validatedDependencyRevisions?: DependencyRevision[];
967
1072
  /**
1073
+ * @public
968
1074
  * <p>The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a
969
1075
  * cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other
970
1076
  * AWS services that the flow uses.</p>
@@ -976,6 +1082,7 @@ export interface SystemInstanceDescription {
976
1082
  */
977
1083
  export interface GetSystemInstanceResponse {
978
1084
  /**
1085
+ * @public
979
1086
  * <p>An object that describes the system instance.</p>
980
1087
  */
981
1088
  description?: SystemInstanceDescription;
@@ -985,6 +1092,7 @@ export interface GetSystemInstanceResponse {
985
1092
  */
986
1093
  export interface GetSystemTemplateRequest {
987
1094
  /**
1095
+ * @public
988
1096
  * <p>The ID of the system to get. This ID must be in the user's namespace.</p>
989
1097
  * <p>The ID should be in the following format.</p>
990
1098
  * <p>
@@ -993,6 +1101,7 @@ export interface GetSystemTemplateRequest {
993
1101
  */
994
1102
  id: string | undefined;
995
1103
  /**
1104
+ * @public
996
1105
  * <p>The number that specifies the revision of the system to get.</p>
997
1106
  */
998
1107
  revisionNumber?: number;
@@ -1003,14 +1112,17 @@ export interface GetSystemTemplateRequest {
1003
1112
  */
1004
1113
  export interface SystemTemplateDescription {
1005
1114
  /**
1115
+ * @public
1006
1116
  * <p>An object that contains summary information about a system.</p>
1007
1117
  */
1008
1118
  summary?: SystemTemplateSummary;
1009
1119
  /**
1120
+ * @public
1010
1121
  * <p>The definition document of a system.</p>
1011
1122
  */
1012
1123
  definition?: DefinitionDocument;
1013
1124
  /**
1125
+ * @public
1014
1126
  * <p>The namespace version against which the system was validated. Use this value in your system instance.</p>
1015
1127
  */
1016
1128
  validatedNamespaceVersion?: number;
@@ -1020,6 +1132,7 @@ export interface SystemTemplateDescription {
1020
1132
  */
1021
1133
  export interface GetSystemTemplateResponse {
1022
1134
  /**
1135
+ * @public
1023
1136
  * <p>An object that contains summary data about the system.</p>
1024
1137
  */
1025
1138
  description?: SystemTemplateDescription;
@@ -1029,6 +1142,7 @@ export interface GetSystemTemplateResponse {
1029
1142
  */
1030
1143
  export interface GetSystemTemplateRevisionsRequest {
1031
1144
  /**
1145
+ * @public
1032
1146
  * <p>The ID of the system template.</p>
1033
1147
  * <p>The ID should be in the following format.</p>
1034
1148
  * <p>
@@ -1037,10 +1151,12 @@ export interface GetSystemTemplateRevisionsRequest {
1037
1151
  */
1038
1152
  id: string | undefined;
1039
1153
  /**
1154
+ * @public
1040
1155
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1041
1156
  */
1042
1157
  nextToken?: string;
1043
1158
  /**
1159
+ * @public
1044
1160
  * <p>The maximum number of results to return in the response.</p>
1045
1161
  */
1046
1162
  maxResults?: number;
@@ -1050,10 +1166,12 @@ export interface GetSystemTemplateRevisionsRequest {
1050
1166
  */
1051
1167
  export interface GetSystemTemplateRevisionsResponse {
1052
1168
  /**
1169
+ * @public
1053
1170
  * <p>An array of objects that contain summary data about the system template revisions.</p>
1054
1171
  */
1055
1172
  summaries?: SystemTemplateSummary[];
1056
1173
  /**
1174
+ * @public
1057
1175
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>
1058
1176
  */
1059
1177
  nextToken?: string;
@@ -1063,6 +1181,7 @@ export interface GetSystemTemplateRevisionsResponse {
1063
1181
  */
1064
1182
  export interface GetUploadStatusRequest {
1065
1183
  /**
1184
+ * @public
1066
1185
  * <p>The ID of the upload. This value is returned by the <code>UploadEntityDefinitions</code> action.</p>
1067
1186
  */
1068
1187
  uploadId: string | undefined;
@@ -1085,30 +1204,37 @@ export type UploadStatus = (typeof UploadStatus)[keyof typeof UploadStatus];
1085
1204
  */
1086
1205
  export interface GetUploadStatusResponse {
1087
1206
  /**
1207
+ * @public
1088
1208
  * <p>The ID of the upload.</p>
1089
1209
  */
1090
1210
  uploadId: string | undefined;
1091
1211
  /**
1212
+ * @public
1092
1213
  * <p>The status of the upload. The initial status is <code>IN_PROGRESS</code>. The response show all validation failures if the upload fails.</p>
1093
1214
  */
1094
1215
  uploadStatus: UploadStatus | string | undefined;
1095
1216
  /**
1217
+ * @public
1096
1218
  * <p>The ARN of the upload.</p>
1097
1219
  */
1098
1220
  namespaceArn?: string;
1099
1221
  /**
1222
+ * @public
1100
1223
  * <p>The name of the upload's namespace.</p>
1101
1224
  */
1102
1225
  namespaceName?: string;
1103
1226
  /**
1227
+ * @public
1104
1228
  * <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
1105
1229
  */
1106
1230
  namespaceVersion?: number;
1107
1231
  /**
1232
+ * @public
1108
1233
  * <p>The reason for an upload failure.</p>
1109
1234
  */
1110
1235
  failureReason?: string[];
1111
1236
  /**
1237
+ * @public
1112
1238
  * <p>The date at which the upload was created.</p>
1113
1239
  */
1114
1240
  createdDate: Date | undefined;
@@ -1118,14 +1244,17 @@ export interface GetUploadStatusResponse {
1118
1244
  */
1119
1245
  export interface ListFlowExecutionMessagesRequest {
1120
1246
  /**
1247
+ * @public
1121
1248
  * <p>The ID of the flow execution.</p>
1122
1249
  */
1123
1250
  flowExecutionId: string | undefined;
1124
1251
  /**
1252
+ * @public
1125
1253
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1126
1254
  */
1127
1255
  nextToken?: string;
1128
1256
  /**
1257
+ * @public
1129
1258
  * <p>The maximum number of results to return in the response.</p>
1130
1259
  */
1131
1260
  maxResults?: number;
@@ -1135,10 +1264,12 @@ export interface ListFlowExecutionMessagesRequest {
1135
1264
  */
1136
1265
  export interface ListFlowExecutionMessagesResponse {
1137
1266
  /**
1267
+ * @public
1138
1268
  * <p>A list of objects that contain information about events in the specified flow execution.</p>
1139
1269
  */
1140
1270
  messages?: FlowExecutionMessage[];
1141
1271
  /**
1272
+ * @public
1142
1273
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>
1143
1274
  */
1144
1275
  nextToken?: string;
@@ -1148,14 +1279,17 @@ export interface ListFlowExecutionMessagesResponse {
1148
1279
  */
1149
1280
  export interface ListTagsForResourceRequest {
1150
1281
  /**
1282
+ * @public
1151
1283
  * <p>The maximum number of tags to return.</p>
1152
1284
  */
1153
1285
  maxResults?: number;
1154
1286
  /**
1287
+ * @public
1155
1288
  * <p>The Amazon Resource Name (ARN) of the resource whose tags are to be returned.</p>
1156
1289
  */
1157
1290
  resourceArn: string | undefined;
1158
1291
  /**
1292
+ * @public
1159
1293
  * <p>The token that specifies the next page of results to return.</p>
1160
1294
  */
1161
1295
  nextToken?: string;
@@ -1165,10 +1299,12 @@ export interface ListTagsForResourceRequest {
1165
1299
  */
1166
1300
  export interface ListTagsForResourceResponse {
1167
1301
  /**
1302
+ * @public
1168
1303
  * <p>List of tags returned by the <code>ListTagsForResource</code> operation.</p>
1169
1304
  */
1170
1305
  tags?: Tag[];
1171
1306
  /**
1307
+ * @public
1172
1308
  * <p>The token that specifies the next page of results to return.</p>
1173
1309
  */
1174
1310
  nextToken?: string;
@@ -1178,10 +1314,12 @@ export interface ListTagsForResourceResponse {
1178
1314
  */
1179
1315
  export interface SearchEntitiesRequest {
1180
1316
  /**
1317
+ * @public
1181
1318
  * <p>The entity types for which to search.</p>
1182
1319
  */
1183
1320
  entityTypes: (EntityType | string)[] | undefined;
1184
1321
  /**
1322
+ * @public
1185
1323
  * <p>Optional filter to apply to the search. Valid filters are <code>NAME</code>
1186
1324
  * <code>NAMESPACE</code>, <code>SEMANTIC_TYPE_PATH</code> and <code>REFERENCED_ENTITY_ID</code>.
1187
1325
  * <code>REFERENCED_ENTITY_ID</code> filters on entities that are used by the entity in the result set. For example,
@@ -1190,14 +1328,17 @@ export interface SearchEntitiesRequest {
1190
1328
  */
1191
1329
  filters?: EntityFilter[];
1192
1330
  /**
1331
+ * @public
1193
1332
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1194
1333
  */
1195
1334
  nextToken?: string;
1196
1335
  /**
1336
+ * @public
1197
1337
  * <p>The maximum number of results to return in the response.</p>
1198
1338
  */
1199
1339
  maxResults?: number;
1200
1340
  /**
1341
+ * @public
1201
1342
  * <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
1202
1343
  */
1203
1344
  namespaceVersion?: number;
@@ -1207,10 +1348,12 @@ export interface SearchEntitiesRequest {
1207
1348
  */
1208
1349
  export interface SearchEntitiesResponse {
1209
1350
  /**
1351
+ * @public
1210
1352
  * <p>An array of descriptions for each entity returned in the search result.</p>
1211
1353
  */
1212
1354
  descriptions?: EntityDescription[];
1213
1355
  /**
1356
+ * @public
1214
1357
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
1215
1358
  */
1216
1359
  nextToken?: string;
@@ -1220,26 +1363,32 @@ export interface SearchEntitiesResponse {
1220
1363
  */
1221
1364
  export interface SearchFlowExecutionsRequest {
1222
1365
  /**
1366
+ * @public
1223
1367
  * <p>The ID of the system instance that contains the flow.</p>
1224
1368
  */
1225
1369
  systemInstanceId: string | undefined;
1226
1370
  /**
1371
+ * @public
1227
1372
  * <p>The ID of a flow execution.</p>
1228
1373
  */
1229
1374
  flowExecutionId?: string;
1230
1375
  /**
1376
+ * @public
1231
1377
  * <p>The date and time of the earliest flow execution to return.</p>
1232
1378
  */
1233
1379
  startTime?: Date;
1234
1380
  /**
1381
+ * @public
1235
1382
  * <p>The date and time of the latest flow execution to return.</p>
1236
1383
  */
1237
1384
  endTime?: Date;
1238
1385
  /**
1386
+ * @public
1239
1387
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1240
1388
  */
1241
1389
  nextToken?: string;
1242
1390
  /**
1391
+ * @public
1243
1392
  * <p>The maximum number of results to return in the response.</p>
1244
1393
  */
1245
1394
  maxResults?: number;
@@ -1249,10 +1398,12 @@ export interface SearchFlowExecutionsRequest {
1249
1398
  */
1250
1399
  export interface SearchFlowExecutionsResponse {
1251
1400
  /**
1401
+ * @public
1252
1402
  * <p>An array of objects that contain summary information about each workflow execution in the result set.</p>
1253
1403
  */
1254
1404
  summaries?: FlowExecutionSummary[];
1255
1405
  /**
1406
+ * @public
1256
1407
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
1257
1408
  */
1258
1409
  nextToken?: string;
@@ -1262,14 +1413,17 @@ export interface SearchFlowExecutionsResponse {
1262
1413
  */
1263
1414
  export interface SearchFlowTemplatesRequest {
1264
1415
  /**
1416
+ * @public
1265
1417
  * <p>An array of objects that limit the result set. The only valid filter is <code>DEVICE_MODEL_ID</code>.</p>
1266
1418
  */
1267
1419
  filters?: FlowTemplateFilter[];
1268
1420
  /**
1421
+ * @public
1269
1422
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1270
1423
  */
1271
1424
  nextToken?: string;
1272
1425
  /**
1426
+ * @public
1273
1427
  * <p>The maximum number of results to return in the response.</p>
1274
1428
  */
1275
1429
  maxResults?: number;
@@ -1279,10 +1433,12 @@ export interface SearchFlowTemplatesRequest {
1279
1433
  */
1280
1434
  export interface SearchFlowTemplatesResponse {
1281
1435
  /**
1436
+ * @public
1282
1437
  * <p>An array of objects that contain summary information about each workflow in the result set.</p>
1283
1438
  */
1284
1439
  summaries?: FlowTemplateSummary[];
1285
1440
  /**
1441
+ * @public
1286
1442
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
1287
1443
  */
1288
1444
  nextToken?: string;
@@ -1308,10 +1464,12 @@ export type SystemInstanceFilterName = (typeof SystemInstanceFilterName)[keyof t
1308
1464
  */
1309
1465
  export interface SystemInstanceFilter {
1310
1466
  /**
1467
+ * @public
1311
1468
  * <p>The name of the search filter field.</p>
1312
1469
  */
1313
1470
  name?: SystemInstanceFilterName | string;
1314
1471
  /**
1472
+ * @public
1315
1473
  * <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search. </p>
1316
1474
  */
1317
1475
  value?: string[];
@@ -1321,16 +1479,19 @@ export interface SystemInstanceFilter {
1321
1479
  */
1322
1480
  export interface SearchSystemInstancesRequest {
1323
1481
  /**
1482
+ * @public
1324
1483
  * <p>Optional filter to apply to the search. Valid filters are <code>SYSTEM_TEMPLATE_ID</code>, <code>STATUS</code>, and
1325
1484
  * <code>GREENGRASS_GROUP_NAME</code>.</p>
1326
1485
  * <p>Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.</p>
1327
1486
  */
1328
1487
  filters?: SystemInstanceFilter[];
1329
1488
  /**
1489
+ * @public
1330
1490
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1331
1491
  */
1332
1492
  nextToken?: string;
1333
1493
  /**
1494
+ * @public
1334
1495
  * <p>The maximum number of results to return in the response.</p>
1335
1496
  */
1336
1497
  maxResults?: number;
@@ -1340,10 +1501,12 @@ export interface SearchSystemInstancesRequest {
1340
1501
  */
1341
1502
  export interface SearchSystemInstancesResponse {
1342
1503
  /**
1504
+ * @public
1343
1505
  * <p>An array of objects that contain summary data abour the system instances in the result set.</p>
1344
1506
  */
1345
1507
  summaries?: SystemInstanceSummary[];
1346
1508
  /**
1509
+ * @public
1347
1510
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results. </p>
1348
1511
  */
1349
1512
  nextToken?: string;
@@ -1365,10 +1528,12 @@ export type SystemTemplateFilterName = (typeof SystemTemplateFilterName)[keyof t
1365
1528
  */
1366
1529
  export interface SystemTemplateFilter {
1367
1530
  /**
1531
+ * @public
1368
1532
  * <p>The name of the system search filter field.</p>
1369
1533
  */
1370
1534
  name: SystemTemplateFilterName | string | undefined;
1371
1535
  /**
1536
+ * @public
1372
1537
  * <p>An array of string values for the search filter field. Multiple values function as AND criteria in the search.</p>
1373
1538
  */
1374
1539
  value: string[] | undefined;
@@ -1378,14 +1543,17 @@ export interface SystemTemplateFilter {
1378
1543
  */
1379
1544
  export interface SearchSystemTemplatesRequest {
1380
1545
  /**
1546
+ * @public
1381
1547
  * <p>An array of filters that limit the result set. The only valid filter is <code>FLOW_TEMPLATE_ID</code>.</p>
1382
1548
  */
1383
1549
  filters?: SystemTemplateFilter[];
1384
1550
  /**
1551
+ * @public
1385
1552
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1386
1553
  */
1387
1554
  nextToken?: string;
1388
1555
  /**
1556
+ * @public
1389
1557
  * <p>The maximum number of results to return in the response.</p>
1390
1558
  */
1391
1559
  maxResults?: number;
@@ -1395,10 +1563,12 @@ export interface SearchSystemTemplatesRequest {
1395
1563
  */
1396
1564
  export interface SearchSystemTemplatesResponse {
1397
1565
  /**
1566
+ * @public
1398
1567
  * <p>An array of objects that contain summary information about each system deployment in the result set.</p>
1399
1568
  */
1400
1569
  summaries?: SystemTemplateSummary[];
1401
1570
  /**
1571
+ * @public
1402
1572
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
1403
1573
  */
1404
1574
  nextToken?: string;
@@ -1408,6 +1578,7 @@ export interface SearchSystemTemplatesResponse {
1408
1578
  */
1409
1579
  export interface SearchThingsRequest {
1410
1580
  /**
1581
+ * @public
1411
1582
  * <p>The ID of the entity to which the things are associated.</p>
1412
1583
  * <p>The IDs should be in the following format.</p>
1413
1584
  * <p>
@@ -1416,14 +1587,17 @@ export interface SearchThingsRequest {
1416
1587
  */
1417
1588
  entityId: string | undefined;
1418
1589
  /**
1590
+ * @public
1419
1591
  * <p>The string that specifies the next page of results. Use this when you're paginating results.</p>
1420
1592
  */
1421
1593
  nextToken?: string;
1422
1594
  /**
1595
+ * @public
1423
1596
  * <p>The maximum number of results to return in the response.</p>
1424
1597
  */
1425
1598
  maxResults?: number;
1426
1599
  /**
1600
+ * @public
1427
1601
  * <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
1428
1602
  */
1429
1603
  namespaceVersion?: number;
@@ -1434,10 +1608,12 @@ export interface SearchThingsRequest {
1434
1608
  */
1435
1609
  export interface Thing {
1436
1610
  /**
1611
+ * @public
1437
1612
  * <p>The ARN of the thing.</p>
1438
1613
  */
1439
1614
  thingArn?: string;
1440
1615
  /**
1616
+ * @public
1441
1617
  * <p>The name of the thing.</p>
1442
1618
  */
1443
1619
  thingName?: string;
@@ -1447,10 +1623,12 @@ export interface Thing {
1447
1623
  */
1448
1624
  export interface SearchThingsResponse {
1449
1625
  /**
1626
+ * @public
1450
1627
  * <p>An array of things in the result set.</p>
1451
1628
  */
1452
1629
  things?: Thing[];
1453
1630
  /**
1631
+ * @public
1454
1632
  * <p>The string to specify as <code>nextToken</code> when you request the next page of results.</p>
1455
1633
  */
1456
1634
  nextToken?: string;
@@ -1460,10 +1638,12 @@ export interface SearchThingsResponse {
1460
1638
  */
1461
1639
  export interface TagResourceRequest {
1462
1640
  /**
1641
+ * @public
1463
1642
  * <p>The Amazon Resource Name (ARN) of the resource whose tags are returned.</p>
1464
1643
  */
1465
1644
  resourceArn: string | undefined;
1466
1645
  /**
1646
+ * @public
1467
1647
  * <p>A list of tags to add to the resource.></p>
1468
1648
  */
1469
1649
  tags: Tag[] | undefined;
@@ -1478,6 +1658,7 @@ export interface TagResourceResponse {
1478
1658
  */
1479
1659
  export interface UndeploySystemInstanceRequest {
1480
1660
  /**
1661
+ * @public
1481
1662
  * <p>The ID of the system instance to remove from its target.</p>
1482
1663
  */
1483
1664
  id?: string;
@@ -1487,6 +1668,7 @@ export interface UndeploySystemInstanceRequest {
1487
1668
  */
1488
1669
  export interface UndeploySystemInstanceResponse {
1489
1670
  /**
1671
+ * @public
1490
1672
  * <p>An object that contains summary information about the system instance that was removed from its target.</p>
1491
1673
  */
1492
1674
  summary?: SystemInstanceSummary;
@@ -1496,10 +1678,12 @@ export interface UndeploySystemInstanceResponse {
1496
1678
  */
1497
1679
  export interface UntagResourceRequest {
1498
1680
  /**
1681
+ * @public
1499
1682
  * <p>The Amazon Resource Name (ARN) of the resource whose tags are to be removed.</p>
1500
1683
  */
1501
1684
  resourceArn: string | undefined;
1502
1685
  /**
1686
+ * @public
1503
1687
  * <p>A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed. </p>
1504
1688
  * <p>This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#cli-using-param-json">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. </p>
1505
1689
  */
@@ -1515,6 +1699,7 @@ export interface UntagResourceResponse {
1515
1699
  */
1516
1700
  export interface UpdateFlowTemplateRequest {
1517
1701
  /**
1702
+ * @public
1518
1703
  * <p>The ID of the workflow to be updated.</p>
1519
1704
  * <p>The ID should be in the following format.</p>
1520
1705
  * <p>
@@ -1523,10 +1708,12 @@ export interface UpdateFlowTemplateRequest {
1523
1708
  */
1524
1709
  id: string | undefined;
1525
1710
  /**
1711
+ * @public
1526
1712
  * <p>The <code>DefinitionDocument</code> that contains the updated workflow definition.</p>
1527
1713
  */
1528
1714
  definition: DefinitionDocument | undefined;
1529
1715
  /**
1716
+ * @public
1530
1717
  * <p>The version of the user's namespace.</p>
1531
1718
  * <p>If no value is specified, the latest version is used by default. Use the <code>GetFlowTemplateRevisions</code> if you want to find earlier revisions of the flow
1532
1719
  * to update.</p>
@@ -1538,6 +1725,7 @@ export interface UpdateFlowTemplateRequest {
1538
1725
  */
1539
1726
  export interface UpdateFlowTemplateResponse {
1540
1727
  /**
1728
+ * @public
1541
1729
  * <p>An object containing summary information about the updated workflow.</p>
1542
1730
  */
1543
1731
  summary?: FlowTemplateSummary;
@@ -1547,6 +1735,7 @@ export interface UpdateFlowTemplateResponse {
1547
1735
  */
1548
1736
  export interface UpdateSystemTemplateRequest {
1549
1737
  /**
1738
+ * @public
1550
1739
  * <p>The ID of the system to be updated.</p>
1551
1740
  * <p>The ID should be in the following format.</p>
1552
1741
  * <p>
@@ -1555,10 +1744,12 @@ export interface UpdateSystemTemplateRequest {
1555
1744
  */
1556
1745
  id: string | undefined;
1557
1746
  /**
1747
+ * @public
1558
1748
  * <p>The <code>DefinitionDocument</code> that contains the updated system definition.</p>
1559
1749
  */
1560
1750
  definition: DefinitionDocument | undefined;
1561
1751
  /**
1752
+ * @public
1562
1753
  * <p>The version of the user's namespace. Defaults to the latest version of the user's namespace.</p>
1563
1754
  * <p>If no value is specified, the latest version is used by default.</p>
1564
1755
  */
@@ -1569,6 +1760,7 @@ export interface UpdateSystemTemplateRequest {
1569
1760
  */
1570
1761
  export interface UpdateSystemTemplateResponse {
1571
1762
  /**
1763
+ * @public
1572
1764
  * <p>An object containing summary information about the updated system.</p>
1573
1765
  */
1574
1766
  summary?: SystemTemplateSummary;
@@ -1578,14 +1770,17 @@ export interface UpdateSystemTemplateResponse {
1578
1770
  */
1579
1771
  export interface UploadEntityDefinitionsRequest {
1580
1772
  /**
1773
+ * @public
1581
1774
  * <p>The <code>DefinitionDocument</code> that defines the updated entities.</p>
1582
1775
  */
1583
1776
  document?: DefinitionDocument;
1584
1777
  /**
1778
+ * @public
1585
1779
  * <p>A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to <code>true</code>, the upload will create a new namespace version.</p>
1586
1780
  */
1587
1781
  syncWithPublicNamespace?: boolean;
1588
1782
  /**
1783
+ * @public
1589
1784
  * <p>A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new <code>DefinitionDocument</code>.
1590
1785
  * If set to <code>true</code>, the upload will create a new namespace version.</p>
1591
1786
  */
@@ -1596,6 +1791,7 @@ export interface UploadEntityDefinitionsRequest {
1596
1791
  */
1597
1792
  export interface UploadEntityDefinitionsResponse {
1598
1793
  /**
1794
+ * @public
1599
1795
  * <p>The ID that specifies the upload action. You can use this to track the status of the upload.</p>
1600
1796
  */
1601
1797
  uploadId: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-iotthingsgraph",
3
3
  "description": "AWS SDK for JavaScript Iotthingsgraph Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",