AWS IoT Things Graph exemples utilisant AWS CLI

Pour associer un objet à un appareil

L'associate-entity-to-thingexemple suivant associe un objet à un appareil. L'exemple utilise un dispositif de détection de mouvement qui se trouve dans l'espace de noms public.

aws iotthingsgraph associate-entity-to-thing \
    --thing-name "MotionSensorName" \
    --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Création et téléchargement de modèles dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour créer un flux

L'create-flow-templateexemple suivant crée un flux (flux de travail). La valeur de MyFlowDefinition est le GraphQL qui modélise le flux.

aws iotthingsgraph create-flow-template \
    --definition language=GRAPHQL,text="MyFlowDefinition"

Sortie :

{
    "summary": {
        "createdAt": 1559248067.545,
        "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow",
        "revisionNumber": 1
    }
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour créer une instance de système

L'create-system-instanceexemple suivant crée une instance de système. La valeur de MySystemInstanceDefinition est le GraphQL qui modélise l'instance du système.

aws iotthingsgraph create-system-instance -\
    -definition language=GRAPHQL,text="MySystemInstanceDefinition" \
    --target CLOUD \
    --flow-actions-role-arn myRoleARN

Sortie :

{
    "summary": {
        "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218",
        "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218",
        "status": "NOT_DEPLOYED",
        "target": "CLOUD",
        "createdAt": 1559249315.208,
        "updatedAt": 1559249315.208
    }
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour créer un système

L'create-system-templateexemple suivant crée un système. La valeur de MySystemDefinition est le GraphQL qui modélise le système.

aws iotthingsgraph create-system-template \
    --definition language=GRAPHQL,text="MySystemDefinition"

Sortie :

{
    "summary": {
        "createdAt": 1559249776.254,
        "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem",
        "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem",
        "revisionNumber": 1
    }
}

Pour plus d'informations, consultez la section Création de systèmes dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour supprimer un flux

L'delete-flow-templateexemple suivant supprime un flux (flux de travail).

aws iotthingsgraph delete-flow-template \
    --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour supprimer un espace de noms

L'delete-namespaceexemple suivant supprime un espace de noms.

aws iotthingsgraph delete-namespace

Sortie :

{
   "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012",
   "namespaceName": "us-west-2/123456789012/default"
}

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour supprimer une instance du système

L'delete-system-instanceexemple suivant supprime une instance du système.

aws iotthingsgraph delete-system-instance \
    --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour supprimer un système

L'delete-system-templateexemple suivant supprime un système.

aws iotthingsgraph delete-system-template \
    --id "urn:tdm:us-west-2/123456789012/default:System:MySystem"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour déployer une instance de système

L'delete-system-templateexemple suivant déploie une instance de système.

aws iotthingsgraph deploy-system-instance \
    --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218"

Sortie :

{
   "summary": {
      "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment:Room218",
      "createdAt": 1559249776.254,
      "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218",
      "status": "DEPLOYED_IN_TARGET",
      "target": "CLOUD",
      "updatedAt": 1559249776.254
   }
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour déprécier un flux

L'deprecate-flow-templateexemple suivant déconseille un flux (flux de travail).

aws iotthingsgraph deprecate-flow-template \
    --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour déprécier un système

L'deprecate-system-templateexemple suivant déconseille un système.

aws iotthingsgraph deprecate-system-template \
    --id "urn:tdm:us-west-2/123456789012/default:System:MySystem"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir une description de votre espace de noms

L'describe-namespaceexemple suivant fournit une description de votre espace de noms.

aws iotthingsgraph describe-namespace

Sortie :

{
    "namespaceName": "us-west-2/123456789012/default",
    "trackingNamespaceName": "aws",
    "trackingNamespaceVersion": 1,
    "namespaceVersion": 5
}

Pour plus d'informations, consultez la section Namespaces dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour dissocier un objet d'un appareil

L'dissociate-entity-from-thingexemple suivant dissocie un objet d'un appareil.

aws iotthingsgraph dissociate-entity-from-thing \
    --thing-name "MotionSensorName" \
    --entity-type "DEVICE"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Création et téléchargement de modèles dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir des définitions pour des entités

L'get-entitiesexemple suivant permet d'obtenir la définition d'un modèle d'appareil.

aws iotthingsgraph get-entities \
    --ids "urn:tdm:aws/examples:DeviceModel:MotionSensor"

Sortie :

{
    "descriptions": [
        {
            "id": "urn:tdm:aws/examples:DeviceModel:MotionSensor",
            "type": "DEVICE_MODEL",
            "createdAt": 1559256190.599,
            "definition": {
                "language": "GRAPHQL",
                "text": "##\n# Specification of motion sensor devices interface.\n##\ntype MotionSensor @deviceModel(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\",\n        capability: \"urn:tdm:aws/examples:capability:MotionSensorCapability\") {ignore:void}"
            }
        }
    ]
}

Pour plus d'informations, consultez la section Création et téléchargement de modèles dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir des informations de révision concernant un flux

L'get-flow-template-revisionsexemple suivant permet d'obtenir des informations de révision concernant un flux (flux de travail).

aws iotthingsgraph get-flow-template-revisions \
    --id urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow

Sortie :

{
    "summaries": [
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow",
            "revisionNumber": 1,
            "createdAt": 1559247540.292
        }
    ]
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir une définition de flux

L'get-flow-templateexemple suivant obtient la définition d'un flux (flux de travail).

aws iotthingsgraph get-flow-template \
    --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow"

Sortie :

{
    "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
    }
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir le statut de la tâche de suppression de l'espace de noms

L'get-namespace-deletion-statusexemple suivant permet d'obtenir le statut de la tâche de suppression de l'espace de noms.

aws iotthingsgraph get-namespace-deletion-status

Sortie :

{
   "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012",
   "namespaceName": "us-west-2/123456789012/default"
   "status": "SUCCEEDED "
}

Pour plus d'informations, consultez la section Namespaces dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir une instance de système

L'get-system-instanceexemple suivant permet d'obtenir une définition pour une instance de système.

aws iotthingsgraph get-system-instance \
    --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218"

Sortie :

{
    "description": {
        "summary": {
            "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218",
            "status": "NOT_DEPLOYED",
            "target": "CLOUD",
            "createdAt": 1559249315.208,
            "updatedAt": 1559249315.208
        },
        "definition": {
            "language": "GRAPHQL",
            "text": "{\r\nquery Room218 @deployment(id: \"urn:tdm:us-west-2/123456789012/default:Deployment:Room218\", systemId: \"urn:tdm:us-west-2/123456789012/default:System:SecurityFlow\") {\r\n    motionSensor(deviceId: \"MotionSensorName\")\r\n    screen(deviceId: \"ScreenName\")\r\n    camera(deviceId: \"CameraName\") \r\n    triggers {MotionEventTrigger(description: \"a trigger\") {  \r\n    condition(expr: \"devices[name == 'motionSensor'].events[name == 'StateChanged'].lastEvent\") \r\n    action(expr: \"ThingsGraph.startFlow('SecurityFlow', bindings[name == 'camera'].deviceId, bindings[name == 'screen'].deviceId)\")\r\n    }\r\n   }\r\n  }\r\n  }"
        },
        "metricsConfiguration": {
            "cloudMetricEnabled": false
        },
        "validatedNamespaceVersion": 5,
        "flowActionsRoleArn": "arn:aws:iam::123456789012:role/ThingsGraphRole"
    }
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir des informations de révision concernant un système

L'get-system-template-revisionsexemple suivant permet d'obtenir des informations de révision concernant un système.

aws iotthingsgraph get-system-template-revisions \
    --id "urn:tdm:us-west-2/123456789012/default:System:MySystem"

Sortie :

{
    "summaries": [
        {
            "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem",
            "revisionNumber": 1,
            "createdAt": 1559247540.656
        }
    ]
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir un système

L'get-system-templateexemple suivant permet d'obtenir la définition d'un système.

aws iotthingsgraph get-system-template \
    --id "urn:tdm:us-west-2/123456789012/default:System:MySystem"

Sortie :

{
    "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
    }
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour connaître le statut de votre entité, téléchargez

L'get-upload-statusexemple suivant permet d'obtenir le statut de votre opération de téléchargement d'entités. La valeur de MyUploadId est la valeur d'ID renvoyée par l'upload-entity-definitionsopération.

aws iotthingsgraph get-upload-status \
    --upload-id "MyUploadId"

Sortie :

{
    "namespaceName": "us-west-2/123456789012/default",
    "namespaceVersion": 5,
    "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da",
    "uploadStatus": "SUCCEEDED"
}

Pour plus d'informations, consultez la section Modeling Entities dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour obtenir des informations sur les événements liés à l'exécution d'un flux

L'list-flow-execution-messagesexemple suivant permet d'obtenir des informations sur les événements d'une exécution de flux.

aws iotthingsgraph list-flow-execution-messages \
    --flow-execution-id "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow_2019-05-11T19:39:55.317Z_MotionSensor_69b151ad-a611-42f5-ac21-fe537f9868ad"

Sortie :

{
    "messages": [
        {
         "eventType": "EXECUTION_STARTED",
         "messageId": "f6294f1e-b109-4bbe-9073-f451a2dda2da",
         "payload": "Flow execution started",
         "timestamp": 1559247540.656
        }
    ]
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour répertorier tous les tags d'une ressource

L'list-tags-for-resourceexemple suivant répertorie toutes les balises d'une ressource AWS IoT Things Graph.

aws iotthingsgraph list-tags-for-resource \
    --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218"

Sortie :

{
   "tags": [
      {
         "key": "Type",
         "value": "Residential"
      }
   ]
}

Pour plus d'informations, consultez la section Tagging Your AWS IoT Things Graph Resources dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour rechercher des entités

L'search-entitiesexemple suivant recherche toutes les entités de typeEVENT.

aws iotthingsgraph search-entities \
    --entity-types "EVENT"

Sortie :

{
    "descriptions": [
        {
            "id": "urn:tdm:aws/examples:Event:MotionSensorEvent",
            "type": "EVENT",
            "definition": {
                "language": "GRAPHQL",
                "text": "##\n# Description of events emitted by motion sensor.\n##\ntype MotionSensorEvent @eventType(id: \"urn:tdm:aws/examples:event:MotionSensorEvent\",\n            payload: \"urn:tdm:aws/examples:property:MotionSensorStateProperty\") {ignore:void}"
            }
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Event:CameraClickedEventV2",
            "type": "EVENT",
            "definition": {
                "language": "GRAPHQL",
                "text": "type CameraClickedEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:CameraClickedEventV2\",\r\npayload: \"urn:tdm:aws:Property:Boolean\"){ignore:void}"
            }
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2",
            "type": "EVENT",
            "definition": {
                "language": "GRAPHQL",
                "text": "# Event emitted by the motion sensor.\r\ntype MotionSensorEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:MotionSensorEventV2\",\r\npayload: \"urn:tdm:us-west-2/123456789012/default:property:MotionSensorStateProperty2\") {ignore:void}"
            }
        }
    ],
    "nextToken": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2"
}

Pour plus d'informations, reportez-vous à la section Référence du modèle de données AWS IoT Things Graph dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour rechercher des exécutions de flux

L'search-flow-executionsexemple suivant permet de rechercher toutes les exécutions d'un flux dans une instance système spécifiée.

aws iotthingsgraph search-flow-executions \
    --system-instance-id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218"

Sortie :

{
   "summaries": [
      {
         "createdAt": 1559247540.656,
         "flowExecutionId": "f6294f1e-b109-4bbe-9073-f451a2dda2da",
         "flowTemplateId": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow",
         "status": "RUNNING ",
         "systemInstanceId": "urn:tdm:us-west-2/123456789012/default:System:MySystem",
         "updatedAt": 1559247540.656
      }
   ]
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour rechercher des flux (ou des flux de travail)

L'search-flow-templatesexemple suivant recherche tous les flux (flux de travail) contenant le modèle d'appareil photo.

aws iotthingsgraph search-flow-templates \
    --filters name="DEVICE_MODEL_ID",value="urn:tdm:aws/examples:DeviceModel:Camera"

Sortie :

{
    "summaries": [
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow",
            "revisionNumber": 1,
            "createdAt": 1559247540.292
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow",
            "revisionNumber": 3,
            "createdAt": 1548283099.27
        }
    ]
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour rechercher des instances du système

L'search-system-instancesexemple suivant recherche toutes les instances du système qui contiennent le système spécifié.

aws iotthingsgraph search-system-instances \
    --filters name="SYSTEM_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:System:SecurityFlow"

Sortie :

{
    "summaries": [
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Deployment:DeploymentForSample",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/DeploymentForSample",
            "status": "NOT_DEPLOYED",
            "target": "GREENGRASS",
            "greengrassGroupName": "ThingsGraphGrnGr",
            "createdAt": 1555716314.707,
            "updatedAt": 1555716314.707
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment",
            "status": "DELETED_IN_TARGET",
            "target": "GREENGRASS",
            "greengrassGroupName": "ThingsGraphGrnGr",
            "createdAt": 1549416462.049,
            "updatedAt": 1549416722.361,
            "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf",
            "greengrassGroupVersionId": "7365aed7-2d3e-4d13-aad8-75443d45eb05"
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment2",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment2",
            "status": "DEPLOYED_IN_TARGET",
            "target": "GREENGRASS",
            "greengrassGroupName": "ThingsGraphGrnGr",
            "createdAt": 1549572385.774,
            "updatedAt": 1549572418.408,
            "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf",
            "greengrassGroupVersionId": "bfa70ab3-2bf7-409c-a4d4-bc8328ae5b86"
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215",
            "status": "NOT_DEPLOYED",
            "target": "GREENGRASS",
            "greengrassGroupName": "ThingsGraphGG",
            "createdAt": 1547056918.413,
            "updatedAt": 1547056918.413
        },
        {
            "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218",
            "status": "NOT_DEPLOYED",
            "target": "CLOUD",
            "createdAt": 1559249315.208,
            "updatedAt": 1559249315.208
        }
    ]
}

Pour plus d'informations, consultez la section Travailler avec des systèmes et des configurations de flux dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour rechercher un système

L'search-system-templatesexemple suivant recherche tous les systèmes contenant le flux spécifié.

aws iotthingsgraph search-system-templates \
    --filters name="FLOW_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow"

Sortie :

{
    "summaries": [
        {
            "id": "urn:tdm:us-west-2/123456789012/default:System:SecurityFlow",
            "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/SecurityFlow",
            "revisionNumber": 1,
            "createdAt": 1548283099.433
        }
    ]
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour rechercher des éléments associés à des appareils et à des modèles d'appareils

L'search-thingsexemple suivant recherche tous les éléments associés au MotionSensor périphérique HCSR5 01.

aws iotthingsgraph search-things \
    --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor"

Sortie :

{
    "things": [
        {
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MotionSensor1",
            "thingName": "MotionSensor1"
        },
        {
            "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/TG_MS",
            "thingName": "TG_MS"
        }
    ]
}

Pour plus d'informations, consultez la section Création et téléchargement de modèles dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour créer un tag pour une ressource

L'tag-resourceexemple suivant crée une balise pour la ressource spécifiée.

aws iotthingsgraph tag-resource \
    --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \
    --tags key="Type",value="Residential"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Tagging Your AWS IoT Things Graph Resources dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour annuler le déploiement d'une instance système depuis sa cible

L'undeploy-system-instanceexemple suivant supprime une instance de système de sa cible.

aws iotthingsgraph undeploy-system-instance \
    --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room215"

Sortie :

{
    "summary": {
        "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215",
        "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215",
        "status": "PENDING_DELETE",
        "target": "GREENGRASS",
        "greengrassGroupName": "ThingsGraphGrnGr",
        "createdAt": 1553189694.255,
        "updatedAt": 1559344549.601,
        "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf",
        "greengrassGroupVersionId": "731b371d-d644-4b67-ac64-3934e99b75d7"
    }
}

Pour plus d'informations, consultez la section Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments dans le Guide de l'utilisateur de l'AWS IoT Things Graph.

Pour supprimer le tag d'une ressource

L'untag-resourceexemple suivant supprime une balise pour la ressource spécifiée.

aws iotthingsgraph untag-resource \
    --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \
    --tag-keys "Type"

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Tagging Your AWS IoT Things Graph Resources dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour mettre à jour un flux

L'update-flow-templateexemple suivant met à jour un flux (flux de travail). La valeur de MyFlowDefinition est le GraphQL qui modélise le flux.

aws iotthingsgraph update-flow-template \
    --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" \
    --definition language=GRAPHQL,text="MyFlowDefinition"

Sortie :

{
    "summary": {
        "createdAt": 1559248067.545,
        "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow",
        "revisionNumber": 2
    }
}

Pour plus d'informations, voir Working with Flows dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour mettre à jour un système

L'update-system-templateexemple suivant met à jour un système. La valeur de MySystemDefinition est le GraphQL qui modélise le système.

aws iotthingsgraph update-system-template \
    --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" \
    --definition language=GRAPHQL,text="MySystemDefinition"

Sortie :

{
    "summary": {
        "createdAt": 1559249776.254,
        "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem",
        "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem",
        "revisionNumber": 2
    }
}

Pour plus d'informations, consultez la section Création de systèmes dans le guide de l'utilisateur de l'AWS IoT Things Graph.

Pour télécharger des définitions d'entités

L'upload-entity-definitionsexemple suivant télécharge les définitions d'entités dans votre espace de noms. La valeur de MyEntityDefinitions est le GraphQL qui modélise les entités.

aws iotthingsgraph upload-entity-definitions \
    --document language=GRAPHQL,text="MyEntityDefinitions"

Sortie :

{
    "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da"
}

Pour plus d'informations, consultez la section Modeling Entities dans le guide de l'utilisateur de l'AWS IoT Things Graph.