Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS IoT Things Graph can respond with.

Structs

DefinitionDocument

A document that defines an entity.

DependencyRevision

An object that contains the ID and revision number of a workflow or system that is part of a deployment.

EntityDescription

Describes the properties of an entity.

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.

FlowExecutionMessage

An object that contains information about a flow event.

FlowExecutionSummary

An object that contains summary information about a flow execution.

FlowTemplateDescription

An object that contains a workflow's definition and summary information.

FlowTemplateFilter

An object that filters a workflow search.

FlowTemplateSummary

An object that contains summary information about a workflow.

MetricsConfiguration

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

SystemInstanceDescription

An object that contains a system instance definition and summary information.

SystemInstanceFilter

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.

SystemInstanceSummary

An object that contains summary information about a system instance.

SystemTemplateDescription

An object that contains a system's definition document and summary information.

SystemTemplateFilter

An object that filters a system search.

SystemTemplateSummary

An object that contains information about a system.

Tag

Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.

Thing

An AWS IoT thing.

Enums

DefinitionLanguage

When writing a match expression against DefinitionLanguage, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeploymentTarget

When writing a match expression against DeploymentTarget, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EntityFilterName

When writing a match expression against EntityFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EntityType

When writing a match expression against EntityType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowExecutionEventType

When writing a match expression against FlowExecutionEventType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowExecutionStatus

When writing a match expression against FlowExecutionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FlowTemplateFilterName

When writing a match expression against FlowTemplateFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NamespaceDeletionStatus

When writing a match expression against NamespaceDeletionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

NamespaceDeletionStatusErrorCodes

When writing a match expression against NamespaceDeletionStatusErrorCodes, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SystemInstanceDeploymentStatus

When writing a match expression against SystemInstanceDeploymentStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SystemInstanceFilterName

When writing a match expression against SystemInstanceFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SystemTemplateFilterName

When writing a match expression against SystemTemplateFilterName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

UploadStatus

When writing a match expression against UploadStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.