@aws-sdk/client-simspaceweaver 3.533.0 → 3.540.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 (43) hide show
  1. package/dist-cjs/endpoint/endpointResolver.js +4 -2
  2. package/dist-cjs/index.js +0 -3
  3. package/dist-es/endpoint/endpointResolver.js +3 -1
  4. package/dist-es/index.js +0 -1
  5. package/dist-types/SimSpaceWeaver.d.ts +2 -1
  6. package/dist-types/SimSpaceWeaverClient.d.ts +1 -1
  7. package/dist-types/commands/CreateSnapshotCommand.d.ts +2 -1
  8. package/dist-types/commands/DeleteAppCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteSimulationCommand.d.ts +2 -1
  10. package/dist-types/commands/DescribeAppCommand.d.ts +2 -1
  11. package/dist-types/commands/DescribeSimulationCommand.d.ts +2 -1
  12. package/dist-types/commands/ListAppsCommand.d.ts +2 -1
  13. package/dist-types/commands/ListSimulationsCommand.d.ts +2 -1
  14. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  15. package/dist-types/commands/StartAppCommand.d.ts +2 -1
  16. package/dist-types/commands/StartClockCommand.d.ts +2 -1
  17. package/dist-types/commands/StartSimulationCommand.d.ts +2 -1
  18. package/dist-types/commands/StopAppCommand.d.ts +2 -1
  19. package/dist-types/commands/StopClockCommand.d.ts +2 -1
  20. package/dist-types/commands/StopSimulationCommand.d.ts +2 -1
  21. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  22. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  23. package/dist-types/index.d.ts +0 -1
  24. package/dist-types/models/models_0.d.ts +123 -123
  25. package/dist-types/ts3.4/SimSpaceWeaver.d.ts +1 -0
  26. package/dist-types/ts3.4/commands/CreateSnapshotCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/DeleteAppCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/DeleteSimulationCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/DescribeAppCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/DescribeSimulationCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/ListAppsCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/ListSimulationsCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/StartAppCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/StartClockCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/StartSimulationCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/commands/StopAppCommand.d.ts +7 -0
  38. package/dist-types/ts3.4/commands/StopClockCommand.d.ts +9 -0
  39. package/dist-types/ts3.4/commands/StopSimulationCommand.d.ts +9 -0
  40. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  41. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  42. package/dist-types/ts3.4/index.d.ts +0 -1
  43. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { SimSpaceWeaverServiceException as __BaseException } from "./SimSpaceWeaverServiceException";
3
3
  /**
4
- * @public
5
4
  * <p/>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -14,23 +14,23 @@ export declare class AccessDeniedException extends __BaseException {
14
14
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
15
  }
16
16
  /**
17
- * @public
18
17
  * <p>A collection of TCP/UDP ports for a custom or service app.</p>
18
+ * @public
19
19
  */
20
20
  export interface SimulationAppPortMapping {
21
21
  /**
22
- * @public
23
22
  * <p>The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps
24
23
  * the <code>Declared</code> port to the <code>Actual</code> port. The source code for the
25
24
  * app should bind to the <code>Declared</code> port.</p>
25
+ * @public
26
26
  */
27
27
  Declared?: number;
28
28
  /**
29
- * @public
30
29
  * <p>The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port
31
30
  * number when the app starts. SimSpace Weaver maps the <code>Declared</code> port to the
32
31
  * <code>Actual</code> port. Clients connect to the app using the app's IP address
33
32
  * and the <code>Actual</code> port number.</p>
33
+ * @public
34
34
  */
35
35
  Actual?: number;
36
36
  }
@@ -63,23 +63,23 @@ export declare const ClockTargetStatus: {
63
63
  */
64
64
  export type ClockTargetStatus = (typeof ClockTargetStatus)[keyof typeof ClockTargetStatus];
65
65
  /**
66
- * @public
67
66
  * <p>The Amazon CloudWatch Logs log group for the simulation. 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
68
67
  * groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
68
+ * @public
69
69
  */
70
70
  export interface CloudWatchLogsLogGroup {
71
71
  /**
72
- * @public
73
72
  * <p>The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group for the simulation.
74
73
  * 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>
75
74
  * 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
76
75
  * groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
76
+ * @public
77
77
  */
78
78
  LogGroupArn?: string;
79
79
  }
80
80
  /**
81
- * @public
82
81
  * <p/>
82
+ * @public
83
83
  */
84
84
  export declare class ConflictException extends __BaseException {
85
85
  readonly name: "ConflictException";
@@ -91,22 +91,22 @@ export declare class ConflictException extends __BaseException {
91
91
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
92
92
  }
93
93
  /**
94
- * @public
95
94
  * <p>An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.</p>
95
+ * @public
96
96
  */
97
97
  export interface S3Destination {
98
98
  /**
99
- * @public
100
99
  * <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,
101
100
  * configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User
102
101
  * Guide</i>.</p>
102
+ * @public
103
103
  */
104
104
  BucketName: string | undefined;
105
105
  /**
106
- * @public
107
106
  * <p>A string prefix for an Amazon S3 object key. It's usually a folder name.
108
107
  * 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>
109
108
  * in the <i>Amazon Simple Storage Service User Guide</i>.</p>
109
+ * @public
110
110
  */
111
111
  ObjectKeyPrefix?: string;
112
112
  }
@@ -115,14 +115,14 @@ export interface S3Destination {
115
115
  */
116
116
  export interface CreateSnapshotInput {
117
117
  /**
118
- * @public
119
118
  * <p>The name of the simulation.</p>
119
+ * @public
120
120
  */
121
121
  Simulation: string | undefined;
122
122
  /**
123
- * @public
124
123
  * <p>The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.</p>
125
124
  * <p>The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.</p>
125
+ * @public
126
126
  */
127
127
  Destination: S3Destination | undefined;
128
128
  }
@@ -132,8 +132,8 @@ export interface CreateSnapshotInput {
132
132
  export interface CreateSnapshotOutput {
133
133
  }
134
134
  /**
135
- * @public
136
135
  * <p/>
136
+ * @public
137
137
  */
138
138
  export declare class InternalServerException extends __BaseException {
139
139
  readonly name: "InternalServerException";
@@ -145,8 +145,8 @@ export declare class InternalServerException extends __BaseException {
145
145
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
146
146
  }
147
147
  /**
148
- * @public
149
148
  * <p/>
149
+ * @public
150
150
  */
151
151
  export declare class ResourceNotFoundException extends __BaseException {
152
152
  readonly name: "ResourceNotFoundException";
@@ -158,8 +158,8 @@ export declare class ResourceNotFoundException extends __BaseException {
158
158
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
159
159
  }
160
160
  /**
161
- * @public
162
161
  * <p/>
162
+ * @public
163
163
  */
164
164
  export declare class ValidationException extends __BaseException {
165
165
  readonly name: "ValidationException";
@@ -175,18 +175,18 @@ export declare class ValidationException extends __BaseException {
175
175
  */
176
176
  export interface DeleteAppInput {
177
177
  /**
178
- * @public
179
178
  * <p>The name of the simulation of the app.</p>
179
+ * @public
180
180
  */
181
181
  Simulation: string | undefined;
182
182
  /**
183
- * @public
184
183
  * <p>The name of the domain of the app.</p>
184
+ * @public
185
185
  */
186
186
  Domain: string | undefined;
187
187
  /**
188
- * @public
189
188
  * <p>The name of the app.</p>
189
+ * @public
190
190
  */
191
191
  App: string | undefined;
192
192
  }
@@ -200,8 +200,8 @@ export interface DeleteAppOutput {
200
200
  */
201
201
  export interface DeleteSimulationInput {
202
202
  /**
203
- * @public
204
203
  * <p>The name of the simulation.</p>
204
+ * @public
205
205
  */
206
206
  Simulation: string | undefined;
207
207
  }
@@ -215,50 +215,50 @@ export interface DeleteSimulationOutput {
215
215
  */
216
216
  export interface DescribeAppInput {
217
217
  /**
218
- * @public
219
218
  * <p>The name of the simulation of the app.</p>
219
+ * @public
220
220
  */
221
221
  Simulation: string | undefined;
222
222
  /**
223
- * @public
224
223
  * <p>The name of the domain of the app.</p>
224
+ * @public
225
225
  */
226
226
  Domain: string | undefined;
227
227
  /**
228
- * @public
229
228
  * <p>The name of the app.</p>
229
+ * @public
230
230
  */
231
231
  App: string | undefined;
232
232
  }
233
233
  /**
234
- * @public
235
234
  * <p>Information about the network endpoint that you can use to connect to your custom or
236
235
  * service app. For more information about SimSpace Weaver apps, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_apps">Key concepts: Apps</a>
237
236
  * in the <i>SimSpace Weaver User Guide</i>..</p>
237
+ * @public
238
238
  */
239
239
  export interface SimulationAppEndpointInfo {
240
240
  /**
241
- * @public
242
241
  * <p>The IP address of the app. SimSpace Weaver dynamically assigns this IP address when the
243
242
  * app starts.</p>
243
+ * @public
244
244
  */
245
245
  Address?: string;
246
246
  /**
247
- * @public
248
247
  * <p>The inbound TCP/UDP port numbers of the app. The combination of an IP address and
249
248
  * a port number form a network endpoint.</p>
249
+ * @public
250
250
  */
251
251
  IngressPortMappings?: SimulationAppPortMapping[];
252
252
  }
253
253
  /**
254
- * @public
255
254
  * <p>Options that apply when the app starts. These options override default behavior.</p>
255
+ * @public
256
256
  */
257
257
  export interface LaunchOverrides {
258
258
  /**
259
- * @public
260
259
  * <p>App launch commands and command line parameters that override the launch command
261
260
  * configured in the simulation schema.</p>
261
+ * @public
262
262
  */
263
263
  LaunchCommands?: string[];
264
264
  }
@@ -296,43 +296,43 @@ export type SimulationAppTargetStatus = (typeof SimulationAppTargetStatus)[keyof
296
296
  */
297
297
  export interface DescribeAppOutput {
298
298
  /**
299
- * @public
300
299
  * <p>The name of the app.</p>
300
+ * @public
301
301
  */
302
302
  Name?: string;
303
303
  /**
304
- * @public
305
304
  * <p>The name of the simulation of the app.</p>
305
+ * @public
306
306
  */
307
307
  Simulation?: string;
308
308
  /**
309
- * @public
310
309
  * <p>The name of the domain of the app.</p>
310
+ * @public
311
311
  */
312
312
  Domain?: string;
313
313
  /**
314
- * @public
315
314
  * <p>The current lifecycle state of the custom app.</p>
315
+ * @public
316
316
  */
317
317
  Status?: SimulationAppStatus;
318
318
  /**
319
- * @public
320
319
  * <p>The desired lifecycle state of the custom app.</p>
320
+ * @public
321
321
  */
322
322
  TargetStatus?: SimulationAppTargetStatus;
323
323
  /**
324
- * @public
325
324
  * <p>Options that apply when the app starts. These options override default behavior.</p>
325
+ * @public
326
326
  */
327
327
  LaunchOverrides?: LaunchOverrides;
328
328
  /**
329
- * @public
330
329
  * <p>The description of the app.</p>
330
+ * @public
331
331
  */
332
332
  Description?: string;
333
333
  /**
334
- * @public
335
334
  * <p>Information about the network endpoint for the custom app. You can use the endpoint to connect to the custom app.</p>
335
+ * @public
336
336
  */
337
337
  EndpointInfo?: SimulationAppEndpointInfo;
338
338
  }
@@ -341,24 +341,24 @@ export interface DescribeAppOutput {
341
341
  */
342
342
  export interface DescribeSimulationInput {
343
343
  /**
344
- * @public
345
344
  * <p>The name of the simulation.</p>
345
+ * @public
346
346
  */
347
347
  Simulation: string | undefined;
348
348
  }
349
349
  /**
350
- * @public
351
350
  * <p>Status information about the simulation clock.</p>
351
+ * @public
352
352
  */
353
353
  export interface SimulationClock {
354
354
  /**
355
- * @public
356
355
  * <p>The current status of the simulation clock.</p>
356
+ * @public
357
357
  */
358
358
  Status?: ClockStatus;
359
359
  /**
360
- * @public
361
360
  * <p>The desired status of the simulation clock.</p>
361
+ * @public
362
362
  */
363
363
  TargetStatus?: ClockTargetStatus;
364
364
  }
@@ -377,20 +377,19 @@ export declare const LifecycleManagementStrategy: {
377
377
  */
378
378
  export type LifecycleManagementStrategy = (typeof LifecycleManagementStrategy)[keyof typeof LifecycleManagementStrategy];
379
379
  /**
380
- * @public
381
380
  * <p>A collection of app instances that run the same executable app code and have the same
382
381
  * launch options and commands.</p>
383
382
  * <p>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>
384
383
  * in the <i>SimSpace Weaver User Guide</i>.</p>
384
+ * @public
385
385
  */
386
386
  export interface Domain {
387
387
  /**
388
- * @public
389
388
  * <p>The name of the domain.</p>
389
+ * @public
390
390
  */
391
391
  Name?: string;
392
392
  /**
393
- * @public
394
393
  * <p>The type of lifecycle management for apps in the domain. Indicates whether apps in this
395
394
  * domain are <i>managed</i> (SimSpace Weaver starts and stops the apps) or
396
395
  * <i>unmanaged</i> (you must start and stop the apps).</p>
@@ -414,74 +413,75 @@ export interface Domain {
414
413
  * API to start the apps and use the <code>StopApp</code> API to stop the apps.</p>
415
414
  * </li>
416
415
  * </ul>
416
+ * @public
417
417
  */
418
418
  Lifecycle?: LifecycleManagementStrategy;
419
419
  }
420
420
  /**
421
- * @public
422
421
  * <p>A collection of additional state information, such as
423
422
  * domain and clock configuration.</p>
423
+ * @public
424
424
  */
425
425
  export interface LiveSimulationState {
426
426
  /**
427
- * @public
428
427
  * <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>
429
428
  * in the <i>SimSpace Weaver User Guide</i>.</p>
429
+ * @public
430
430
  */
431
431
  Domains?: Domain[];
432
432
  /**
433
- * @public
434
433
  * <p>A list of simulation clocks.</p>
435
434
  * <note>
436
435
  * <p>At this time, a simulation has only one clock.</p>
437
436
  * </note>
437
+ * @public
438
438
  */
439
439
  Clocks?: SimulationClock[];
440
440
  }
441
441
  /**
442
- * @public
443
442
  * <p>The location where SimSpace Weaver sends simulation log data.</p>
443
+ * @public
444
444
  */
445
445
  export interface LogDestination {
446
446
  /**
447
- * @public
448
447
  * <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
449
448
  * groups and log streams</a> in the <i>Amazon CloudWatch Logs User Guide</i>.</p>
449
+ * @public
450
450
  */
451
451
  CloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
452
452
  }
453
453
  /**
454
- * @public
455
454
  * <p>The logging configuration for a simulation.</p>
455
+ * @public
456
456
  */
457
457
  export interface LoggingConfiguration {
458
458
  /**
459
- * @public
460
459
  * <p>A list of the locations where SimSpace Weaver sends simulation log data.</p>
460
+ * @public
461
461
  */
462
462
  Destinations?: LogDestination[];
463
463
  }
464
464
  /**
465
- * @public
466
465
  * <p>A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip
467
466
  * files and schema file. For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
468
467
  * <i>Amazon Simple Storage Service User Guide</i>
469
468
  * </a>.</p>
469
+ * @public
470
470
  */
471
471
  export interface S3Location {
472
472
  /**
473
- * @public
474
473
  * <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,
475
474
  * configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User
476
475
  * Guide</i>.</p>
476
+ * @public
477
477
  */
478
478
  BucketName: string | undefined;
479
479
  /**
480
- * @public
481
480
  * <p>The key name of an object in Amazon S3. For more information about Amazon S3 objects and object
482
481
  * keys, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/uploading-downloading-objects.html">Uploading,
483
482
  * downloading, and working with objects in Amazon S3</a> in the <i>Amazon Simple Storage Service User
484
483
  * Guide</i>.</p>
484
+ * @public
485
485
  */
486
486
  ObjectKey: string | undefined;
487
487
  }
@@ -523,98 +523,98 @@ export type SimulationTargetStatus = (typeof SimulationTargetStatus)[keyof typeo
523
523
  */
524
524
  export interface DescribeSimulationOutput {
525
525
  /**
526
- * @public
527
526
  * <p>The name of the simulation.</p>
527
+ * @public
528
528
  */
529
529
  Name?: string;
530
530
  /**
531
- * @public
532
531
  * <p>A universally unique identifier (UUID) for this simulation.</p>
532
+ * @public
533
533
  */
534
534
  ExecutionId?: string;
535
535
  /**
536
- * @public
537
536
  * <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>
538
537
  * in the <i>Amazon Web Services General Reference</i>.</p>
538
+ * @public
539
539
  */
540
540
  Arn?: string;
541
541
  /**
542
- * @public
543
542
  * <p>The description of the simulation.</p>
543
+ * @public
544
544
  */
545
545
  Description?: string;
546
546
  /**
547
- * @public
548
547
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
549
548
  * 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>
550
549
  * in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles,
551
550
  * see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
552
551
  * <i>Identity and Access Management User Guide</i>.</p>
552
+ * @public
553
553
  */
554
554
  RoleArn?: string;
555
555
  /**
556
- * @public
557
556
  * <p>The time when the simulation was created, expressed as the
558
557
  * number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>
558
+ * @public
559
559
  */
560
560
  CreationTime?: Date;
561
561
  /**
562
- * @public
563
562
  * <p>The current lifecycle state of the simulation.</p>
563
+ * @public
564
564
  */
565
565
  Status?: SimulationStatus;
566
566
  /**
567
- * @public
568
567
  * <p>The desired lifecycle state of the simulation.</p>
568
+ * @public
569
569
  */
570
570
  TargetStatus?: SimulationTargetStatus;
571
571
  /**
572
- * @public
573
572
  * <p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
574
573
  * For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
575
574
  * <i>Amazon Simple Storage Service User Guide</i>
576
575
  * </a>.</p>
576
+ * @public
577
577
  */
578
578
  SchemaS3Location?: S3Location;
579
579
  /**
580
- * @public
581
580
  * @deprecated
582
581
  *
583
582
  * <p>An error message that SimSpace Weaver returns only if there is a problem with the simulation
584
583
  * schema.</p>
584
+ * @public
585
585
  */
586
586
  SchemaError?: string;
587
587
  /**
588
- * @public
589
588
  * <p>Settings that control how SimSpace Weaver handles your simulation log data.</p>
589
+ * @public
590
590
  */
591
591
  LoggingConfiguration?: LoggingConfiguration;
592
592
  /**
593
- * @public
594
593
  * <p>A collection of additional state information, such as
595
594
  * domain and clock configuration.</p>
595
+ * @public
596
596
  */
597
597
  LiveSimulationState?: LiveSimulationState;
598
598
  /**
599
- * @public
600
599
  * <p>The maximum running time of the simulation,
601
600
  * specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation
602
601
  * stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the
603
602
  * other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the
604
603
  * simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>
604
+ * @public
605
605
  */
606
606
  MaximumDuration?: string;
607
607
  /**
608
- * @public
609
608
  * <p>A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip
610
609
  * files and schema file. For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
611
610
  * <i>Amazon Simple Storage Service User Guide</i>
612
611
  * </a>.</p>
612
+ * @public
613
613
  */
614
614
  SnapshotS3Location?: S3Location;
615
615
  /**
616
- * @public
617
616
  * <p>An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the <code>STARTING</code> state.</p>
617
+ * @public
618
618
  */
619
619
  StartError?: string;
620
620
  }
@@ -623,59 +623,59 @@ export interface DescribeSimulationOutput {
623
623
  */
624
624
  export interface ListAppsInput {
625
625
  /**
626
- * @public
627
626
  * <p>The name of the simulation that you want to list apps for.</p>
627
+ * @public
628
628
  */
629
629
  Simulation: string | undefined;
630
630
  /**
631
- * @public
632
631
  * <p>The name of the domain that you want to list apps for.</p>
632
+ * @public
633
633
  */
634
634
  Domain?: string;
635
635
  /**
636
- * @public
637
636
  * <p>The maximum number of apps to list.</p>
637
+ * @public
638
638
  */
639
639
  MaxResults?: number;
640
640
  /**
641
- * @public
642
641
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
643
642
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
644
643
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
645
644
  * then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
646
645
  * If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
646
+ * @public
647
647
  */
648
648
  NextToken?: string;
649
649
  }
650
650
  /**
651
- * @public
652
651
  * <p>A collection of metadata about the app.</p>
652
+ * @public
653
653
  */
654
654
  export interface SimulationAppMetadata {
655
655
  /**
656
- * @public
657
656
  * <p>The name of the app.</p>
657
+ * @public
658
658
  */
659
659
  Name?: string;
660
660
  /**
661
- * @public
662
661
  * <p>The name of the simulation of the app.</p>
662
+ * @public
663
663
  */
664
664
  Simulation?: string;
665
665
  /**
666
- * @public
667
666
  * <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>
668
667
  * in the <i>SimSpace Weaver User Guide</i>.</p>
668
+ * @public
669
669
  */
670
670
  Domain?: string;
671
671
  /**
672
- * @public
673
672
  * <p>The current status of the app.</p>
673
+ * @public
674
674
  */
675
675
  Status?: SimulationAppStatus;
676
676
  /**
677
- * @public
678
677
  * <p>The desired status of the app.</p>
678
+ * @public
679
679
  */
680
680
  TargetStatus?: SimulationAppTargetStatus;
681
681
  }
@@ -684,17 +684,17 @@ export interface SimulationAppMetadata {
684
684
  */
685
685
  export interface ListAppsOutput {
686
686
  /**
687
- * @public
688
687
  * <p>The list of apps for the given simulation and domain.</p>
688
+ * @public
689
689
  */
690
690
  Apps?: SimulationAppMetadata[];
691
691
  /**
692
- * @public
693
692
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
694
693
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
695
694
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
696
695
  * then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
697
696
  * If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
697
+ * @public
698
698
  */
699
699
  NextToken?: string;
700
700
  }
@@ -703,50 +703,50 @@ export interface ListAppsOutput {
703
703
  */
704
704
  export interface ListSimulationsInput {
705
705
  /**
706
- * @public
707
706
  * <p>The maximum number of simulations to list.</p>
707
+ * @public
708
708
  */
709
709
  MaxResults?: number;
710
710
  /**
711
- * @public
712
711
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
713
712
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
714
713
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
715
714
  * then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
716
715
  * If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
716
+ * @public
717
717
  */
718
718
  NextToken?: string;
719
719
  }
720
720
  /**
721
- * @public
722
721
  * <p>A collection of data about the simulation.</p>
722
+ * @public
723
723
  */
724
724
  export interface SimulationMetadata {
725
725
  /**
726
- * @public
727
726
  * <p>The name of the simulation.</p>
727
+ * @public
728
728
  */
729
729
  Name?: string;
730
730
  /**
731
- * @public
732
731
  * <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>
733
732
  * in the <i>Amazon Web Services General Reference</i>.</p>
733
+ * @public
734
734
  */
735
735
  Arn?: string;
736
736
  /**
737
- * @public
738
737
  * <p>The time when the simulation was created, expressed as the
739
738
  * number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>
739
+ * @public
740
740
  */
741
741
  CreationTime?: Date;
742
742
  /**
743
- * @public
744
743
  * <p>The current status of the simulation.</p>
744
+ * @public
745
745
  */
746
746
  Status?: SimulationStatus;
747
747
  /**
748
- * @public
749
748
  * <p>The desired status of the simulation.</p>
749
+ * @public
750
750
  */
751
751
  TargetStatus?: SimulationTargetStatus;
752
752
  }
@@ -755,17 +755,17 @@ export interface SimulationMetadata {
755
755
  */
756
756
  export interface ListSimulationsOutput {
757
757
  /**
758
- * @public
759
758
  * <p>The list of simulations.</p>
759
+ * @public
760
760
  */
761
761
  Simulations?: SimulationMetadata[];
762
762
  /**
763
- * @public
764
763
  * <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
765
764
  * The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
766
765
  * call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
767
766
  * then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
768
767
  * If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
768
+ * @public
769
769
  */
770
770
  NextToken?: string;
771
771
  }
@@ -774,9 +774,9 @@ export interface ListSimulationsOutput {
774
774
  */
775
775
  export interface ListTagsForResourceInput {
776
776
  /**
777
- * @public
778
777
  * <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>
779
778
  * in the <i>Amazon Web Services General Reference</i>.</p>
779
+ * @public
780
780
  */
781
781
  ResourceArn: string | undefined;
782
782
  }
@@ -785,14 +785,14 @@ export interface ListTagsForResourceInput {
785
785
  */
786
786
  export interface ListTagsForResourceOutput {
787
787
  /**
788
- * @public
789
788
  * <p>The list of tags for the resource.</p>
789
+ * @public
790
790
  */
791
791
  Tags?: Record<string, string>;
792
792
  }
793
793
  /**
794
- * @public
795
794
  * <p/>
795
+ * @public
796
796
  */
797
797
  export declare class ServiceQuotaExceededException extends __BaseException {
798
798
  readonly name: "ServiceQuotaExceededException";
@@ -808,35 +808,35 @@ export declare class ServiceQuotaExceededException extends __BaseException {
808
808
  */
809
809
  export interface StartAppInput {
810
810
  /**
811
- * @public
812
811
  * <p>A value that you provide to ensure that repeated calls to this
813
812
  * API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an
814
813
  * <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>
814
+ * @public
815
815
  */
816
816
  ClientToken?: string;
817
817
  /**
818
- * @public
819
818
  * <p>The name of the simulation of the app.</p>
819
+ * @public
820
820
  */
821
821
  Simulation: string | undefined;
822
822
  /**
823
- * @public
824
823
  * <p>The name of the domain of the app.</p>
824
+ * @public
825
825
  */
826
826
  Domain: string | undefined;
827
827
  /**
828
- * @public
829
828
  * <p>The name of the app.</p>
829
+ * @public
830
830
  */
831
831
  Name: string | undefined;
832
832
  /**
833
- * @public
834
833
  * <p>The description of the app.</p>
834
+ * @public
835
835
  */
836
836
  Description?: string;
837
837
  /**
838
- * @public
839
838
  * <p>Options that apply when the app starts. These options override default behavior.</p>
839
+ * @public
840
840
  */
841
841
  LaunchOverrides?: LaunchOverrides;
842
842
  }
@@ -845,18 +845,18 @@ export interface StartAppInput {
845
845
  */
846
846
  export interface StartAppOutput {
847
847
  /**
848
- * @public
849
848
  * <p>The name of the app.</p>
849
+ * @public
850
850
  */
851
851
  Name?: string;
852
852
  /**
853
- * @public
854
853
  * <p>The name of the domain of the app.</p>
854
+ * @public
855
855
  */
856
856
  Domain?: string;
857
857
  /**
858
- * @public
859
858
  * <p>The name of the simulation of the app.</p>
859
+ * @public
860
860
  */
861
861
  Simulation?: string;
862
862
  }
@@ -865,8 +865,8 @@ export interface StartAppOutput {
865
865
  */
866
866
  export interface StartClockInput {
867
867
  /**
868
- * @public
869
868
  * <p>The name of the simulation.</p>
869
+ * @public
870
870
  */
871
871
  Simulation: string | undefined;
872
872
  }
@@ -880,58 +880,57 @@ export interface StartClockOutput {
880
880
  */
881
881
  export interface StartSimulationInput {
882
882
  /**
883
- * @public
884
883
  * <p>A value that you provide to ensure that repeated calls to this
885
884
  * API operation using the same parameters complete only once. A <code>ClientToken</code> is also known as an
886
885
  * <i>idempotency token</i>. A <code>ClientToken</code> expires after 24 hours.</p>
886
+ * @public
887
887
  */
888
888
  ClientToken?: string;
889
889
  /**
890
- * @public
891
890
  * <p>The name of the simulation.</p>
891
+ * @public
892
892
  */
893
893
  Name: string | undefined;
894
894
  /**
895
- * @public
896
895
  * <p>The description of the simulation.</p>
896
+ * @public
897
897
  */
898
898
  Description?: string;
899
899
  /**
900
- * @public
901
900
  * <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role
902
901
  * 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>
903
902
  * in the <i>Amazon Web Services General Reference</i>. For more information about IAM roles,
904
903
  * see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html">IAM roles</a> in the
905
904
  * <i>Identity and Access Management User Guide</i>.</p>
905
+ * @public
906
906
  */
907
907
  RoleArn: string | undefined;
908
908
  /**
909
- * @public
910
909
  * <p>The location of the simulation schema in Amazon Simple Storage Service (Amazon S3).
911
910
  * For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
912
911
  * <i>Amazon Simple Storage Service User Guide</i>
913
912
  * </a>.</p>
914
913
  * <p>Provide a <code>SchemaS3Location</code> to start your simulation from a schema.</p>
915
914
  * <p>If you provide a <code>SchemaS3Location</code> then you can't provide a <code>SnapshotS3Location</code>.</p>
915
+ * @public
916
916
  */
917
917
  SchemaS3Location?: S3Location;
918
918
  /**
919
- * @public
920
919
  * <p>The maximum running time of the simulation,
921
920
  * specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation
922
921
  * stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the
923
922
  * other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the
924
923
  * simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>
924
+ * @public
925
925
  */
926
926
  MaximumDuration?: string;
927
927
  /**
928
- * @public
929
928
  * <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
930
929
  * <i>Amazon Web Services General Reference</i>.</p>
930
+ * @public
931
931
  */
932
932
  Tags?: Record<string, string>;
933
933
  /**
934
- * @public
935
934
  * <p>The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).
936
935
  * For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
937
936
  * <i>Amazon Simple Storage Service User Guide</i>
@@ -939,6 +938,7 @@ export interface StartSimulationInput {
939
938
  * <p>Provide a <code>SnapshotS3Location</code> to start your simulation from a snapshot.</p>
940
939
  * <p>The Amazon S3 bucket must be in the same Amazon Web Services Region as the simulation.</p>
941
940
  * <p>If you provide a <code>SnapshotS3Location</code> then you can't provide a <code>SchemaS3Location</code>.</p>
941
+ * @public
942
942
  */
943
943
  SnapshotS3Location?: S3Location;
944
944
  }
@@ -947,20 +947,20 @@ export interface StartSimulationInput {
947
947
  */
948
948
  export interface StartSimulationOutput {
949
949
  /**
950
- * @public
951
950
  * <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>
952
951
  * in the <i>Amazon Web Services General Reference</i>.</p>
952
+ * @public
953
953
  */
954
954
  Arn?: string;
955
955
  /**
956
- * @public
957
956
  * <p>A universally unique identifier (UUID) for this simulation.</p>
957
+ * @public
958
958
  */
959
959
  ExecutionId?: string;
960
960
  /**
961
- * @public
962
961
  * <p>The time when the simulation was created, expressed as the
963
962
  * number of seconds and milliseconds in UTC since the Unix epoch (0:0:0.000, January 1, 1970).</p>
963
+ * @public
964
964
  */
965
965
  CreationTime?: Date;
966
966
  }
@@ -969,18 +969,18 @@ export interface StartSimulationOutput {
969
969
  */
970
970
  export interface StopAppInput {
971
971
  /**
972
- * @public
973
972
  * <p>The name of the simulation of the app.</p>
973
+ * @public
974
974
  */
975
975
  Simulation: string | undefined;
976
976
  /**
977
- * @public
978
977
  * <p>The name of the domain of the app.</p>
978
+ * @public
979
979
  */
980
980
  Domain: string | undefined;
981
981
  /**
982
- * @public
983
982
  * <p>The name of the app.</p>
983
+ * @public
984
984
  */
985
985
  App: string | undefined;
986
986
  }
@@ -994,8 +994,8 @@ export interface StopAppOutput {
994
994
  */
995
995
  export interface StopClockInput {
996
996
  /**
997
- * @public
998
997
  * <p>The name of the simulation.</p>
998
+ * @public
999
999
  */
1000
1000
  Simulation: string | undefined;
1001
1001
  }
@@ -1009,8 +1009,8 @@ export interface StopClockOutput {
1009
1009
  */
1010
1010
  export interface StopSimulationInput {
1011
1011
  /**
1012
- * @public
1013
1012
  * <p>The name of the simulation.</p>
1013
+ * @public
1014
1014
  */
1015
1015
  Simulation: string | undefined;
1016
1016
  }
@@ -1024,15 +1024,15 @@ export interface StopSimulationOutput {
1024
1024
  */
1025
1025
  export interface TagResourceInput {
1026
1026
  /**
1027
- * @public
1028
1027
  * <p>The Amazon Resource Name (ARN) of the resource that you want to add tags to.
1029
1028
  * 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>
1030
1029
  * in the <i>Amazon Web Services General Reference</i>.</p>
1030
+ * @public
1031
1031
  */
1032
1032
  ResourceArn: string | undefined;
1033
1033
  /**
1034
- * @public
1035
1034
  * <p>A list of tags to apply to the resource.</p>
1035
+ * @public
1036
1036
  */
1037
1037
  Tags: Record<string, string> | undefined;
1038
1038
  }
@@ -1042,8 +1042,8 @@ export interface TagResourceInput {
1042
1042
  export interface TagResourceOutput {
1043
1043
  }
1044
1044
  /**
1045
- * @public
1046
1045
  * <p/>
1046
+ * @public
1047
1047
  */
1048
1048
  export declare class TooManyTagsException extends __BaseException {
1049
1049
  readonly name: "TooManyTagsException";
@@ -1059,15 +1059,15 @@ export declare class TooManyTagsException extends __BaseException {
1059
1059
  */
1060
1060
  export interface UntagResourceInput {
1061
1061
  /**
1062
- * @public
1063
1062
  * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
1064
1063
  * 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>
1065
1064
  * in the <i>Amazon Web Services General Reference</i>.</p>
1065
+ * @public
1066
1066
  */
1067
1067
  ResourceArn: string | undefined;
1068
1068
  /**
1069
- * @public
1070
1069
  * <p>A list of tag keys to remove from the resource.</p>
1070
+ * @public
1071
1071
  */
1072
1072
  TagKeys: string[] | undefined;
1073
1073
  }