[ aws . iotthingsgraph ]
Gets the latest version of the DefinitionDocument
and FlowTemplateSummary
for the specified workflow.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-flow-template
--id <value>
[--revision-number <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--id
(string)
The ID of the workflow.
The ID should be in the following format.
urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
--revision-number
(long)
The number of the workflow revision to retrieve.
--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 flow definition
The following get-flow-template
example gets a definition for a flow (workflow).
aws iotthingsgraph get-flow-template \
--id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow"
Output:
{
"description": {
"summary": {
"id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow",
"revisionNumber": 1,
"createdAt": 1559247540.292
},
"definition": {
"language": "GRAPHQL",
"text": "{\nquery MyFlow($camera: string!, $screen: string!) @workflowType(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\") @annotation(type: \"tgc:FlowEvent\", id: \"sledged790c1b2bcd949e09da0c9bfc077f79d\", x: 1586, y: 653) @triggers(definition: \"{MotionSensor(description: \\\"\\\") @position(x: 1045, y: 635.6666564941406) {\\n condition(expr: \\\"devices[name == \\\\\\\"motionSensor\\\\\\\"].events[name == \\\\\\\"StateChanged\\\\\\\"].lastEvent\\\")\\n action(expr: \\\"\\\")\\n}}\") {\n variables {\n cameraResult @property(id: \"urn:tdm:aws/examples:property:CameraStateProperty\")\n }\n steps {\n step(name: \"Camera\", outEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1377, y: 638.6666564941406) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Camera\", out: \"cameraResult\", deviceId: \"${camera}\") {\n capture\n }\n }\n step(name: \"Screen\", inEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1675.6666870117188, y: 637.9999847412109) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Screen\", deviceId: \"${screen}\") {\n display(imageUrl: \"${cameraResult.lastClickedImage}\")\n }\n }\n }\n}\n}"
},
"validatedNamespaceVersion": 5
}
}
For more information, see Working with Flows in the AWS IoT Things Graph User Guide.
description -> (structure)
The object that describes the specified workflow.
summary -> (structure)
An object that contains summary information about a workflow.
id -> (string)
The ID of the workflow.
arn -> (string)
The ARN of the workflow.
revisionNumber -> (long)
The revision number of the workflow.
createdAt -> (timestamp)
The date when the workflow was created.
definition -> (structure)
A workflow’s definition document.
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 version of the user’s namespace against which the workflow was validated. Use this value in your system instance.