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.

SystemInstanceSummary

An object that contains summary information about a system instance.

Contents

arn

The ARN of the system instance.

Type: String

Required: No

createdAt

The date when the system instance was created.

Type: Timestamp

Required: No

greengrassGroupId

The ID of the Greengrass group where the system instance is deployed.

Type: String

Required: No

greengrassGroupName

The ID of the Greengrass group where the system instance is deployed.

Type: String

Required: No

greengrassGroupVersionId

The version of the Greengrass group where the system instance is deployed.

Type: String

Required: No

id

The ID of the system instance.

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 status of the system instance.

Type: String

Valid Values: NOT_DEPLOYED | BOOTSTRAP | DEPLOY_IN_PROGRESS | DEPLOYED_IN_TARGET | UNDEPLOY_IN_PROGRESS | FAILED | PENDING_DELETE | DELETED_IN_TARGET

Required: No

target

The target of the system instance.

Type: String

Valid Values: GREENGRASS | CLOUD

Required: No

updatedAt

The date and time when the system instance 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:

On this page: