[ aws . iotthingsgraph ]
Gets a system.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-system-template
--id <value>
[--revision-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--id
(string)
The ID of the system to get. This ID must be in the user’s namespace.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
--revision-number
(long)
The number that specifies the revision of the system to get.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To get a system
The following get-system-template
example gets a definition for a system.
aws iotthingsgraph get-system-template \
--id "urn:tdm:us-west-2/123456789012/default:System:MySystem"
Output:
{
"description": {
"summary": {
"id": "urn:tdm:us-west-2/123456789012/default:System:MySystem",
"arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MyFlow",
"revisionNumber": 1,
"createdAt": 1559247540.656
},
"definition": {
"language": "GRAPHQL",
"text": "{\ntype MySystem @systemType(id: \"urn:tdm:us-west-2/123456789012/default:System:MySystem\", description: \"\") {\n camera: Camera @thing(id: \"urn:tdm:aws/examples:deviceModel:Camera\")\n screen: Screen @thing(id: \"urn:tdm:aws/examples:deviceModel:Screen\")\n motionSensor: MotionSensor @thing(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\")\n MyFlow: MyFlow @workflow(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\")\n}\n}"
},
"validatedNamespaceVersion": 5
}
}
For more information, see Working with Systems and Flow Configurations in the AWS IoT Things Graph User Guide.
description -> (structure)
An object that contains summary data about the system.
summary -> (structure)
An object that contains summary information about a system.
id -> (string)
The ID of the system.
arn -> (string)
The ARN of the system.
revisionNumber -> (long)
The revision number of the system.
createdAt -> (timestamp)
The date when the system was created.
definition -> (structure)
The definition document of a system.
language -> (string)
The language used to define the entity.
GRAPHQL
is the only valid value.text -> (string)
The GraphQL text that defines the entity.
validatedNamespaceVersion -> (long)
The namespace version against which the system was validated. Use this value in your system instance.