@aws-sdk/client-iottwinmaker 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { ListWorkspacesRequest, ListWorkspacesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link ListWorkspacesCommand}.
  */
 export interface ListWorkspacesCommandInput extends ListWorkspacesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ListWorkspacesCommand}.
  */
 export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves information about workspaces in the current account.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
  * const response = await client.send(command);
  * ```
  *
+ * @param ListWorkspacesCommandInput - {@link ListWorkspacesCommandInput}
+ * @returns {@link ListWorkspacesCommandOutput}
  * @see {@link ListWorkspacesCommandInput} for command's `input` shape.
  * @see {@link ListWorkspacesCommandOutput} for command's `response` shape.
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface ListWorkspacesCommandOutput extends ListWorkspacesResponse, __M
 export declare class ListWorkspacesCommand extends $Command<ListWorkspacesCommandInput, ListWorkspacesCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: ListWorkspacesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ListWorkspacesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkspacesCommandInput, ListWorkspacesCommandOutput>;
+    /**
+     * @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 { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds tags to a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * 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 IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -43,11 +50,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, 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 { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes tags from a resource.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * 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 IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -40,11 +47,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { UpdateComponentTypeRequest, UpdateComponentTypeResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateComponentTypeCommand}.
  */
 export interface UpdateComponentTypeCommandInput extends UpdateComponentTypeRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateComponentTypeCommand}.
  */
 export interface UpdateComponentTypeCommandOutput extends UpdateComponentTypeResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates information in a component type.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateComponentTypeCommandOutput extends UpdateComponentTypeRes
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateComponentTypeCommandInput - {@link UpdateComponentTypeCommandInput}
+ * @returns {@link UpdateComponentTypeCommandOutput}
  * @see {@link UpdateComponentTypeCommandInput} for command's `input` shape.
  * @see {@link UpdateComponentTypeCommandOutput} for command's `response` shape.
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateComponentTypeCommandOutput extends UpdateComponentTypeRes
 export declare class UpdateComponentTypeCommand extends $Command<UpdateComponentTypeCommandInput, UpdateComponentTypeCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: UpdateComponentTypeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateComponentTypeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateComponentTypeCommandInput, UpdateComponentTypeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { UpdateEntityRequest, UpdateEntityResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateEntityCommand}.
  */
 export interface UpdateEntityCommandInput extends UpdateEntityRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateEntityCommand}.
  */
 export interface UpdateEntityCommandOutput extends UpdateEntityResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an entity.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateEntityCommandOutput extends UpdateEntityResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateEntityCommandInput - {@link UpdateEntityCommandInput}
+ * @returns {@link UpdateEntityCommandOutput}
  * @see {@link UpdateEntityCommandInput} for command's `input` shape.
  * @see {@link UpdateEntityCommandOutput} for command's `response` shape.
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UpdateEntityCommandOutput extends UpdateEntityResponse, __Metad
 export declare class UpdateEntityCommand extends $Command<UpdateEntityCommandInput, UpdateEntityCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: UpdateEntityCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateEntityCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateEntityCommandInput, UpdateEntityCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { UpdatePricingPlanRequest, UpdatePricingPlanResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdatePricingPlanCommand}.
  */
 export interface UpdatePricingPlanCommandInput extends UpdatePricingPlanRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdatePricingPlanCommand}.
  */
 export interface UpdatePricingPlanCommandOutput extends UpdatePricingPlanResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Update the pricing plan.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdatePricingPlanCommandOutput extends UpdatePricingPlanRespons
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdatePricingPlanCommandInput - {@link UpdatePricingPlanCommandInput}
+ * @returns {@link UpdatePricingPlanCommandOutput}
  * @see {@link UpdatePricingPlanCommandInput} for command's `input` shape.
  * @see {@link UpdatePricingPlanCommandOutput} for command's `response` shape.
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -46,11 +53,20 @@ export interface UpdatePricingPlanCommandOutput extends UpdatePricingPlanRespons
 export declare class UpdatePricingPlanCommand extends $Command<UpdatePricingPlanCommandInput, UpdatePricingPlanCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: UpdatePricingPlanCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdatePricingPlanCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePricingPlanCommandInput, UpdatePricingPlanCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

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

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTTwinMakerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTTwinMakerClient";
 import { UpdateWorkspaceRequest, UpdateWorkspaceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateWorkspaceCommand}.
  */
 export interface UpdateWorkspaceCommandInput extends UpdateWorkspaceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateWorkspaceCommand}.
  */
 export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a workspace.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateWorkspaceCommandInput - {@link UpdateWorkspaceCommandInput}
+ * @returns {@link UpdateWorkspaceCommandOutput}
  * @see {@link UpdateWorkspaceCommandInput} for command's `input` shape.
  * @see {@link UpdateWorkspaceCommandOutput} for command's `response` shape.
  * @see {@link IoTTwinMakerClientResolvedConfig | config} for IoTTwinMakerClient's `config` shape.
@@ -52,11 +59,20 @@ export interface UpdateWorkspaceCommandOutput extends UpdateWorkspaceResponse, _
 export declare class UpdateWorkspaceCommand extends $Command<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput, IoTTwinMakerClientResolvedConfig> {
     readonly input: UpdateWorkspaceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateWorkspaceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTTwinMakerClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateWorkspaceCommandInput, UpdateWorkspaceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region: string;
+    Region?: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;

package/dist-types/models/IoTTwinMakerServiceException.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 IoTTwinMaker service.
  */
 export declare class IoTTwinMakerServiceException extends __ServiceException {