@aws-sdk/client-simspaceweaver 3.319.0 → 3.323.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.
- package/README.md +21 -13
- package/dist-cjs/SimSpaceWeaver.js +2 -0
- package/dist-cjs/commands/CreateSnapshotCommand.js +45 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +68 -1
- package/dist-es/SimSpaceWeaver.js +2 -0
- package/dist-es/commands/CreateSnapshotCommand.js +41 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +65 -0
- package/dist-types/SimSpaceWeaver.d.ts +13 -6
- package/dist-types/SimSpaceWeaverClient.d.ts +9 -8
- package/dist-types/commands/CreateSnapshotCommand.d.ts +137 -0
- package/dist-types/commands/DeleteSimulationCommand.d.ts +2 -2
- package/dist-types/commands/StartSimulationCommand.d.ts +10 -1
- package/dist-types/commands/StopSimulationCommand.d.ts +2 -3
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +111 -46
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/SimSpaceWeaver.d.ts +17 -0
- package/dist-types/ts3.4/SimSpaceWeaverClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CreateSnapshotCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +18 -5
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +4 -4
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { CreateSnapshotInput, CreateSnapshotOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link CreateSnapshotCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface CreateSnapshotCommandInput extends CreateSnapshotInput {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link CreateSnapshotCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface CreateSnapshotCommandOutput extends CreateSnapshotOutput, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>Creates a snapshot of the specified simulation.
|
|
23
|
+
* A snapshot is a file that contains simulation state data at a specific time.
|
|
24
|
+
* The state data saved in a snapshot includes entity data from the State Fabric,
|
|
25
|
+
* the simulation configuration specified in the schema, and the clock tick number.
|
|
26
|
+
* You can use the snapshot to initialize a new simulation.
|
|
27
|
+
* For more information about snapshots, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html">Snapshots</a>
|
|
28
|
+
* in the <i>SimSpace Weaver User Guide</i>.
|
|
29
|
+
* </p>
|
|
30
|
+
* <p>You specify a <code>Destination</code> when you create a snapshot.
|
|
31
|
+
* The <code>Destination</code> is the name of an Amazon S3 bucket and an optional
|
|
32
|
+
* <code>ObjectKeyPrefix</code>. The <code>ObjectKeyPrefix</code> is
|
|
33
|
+
* usually the name of a folder in the bucket. SimSpace Weaver creates a
|
|
34
|
+
* <code>snapshot</code> folder inside the <code>Destination</code> and
|
|
35
|
+
* places the snapshot file there.</p>
|
|
36
|
+
* <p>The snapshot file is an Amazon S3 object. It has an object key with the
|
|
37
|
+
* form: <code>
|
|
38
|
+
* <i>object-key-prefix</i>/snapshot/<i>simulation-name</i>-<i>YYMMdd</i>-<i>HHmm</i>-<i>ss</i>.zip</code>, where:
|
|
39
|
+
* </p>
|
|
40
|
+
* <ul>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>
|
|
44
|
+
* <i>YY</i>
|
|
45
|
+
* </code> is the 2-digit year</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>
|
|
49
|
+
* <code>
|
|
50
|
+
* <i>MM</i>
|
|
51
|
+
* </code> is the 2-digit month</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>
|
|
55
|
+
* <code>
|
|
56
|
+
* <i>dd</i>
|
|
57
|
+
* </code> is the 2-digit day of the month</p>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>
|
|
61
|
+
* <code>
|
|
62
|
+
* <i>HH</i>
|
|
63
|
+
* </code> is the 2-digit hour (24-hour clock)</p>
|
|
64
|
+
* </li>
|
|
65
|
+
* <li>
|
|
66
|
+
* <p>
|
|
67
|
+
* <code>
|
|
68
|
+
* <i>mm</i>
|
|
69
|
+
* </code> is the 2-digit minutes</p>
|
|
70
|
+
* </li>
|
|
71
|
+
* <li>
|
|
72
|
+
* <p>
|
|
73
|
+
* <code>
|
|
74
|
+
* <i>ss</i>
|
|
75
|
+
* </code> is the 2-digit seconds</p>
|
|
76
|
+
* </li>
|
|
77
|
+
* </ul>
|
|
78
|
+
* @example
|
|
79
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
80
|
+
* ```javascript
|
|
81
|
+
* import { SimSpaceWeaverClient, CreateSnapshotCommand } from "@aws-sdk/client-simspaceweaver"; // ES Modules import
|
|
82
|
+
* // const { SimSpaceWeaverClient, CreateSnapshotCommand } = require("@aws-sdk/client-simspaceweaver"); // CommonJS import
|
|
83
|
+
* const client = new SimSpaceWeaverClient(config);
|
|
84
|
+
* const input = { // CreateSnapshotInput
|
|
85
|
+
* Simulation: "STRING_VALUE", // required
|
|
86
|
+
* Destination: { // S3Destination
|
|
87
|
+
* BucketName: "STRING_VALUE",
|
|
88
|
+
* ObjectKeyPrefix: "STRING_VALUE",
|
|
89
|
+
* },
|
|
90
|
+
* };
|
|
91
|
+
* const command = new CreateSnapshotCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
95
|
+
* @param CreateSnapshotCommandInput - {@link CreateSnapshotCommandInput}
|
|
96
|
+
* @returns {@link CreateSnapshotCommandOutput}
|
|
97
|
+
* @see {@link CreateSnapshotCommandInput} for command's `input` shape.
|
|
98
|
+
* @see {@link CreateSnapshotCommandOutput} for command's `response` shape.
|
|
99
|
+
* @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
102
|
+
* <p/>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ConflictException} (client fault)
|
|
105
|
+
* <p/>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link InternalServerException} (server fault)
|
|
108
|
+
* <p/>
|
|
109
|
+
*
|
|
110
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
111
|
+
* <p/>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link ValidationException} (client fault)
|
|
114
|
+
* <p/>
|
|
115
|
+
*
|
|
116
|
+
*
|
|
117
|
+
*/
|
|
118
|
+
export declare class CreateSnapshotCommand extends $Command<CreateSnapshotCommandInput, CreateSnapshotCommandOutput, SimSpaceWeaverClientResolvedConfig> {
|
|
119
|
+
readonly input: CreateSnapshotCommandInput;
|
|
120
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
121
|
+
/**
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
constructor(input: CreateSnapshotCommandInput);
|
|
125
|
+
/**
|
|
126
|
+
* @internal
|
|
127
|
+
*/
|
|
128
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateSnapshotCommandInput, CreateSnapshotCommandOutput>;
|
|
129
|
+
/**
|
|
130
|
+
* @internal
|
|
131
|
+
*/
|
|
132
|
+
private serialize;
|
|
133
|
+
/**
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
136
|
+
private deserialize;
|
|
137
|
+
}
|
|
@@ -21,8 +21,8 @@ export interface DeleteSimulationCommandOutput extends DeleteSimulationOutput, _
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes all SimSpace Weaver resources assigned to the given simulation.</p>
|
|
23
23
|
* <note>
|
|
24
|
-
* <p>Your simulation uses resources in other Amazon Web Services
|
|
25
|
-
* resources in other Amazon Web Services
|
|
24
|
+
* <p>Your simulation uses resources in other Amazon Web Services. This API operation doesn't delete
|
|
25
|
+
* resources in other Amazon Web Services.</p>
|
|
26
26
|
* </note>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -19,7 +19,12 @@ export interface StartSimulationCommandOutput extends StartSimulationOutput, __M
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Starts a simulation with the given name
|
|
22
|
+
* <p>Starts a simulation with the given name. You must choose to start your
|
|
23
|
+
* simulation from a schema or from a snapshot.
|
|
24
|
+
* For more information about the schema, see the <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/schema-reference.html">schema reference</a>
|
|
25
|
+
* in the <i>SimSpace Weaver User Guide</i>.
|
|
26
|
+
* For more information about snapshots, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/working-with_snapshots.html">Snapshots</a>
|
|
27
|
+
* in the <i>SimSpace Weaver User Guide</i>.</p>
|
|
23
28
|
* @example
|
|
24
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
30
|
* ```javascript
|
|
@@ -39,6 +44,10 @@ export interface StartSimulationCommandOutput extends StartSimulationOutput, __M
|
|
|
39
44
|
* Tags: { // TagMap
|
|
40
45
|
* "<keys>": "STRING_VALUE",
|
|
41
46
|
* },
|
|
47
|
+
* SnapshotS3Location: {
|
|
48
|
+
* BucketName: "STRING_VALUE",
|
|
49
|
+
* ObjectKey: "STRING_VALUE",
|
|
50
|
+
* },
|
|
42
51
|
* };
|
|
43
52
|
* const command = new StartSimulationCommand(input);
|
|
44
53
|
* const response = await client.send(command);
|
|
@@ -21,9 +21,8 @@ export interface StopSimulationCommandOutput extends StopSimulationOutput, __Met
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Stops the given simulation.</p>
|
|
23
23
|
* <important>
|
|
24
|
-
* <p>You can't restart a simulation after you stop it.
|
|
25
|
-
*
|
|
26
|
-
* and start a new instance of it.</p>
|
|
24
|
+
* <p>You can't restart a simulation after you stop it. If you want to restart a simulation, then
|
|
25
|
+
* you must stop it, delete it, and start a new instance of it.</p>
|
|
27
26
|
* </important>
|
|
28
27
|
* @example
|
|
29
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -89,25 +89,39 @@ export declare class ConflictException extends __BaseException {
|
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
91
|
* @public
|
|
92
|
+
* <p>An Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates a file.</p>
|
|
92
93
|
*/
|
|
93
|
-
export interface
|
|
94
|
+
export interface S3Destination {
|
|
94
95
|
/**
|
|
95
|
-
* <p>The name of
|
|
96
|
+
* <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
|
+
* configuring, and working with Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User
|
|
98
|
+
* Guide</i>.</p>
|
|
96
99
|
*/
|
|
97
|
-
|
|
100
|
+
BucketName?: string;
|
|
98
101
|
/**
|
|
99
|
-
* <p>
|
|
102
|
+
* <p>A string prefix for an Amazon S3 object key. It's usually a folder name.
|
|
103
|
+
* 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
|
+
* in the <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
100
105
|
*/
|
|
101
|
-
|
|
106
|
+
ObjectKeyPrefix?: string;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export interface CreateSnapshotInput {
|
|
102
112
|
/**
|
|
103
|
-
* <p>The name of the
|
|
113
|
+
* <p>The name of the simulation.</p>
|
|
104
114
|
*/
|
|
105
|
-
|
|
115
|
+
Simulation: string | undefined;
|
|
116
|
+
/**
|
|
117
|
+
* <p>The Amazon S3 bucket and optional folder (object key prefix) where SimSpace Weaver creates the snapshot file.</p>
|
|
118
|
+
*/
|
|
119
|
+
Destination: S3Destination | undefined;
|
|
106
120
|
}
|
|
107
121
|
/**
|
|
108
122
|
* @public
|
|
109
123
|
*/
|
|
110
|
-
export interface
|
|
124
|
+
export interface CreateSnapshotOutput {
|
|
111
125
|
}
|
|
112
126
|
/**
|
|
113
127
|
* @public
|
|
@@ -148,6 +162,28 @@ export declare class ValidationException extends __BaseException {
|
|
|
148
162
|
*/
|
|
149
163
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
150
164
|
}
|
|
165
|
+
/**
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
export interface DeleteAppInput {
|
|
169
|
+
/**
|
|
170
|
+
* <p>The name of the simulation of the app.</p>
|
|
171
|
+
*/
|
|
172
|
+
Simulation: string | undefined;
|
|
173
|
+
/**
|
|
174
|
+
* <p>The name of the domain of the app.</p>
|
|
175
|
+
*/
|
|
176
|
+
Domain: string | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>The name of the app.</p>
|
|
179
|
+
*/
|
|
180
|
+
App: string | undefined;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export interface DeleteAppOutput {
|
|
186
|
+
}
|
|
151
187
|
/**
|
|
152
188
|
* @public
|
|
153
189
|
*/
|
|
@@ -182,7 +218,8 @@ export interface DescribeAppInput {
|
|
|
182
218
|
/**
|
|
183
219
|
* @public
|
|
184
220
|
* <p>Information about the network endpoint that you can use to connect to your custom or
|
|
185
|
-
* service app
|
|
221
|
+
* 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>
|
|
222
|
+
* in the <i>SimSpace Weaver User Guide</i>..</p>
|
|
186
223
|
*/
|
|
187
224
|
export interface SimulationAppEndpointInfo {
|
|
188
225
|
/**
|
|
@@ -198,7 +235,7 @@ export interface SimulationAppEndpointInfo {
|
|
|
198
235
|
}
|
|
199
236
|
/**
|
|
200
237
|
* @public
|
|
201
|
-
* <p>Options that apply when the app starts. These
|
|
238
|
+
* <p>Options that apply when the app starts. These options override default behavior.</p>
|
|
202
239
|
*/
|
|
203
240
|
export interface LaunchOverrides {
|
|
204
241
|
/**
|
|
@@ -261,7 +298,7 @@ export interface DescribeAppOutput {
|
|
|
261
298
|
*/
|
|
262
299
|
TargetStatus?: SimulationAppTargetStatus | string;
|
|
263
300
|
/**
|
|
264
|
-
* <p>Options that apply when the app starts. These
|
|
301
|
+
* <p>Options that apply when the app starts. These options override default behavior.</p>
|
|
265
302
|
*/
|
|
266
303
|
LaunchOverrides?: LaunchOverrides;
|
|
267
304
|
/**
|
|
@@ -314,8 +351,8 @@ export type LifecycleManagementStrategy = (typeof LifecycleManagementStrategy)[k
|
|
|
314
351
|
* @public
|
|
315
352
|
* <p>A collection of app instances that run the same executable app code and have the same
|
|
316
353
|
* launch options and commands.</p>
|
|
317
|
-
* <p>For more information about domains, see <a href="https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html">Key concepts</a>
|
|
318
|
-
* in the <i>
|
|
354
|
+
* <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>
|
|
355
|
+
* in the <i>SimSpace Weaver User Guide</i>.</p>
|
|
319
356
|
*/
|
|
320
357
|
export interface Domain {
|
|
321
358
|
/**
|
|
@@ -323,8 +360,8 @@ export interface Domain {
|
|
|
323
360
|
*/
|
|
324
361
|
Name?: string;
|
|
325
362
|
/**
|
|
326
|
-
* <p>The type of lifecycle management for apps in the domain.
|
|
327
|
-
*
|
|
363
|
+
* <p>The type of lifecycle management for apps in the domain. Indicates whether apps in this
|
|
364
|
+
* domain are <i>managed</i> (SimSpace Weaver starts and stops the apps) or
|
|
328
365
|
* <i>unmanaged</i> (you must start and stop the apps).</p>
|
|
329
366
|
* <p class="title">
|
|
330
367
|
* <b>Lifecycle types</b>
|
|
@@ -332,21 +369,20 @@ export interface Domain {
|
|
|
332
369
|
* <ul>
|
|
333
370
|
* <li>
|
|
334
371
|
* <p>
|
|
335
|
-
* <code>PerWorker</code> – Managed: SimSpace Weaver starts
|
|
372
|
+
* <code>PerWorker</code> – Managed: SimSpace Weaver starts one app on each
|
|
373
|
+
* worker.</p>
|
|
336
374
|
* </li>
|
|
337
375
|
* <li>
|
|
338
376
|
* <p>
|
|
339
|
-
* <code>BySpatialSubdivision</code> – Managed: SimSpace Weaver starts
|
|
377
|
+
* <code>BySpatialSubdivision</code> – Managed: SimSpace Weaver starts one app for
|
|
378
|
+
* each spatial partition.</p>
|
|
340
379
|
* </li>
|
|
341
380
|
* <li>
|
|
342
381
|
* <p>
|
|
343
|
-
* <code>ByRequest</code> – Unmanaged: You use the <
|
|
344
|
-
* API to start the apps and use the <
|
|
382
|
+
* <code>ByRequest</code> – Unmanaged: You use the <code>StartApp</code>
|
|
383
|
+
* API to start the apps and use the <code>StopApp</code> API to stop the apps.</p>
|
|
345
384
|
* </li>
|
|
346
385
|
* </ul>
|
|
347
|
-
* <note>
|
|
348
|
-
* <p>The lifecycle types will change when the service is released for general availability (GA).</p>
|
|
349
|
-
* </note>
|
|
350
386
|
*/
|
|
351
387
|
Lifecycle?: LifecycleManagementStrategy | string;
|
|
352
388
|
}
|
|
@@ -357,8 +393,8 @@ export interface Domain {
|
|
|
357
393
|
*/
|
|
358
394
|
export interface LiveSimulationState {
|
|
359
395
|
/**
|
|
360
|
-
* <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">Key concepts</a>
|
|
361
|
-
* in the <i>
|
|
396
|
+
* <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>
|
|
397
|
+
* in the <i>SimSpace Weaver User Guide</i>.</p>
|
|
362
398
|
*/
|
|
363
399
|
Domains?: Domain[];
|
|
364
400
|
/**
|
|
@@ -392,7 +428,7 @@ export interface LoggingConfiguration {
|
|
|
392
428
|
}
|
|
393
429
|
/**
|
|
394
430
|
* @public
|
|
395
|
-
* <p>A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app zip
|
|
431
|
+
* <p>A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip
|
|
396
432
|
* files and schema file. For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
|
|
397
433
|
* <i>Amazon Simple Storage Service User Guide</i>
|
|
398
434
|
* </a>.</p>
|
|
@@ -420,6 +456,7 @@ export declare const SimulationStatus: {
|
|
|
420
456
|
readonly DELETED: "DELETED";
|
|
421
457
|
readonly DELETING: "DELETING";
|
|
422
458
|
readonly FAILED: "FAILED";
|
|
459
|
+
readonly SNAPSHOT_IN_PROGRESS: "SNAPSHOT_IN_PROGRESS";
|
|
423
460
|
readonly STARTED: "STARTED";
|
|
424
461
|
readonly STARTING: "STARTING";
|
|
425
462
|
readonly STOPPED: "STOPPED";
|
|
@@ -494,6 +531,8 @@ export interface DescribeSimulationOutput {
|
|
|
494
531
|
*/
|
|
495
532
|
SchemaS3Location?: S3Location;
|
|
496
533
|
/**
|
|
534
|
+
* @deprecated
|
|
535
|
+
*
|
|
497
536
|
* <p>An error message that SimSpace Weaver returns only if there is a problem with the simulation
|
|
498
537
|
* schema.</p>
|
|
499
538
|
*/
|
|
@@ -509,10 +548,23 @@ export interface DescribeSimulationOutput {
|
|
|
509
548
|
LiveSimulationState?: LiveSimulationState;
|
|
510
549
|
/**
|
|
511
550
|
* <p>The maximum running time of the simulation,
|
|
512
|
-
* specified as a number of
|
|
513
|
-
* stops when it reaches this limit
|
|
551
|
+
* specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation
|
|
552
|
+
* stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the
|
|
553
|
+
* other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the
|
|
554
|
+
* simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>
|
|
514
555
|
*/
|
|
515
556
|
MaximumDuration?: string;
|
|
557
|
+
/**
|
|
558
|
+
* <p>A location in Amazon Simple Storage Service (Amazon S3) where SimSpace Weaver stores simulation data, such as your app .zip
|
|
559
|
+
* files and schema file. For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
|
|
560
|
+
* <i>Amazon Simple Storage Service User Guide</i>
|
|
561
|
+
* </a>.</p>
|
|
562
|
+
*/
|
|
563
|
+
SnapshotS3Location?: S3Location;
|
|
564
|
+
/**
|
|
565
|
+
* <p>An error message that SimSpace Weaver returns only if a problem occurs when the simulation is in the <code>STARTING</code> state.</p>
|
|
566
|
+
*/
|
|
567
|
+
StartError?: string;
|
|
516
568
|
}
|
|
517
569
|
/**
|
|
518
570
|
* @public
|
|
@@ -531,17 +583,17 @@ export interface ListAppsInput {
|
|
|
531
583
|
*/
|
|
532
584
|
MaxResults?: number;
|
|
533
585
|
/**
|
|
534
|
-
* <p>If SimSpace Weaver returns <code>nextToken</code>, there are more results available.
|
|
586
|
+
* <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
|
|
535
587
|
* The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
|
|
536
588
|
* call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
|
|
537
|
-
* <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
538
|
-
* If you provide a token that isn't valid, you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
589
|
+
* then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
590
|
+
* If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
539
591
|
*/
|
|
540
592
|
NextToken?: string;
|
|
541
593
|
}
|
|
542
594
|
/**
|
|
543
595
|
* @public
|
|
544
|
-
* <p>A collection of metadata about
|
|
596
|
+
* <p>A collection of metadata about the app.</p>
|
|
545
597
|
*/
|
|
546
598
|
export interface SimulationAppMetadata {
|
|
547
599
|
/**
|
|
@@ -553,8 +605,8 @@ export interface SimulationAppMetadata {
|
|
|
553
605
|
*/
|
|
554
606
|
Simulation?: string;
|
|
555
607
|
/**
|
|
556
|
-
* <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">Key concepts</a>
|
|
557
|
-
* in the <i>
|
|
608
|
+
* <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>
|
|
609
|
+
* in the <i>SimSpace Weaver User Guide</i>.</p>
|
|
558
610
|
*/
|
|
559
611
|
Domain?: string;
|
|
560
612
|
/**
|
|
@@ -575,11 +627,11 @@ export interface ListAppsOutput {
|
|
|
575
627
|
*/
|
|
576
628
|
Apps?: SimulationAppMetadata[];
|
|
577
629
|
/**
|
|
578
|
-
* <p>If SimSpace Weaver returns <code>nextToken</code>, there are more results available.
|
|
630
|
+
* <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
|
|
579
631
|
* The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
|
|
580
632
|
* call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
|
|
581
|
-
* <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
582
|
-
* If you provide a token that isn't valid, you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
633
|
+
* then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
634
|
+
* If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
583
635
|
*/
|
|
584
636
|
NextToken?: string;
|
|
585
637
|
}
|
|
@@ -592,11 +644,11 @@ export interface ListSimulationsInput {
|
|
|
592
644
|
*/
|
|
593
645
|
MaxResults?: number;
|
|
594
646
|
/**
|
|
595
|
-
* <p>If SimSpace Weaver returns <code>nextToken</code>, there are more results available.
|
|
647
|
+
* <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
|
|
596
648
|
* The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
|
|
597
649
|
* call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
|
|
598
|
-
* <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
599
|
-
* If you provide a token that isn't valid, you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
650
|
+
* then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
651
|
+
* If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
600
652
|
*/
|
|
601
653
|
NextToken?: string;
|
|
602
654
|
}
|
|
@@ -637,11 +689,11 @@ export interface ListSimulationsOutput {
|
|
|
637
689
|
*/
|
|
638
690
|
Simulations?: SimulationMetadata[];
|
|
639
691
|
/**
|
|
640
|
-
* <p>If SimSpace Weaver returns <code>nextToken</code>, there are more results available.
|
|
692
|
+
* <p>If SimSpace Weaver returns <code>nextToken</code>, then there are more results available.
|
|
641
693
|
* The value of <code>nextToken</code> is a unique pagination token for each page. To retrieve the next page,
|
|
642
694
|
* call the operation again using the returned token. Keep all other arguments unchanged. If no results remain,
|
|
643
|
-
* <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
644
|
-
* If you provide a token that isn't valid, you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
695
|
+
* then <code>nextToken</code> is set to <code>null</code>. Each pagination token expires after 24 hours.
|
|
696
|
+
* If you provide a token that isn't valid, then you receive an <i>HTTP 400 ValidationException</i> error.</p>
|
|
645
697
|
*/
|
|
646
698
|
NextToken?: string;
|
|
647
699
|
}
|
|
@@ -704,7 +756,7 @@ export interface StartAppInput {
|
|
|
704
756
|
*/
|
|
705
757
|
Description?: string;
|
|
706
758
|
/**
|
|
707
|
-
* <p>Options that apply when the app starts. These
|
|
759
|
+
* <p>Options that apply when the app starts. These options override default behavior.</p>
|
|
708
760
|
*/
|
|
709
761
|
LaunchOverrides?: LaunchOverrides;
|
|
710
762
|
}
|
|
@@ -770,12 +822,16 @@ export interface StartSimulationInput {
|
|
|
770
822
|
* For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
|
|
771
823
|
* <i>Amazon Simple Storage Service User Guide</i>
|
|
772
824
|
* </a>.</p>
|
|
825
|
+
* <p>Provide a <code>SchemaS3Location</code> to start your simulation from a schema.</p>
|
|
826
|
+
* <p>If you provide a <code>SchemaS3Location</code> then you can't provide a <code>SnapshotS3Location</code>.</p>
|
|
773
827
|
*/
|
|
774
|
-
SchemaS3Location
|
|
828
|
+
SchemaS3Location?: S3Location;
|
|
775
829
|
/**
|
|
776
830
|
* <p>The maximum running time of the simulation,
|
|
777
|
-
* specified as a number of
|
|
778
|
-
* stops when it reaches this limit
|
|
831
|
+
* specified as a number of minutes (m or M), hours (h or H), or days (d or D). The simulation
|
|
832
|
+
* stops when it reaches this limit. The maximum value is <code>14D</code>, or its equivalent in the
|
|
833
|
+
* other units. The default value is <code>14D</code>. A value equivalent to <code>0</code> makes the
|
|
834
|
+
* simulation immediately transition to <code>Stopping</code> as soon as it reaches <code>Started</code>.</p>
|
|
779
835
|
*/
|
|
780
836
|
MaximumDuration?: string;
|
|
781
837
|
/**
|
|
@@ -783,6 +839,15 @@ export interface StartSimulationInput {
|
|
|
783
839
|
* <i>Amazon Web Services General Reference</i>.</p>
|
|
784
840
|
*/
|
|
785
841
|
Tags?: Record<string, string>;
|
|
842
|
+
/**
|
|
843
|
+
* <p>The location of the snapshot .zip file in Amazon Simple Storage Service (Amazon S3).
|
|
844
|
+
* For more information about Amazon S3, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html">
|
|
845
|
+
* <i>Amazon Simple Storage Service User Guide</i>
|
|
846
|
+
* </a>.</p>
|
|
847
|
+
* <p>Provide a <code>SnapshotS3Location</code> to start your simulation from a snapshot.</p>
|
|
848
|
+
* <p>If you provide a <code>SnapshotS3Location</code> then you can't provide a <code>SchemaS3Location</code>.</p>
|
|
849
|
+
*/
|
|
850
|
+
SnapshotS3Location?: S3Location;
|
|
786
851
|
}
|
|
787
852
|
/**
|
|
788
853
|
* @public
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
|
|
2
2
|
import { SerdeContext as __SerdeContext } from "@aws-sdk/types";
|
|
3
|
+
import { CreateSnapshotCommandInput, CreateSnapshotCommandOutput } from "../commands/CreateSnapshotCommand";
|
|
3
4
|
import { DeleteAppCommandInput, DeleteAppCommandOutput } from "../commands/DeleteAppCommand";
|
|
4
5
|
import { DeleteSimulationCommandInput, DeleteSimulationCommandOutput } from "../commands/DeleteSimulationCommand";
|
|
5
6
|
import { DescribeAppCommandInput, DescribeAppCommandOutput } from "../commands/DescribeAppCommand";
|
|
@@ -15,6 +16,10 @@ import { StopClockCommandInput, StopClockCommandOutput } from "../commands/StopC
|
|
|
15
16
|
import { StopSimulationCommandInput, StopSimulationCommandOutput } from "../commands/StopSimulationCommand";
|
|
16
17
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
17
18
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
19
|
+
/**
|
|
20
|
+
* serializeAws_restJson1CreateSnapshotCommand
|
|
21
|
+
*/
|
|
22
|
+
export declare const se_CreateSnapshotCommand: (input: CreateSnapshotCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
18
23
|
/**
|
|
19
24
|
* serializeAws_restJson1DeleteAppCommand
|
|
20
25
|
*/
|
|
@@ -75,6 +80,10 @@ export declare const se_TagResourceCommand: (input: TagResourceCommandInput, con
|
|
|
75
80
|
* serializeAws_restJson1UntagResourceCommand
|
|
76
81
|
*/
|
|
77
82
|
export declare const se_UntagResourceCommand: (input: UntagResourceCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
83
|
+
/**
|
|
84
|
+
* deserializeAws_restJson1CreateSnapshotCommand
|
|
85
|
+
*/
|
|
86
|
+
export declare const de_CreateSnapshotCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateSnapshotCommandOutput>;
|
|
78
87
|
/**
|
|
79
88
|
* deserializeAws_restJson1DeleteAppCommand
|
|
80
89
|
*/
|
|
@@ -1,4 +1,8 @@
|
|
|
1
1
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
|
|
2
|
+
import {
|
|
3
|
+
CreateSnapshotCommandInput,
|
|
4
|
+
CreateSnapshotCommandOutput,
|
|
5
|
+
} from "./commands/CreateSnapshotCommand";
|
|
2
6
|
import {
|
|
3
7
|
DeleteAppCommandInput,
|
|
4
8
|
DeleteAppCommandOutput,
|
|
@@ -61,6 +65,19 @@ import {
|
|
|
61
65
|
} from "./commands/UntagResourceCommand";
|
|
62
66
|
import { SimSpaceWeaverClient } from "./SimSpaceWeaverClient";
|
|
63
67
|
export interface SimSpaceWeaver {
|
|
68
|
+
createSnapshot(
|
|
69
|
+
args: CreateSnapshotCommandInput,
|
|
70
|
+
options?: __HttpHandlerOptions
|
|
71
|
+
): Promise<CreateSnapshotCommandOutput>;
|
|
72
|
+
createSnapshot(
|
|
73
|
+
args: CreateSnapshotCommandInput,
|
|
74
|
+
cb: (err: any, data?: CreateSnapshotCommandOutput) => void
|
|
75
|
+
): void;
|
|
76
|
+
createSnapshot(
|
|
77
|
+
args: CreateSnapshotCommandInput,
|
|
78
|
+
options: __HttpHandlerOptions,
|
|
79
|
+
cb: (err: any, data?: CreateSnapshotCommandOutput) => void
|
|
80
|
+
): void;
|
|
64
81
|
deleteApp(
|
|
65
82
|
args: DeleteAppCommandInput,
|
|
66
83
|
options?: __HttpHandlerOptions
|
|
@@ -44,6 +44,10 @@ import {
|
|
|
44
44
|
UrlParser as __UrlParser,
|
|
45
45
|
UserAgent as __UserAgent,
|
|
46
46
|
} from "@aws-sdk/types";
|
|
47
|
+
import {
|
|
48
|
+
CreateSnapshotCommandInput,
|
|
49
|
+
CreateSnapshotCommandOutput,
|
|
50
|
+
} from "./commands/CreateSnapshotCommand";
|
|
47
51
|
import {
|
|
48
52
|
DeleteAppCommandInput,
|
|
49
53
|
DeleteAppCommandOutput,
|
|
@@ -110,6 +114,7 @@ import {
|
|
|
110
114
|
EndpointParameters,
|
|
111
115
|
} from "./endpoint/EndpointParameters";
|
|
112
116
|
export type ServiceInputTypes =
|
|
117
|
+
| CreateSnapshotCommandInput
|
|
113
118
|
| DeleteAppCommandInput
|
|
114
119
|
| DeleteSimulationCommandInput
|
|
115
120
|
| DescribeAppCommandInput
|
|
@@ -126,6 +131,7 @@ export type ServiceInputTypes =
|
|
|
126
131
|
| TagResourceCommandInput
|
|
127
132
|
| UntagResourceCommandInput;
|
|
128
133
|
export type ServiceOutputTypes =
|
|
134
|
+
| CreateSnapshotCommandOutput
|
|
129
135
|
| DeleteAppCommandOutput
|
|
130
136
|
| DeleteSimulationCommandOutput
|
|
131
137
|
| DescribeAppCommandOutput
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@aws-sdk/types";
|
|
9
|
+
import { CreateSnapshotInput, CreateSnapshotOutput } from "../models/models_0";
|
|
10
|
+
import {
|
|
11
|
+
ServiceInputTypes,
|
|
12
|
+
ServiceOutputTypes,
|
|
13
|
+
SimSpaceWeaverClientResolvedConfig,
|
|
14
|
+
} from "../SimSpaceWeaverClient";
|
|
15
|
+
export interface CreateSnapshotCommandInput extends CreateSnapshotInput {}
|
|
16
|
+
export interface CreateSnapshotCommandOutput
|
|
17
|
+
extends CreateSnapshotOutput,
|
|
18
|
+
__MetadataBearer {}
|
|
19
|
+
export declare class CreateSnapshotCommand extends $Command<
|
|
20
|
+
CreateSnapshotCommandInput,
|
|
21
|
+
CreateSnapshotCommandOutput,
|
|
22
|
+
SimSpaceWeaverClientResolvedConfig
|
|
23
|
+
> {
|
|
24
|
+
readonly input: CreateSnapshotCommandInput;
|
|
25
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
26
|
+
constructor(input: CreateSnapshotCommandInput);
|
|
27
|
+
resolveMiddleware(
|
|
28
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
29
|
+
configuration: SimSpaceWeaverClientResolvedConfig,
|
|
30
|
+
options?: __HttpHandlerOptions
|
|
31
|
+
): Handler<CreateSnapshotCommandInput, CreateSnapshotCommandOutput>;
|
|
32
|
+
private serialize;
|
|
33
|
+
private deserialize;
|
|
34
|
+
}
|