@aws-sdk/client-simspaceweaver 3.295.0 → 3.297.0

package/dist-types/commands/StartSimulationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartSimulationInput, StartSimulationOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
 /**
+ * @public
+ *
  * The input for {@link StartSimulationCommand}.
  */
 export interface StartSimulationCommandInput extends StartSimulationInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StartSimulationCommand}.
  */
 export interface StartSimulationCommandOutput extends StartSimulationOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts a simulation with the given name and schema.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StartSimulationCommandOutput extends StartSimulationOutput, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param StartSimulationCommandInput - {@link StartSimulationCommandInput}
+ * @returns {@link StartSimulationCommandOutput}
  * @see {@link StartSimulationCommandInput} for command's `input` shape.
  * @see {@link StartSimulationCommandOutput} for command's `response` shape.
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StartSimulationCommandOutput extends StartSimulationOutput, __M
 export declare class StartSimulationCommand extends $Command<StartSimulationCommandInput, StartSimulationCommandOutput, SimSpaceWeaverClientResolvedConfig> {
     readonly input: StartSimulationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartSimulationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSimulationCommandInput, StartSimulationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopAppCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopAppInput, StopAppOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
 /**
+ * @public
+ *
  * The input for {@link StopAppCommand}.
  */
 export interface StopAppCommandInput extends StopAppInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StopAppCommand}.
  */
 export interface StopAppCommandOutput extends StopAppOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops the given custom app and shuts down all of its allocated compute resources.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopAppCommandOutput extends StopAppOutput, __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param StopAppCommandInput - {@link StopAppCommandInput}
+ * @returns {@link StopAppCommandOutput}
  * @see {@link StopAppCommandInput} for command's `input` shape.
  * @see {@link StopAppCommandOutput} for command's `response` shape.
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StopAppCommandOutput extends StopAppOutput, __MetadataBearer {
 export declare class StopAppCommand extends $Command<StopAppCommandInput, StopAppCommandOutput, SimSpaceWeaverClientResolvedConfig> {
     readonly input: StopAppCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopAppCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopAppCommandInput, StopAppCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopClockCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopClockInput, StopClockOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
 /**
+ * @public
+ *
  * The input for {@link StopClockCommand}.
  */
 export interface StopClockCommandInput extends StopClockInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StopClockCommand}.
  */
 export interface StopClockCommandOutput extends StopClockOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops the simulation clock.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface StopClockCommandOutput extends StopClockOutput, __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param StopClockCommandInput - {@link StopClockCommandInput}
+ * @returns {@link StopClockCommandOutput}
  * @see {@link StopClockCommandInput} for command's `input` shape.
  * @see {@link StopClockCommandOutput} for command's `response` shape.
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -49,11 +56,20 @@ export interface StopClockCommandOutput extends StopClockOutput, __MetadataBeare
 export declare class StopClockCommand extends $Command<StopClockCommandInput, StopClockCommandOutput, SimSpaceWeaverClientResolvedConfig> {
     readonly input: StopClockCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopClockCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopClockCommandInput, StopClockCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/StopSimulationCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopSimulationInput, StopSimulationOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
 /**
+ * @public
+ *
  * The input for {@link StopSimulationCommand}.
  */
 export interface StopSimulationCommandInput extends StopSimulationInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StopSimulationCommand}.
  */
 export interface StopSimulationCommandOutput extends StopSimulationOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops the given simulation.</p>
  *          <important>
  *             <p>You can't restart a simulation after you stop it.
@@ -30,6 +35,8 @@ export interface StopSimulationCommandOutput extends StopSimulationOutput, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param StopSimulationCommandInput - {@link StopSimulationCommandInput}
+ * @returns {@link StopSimulationCommandOutput}
  * @see {@link StopSimulationCommandInput} for command's `input` shape.
  * @see {@link StopSimulationCommandOutput} for command's `response` shape.
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -54,11 +61,20 @@ export interface StopSimulationCommandOutput extends StopSimulationOutput, __Met
 export declare class StopSimulationCommand extends $Command<StopSimulationCommandInput, StopSimulationCommandOutput, SimSpaceWeaverClientResolvedConfig> {
     readonly input: StopSimulationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopSimulationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopSimulationCommandInput, StopSimulationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceInput, TagResourceOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <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
  *    <i>Amazon Web Services General Reference</i>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -44,11 +51,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SimSpaceWeaverClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceInput, UntagResourceOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SimSpaceWeaverClientResolvedConfig } from "../SimSpaceWeaverClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <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
  *    <i>Amazon Web Services General Reference</i>.</p>
  * @example
@@ -26,6 +31,8 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link SimSpaceWeaverClientResolvedConfig | config} for SimSpaceWeaverClient's `config` shape.
@@ -41,11 +48,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SimSpaceWeaverClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SimSpaceWeaverClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SimSpaceWeaverServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from SimSpaceWeaver service.
  */
 export declare class SimSpaceWeaverServiceException extends __ServiceException {