aws.iotthingsgraph.get_system_instance

Example SQL Queries

SELECT * FROM
aws.iotthingsgraph.get_system_instance
WHERE
"id" = 'VALUE';

Description

Gets a system instance.

• View All IoTThingsGraph Tables
• Boto3 Reference

Table Definition

Column Name	Column Data Type
id Required Input Column The ID of the system deployment instance. This value is returned by CreateSystemInstance. The ID should be in the following format. urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME	VARCHAR
_aws_profile Input Column The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.	STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) )
Show child fields _aws_profile.account_id The AWS account id _aws_profile.assumed_role_arn The ARN of the assumed role _aws_profile.name The unique name of the profile. _aws_profile.organization Information about this profile's membership in the AWS organization. Show child fields _aws_profile.organization.account_name The name of account speciifed by the organization _aws_profile.organization.id The organization id _aws_profile.organization.master_account Show child fields _aws_profile.organization.master_account.email The organization master account email address _aws_profile.organization.master_account.id The organization master account id _aws_profile.organization.parents[] Show child fields _aws_profile.organization.parents[].id The id of the parent _aws_profile.organization.parents[].name The name of the parent _aws_profile.organization.parents[].tags[] Show child fields _aws_profile.organization.parents[].tags[].key _aws_profile.organization.parents[].tags[].value _aws_profile.organization.parents[].type The type of parent can be an organization unit or a root _aws_profile.organization.tags[] Show child fields _aws_profile.organization.tags[].key _aws_profile.organization.tags[].value _aws_profile.type The type of profile, either 'credentials' or 'assumed_role' _aws_profile.via_profile_name This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
_aws_region Input Column The AWS region to use.	VARCHAR
description An object that describes the system instance.	STRUCT( "summary" STRUCT( "id" VARCHAR, "arn" VARCHAR, "status" VARCHAR, "target" VARCHAR, "greengrass_group_name" VARCHAR, "created_at" TIMESTAMP_S, "updated_at" TIMESTAMP_S, "greengrass_group_id" VARCHAR, "greengrass_group_version_id" VARCHAR ), "definition" STRUCT( "language" VARCHAR, "text" VARCHAR ), "s3_bucket_name" VARCHAR, "metrics_configuration" STRUCT( "cloud_metric_enabled" BOOLEAN, "metric_rule_role_arn" VARCHAR ), "validated_namespace_version" BIGINT, "validated_dependency_revisions" STRUCT( "id" VARCHAR, "revision_number" BIGINT )[], "flow_actions_role_arn" VARCHAR )
Show child fields description.definition A document that defines an entity. Show child fields description.definition.language The language used to define the entity. GRAPHQL is the only valid value. description.definition.text The GraphQL text that defines the entity. description.flow_actions_role_arn 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. description.metrics_configuration An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics. Show child fields description.metrics_configuration.cloud_metric_enabled A Boolean that specifies whether cloud metrics are collected. description.metrics_configuration.metric_rule_role_arn The ARN of the role that is used to collect cloud metrics. description.s3_bucket_name The Amazon Simple Storage Service bucket where information about a system instance is stored. description.summary An object that contains summary information about a system instance. Show child fields description.summary.arn The ARN of the system instance. description.summary.created_at The date when the system instance was created. description.summary.greengrass_group_id The ID of the Greengrass group where the system instance is deployed. description.summary.greengrass_group_name The ID of the Greengrass group where the system instance is deployed. description.summary.greengrass_group_version_id The version of the Greengrass group where the system instance is deployed. description.summary.id The ID of the system instance. description.summary.status The status of the system instance. description.summary.target The target of the system instance. description.summary.updated_at The date and time when the system instance was last updated. description.validated_dependency_revisions[] Show child fields description.validated_dependency_revisions[].id The ID of the workflow or system. description.validated_dependency_revisions[].revision_number The revision number of the workflow or system. description.validated_namespace_version The version of the user's namespace against which the system instance was validated.

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.