AWS IoT Things Graph
Welcome (API Version 2018-09-06)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

SystemInstanceDescription

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

Contents

definition

A document that defines an entity.

Type: DefinitionDocument object

Required: No

flowActionsRoleArn

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

metricsConfiguration

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

Type: MetricsConfiguration object

Required: No

s3BucketName

The Amazon Simple Storage Service bucket where information about a system instance is stored.

Type: String

Required: No

summary

An object that contains summary information about a system instance.

Type: SystemInstanceSummary object

Required: No

validatedDependencyRevisions

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

Type: Array of DependencyRevision objects

Required: No

validatedNamespaceVersion

The version of the user's namespace against which the system instance was validated.

Type: Long

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: