@aws-sdk/client-simspaceweaver 3.378.0 → 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.
@@ -1,4 +1,7 @@
1
1
  import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
2
5
  export interface ClientInputEndpointParameters {
3
6
  region?: string | Provider<string>;
4
7
  useDualstackEndpoint?: boolean | Provider<boolean>;
@@ -16,6 +16,7 @@
16
16
  */
17
17
  export * from "./SimSpaceWeaverClient";
18
18
  export * from "./SimSpaceWeaver";
19
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
19
20
  export * from "./commands";
20
21
  export * from "./pagination";
21
22
  export * from "./models";
@@ -19,12 +19,14 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export interface SimulationAppPortMapping {
21
21
  /**
22
+ * @public
22
23
  * <p>The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps
23
24
  * the <code>Declared</code> port to the <code>Actual</code> port. The source code for the
24
25
  * app should bind to the <code>Declared</code> port.</p>
25
26
  */
26
27
  Declared?: number;
27
28
  /**
29
+ * @public
28
30
  * <p>The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port
29
31
  * number when the app starts. SimSpace Weaver maps the <code>Declared</code> port to the
30
32
  * <code>Actual</code> port. Clients connect to the app using the app's IP address
@@ -67,6 +69,7 @@ export type ClockTargetStatus = (typeof ClockTargetStatus)[keyof typeof ClockTar
67
69
  */
68
70
  export interface CloudWatchLogsLogGroup {
69
71
  /**
72
+ * @public
70
73
  * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation.
71
74
  * For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
72
75
  * in the <i>Amazon Web Services General Reference</i>. For more information about log groups, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with log
@@ -93,12 +96,14 @@ export declare class ConflictException extends __BaseException {
93
96
  */
94
97
  export interface S3Destination {
95
98
  /**
99
+ * @public
96
100
  * <p>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating,
97
101
  * configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User
98
102
  * Guide</i>.</p>
99
103
  */
100
104
  BucketName?: string;
101
105
  /**
106
+ * @public
102
107
  * <p>A string prefix for an Amazon S3 object key. It's usually a folder name.
103
108
  * For more information about folders in Amazon S3, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-folders.html">Organizing objects in the Amazon S3 console using folders</a>
104
109
  * in the <i>Amazon Simple Storage Service User Guide</i>.</p>
@@ -110,10 +115,12 @@ export interface S3Destination {
110
115
  */
111
116
  export interface CreateSnapshotInput {
112
117
  /**
118
+ * @public
113
119
  * <p>The name of the simulation.</p>
114
120
  */
115
121
  Simulation: string | undefined;
116
122
  /**
123
+ * @public
117
124
  * <p>The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.</p>
118
125
  * <p>The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.</p>
119
126
  */
@@ -168,14 +175,17 @@ export declare class ValidationException extends __BaseException {
168
175
  */
169
176
  export interface DeleteAppInput {
170
177
  /**
178
+ * @public
171
179
  * <p>The name of the simulation of the app.</p>
172
180
  */
173
181
  Simulation: string | undefined;
174
182
  /**
183
+ * @public
175
184
  * <p>The name of the domain of the app.</p>
176
185
  */
177
186
  Domain: string | undefined;
178
187
  /**
188
+ * @public
179
189
  * <p>The name of the app.</p>
180
190
  */
181
191
  App: string | undefined;
@@ -190,6 +200,7 @@ export interface DeleteAppOutput {
190
200
  */
191
201
  export interface DeleteSimulationInput {
192
202
  /**
203
+ * @public
193
204
  * <p>The name of the simulation.</p>
194
205
  */
195
206
  Simulation: string | undefined;
@@ -204,14 +215,17 @@ export interface DeleteSimulationOutput {
204
215
  */
205
216
  export interface DescribeAppInput {
206
217
  /**
218
+ * @public
207
219
  * <p>The name of the simulation of the app.</p>
208
220
  */
209
221
  Simulation: string | undefined;
210
222
  /**
223
+ * @public
211
224
  * <p>The name of the domain of the app.</p>
212
225
  */
213
226
  Domain: string | undefined;
214
227
  /**
228
+ * @public
215
229
  * <p>The name of the app.</p>
216
230
  */
217
231
  App: string | undefined;
@@ -224,11 +238,13 @@ export interface DescribeAppInput {
224
238
  */
225
239
  export interface SimulationAppEndpointInfo {
226
240
  /**
241
+ * @public
227
242
  * <p>The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the
228
243
  * app starts.</p>
229
244
  */
230
245
  Address?: string;
231
246
  /**
247
+ * @public
232
248
  * <p>The inbound TCP/UDP port numbers of the app. The combination of an IP address and
233
249
  * a port number form a network endpoint.</p>
234
250
  */
@@ -240,6 +256,7 @@ export interface SimulationAppEndpointInfo {
240
256
  */
241
257
  export interface LaunchOverrides {
242
258
  /**
259
+ * @public
243
260
  * <p>App launch commands and command line parameters that override the launch command
244
261
  * configured in the simulation schema.</p>
245
262
  */
@@ -279,34 +296,42 @@ export type SimulationAppTargetStatus = (typeof SimulationAppTargetStatus)[keyof
279
296
  */
280
297
  export interface DescribeAppOutput {
281
298
  /**
299
+ * @public
282
300
  * <p>The name of the app.</p>
283
301
  */
284
302
  Name?: string;
285
303
  /**
304
+ * @public
286
305
  * <p>The name of the simulation of the app.</p>
287
306
  */
288
307
  Simulation?: string;
289
308
  /**
309
+ * @public
290
310
  * <p>The name of the domain of the app.</p>
291
311
  */
292
312
  Domain?: string;
293
313
  /**
314
+ * @public
294
315
  * <p>The current lifecycle state of the custom app.</p>
295
316
  */
296
317
  Status?: SimulationAppStatus | string;
297
318
  /**
319
+ * @public
298
320
  * <p>The desired lifecycle state of the custom app.</p>
299
321
  */
300
322
  TargetStatus?: SimulationAppTargetStatus | string;
301
323
  /**
324
+ * @public
302
325
  * <p>Options that apply when the app starts. These options override default behavior.</p>
303
326
  */
304
327
  LaunchOverrides?: LaunchOverrides;
305
328
  /**
329
+ * @public
306
330
  * <p>The description of the app.</p>
307
331
  */
308
332
  Description?: string;
309
333
  /**
334
+ * @public
310
335
  * <p>Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.</p>
311
336
  */
312
337
  EndpointInfo?: SimulationAppEndpointInfo;
@@ -316,6 +341,7 @@ export interface DescribeAppOutput {
316
341
  */
317
342
  export interface DescribeSimulationInput {
318
343
  /**
344
+ * @public
319
345
  * <p>The name of the simulation.</p>
320
346
  */
321
347
  Simulation: string | undefined;
@@ -326,10 +352,12 @@ export interface DescribeSimulationInput {
326
352
  */
327
353
  export interface SimulationClock {
328
354
  /**
355
+ * @public
329
356
  * <p>The current status of the simulation clock.</p>
330
357
  */
331
358
  Status?: ClockStatus | string;
332
359
  /**
360
+ * @public
333
361
  * <p>The desired status of the simulation clock.</p>
334
362
  */
335
363
  TargetStatus?: ClockTargetStatus | string;
@@ -357,10 +385,12 @@ export type LifecycleManagementStrategy = (typeof LifecycleManagementStrategy)[k
357
385
  */
358
386
  export interface Domain {
359
387
  /**
388
+ * @public
360
389
  * <p>The name of the domain.</p>
361
390
  */
362
391
  Name?: string;
363
392
  /**
393
+ * @public
364
394
  * <p>The type of lifecycle management for apps in the domain. Indicates whether apps in this
365
395
  * domain are <i>managed</i> (SimSpace Weaver starts and stops the apps) or
366
396
  * <i>unmanaged</i> (you must start and stop the apps).</p>
@@ -394,11 +424,13 @@ export interface Domain {
394
424
  */
395
425
  export interface LiveSimulationState {
396
426
  /**
427
+ * @public
397
428
  * <p>A list of domains for the simulation. For more information about domains, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains">Key concepts: Domains</a>
398
429
  * in the <i>SimSpace Weaver User Guide</i>.</p>
399
430
  */
400
431
  Domains?: Domain[];
401
432
  /**
433
+ * @public
402
434
  * <p>A list of simulation clocks.</p>
403
435
  * <note>
404
436
  * <p>At this time, a simulation has only one clock.</p>
@@ -412,6 +444,7 @@ export interface LiveSimulationState {
412
444
  */
413
445
  export interface LogDestination {
414
446
  /**
447
+ * @public
415
448
  * <p>An Amazon CloudWatch Logs log group that stores simulation log data. For more information about log groups, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with log
416
449
  * groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
417
450
  */
@@ -423,6 +456,7 @@ export interface LogDestination {
423
456
  */
424
457
  export interface LoggingConfiguration {
425
458
  /**
459
+ * @public
426
460
  * <p>A list of the locations where SimSpace Weaver sends simulation log data.</p>
427
461
  */
428
462
  Destinations?: LogDestination[];
@@ -436,12 +470,14 @@ export interface LoggingConfiguration {
436
470
  */
437
471
  export interface S3Location {
438
472
  /**
473
+ * @public
439
474
  * <p>The name of an Amazon S3 bucket. For more information about buckets, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html">Creating,
440
475
  * configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User
441
476
  * Guide</i>.</p>
442
477
  */
443
478
  BucketName?: string;
444
479
  /**
480
+ * @public
445
481
  * <p>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object
446
482
  * keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html">Uploading,
447
483
  * downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User
@@ -487,23 +523,28 @@ export type SimulationTargetStatus = (typeof SimulationTargetStatus)[keyof typeo
487
523
  */
488
524
  export interface DescribeSimulationOutput {
489
525
  /**
526
+ * @public
490
527
  * <p>The name of the simulation.</p>
491
528
  */
492
529
  Name?: string;
493
530
  /**
531
+ * @public
494
532
  * <p>A universally unique identifier (UUID) for this simulation.</p>
495
533
  */
496
534
  ExecutionId?: string;
497
535
  /**
536
+ * @public
498
537
  * <p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
499
538
  * in the <i>Amazon Web Services General Reference</i>.</p>
500
539
  */
501
540
  Arn?: string;
502
541
  /**
542
+ * @public
503
543
  * <p>The description of the simulation.</p>
504
544
  */
505
545
  Description?: string;
506
546
  /**
547
+ * @public
507
548
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
508
549
  * that the simulation assumes to perform actions. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
509
550
  * in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles,
@@ -512,19 +553,23 @@ export interface DescribeSimulationOutput {
512
553
  */
513
554
  RoleArn?: string;
514
555
  /**
556
+ * @public
515
557
  * <p>The time when the simulation was created, expressed as the
516
558
  * number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>
517
559
  */
518
560
  CreationTime?: Date;
519
561
  /**
562
+ * @public
520
563
  * <p>The current lifecycle state of the simulation.</p>
521
564
  */
522
565
  Status?: SimulationStatus | string;
523
566
  /**
567
+ * @public
524
568
  * <p>The desired lifecycle state of the simulation.</p>
525
569
  */
526
570
  TargetStatus?: SimulationTargetStatus | string;
527
571
  /**
572
+ * @public
528
573
  * <p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
529
574
  * For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
530
575
  * <i>Amazon Simple Storage Service User Guide</i>
@@ -532,6 +577,7 @@ export interface DescribeSimulationOutput {
532
577
  */
533
578
  SchemaS3Location?: S3Location;
534
579
  /**
580
+ * @public
535
581
  * @deprecated
536
582
  *
537
583
  * <p>An error message that SimSpace Weaver returns only if there is a problem with the simulation
@@ -539,15 +585,18 @@ export interface DescribeSimulationOutput {
539
585
  */
540
586
  SchemaError?: string;
541
587
  /**
588
+ * @public
542
589
  * <p>Settings that control how SimSpace Weaver handles your simulation log data.</p>
543
590
  */
544
591
  LoggingConfiguration?: LoggingConfiguration;
545
592
  /**
593
+ * @public
546
594
  * <p>A collection of additional state information, such as
547
595
  * domain and clock configuration.</p>
548
596
  */
549
597
  LiveSimulationState?: LiveSimulationState;
550
598
  /**
599
+ * @public
551
600
  * <p>The maximum running time of the simulation,
552
601
  * specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation
553
602
  * stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the
@@ -556,6 +605,7 @@ export interface DescribeSimulationOutput {
556
605
  */
557
606
  MaximumDuration?: string;
558
607
  /**
608
+ * @public
559
609
  * <p>A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip
560
610
  * files and schema file. For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
561
611
  * <i>Amazon Simple Storage Service User Guide</i>
@@ -563,6 +613,7 @@ export interface DescribeSimulationOutput {
563
613
  */
564
614
  SnapshotS3Location?: S3Location;
565
615
  /**
616
+ * @public
566
617
  * <p>An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the <code>STARTING</code> state.</p>
567
618
  */
568
619
  StartError?: string;
@@ -572,18 +623,22 @@ export interface DescribeSimulationOutput {
572
623
  */
573
624
  export interface ListAppsInput {
574
625
  /**
626
+ * @public
575
627
  * <p>The name of the simulation that you want to list apps for.</p>
576
628
  */
577
629
  Simulation: string | undefined;
578
630
  /**
631
+ * @public
579
632
  * <p>The name of the domain that you want to list apps for.</p>
580
633
  */
581
634
  Domain?: string;
582
635
  /**
636
+ * @public
583
637
  * <p>The maximum number of apps to list.</p>
584
638
  */
585
639
  MaxResults?: number;
586
640
  /**
641
+ * @public
587
642
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
588
643
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
589
644
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
@@ -598,23 +653,28 @@ export interface ListAppsInput {
598
653
  */
599
654
  export interface SimulationAppMetadata {
600
655
  /**
656
+ * @public
601
657
  * <p>The name of the app.</p>
602
658
  */
603
659
  Name?: string;
604
660
  /**
661
+ * @public
605
662
  * <p>The name of the simulation of the app.</p>
606
663
  */
607
664
  Simulation?: string;
608
665
  /**
666
+ * @public
609
667
  * <p>The domain of the app. For more information about domains, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains">Key concepts: Domains</a>
610
668
  * in the <i>SimSpace Weaver User Guide</i>.</p>
611
669
  */
612
670
  Domain?: string;
613
671
  /**
672
+ * @public
614
673
  * <p>The current status of the app.</p>
615
674
  */
616
675
  Status?: SimulationAppStatus | string;
617
676
  /**
677
+ * @public
618
678
  * <p>The desired status of the app.</p>
619
679
  */
620
680
  TargetStatus?: SimulationAppTargetStatus | string;
@@ -624,10 +684,12 @@ export interface SimulationAppMetadata {
624
684
  */
625
685
  export interface ListAppsOutput {
626
686
  /**
687
+ * @public
627
688
  * <p>The list of apps for the given simulation and domain.</p>
628
689
  */
629
690
  Apps?: SimulationAppMetadata[];
630
691
  /**
692
+ * @public
631
693
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
632
694
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
633
695
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
@@ -641,10 +703,12 @@ export interface ListAppsOutput {
641
703
  */
642
704
  export interface ListSimulationsInput {
643
705
  /**
706
+ * @public
644
707
  * <p>The maximum number of simulations to list.</p>
645
708
  */
646
709
  MaxResults?: number;
647
710
  /**
711
+ * @public
648
712
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
649
713
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
650
714
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
@@ -659,24 +723,29 @@ export interface ListSimulationsInput {
659
723
  */
660
724
  export interface SimulationMetadata {
661
725
  /**
726
+ * @public
662
727
  * <p>The name of the simulation.</p>
663
728
  */
664
729
  Name?: string;
665
730
  /**
731
+ * @public
666
732
  * <p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
667
733
  * in the <i>Amazon Web Services General Reference</i>.</p>
668
734
  */
669
735
  Arn?: string;
670
736
  /**
737
+ * @public
671
738
  * <p>The time when the simulation was created, expressed as the
672
739
  * number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>
673
740
  */
674
741
  CreationTime?: Date;
675
742
  /**
743
+ * @public
676
744
  * <p>The current status of the simulation.</p>
677
745
  */
678
746
  Status?: SimulationStatus | string;
679
747
  /**
748
+ * @public
680
749
  * <p>The desired status of the simulation.</p>
681
750
  */
682
751
  TargetStatus?: SimulationTargetStatus | string;
@@ -686,10 +755,12 @@ export interface SimulationMetadata {
686
755
  */
687
756
  export interface ListSimulationsOutput {
688
757
  /**
758
+ * @public
689
759
  * <p>The list of simulations.</p>
690
760
  */
691
761
  Simulations?: SimulationMetadata[];
692
762
  /**
763
+ * @public
693
764
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
694
765
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
695
766
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
@@ -703,6 +774,7 @@ export interface ListSimulationsOutput {
703
774
  */
704
775
  export interface ListTagsForResourceInput {
705
776
  /**
777
+ * @public
706
778
  * <p>The Amazon Resource Name (ARN) of the resource. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
707
779
  * in the <i>Amazon Web Services General Reference</i>.</p>
708
780
  */
@@ -713,6 +785,7 @@ export interface ListTagsForResourceInput {
713
785
  */
714
786
  export interface ListTagsForResourceOutput {
715
787
  /**
788
+ * @public
716
789
  * <p>The list of tags for the resource.</p>
717
790
  */
718
791
  Tags?: Record<string, string>;
@@ -735,28 +808,34 @@ export declare class ServiceQuotaExceededException extends __BaseException {
735
808
  */
736
809
  export interface StartAppInput {
737
810
  /**
811
+ * @public
738
812
  * <p>A value that you provide to ensure that repeated calls to this
739
813
  * API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an
740
814
  * <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>
741
815
  */
742
816
  ClientToken?: string;
743
817
  /**
818
+ * @public
744
819
  * <p>The name of the simulation of the app.</p>
745
820
  */
746
821
  Simulation: string | undefined;
747
822
  /**
823
+ * @public
748
824
  * <p>The name of the domain of the app.</p>
749
825
  */
750
826
  Domain: string | undefined;
751
827
  /**
828
+ * @public
752
829
  * <p>The name of the app.</p>
753
830
  */
754
831
  Name: string | undefined;
755
832
  /**
833
+ * @public
756
834
  * <p>The description of the app.</p>
757
835
  */
758
836
  Description?: string;
759
837
  /**
838
+ * @public
760
839
  * <p>Options that apply when the app starts. These options override default behavior.</p>
761
840
  */
762
841
  LaunchOverrides?: LaunchOverrides;
@@ -766,14 +845,17 @@ export interface StartAppInput {
766
845
  */
767
846
  export interface StartAppOutput {
768
847
  /**
848
+ * @public
769
849
  * <p>The name of the app.</p>
770
850
  */
771
851
  Name?: string;
772
852
  /**
853
+ * @public
773
854
  * <p>The name of the domain of the app.</p>
774
855
  */
775
856
  Domain?: string;
776
857
  /**
858
+ * @public
777
859
  * <p>The name of the simulation of the app.</p>
778
860
  */
779
861
  Simulation?: string;
@@ -783,6 +865,7 @@ export interface StartAppOutput {
783
865
  */
784
866
  export interface StartClockInput {
785
867
  /**
868
+ * @public
786
869
  * <p>The name of the simulation.</p>
787
870
  */
788
871
  Simulation: string | undefined;
@@ -797,20 +880,24 @@ export interface StartClockOutput {
797
880
  */
798
881
  export interface StartSimulationInput {
799
882
  /**
883
+ * @public
800
884
  * <p>A value that you provide to ensure that repeated calls to this
801
885
  * API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an
802
886
  * <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>
803
887
  */
804
888
  ClientToken?: string;
805
889
  /**
890
+ * @public
806
891
  * <p>The name of the simulation.</p>
807
892
  */
808
893
  Name: string | undefined;
809
894
  /**
895
+ * @public
810
896
  * <p>The description of the simulation.</p>
811
897
  */
812
898
  Description?: string;
813
899
  /**
900
+ * @public
814
901
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
815
902
  * that the simulation assumes to perform actions. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
816
903
  * in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles,
@@ -819,6 +906,7 @@ export interface StartSimulationInput {
819
906
  */
820
907
  RoleArn: string | undefined;
821
908
  /**
909
+ * @public
822
910
  * <p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
823
911
  * For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
824
912
  * <i>Amazon Simple Storage Service User Guide</i>
@@ -828,6 +916,7 @@ export interface StartSimulationInput {
828
916
  */
829
917
  SchemaS3Location?: S3Location;
830
918
  /**
919
+ * @public
831
920
  * <p>The maximum running time of the simulation,
832
921
  * specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation
833
922
  * stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the
@@ -836,11 +925,13 @@ export interface StartSimulationInput {
836
925
  */
837
926
  MaximumDuration?: string;
838
927
  /**
928
+ * @public
839
929
  * <p>A list of tags for the simulation. For more information about tags, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the
840
930
  * <i>Amazon Web Services General Reference</i>.</p>
841
931
  */
842
932
  Tags?: Record<string, string>;
843
933
  /**
934
+ * @public
844
935
  * <p>The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).
845
936
  * For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
846
937
  * <i>Amazon Simple Storage Service User Guide</i>
@@ -856,15 +947,18 @@ export interface StartSimulationInput {
856
947
  */
857
948
  export interface StartSimulationOutput {
858
949
  /**
950
+ * @public
859
951
  * <p>The Amazon Resource Name (ARN) of the simulation. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
860
952
  * in the <i>Amazon Web Services General Reference</i>.</p>
861
953
  */
862
954
  Arn?: string;
863
955
  /**
956
+ * @public
864
957
  * <p>A universally unique identifier (UUID) for this simulation.</p>
865
958
  */
866
959
  ExecutionId?: string;
867
960
  /**
961
+ * @public
868
962
  * <p>The time when the simulation was created, expressed as the
869
963
  * number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>
870
964
  */
@@ -875,14 +969,17 @@ export interface StartSimulationOutput {
875
969
  */
876
970
  export interface StopAppInput {
877
971
  /**
972
+ * @public
878
973
  * <p>The name of the simulation of the app.</p>
879
974
  */
880
975
  Simulation: string | undefined;
881
976
  /**
977
+ * @public
882
978
  * <p>The name of the domain of the app.</p>
883
979
  */
884
980
  Domain: string | undefined;
885
981
  /**
982
+ * @public
886
983
  * <p>The name of the app.</p>
887
984
  */
888
985
  App: string | undefined;
@@ -897,6 +994,7 @@ export interface StopAppOutput {
897
994
  */
898
995
  export interface StopClockInput {
899
996
  /**
997
+ * @public
900
998
  * <p>The name of the simulation.</p>
901
999
  */
902
1000
  Simulation: string | undefined;
@@ -911,6 +1009,7 @@ export interface StopClockOutput {
911
1009
  */
912
1010
  export interface StopSimulationInput {
913
1011
  /**
1012
+ * @public
914
1013
  * <p>The name of the simulation.</p>
915
1014
  */
916
1015
  Simulation: string | undefined;
@@ -925,12 +1024,14 @@ export interface StopSimulationOutput {
925
1024
  */
926
1025
  export interface TagResourceInput {
927
1026
  /**
1027
+ * @public
928
1028
  * <p>The Amazon Resource Name (ARN) of the resource that you want to add tags to.
929
1029
  * For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
930
1030
  * in the <i>Amazon Web Services General Reference</i>.</p>
931
1031
  */
932
1032
  ResourceArn: string | undefined;
933
1033
  /**
1034
+ * @public
934
1035
  * <p>A list of tags to apply to the resource.</p>
935
1036
  */
936
1037
  Tags: Record<string, string> | undefined;
@@ -958,12 +1059,14 @@ export declare class TooManyTagsException extends __BaseException {
958
1059
  */
959
1060
  export interface UntagResourceInput {
960
1061
  /**
1062
+ * @public
961
1063
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
962
1064
  * For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>
963
1065
  * in the <i>Amazon Web Services General Reference</i>.</p>
964
1066
  */
965
1067
  ResourceArn: string | undefined;
966
1068
  /**
1069
+ * @public
967
1070
  * <p>A list of tag keys to remove from the resource.</p>
968
1071
  */
969
1072
  TagKeys: string[] | undefined;
@@ -1,5 +1,6 @@
1
1
  export * from "./SimSpaceWeaverClient";
2
2
  export * from "./SimSpaceWeaver";
3
+ export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
3
4
  export * from "./commands";
4
5
  export * from "./pagination";
5
6
  export * from "./models";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-simspaceweaver",
3
3
  "description": "AWS SDK for JavaScript Simspaceweaver Client for Node.js, Browser and React Native",
4
- "version": "3.378.0",
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.378.0",
25
- "@aws-sdk/credential-provider-node": "3.378.0",
26
- "@aws-sdk/middleware-host-header": "3.378.0",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
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
- "@aws-sdk/middleware-signing": "3.378.0",
30
- "@aws-sdk/middleware-user-agent": "3.378.0",
29
+ "@aws-sdk/middleware-signing": "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",