IotThingsGraphClient
AWS IoT Things Graph
AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, 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.
For more information about how AWS IoT Things Graph works, see the User Guide.
The AWS IoT Things Graph service is discontinued.
Functions
Associates a device with a concrete thing that is in the user's registry.
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.
Creates a system instance.
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.
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).
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.
Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.
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.
Greengrass and Cloud Deployments
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
Deprecates the specified system.
Gets the latest version of the user's namespace and the public version that it is tracking.
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.
Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
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.
Gets the status of a namespace deletion task.
Gets a system instance.
Gets a system.
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.
Gets the status of the specified upload.
Returns a list of objects that contain information about events in a flow execution.
Lists all tags on an AWS IoT Things Graph resource.
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
Searches for AWS IoT Things Graph workflow execution instances.
Searches for summary information about workflows.
Searches for system instances in the user's account.
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.
Searches for things associated with the specified entity. You can search by both device and device model.
Creates a tag for the specified resource.
Removes a system instance from its target (Cloud or Greengrass).
Removes a tag from the specified resource.
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.
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.
Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.
Inherited functions
Associates a device with a concrete thing that is in the user's registry.
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.
Creates a system instance.
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.
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).
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.
Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.
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.
Greengrass and Cloud Deployments
Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.
Deprecates the specified system.
Gets the latest version of the user's namespace and the public version that it is tracking.
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.
Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.
Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.
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.
Paginate over GetFlowTemplateRevisionsResponse results.
Gets the status of a namespace deletion task.
Gets a system instance.
Gets a system.
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.
Paginate over GetSystemTemplateRevisionsResponse results.
Gets the status of the specified upload.
Returns a list of objects that contain information about events in a flow execution.
Paginate over ListFlowExecutionMessagesResponse results.
Lists all tags on an AWS IoT Things Graph resource.
Paginate over ListTagsForResourceResponse results.
Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.
Paginate over SearchEntitiesResponse results.
Searches for AWS IoT Things Graph workflow execution instances.
Paginate over SearchFlowExecutionsResponse results.
Searches for summary information about workflows.
Paginate over SearchFlowTemplatesResponse results.
Searches for system instances in the user's account.
Paginate over SearchSystemInstancesResponse results.
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.
Paginate over SearchSystemTemplatesResponse results.
Searches for things associated with the specified entity. You can search by both device and device model.
Paginate over SearchThingsResponse results.
Creates a tag for the specified resource.
Removes a system instance from its target (Cloud or Greengrass).
Removes a tag from the specified resource.
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.
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.
Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.