Expand description
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.
If you’re using the service, you’re probably looking for IotThingsGraphClient and IotThingsGraph.
Structs§
- Associate
Entity ToThing Request - Associate
Entity ToThing Response - Create
Flow Template Request - Create
Flow Template Response - Create
System Instance Request - Create
System Instance Response - Create
System Template Request - Create
System Template Response - Definition
Document A document that defines an entity.
- Delete
Flow Template Request - Delete
Flow Template Response - Delete
Namespace Request - Delete
Namespace Response - Delete
System Instance Request - Delete
System Instance Response - Delete
System Template Request - Delete
System Template Response - Dependency
Revision An object that contains the ID and revision number of a workflow or system that is part of a deployment.
- Deploy
System Instance Request - Deploy
System Instance Response - Deprecate
Flow Template Request - Deprecate
Flow Template Response - Deprecate
System Template Request - Deprecate
System Template Response - Describe
Namespace Request - Describe
Namespace Response - Dissociate
Entity From Thing Request - Dissociate
Entity From Thing Response - Entity
Description Describes the properties of an entity.
- Entity
Filter An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a
NAMESPACEand aREFERENCED_ENTITY_IDfilter searches for entities in the specified namespace that use the entity specified by the value ofREFERENCED_ENTITY_ID.- Flow
Execution Message An object that contains information about a flow event.
- Flow
Execution Summary An object that contains summary information about a flow execution.
- Flow
Template Description An object that contains a workflow's definition and summary information.
- Flow
Template Filter An object that filters a workflow search.
- Flow
Template Summary An object that contains summary information about a workflow.
- GetEntities
Request - GetEntities
Response - GetFlow
Template Request - GetFlow
Template Response - GetFlow
Template Revisions Request - GetFlow
Template Revisions Response - GetNamespace
Deletion Status Request - GetNamespace
Deletion Status Response - GetSystem
Instance Request - GetSystem
Instance Response - GetSystem
Template Request - GetSystem
Template Response - GetSystem
Template Revisions Request - GetSystem
Template Revisions Response - GetUpload
Status Request - GetUpload
Status Response - IotThings
Graph Client - A client for the AWS IoT Things Graph API.
- List
Flow Execution Messages Request - List
Flow Execution Messages Response - List
Tags ForResource Request - List
Tags ForResource Response - Metrics
Configuration An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.
- Search
Entities Request - Search
Entities Response - Search
Flow Executions Request - Search
Flow Executions Response - Search
Flow Templates Request - Search
Flow Templates Response - Search
System Instances Request - Search
System Instances Response - Search
System Templates Request - Search
System Templates Response - Search
Things Request - Search
Things Response - System
Instance Description An object that contains a system instance definition and summary information.
- System
Instance Filter An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.
- System
Instance Summary An object that contains summary information about a system instance.
- System
Template Description An object that contains a system's definition document and summary information.
- System
Template Filter An object that filters a system search.
- System
Template Summary An object that contains information about a system.
- Tag
Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.
- TagResource
Request - TagResource
Response - Thing
An AWS IoT thing.
- Undeploy
System Instance Request - Undeploy
System Instance Response - Untag
Resource Request - Untag
Resource Response - Update
Flow Template Request - Update
Flow Template Response - Update
System Template Request - Update
System Template Response - Upload
Entity Definitions Request - Upload
Entity Definitions Response
Enums§
- Associate
Entity ToThing Error - Errors returned by AssociateEntityToThing
- Create
Flow Template Error - Errors returned by CreateFlowTemplate
- Create
System Instance Error - Errors returned by CreateSystemInstance
- Create
System Template Error - Errors returned by CreateSystemTemplate
- Delete
Flow Template Error - Errors returned by DeleteFlowTemplate
- Delete
Namespace Error - Errors returned by DeleteNamespace
- Delete
System Instance Error - Errors returned by DeleteSystemInstance
- Delete
System Template Error - Errors returned by DeleteSystemTemplate
- Deploy
System Instance Error - Errors returned by DeploySystemInstance
- Deprecate
Flow Template Error - Errors returned by DeprecateFlowTemplate
- Deprecate
System Template Error - Errors returned by DeprecateSystemTemplate
- Describe
Namespace Error - Errors returned by DescribeNamespace
- Dissociate
Entity From Thing Error - Errors returned by DissociateEntityFromThing
- GetEntities
Error - Errors returned by GetEntities
- GetFlow
Template Error - Errors returned by GetFlowTemplate
- GetFlow
Template Revisions Error - Errors returned by GetFlowTemplateRevisions
- GetNamespace
Deletion Status Error - Errors returned by GetNamespaceDeletionStatus
- GetSystem
Instance Error - Errors returned by GetSystemInstance
- GetSystem
Template Error - Errors returned by GetSystemTemplate
- GetSystem
Template Revisions Error - Errors returned by GetSystemTemplateRevisions
- GetUpload
Status Error - Errors returned by GetUploadStatus
- List
Flow Execution Messages Error - Errors returned by ListFlowExecutionMessages
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Search
Entities Error - Errors returned by SearchEntities
- Search
Flow Executions Error - Errors returned by SearchFlowExecutions
- Search
Flow Templates Error - Errors returned by SearchFlowTemplates
- Search
System Instances Error - Errors returned by SearchSystemInstances
- Search
System Templates Error - Errors returned by SearchSystemTemplates
- Search
Things Error - Errors returned by SearchThings
- TagResource
Error - Errors returned by TagResource
- Undeploy
System Instance Error - Errors returned by UndeploySystemInstance
- Untag
Resource Error - Errors returned by UntagResource
- Update
Flow Template Error - Errors returned by UpdateFlowTemplate
- Update
System Template Error - Errors returned by UpdateSystemTemplate
- Upload
Entity Definitions Error - Errors returned by UploadEntityDefinitions
Traits§
- IotThings
Graph - Trait representing the capabilities of the AWS IoT Things Graph API. AWS IoT Things Graph clients implement this trait.