The AWS IoT Things Graph API contains several data types that various actions use. This section describes each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.
The following data types are supported:
• DefinitionDocument (p. 94)
• DependencyRevision (p. 95)
• EntityDescription (p. 96)
• EntityFilter (p. 98)
• FlowExecutionMessage (p. 99)
• FlowExecutionSummary (p. 100)
• FlowTemplateDescription (p. 102)
• FlowTemplateFilter (p. 103)
• FlowTemplateSummary (p. 104)
• MetricsConfiguration (p. 105)
• SystemInstanceDescription (p. 106)
• SystemInstanceFilter (p. 108)
• SystemInstanceSummary (p. 109)
• SystemTemplateDescription (p. 111)
• SystemTemplateFilter (p. 112)
• SystemTemplateSummary (p. 113)
• Tag (p. 114)
• Thing (p. 115)
API Version 2018-09-06 93
DefinitionDocument
DefinitionDocument
A document that defines an entity.
Contents
language
The language used to define the entity. GRAPHQL is the only valid value.
Type: String
Valid Values: GRAPHQL Required: Yes
text
The GraphQL text that defines the entity.
Type: String
Length Constraints: Maximum length of 1048576.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DependencyRevision
An object that contains the ID and revision number of a workflow or system that is part of a deployment.
Contents
id
The ID of the workflow or system.
Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: No revisionNumber
The revision number of the workflow or system.
Type: Long Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-09-06 95
EntityDescription
EntityDescription
Describes the properties of an entity.
Contents
arn
The entity ARN.
Type: String Required: No createdAt
The time at which the entity was created.
Type: Timestamp Required: No definition
The definition document of the entity.
Type: DefinitionDocument (p. 94) object Required: No
id
The entity ID.
Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: No type
The entity type.
Type: String
Valid Values: DEVICE | SERVICE | DEVICE_MODEL | CAPABILITY | STATE | ACTION | EVENT | PROPERTY | MAPPING | ENUM
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-09-06 97
EntityFilter
EntityFilter
An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.
Contents
name
The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.
Type: String
Valid Values: NAME | NAMESPACE | SEMANTIC_TYPE_PATH | REFERENCED_ENTITY_ID Required: No
value
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
Type: Array of strings Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FlowExecutionMessage
An object that contains information about a flow event.
Contents
eventType
The type of flow event . Type: String
Valid Values: EXECUTION_STARTED | EXECUTION_FAILED | EXECUTION_ABORTED | EXECUTION_SUCCEEDED | STEP_STARTED | STEP_FAILED | STEP_SUCCEEDED |
ACTIVITY_SCHEDULED | ACTIVITY_STARTED | ACTIVITY_FAILED | ACTIVITY_SUCCEEDED
| START_FLOW_EXECUTION_TASK | SCHEDULE_NEXT_READY_STEPS_TASK |
THING_ACTION_TASK | THING_ACTION_TASK_FAILED | THING_ACTION_TASK_SUCCEEDED | ACKNOWLEDGE_TASK_MESSAGE
Required: No messageId
The unique identifier of the message.
Type: String Required: No payload
A string containing information about the flow event.
Type: String Required: No timestamp
The date and time when the message was last updated.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-09-06 99
FlowExecutionSummary
FlowExecutionSummary
An object that contains summary information about a flow execution.
Contents
createdAt
The date and time when the flow execution summary was created.
Type: Timestamp Required: No flowExecutionId
The ID of the flow execution.
Type: String Required: No flowTemplateId
The ID of the flow.
Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: No status
The current status of the flow execution.
Type: String
Valid Values: RUNNING | ABORTED | SUCCEEDED | FAILED Required: No
systemInstanceId
The ID of the system instance that contains the flow.
Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: No updatedAt
The date and time when the flow execution summary was last updated.
Type: Timestamp Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-09-06 101
FlowTemplateDescription
FlowTemplateDescription
An object that contains a workflow's definition and summary information.
Contents
definition
A workflow's definition document.
Type: DefinitionDocument (p. 94) object Required: No
summary
An object that contains summary information about a workflow.
Type: FlowTemplateSummary (p. 104) object Required: No
validatedNamespaceVersion
The version of the user's namespace against which the workflow was validated. Use this value in your system instance.
Type: Long Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FlowTemplateFilter
An object that filters a workflow search.
Contents
name
The name of the search filter field.
Type: String
Valid Values: DEVICE_MODEL_ID Required: Yes
value
An array of string values for the search filter field. Multiple values function as AND criteria in the search.
Type: Array of strings
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
API Version 2018-09-06 103
FlowTemplateSummary
FlowTemplateSummary
An object that contains summary information about a workflow.
Contents
arn
The ARN of the workflow.
Type: String Required: No createdAt
The date when the workflow was created.
Type: Timestamp Required: No id
The ID of the workflow.
Type: String
Length Constraints: Maximum length of 160.
Pattern: ^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/
[0-9]+/)*[\p{Alnum}_]+(/[\p{Alnum}_]+)*):([\p{Alpha}]*):([\p{Alnum}_]+(/
[\p{Alnum}_]+)*)$
Required: No revisionNumber
The revision number of the workflow.
Type: Long Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3