@aws-sdk/client-iotthingsgraph 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 import { SearchSystemTemplatesRequest, SearchSystemTemplatesResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchSystemTemplatesCommand}.
  */
 export interface SearchSystemTemplatesCommandInput extends SearchSystemTemplatesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchSystemTemplatesCommand}.
  */
 export interface SearchSystemTemplatesCommandOutput extends SearchSystemTemplatesResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.</p>
@@ -27,6 +32,8 @@ export interface SearchSystemTemplatesCommandOutput extends SearchSystemTemplate
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchSystemTemplatesCommandInput - {@link SearchSystemTemplatesCommandInput}
+ * @returns {@link SearchSystemTemplatesCommandOutput}
  * @see {@link SearchSystemTemplatesCommandInput} for command's `input` shape.
  * @see {@link SearchSystemTemplatesCommandOutput} for command's `response` shape.
  * @see {@link IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -45,11 +52,20 @@ export interface SearchSystemTemplatesCommandOutput extends SearchSystemTemplate
 export declare class SearchSystemTemplatesCommand extends $Command<SearchSystemTemplatesCommandInput, SearchSystemTemplatesCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: SearchSystemTemplatesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchSystemTemplatesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchSystemTemplatesCommandInput, SearchSystemTemplatesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 import { SearchThingsRequest, SearchThingsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link SearchThingsCommand}.
  */
 export interface SearchThingsCommandInput extends SearchThingsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SearchThingsCommand}.
  */
 export interface SearchThingsCommandOutput extends SearchThingsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Searches for things associated with the specified entity. You can search by both device and device model.</p>
@@ -30,6 +35,8 @@ export interface SearchThingsCommandOutput extends SearchThingsResponse, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param SearchThingsCommandInput - {@link SearchThingsCommandInput}
+ * @returns {@link SearchThingsCommandOutput}
  * @see {@link SearchThingsCommandInput} for command's `input` shape.
  * @see {@link SearchThingsCommandOutput} for command's `response` shape.
  * @see {@link IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -51,11 +58,20 @@ export interface SearchThingsCommandOutput extends SearchThingsResponse, __Metad
 export declare class SearchThingsCommand extends $Command<SearchThingsCommandInput, SearchThingsCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: SearchThingsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SearchThingsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SearchThingsCommandInput, SearchThingsCommandOutput>;
+    /**
+     * @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 { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 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
  * @deprecated
  *
  * <p>Creates a tag for the specified resource.</p>
@@ -27,6 +32,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 IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -48,11 +55,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 import { UndeploySystemInstanceRequest, UndeploySystemInstanceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UndeploySystemInstanceCommand}.
  */
 export interface UndeploySystemInstanceCommandInput extends UndeploySystemInstanceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UndeploySystemInstanceCommand}.
  */
 export interface UndeploySystemInstanceCommandOutput extends UndeploySystemInstanceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Removes a system instance from its target (Cloud or Greengrass).</p>
@@ -27,6 +32,8 @@ export interface UndeploySystemInstanceCommandOutput extends UndeploySystemInsta
  * const response = await client.send(command);
  * ```
  *
+ * @param UndeploySystemInstanceCommandInput - {@link UndeploySystemInstanceCommandInput}
+ * @returns {@link UndeploySystemInstanceCommandOutput}
  * @see {@link UndeploySystemInstanceCommandInput} for command's `input` shape.
  * @see {@link UndeploySystemInstanceCommandOutput} for command's `response` shape.
  * @see {@link IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -51,11 +58,20 @@ export interface UndeploySystemInstanceCommandOutput extends UndeploySystemInsta
 export declare class UndeploySystemInstanceCommand extends $Command<UndeploySystemInstanceCommandInput, UndeploySystemInstanceCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: UndeploySystemInstanceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UndeploySystemInstanceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UndeploySystemInstanceCommandInput, UndeploySystemInstanceCommandOutput>;
+    /**
+     * @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 { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 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
  * @deprecated
  *
  * <p>Removes a tag from the specified resource.</p>
@@ -27,6 +32,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 IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -48,11 +55,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 import { UpdateFlowTemplateRequest, UpdateFlowTemplateResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateFlowTemplateCommand}.
  */
 export interface UpdateFlowTemplateCommandInput extends UpdateFlowTemplateRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateFlowTemplateCommand}.
  */
 export interface UpdateFlowTemplateCommandOutput extends UpdateFlowTemplateResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this
@@ -28,6 +33,8 @@ export interface UpdateFlowTemplateCommandOutput extends UpdateFlowTemplateRespo
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateFlowTemplateCommandInput - {@link UpdateFlowTemplateCommandInput}
+ * @returns {@link UpdateFlowTemplateCommandOutput}
  * @see {@link UpdateFlowTemplateCommandInput} for command's `input` shape.
  * @see {@link UpdateFlowTemplateCommandOutput} for command's `response` shape.
  * @see {@link IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateFlowTemplateCommandOutput extends UpdateFlowTemplateRespo
 export declare class UpdateFlowTemplateCommand extends $Command<UpdateFlowTemplateCommandInput, UpdateFlowTemplateCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: UpdateFlowTemplateCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateFlowTemplateCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFlowTemplateCommandInput, UpdateFlowTemplateCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 import { UpdateSystemTemplateRequest, UpdateSystemTemplateResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateSystemTemplateCommand}.
  */
 export interface UpdateSystemTemplateCommandInput extends UpdateSystemTemplateRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateSystemTemplateCommand}.
  */
 export interface UpdateSystemTemplateCommandOutput extends UpdateSystemTemplateResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.</p>
@@ -27,6 +32,8 @@ export interface UpdateSystemTemplateCommandOutput extends UpdateSystemTemplateR
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateSystemTemplateCommandInput - {@link UpdateSystemTemplateCommandInput}
+ * @returns {@link UpdateSystemTemplateCommandOutput}
  * @see {@link UpdateSystemTemplateCommandInput} for command's `input` shape.
  * @see {@link UpdateSystemTemplateCommandOutput} for command's `response` shape.
  * @see {@link IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -48,11 +55,20 @@ export interface UpdateSystemTemplateCommandOutput extends UpdateSystemTemplateR
 export declare class UpdateSystemTemplateCommand extends $Command<UpdateSystemTemplateCommandInput, UpdateSystemTemplateCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: UpdateSystemTemplateCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateSystemTemplateCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateSystemTemplateCommandInput, UpdateSystemTemplateCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { IoTThingsGraphClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTThingsGraphClient";
 import { UploadEntityDefinitionsRequest, UploadEntityDefinitionsResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UploadEntityDefinitionsCommand}.
  */
 export interface UploadEntityDefinitionsCommandInput extends UploadEntityDefinitionsRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UploadEntityDefinitionsCommand}.
  */
 export interface UploadEntityDefinitionsCommandOutput extends UploadEntityDefinitionsResponse, __MetadataBearer {
 }
 /**
+ * @public
  * @deprecated
  *
  * <p>Asynchronously uploads one or more entity definitions to the user's namespace. The <code>document</code> parameter is required if
@@ -37,6 +42,8 @@ export interface UploadEntityDefinitionsCommandOutput extends UploadEntityDefini
  * const response = await client.send(command);
  * ```
  *
+ * @param UploadEntityDefinitionsCommandInput - {@link UploadEntityDefinitionsCommandInput}
+ * @returns {@link UploadEntityDefinitionsCommandOutput}
  * @see {@link UploadEntityDefinitionsCommandInput} for command's `input` shape.
  * @see {@link UploadEntityDefinitionsCommandOutput} for command's `response` shape.
  * @see {@link IoTThingsGraphClientResolvedConfig | config} for IoTThingsGraphClient's `config` shape.
@@ -55,11 +62,20 @@ export interface UploadEntityDefinitionsCommandOutput extends UploadEntityDefini
 export declare class UploadEntityDefinitionsCommand extends $Command<UploadEntityDefinitionsCommandInput, UploadEntityDefinitionsCommandOutput, IoTThingsGraphClientResolvedConfig> {
     readonly input: UploadEntityDefinitionsCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UploadEntityDefinitionsCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: IoTThingsGraphClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UploadEntityDefinitionsCommandInput, UploadEntityDefinitionsCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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