@aws-sdk/client-simspaceweaver 3.296.0 → 3.297.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.
@@ -16,6 +16,7 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
16
16
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
17
17
  import { SimSpaceWeaverClient } from "./SimSpaceWeaverClient";
18
18
  /**
19
+ * @public
19
20
  * <p>Amazon Web Services SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale
20
21
  * spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,
21
22
  * crowd simulations with millions of people and objects, and massilvely-multiplayer games with
@@ -31,12 +32,14 @@ import { SimSpaceWeaverClient } from "./SimSpaceWeaverClient";
31
32
  */
32
33
  export declare class SimSpaceWeaver extends SimSpaceWeaverClient {
33
34
  /**
35
+ * @public
34
36
  * <p>Deletes the instance of the given custom app.</p>
35
37
  */
36
38
  deleteApp(args: DeleteAppCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAppCommandOutput>;
37
39
  deleteApp(args: DeleteAppCommandInput, cb: (err: any, data?: DeleteAppCommandOutput) => void): void;
38
40
  deleteApp(args: DeleteAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppCommandOutput) => void): void;
39
41
  /**
42
+ * @public
40
43
  * <p>Deletes all SimSpace Weaver resources assigned to the given simulation.</p>
41
44
  * <note>
42
45
  * <p>Your simulation uses resources in other Amazon Web Services services. This API operation doesn't delete
@@ -47,66 +50,77 @@ export declare class SimSpaceWeaver extends SimSpaceWeaverClient {
47
50
  deleteSimulation(args: DeleteSimulationCommandInput, cb: (err: any, data?: DeleteSimulationCommandOutput) => void): void;
48
51
  deleteSimulation(args: DeleteSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteSimulationCommandOutput) => void): void;
49
52
  /**
53
+ * @public
50
54
  * <p>Returns the state of the given custom app.</p>
51
55
  */
52
56
  describeApp(args: DescribeAppCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAppCommandOutput>;
53
57
  describeApp(args: DescribeAppCommandInput, cb: (err: any, data?: DescribeAppCommandOutput) => void): void;
54
58
  describeApp(args: DescribeAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAppCommandOutput) => void): void;
55
59
  /**
60
+ * @public
56
61
  * <p>Returns the current state of the given simulation.</p>
57
62
  */
58
63
  describeSimulation(args: DescribeSimulationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeSimulationCommandOutput>;
59
64
  describeSimulation(args: DescribeSimulationCommandInput, cb: (err: any, data?: DescribeSimulationCommandOutput) => void): void;
60
65
  describeSimulation(args: DescribeSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeSimulationCommandOutput) => void): void;
61
66
  /**
67
+ * @public
62
68
  * <p>Lists all custom apps or service apps for the given simulation and domain.</p>
63
69
  */
64
70
  listApps(args: ListAppsCommandInput, options?: __HttpHandlerOptions): Promise<ListAppsCommandOutput>;
65
71
  listApps(args: ListAppsCommandInput, cb: (err: any, data?: ListAppsCommandOutput) => void): void;
66
72
  listApps(args: ListAppsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsCommandOutput) => void): void;
67
73
  /**
74
+ * @public
68
75
  * <p>Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.</p>
69
76
  */
70
77
  listSimulations(args: ListSimulationsCommandInput, options?: __HttpHandlerOptions): Promise<ListSimulationsCommandOutput>;
71
78
  listSimulations(args: ListSimulationsCommandInput, cb: (err: any, data?: ListSimulationsCommandOutput) => void): void;
72
79
  listSimulations(args: ListSimulationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSimulationsCommandOutput) => void): void;
73
80
  /**
81
+ * @public
74
82
  * <p>Lists all tags on a SimSpace Weaver resource.</p>
75
83
  */
76
84
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
77
85
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
78
86
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
79
87
  /**
88
+ * @public
80
89
  * <p>Starts a custom app with the configuration specified in the simulation schema.</p>
81
90
  */
82
91
  startApp(args: StartAppCommandInput, options?: __HttpHandlerOptions): Promise<StartAppCommandOutput>;
83
92
  startApp(args: StartAppCommandInput, cb: (err: any, data?: StartAppCommandOutput) => void): void;
84
93
  startApp(args: StartAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartAppCommandOutput) => void): void;
85
94
  /**
95
+ * @public
86
96
  * <p>Starts the simulation clock.</p>
87
97
  */
88
98
  startClock(args: StartClockCommandInput, options?: __HttpHandlerOptions): Promise<StartClockCommandOutput>;
89
99
  startClock(args: StartClockCommandInput, cb: (err: any, data?: StartClockCommandOutput) => void): void;
90
100
  startClock(args: StartClockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartClockCommandOutput) => void): void;
91
101
  /**
102
+ * @public
92
103
  * <p>Starts a simulation with the given name and schema.</p>
93
104
  */
94
105
  startSimulation(args: StartSimulationCommandInput, options?: __HttpHandlerOptions): Promise<StartSimulationCommandOutput>;
95
106
  startSimulation(args: StartSimulationCommandInput, cb: (err: any, data?: StartSimulationCommandOutput) => void): void;
96
107
  startSimulation(args: StartSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartSimulationCommandOutput) => void): void;
97
108
  /**
109
+ * @public
98
110
  * <p>Stops the given custom app and shuts down all of its allocated compute resources.</p>
99
111
  */
100
112
  stopApp(args: StopAppCommandInput, options?: __HttpHandlerOptions): Promise<StopAppCommandOutput>;
101
113
  stopApp(args: StopAppCommandInput, cb: (err: any, data?: StopAppCommandOutput) => void): void;
102
114
  stopApp(args: StopAppCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAppCommandOutput) => void): void;
103
115
  /**
116
+ * @public
104
117
  * <p>Stops the simulation clock.</p>
105
118
  */
106
119
  stopClock(args: StopClockCommandInput, options?: __HttpHandlerOptions): Promise<StopClockCommandOutput>;
107
120
  stopClock(args: StopClockCommandInput, cb: (err: any, data?: StopClockCommandOutput) => void): void;
108
121
  stopClock(args: StopClockCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopClockCommandOutput) => void): void;
109
122
  /**
123
+ * @public
110
124
  * <p>Stops the given simulation.</p>
111
125
  * <important>
112
126
  * <p>You can't restart a simulation after you stop it.
@@ -118,6 +132,7 @@ export declare class SimSpaceWeaver extends SimSpaceWeaverClient {
118
132
  stopSimulation(args: StopSimulationCommandInput, cb: (err: any, data?: StopSimulationCommandOutput) => void): void;
119
133
  stopSimulation(args: StopSimulationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopSimulationCommandOutput) => void): void;
120
134
  /**
135
+ * @public
121
136
  * <p>Adds tags to a SimSpace Weaver resource. 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
122
137
  * <i>Amazon Web Services General Reference</i>.</p>
123
138
  */
@@ -125,6 +140,7 @@ export declare class SimSpaceWeaver extends SimSpaceWeaverClient {
125
140
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
126
141
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
127
142
  /**
143
+ * @public
128
144
  * <p>Removes tags from a SimSpace Weaver resource. 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
129
145
  * <i>Amazon Web Services General Reference</i>.</p>
130
146
  */
@@ -23,15 +23,24 @@ import { StopSimulationCommandInput, StopSimulationCommandOutput } from "./comma
23
23
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
24
24
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
25
25
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
26
+ /**
27
+ * @public
28
+ */
26
29
  export type ServiceInputTypes = DeleteAppCommandInput | DeleteSimulationCommandInput | DescribeAppCommandInput | DescribeSimulationCommandInput | ListAppsCommandInput | ListSimulationsCommandInput | ListTagsForResourceCommandInput | StartAppCommandInput | StartClockCommandInput | StartSimulationCommandInput | StopAppCommandInput | StopClockCommandInput | StopSimulationCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
30
+ /**
31
+ * @public
32
+ */
27
33
  export type ServiceOutputTypes = DeleteAppCommandOutput | DeleteSimulationCommandOutput | DescribeAppCommandOutput | DescribeSimulationCommandOutput | ListAppsCommandOutput | ListSimulationsCommandOutput | ListTagsForResourceCommandOutput | StartAppCommandOutput | StartClockCommandOutput | StartSimulationCommandOutput | StopAppCommandOutput | StopClockCommandOutput | StopSimulationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
34
+ /**
35
+ * @public
36
+ */
28
37
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
29
38
  /**
30
39
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
31
40
  */
32
41
  requestHandler?: __HttpHandler;
33
42
  /**
34
- * A constructor for a class implementing the {@link __Checksum} interface
43
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
35
44
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
36
45
  * @internal
37
46
  */
@@ -121,23 +130,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
121
130
  */
122
131
  logger?: __Logger;
123
132
  /**
124
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
133
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
125
134
  */
126
135
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
127
136
  }
137
+ /**
138
+ * @public
139
+ */
128
140
  type SimSpaceWeaverClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
129
141
  /**
130
- * The configuration interface of SimSpaceWeaverClient class constructor that set the region, credentials and other options.
142
+ * @public
143
+ *
144
+ * The configuration interface of SimSpaceWeaverClient class constructor that set the region, credentials and other options.
131
145
  */
132
146
  export interface SimSpaceWeaverClientConfig extends SimSpaceWeaverClientConfigType {
133
147
  }
148
+ /**
149
+ * @public
150
+ */
134
151
  type SimSpaceWeaverClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
135
152
  /**
136
- * The resolved configuration interface of SimSpaceWeaverClient class. This is resolved and normalized from the {@link SimSpaceWeaverClientConfig | constructor configuration interface}.
153
+ * @public
154
+ *
155
+ * The resolved configuration interface of SimSpaceWeaverClient class. This is resolved and normalized from the {@link SimSpaceWeaverClientConfig | constructor configuration interface}.
137
156
  */
138
157
  export interface SimSpaceWeaverClientResolvedConfig extends SimSpaceWeaverClientResolvedConfigType {
139
158
  }
140
159
  /**
160
+ * @public
141
161
  * <p>Amazon Web Services SimSpace Weaver (SimSpace Weaver) is a managed service that you can use to build and operate large-scale
142
162
  * spatial simulations in the Amazon Web Services Cloud. For example, you can create a digital twin of a city,
143
163
  * crowd simulations with millions of people and objects, and massilvely-multiplayer games with
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteAppInput, DeleteAppOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAppCommand}.
8
10
  */
9
11
  export interface DeleteAppCommandInput extends DeleteAppInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAppCommand}.
13
17
  */
14
18
  export interface DeleteAppCommandOutput extends DeleteAppOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the instance of the given custom app.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteAppCommandOutput extends DeleteAppOutput, __MetadataBeare
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteAppCommandInput - {@link DeleteAppCommandInput}
34
+ * @returns {@link DeleteAppCommandOutput}
28
35
  * @see {@link DeleteAppCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteAppCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -49,11 +56,20 @@ export interface DeleteAppCommandOutput extends DeleteAppOutput, __MetadataBeare
49
56
  export declare class DeleteAppCommand extends $Command<DeleteAppCommandInput, DeleteAppCommandOutput, SimSpaceWeaverClientResolvedConfig> {
50
57
  readonly input: DeleteAppCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: DeleteAppCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAppCommandInput, DeleteAppCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteSimulationInput, DeleteSimulationOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteSimulationCommand}.
8
10
  */
9
11
  export interface DeleteSimulationCommandInput extends DeleteSimulationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteSimulationCommand}.
13
17
  */
14
18
  export interface DeleteSimulationCommandOutput extends DeleteSimulationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes all SimSpace Weaver resources assigned to the given simulation.</p>
18
23
  * <note>
19
24
  * <p>Your simulation uses resources in other Amazon Web Services services. This API operation doesn't delete
@@ -29,6 +34,8 @@ export interface DeleteSimulationCommandOutput extends DeleteSimulationOutput, _
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteSimulationCommandInput - {@link DeleteSimulationCommandInput}
38
+ * @returns {@link DeleteSimulationCommandOutput}
32
39
  * @see {@link DeleteSimulationCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteSimulationCommandOutput} for command's `response` shape.
34
41
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -53,11 +60,20 @@ export interface DeleteSimulationCommandOutput extends DeleteSimulationOutput, _
53
60
  export declare class DeleteSimulationCommand extends $Command<DeleteSimulationCommandInput, DeleteSimulationCommandOutput, SimSpaceWeaverClientResolvedConfig> {
54
61
  readonly input: DeleteSimulationCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: DeleteSimulationCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteSimulationCommandInput, DeleteSimulationCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeAppInput, DescribeAppOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeAppCommand}.
8
10
  */
9
11
  export interface DescribeAppCommandInput extends DescribeAppInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeAppCommand}.
13
17
  */
14
18
  export interface DescribeAppCommandOutput extends DescribeAppOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the state of the given custom app.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeAppCommandOutput extends DescribeAppOutput, __MetadataB
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeAppCommandInput - {@link DescribeAppCommandInput}
34
+ * @returns {@link DescribeAppCommandOutput}
28
35
  * @see {@link DescribeAppCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeAppCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeAppCommandOutput extends DescribeAppOutput, __MetadataB
46
53
  export declare class DescribeAppCommand extends $Command<DescribeAppCommandInput, DescribeAppCommandOutput, SimSpaceWeaverClientResolvedConfig> {
47
54
  readonly input: DescribeAppCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeAppCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAppCommandInput, DescribeAppCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeSimulationInput, DescribeSimulationOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeSimulationCommand}.
8
10
  */
9
11
  export interface DescribeSimulationCommandInput extends DescribeSimulationInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeSimulationCommand}.
13
17
  */
14
18
  export interface DescribeSimulationCommandOutput extends DescribeSimulationOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the current state of the given simulation.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeSimulationCommandOutput extends DescribeSimulationOutpu
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeSimulationCommandInput - {@link DescribeSimulationCommandInput}
34
+ * @returns {@link DescribeSimulationCommandOutput}
28
35
  * @see {@link DescribeSimulationCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeSimulationCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -46,11 +53,20 @@ export interface DescribeSimulationCommandOutput extends DescribeSimulationOutpu
46
53
  export declare class DescribeSimulationCommand extends $Command<DescribeSimulationCommandInput, DescribeSimulationCommandOutput, SimSpaceWeaverClientResolvedConfig> {
47
54
  readonly input: DescribeSimulationCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: DescribeSimulationCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeSimulationCommandInput, DescribeSimulationCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListAppsInput, ListAppsOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListAppsCommand}.
8
10
  */
9
11
  export interface ListAppsCommandInput extends ListAppsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListAppsCommand}.
13
17
  */
14
18
  export interface ListAppsCommandOutput extends ListAppsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all custom apps or service apps for the given simulation and domain.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListAppsCommandOutput extends ListAppsOutput, __MetadataBearer
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListAppsCommandInput - {@link ListAppsCommandInput}
34
+ * @returns {@link ListAppsCommandOutput}
28
35
  * @see {@link ListAppsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListAppsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListAppsCommandOutput extends ListAppsOutput, __MetadataBearer
46
53
  export declare class ListAppsCommand extends $Command<ListAppsCommandInput, ListAppsCommandOutput, SimSpaceWeaverClientResolvedConfig> {
47
54
  readonly input: ListAppsCommandInput;
48
55
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
56
+ /**
57
+ * @public
58
+ */
49
59
  constructor(input: ListAppsCommandInput);
50
60
  /**
51
61
  * @internal
52
62
  */
53
63
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAppsCommandInput, ListAppsCommandOutput>;
64
+ /**
65
+ * @internal
66
+ */
54
67
  private serialize;
68
+ /**
69
+ * @internal
70
+ */
55
71
  private deserialize;
56
72
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListSimulationsInput, ListSimulationsOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListSimulationsCommand}.
8
10
  */
9
11
  export interface ListSimulationsCommandInput extends ListSimulationsInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListSimulationsCommand}.
13
17
  */
14
18
  export interface ListSimulationsCommandOutput extends ListSimulationsOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists the SimSpace Weaver simulations in the Amazon Web Services account used to make the API call.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListSimulationsCommandOutput extends ListSimulationsOutput, __M
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListSimulationsCommandInput - {@link ListSimulationsCommandInput}
34
+ * @returns {@link ListSimulationsCommandOutput}
28
35
  * @see {@link ListSimulationsCommandInput} for command's `input` shape.
29
36
  * @see {@link ListSimulationsCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -43,11 +50,20 @@ export interface ListSimulationsCommandOutput extends ListSimulationsOutput, __M
43
50
  export declare class ListSimulationsCommand extends $Command<ListSimulationsCommandInput, ListSimulationsCommandOutput, SimSpaceWeaverClientResolvedConfig> {
44
51
  readonly input: ListSimulationsCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: ListSimulationsCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListSimulationsCommandInput, ListSimulationsCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListTagsForResourceInput, ListTagsForResourceOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListTagsForResourceCommand}.
8
10
  */
9
11
  export interface ListTagsForResourceCommandInput extends ListTagsForResourceInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListTagsForResourceCommand}.
13
17
  */
14
18
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Lists all tags on a SimSpace Weaver resource.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
34
+ * @returns {@link ListTagsForResourceCommandOutput}
28
35
  * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
29
36
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -40,11 +47,20 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceOut
40
47
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, SimSpaceWeaverClientResolvedConfig> {
41
48
  readonly input: ListTagsForResourceCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: ListTagsForResourceCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartAppInput, StartAppOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartAppCommand}.
8
10
  */
9
11
  export interface StartAppCommandInput extends StartAppInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartAppCommand}.
13
17
  */
14
18
  export interface StartAppCommandOutput extends StartAppOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts a custom app with the configuration specified in the simulation schema.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartAppCommandOutput extends StartAppOutput, __MetadataBearer
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartAppCommandInput - {@link StartAppCommandInput}
34
+ * @returns {@link StartAppCommandOutput}
28
35
  * @see {@link StartAppCommandInput} for command's `input` shape.
29
36
  * @see {@link StartAppCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartAppCommandOutput extends StartAppOutput, __MetadataBearer
49
56
  export declare class StartAppCommand extends $Command<StartAppCommandInput, StartAppCommandOutput, SimSpaceWeaverClientResolvedConfig> {
50
57
  readonly input: StartAppCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: StartAppCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartAppCommandInput, StartAppCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { StartClockInput, StartClockOutput } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link StartClockCommand}.
8
10
  */
9
11
  export interface StartClockCommandInput extends StartClockInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link StartClockCommand}.
13
17
  */
14
18
  export interface StartClockCommandOutput extends StartClockOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Starts the simulation clock.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartClockCommandOutput extends StartClockOutput, __MetadataBea
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param StartClockCommandInput - {@link StartClockCommandInput}
34
+ * @returns {@link StartClockCommandOutput}
28
35
  * @see {@link StartClockCommandInput} for command's `input` shape.
29
36
  * @see {@link StartClockCommandOutput} for command's `response` shape.
30
37
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartClockCommandOutput extends StartClockOutput, __MetadataBea
49
56
  export declare class StartClockCommand extends $Command<StartClockCommandInput, StartClockCommandOutput, SimSpaceWeaverClientResolvedConfig> {
50
57
  readonly input: StartClockCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: StartClockCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartClockCommandInput, StartClockCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }