feat(client-iotthingsgraph): This release deprecates all APIs of the ThingsGraph service

Author: awstools

clients/client-iotthingsgraph/README.md

@@ -16,6 +16,8 @@ such as units of measure and communication protocols. AWS IoT Things Graph makes
 and defining how they interact at an abstract level.</p>
 <p>For more information about how AWS IoT Things Graph works, see the <a href="https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html">User Guide</a>.</p>
 
+<p>The AWS IoT Things Graph service is discontinued.</p>
+
 ## Installing
 
 To install the this package, simply type add or install @aws-sdk/client-iotthingsgraph

clients/client-iotthingsgraph/src/IoTThingsGraph.ts

@@ -176,9 +176,13 @@ import { IoTThingsGraphClient } from "./IoTThingsGraphClient";
  *        such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services
  *        and defining how they interact at an abstract level.</p>
  *          <p>For more information about how AWS IoT Things Graph works, see the <a href="https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html">User Guide</a>.</p>
+ *
+ *          <p>The AWS IoT Things Graph service is discontinued.</p>
  */
 export class IoTThingsGraph extends IoTThingsGraphClient {
   /**
+   * @deprecated
+   *
    * <p>Associates a device with a concrete thing that is in the user's registry.</p>
    *          <p>A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.</p>
    */
@@ -212,6 +216,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only
    *          entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the
    *       latest version of the user's namespace unless another namespace version is specified in the request.</p>
@@ -246,6 +252,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Creates a system instance. </p>
    *          <p>This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is
    *             specified by the <code>greengrassGroupName</code> parameter. It also adds a file to the S3 bucket specified by the <code>s3BucketName</code> parameter. You need to
@@ -286,6 +294,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Creates a system. The system is validated against the entities in the
    *          latest version of the user's namespace unless another namespace version is specified in the request.</p>
    */
@@ -319,6 +329,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy.
    *          Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).</p>
    */
@@ -352,7 +364,10 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
-   * <p>Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.</p>
+   * @deprecated
+   *
+   * <p>Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no
+   *       request parameters.</p>
    */
   public deleteNamespace(
     args: DeleteNamespaceCommandInput,
@@ -384,6 +399,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Deletes a system instance.
    *          Only system instances that have never been deployed, or that have been undeployed can be deleted.</p>
    *          <p>Users can create a new system instance that has the same ID as a deleted system instance.</p>
@@ -418,6 +435,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Deletes a system. New deployments can't contain the system after its deletion.
    *       Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.</p>
    */
@@ -451,6 +470,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>
    *             <b>Greengrass and Cloud Deployments</b>
    *          </p>
@@ -494,6 +515,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.</p>
    */
   public deprecateFlowTemplate(
@@ -526,6 +549,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Deprecates the specified system.</p>
    */
   public deprecateSystemTemplate(
@@ -558,6 +583,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets the latest version of the user's namespace and the public version that it is tracking.</p>
    */
   public describeNamespace(
@@ -590,6 +617,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only
    *          one entity of a particular type can be associated with a thing.</p>
    */
@@ -623,6 +652,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the
    *       following TDM entities.</p>
    *          <ul>
@@ -680,6 +711,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets the latest version of the <code>DefinitionDocument</code> and <code>FlowTemplateSummary</code> for the specified workflow.</p>
    */
   public getFlowTemplate(
@@ -712,6 +745,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated,
    *       this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.</p>
    */
@@ -745,6 +780,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets the status of a namespace deletion task.</p>
    */
   public getNamespaceDeletionStatus(
@@ -777,6 +814,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets a system instance.</p>
    */
   public getSystemInstance(
@@ -809,6 +848,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets a system.</p>
    */
   public getSystemTemplate(
@@ -841,6 +882,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return
    *       the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.</p>
    */
@@ -874,6 +917,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Gets the status of the specified upload.</p>
    */
   public getUploadStatus(
@@ -906,6 +951,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Returns a list of objects that contain information about events in a flow execution.</p>
    */
   public listFlowExecutionMessages(
@@ -938,6 +985,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Lists all tags on an AWS IoT Things Graph resource.</p>
    */
   public listTagsForResource(
@@ -970,6 +1019,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.</p>
    */
   public searchEntities(
@@ -1002,6 +1053,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Searches for AWS IoT Things Graph workflow execution instances.</p>
    */
   public searchFlowExecutions(
@@ -1034,6 +1087,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Searches for summary information about workflows.</p>
    */
   public searchFlowTemplates(
@@ -1066,6 +1121,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Searches for system instances in the user's account.</p>
    */
   public searchSystemInstances(
@@ -1098,6 +1155,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @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>
    */
   public searchSystemTemplates(
@@ -1130,6 +1189,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Searches for things associated with the specified entity. You can search by both device and device model.</p>
    *          <p>For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2.
    *          <code>SearchThings(camera2)</code> will return only thing2, but <code>SearchThings(camera)</code> will return both thing1 and thing2.</p>
@@ -1162,6 +1223,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Creates a tag for the specified resource.</p>
    */
   public tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
@@ -1188,6 +1251,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Removes a system instance from its target (Cloud or Greengrass).</p>
    */
   public undeploySystemInstance(
@@ -1220,6 +1285,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Removes a tag from the specified resource.</p>
    */
   public untagResource(
@@ -1252,6 +1319,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @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
    *          behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace. </p>
    */
@@ -1285,6 +1354,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @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>
    */
   public updateSystemTemplate(
@@ -1317,6 +1388,8 @@ export class IoTThingsGraph extends IoTThingsGraphClient {
   }
 
   /**
+   * @deprecated
+   *
    * <p>Asynchronously uploads one or more entity definitions to the user's namespace. The <code>document</code> parameter is required if
    *       <code>syncWithPublicNamespace</code> and <code>deleteExistingEntites</code> are false. If the <code>syncWithPublicNamespace</code> parameter  is set to
    *          <code>true</code>, the user's namespace will synchronize with the latest version of the public namespace. If <code>deprecateExistingEntities</code> is set to true,

clients/client-iotthingsgraph/src/IoTThingsGraphClient.ts

@@ -386,6 +386,8 @@ export interface IoTThingsGraphClientResolvedConfig extends IoTThingsGraphClient
  *        such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services
  *        and defining how they interact at an abstract level.</p>
  *          <p>For more information about how AWS IoT Things Graph works, see the <a href="https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis.html">User Guide</a>.</p>
+ *
+ *          <p>The AWS IoT Things Graph service is discontinued.</p>
  */
 export class IoTThingsGraphClient extends __Client<
   __HttpHandlerOptions,

clients/client-iotthingsgraph/src/commands/AssociateEntityToThingCommand.ts

@@ -28,6 +28,8 @@ export interface AssociateEntityToThingCommandInput extends AssociateEntityToThi
 export interface AssociateEntityToThingCommandOutput extends AssociateEntityToThingResponse, __MetadataBearer {}
 
 /**
+ * @deprecated
+ *
  * <p>Associates a device with a concrete thing that is in the user's registry.</p>
  *          <p>A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.</p>
  * @example

clients/client-iotthingsgraph/src/commands/CreateFlowTemplateCommand.ts

@@ -28,6 +28,8 @@ export interface CreateFlowTemplateCommandInput extends CreateFlowTemplateReques
 export interface CreateFlowTemplateCommandOutput extends CreateFlowTemplateResponse, __MetadataBearer {}
 
 /**
+ * @deprecated
+ *
  * <p>Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only
  *          entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the
  *       latest version of the user's namespace unless another namespace version is specified in the request.</p>

clients/client-iotthingsgraph/src/commands/CreateSystemInstanceCommand.ts

@@ -28,6 +28,8 @@ export interface CreateSystemInstanceCommandInput extends CreateSystemInstanceRe
 export interface CreateSystemInstanceCommandOutput extends CreateSystemInstanceResponse, __MetadataBearer {}
 
 /**
+ * @deprecated
+ *
  * <p>Creates a system instance. </p>
  *          <p>This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is
  *             specified by the <code>greengrassGroupName</code> parameter. It also adds a file to the S3 bucket specified by the <code>s3BucketName</code> parameter. You need to

clients/client-iotthingsgraph/src/commands/CreateSystemTemplateCommand.ts

@@ -28,6 +28,8 @@ export interface CreateSystemTemplateCommandInput extends CreateSystemTemplateRe
 export interface CreateSystemTemplateCommandOutput extends CreateSystemTemplateResponse, __MetadataBearer {}
 
 /**
+ * @deprecated
+ *
  * <p>Creates a system. The system is validated against the entities in the
  *          latest version of the user's namespace unless another namespace version is specified in the request.</p>
  * @example

clients/client-iotthingsgraph/src/commands/DeleteFlowTemplateCommand.ts

@@ -28,6 +28,8 @@ export interface DeleteFlowTemplateCommandInput extends DeleteFlowTemplateReques
 export interface DeleteFlowTemplateCommandOutput extends DeleteFlowTemplateResponse, __MetadataBearer {}
 
 /**
+ * @deprecated
+ *
  * <p>Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy.
  *          Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).</p>
  * @example

clients/client-iotthingsgraph/src/commands/DeleteNamespaceCommand.ts

@@ -28,7 +28,10 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {}
 export interface DeleteNamespaceCommandOutput extends DeleteNamespaceResponse, __MetadataBearer {}
 
 /**
- * <p>Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.</p>
+ * @deprecated
+ *
+ * <p>Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action. This action takes no
+ *       request parameters.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript