Exemplos do AWS IoT Things Graph usando oAWS CLI

Como associar um item a um dispositivo

O exemplo associate-entity-to-thing a seguir associa um item a um dispositivo. O exemplo usa um dispositivo de sensor de movimento que está no namespace público.

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

Este comando não produz saída.

Para obter mais informações, consulte Criar e fazer upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para criar um fluxo

O exemplo create-flow-template a seguir cria um fluxo (fluxo de trabalho). O valor de MyFlowDefinition é o GraphQL que modela o fluxo.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para criar uma instância de sistema

O exemplo create-system-instance a seguir cria uma instância de sistema. O valor de MySystemInstanceDefinition é o GraphQL que modela a instância do sistema.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para criar um sistema

O exemplo create-system-template a seguir cria um sistema. O valor de MySystemDefinition é o GraphQL que modela o sistema.

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

Saída:

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

Para obter mais informações, consulte Criar sistemas no Guia do usuário do AWS IoT Things Graph.

Para excluir um fluxo

O exemplo delete-flow-template a seguir cria um fluxo (fluxo de trabalho).

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para excluir um namespace

O exemplo delete-namespace a seguir exclui um namespace.

aws iotthingsgraph delete-namespace

Saída:

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

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para excluir uma instância de sistema

O exemplo delete-system-instance a seguir exclui uma instância de sistema.

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para excluir um sistema

O exemplo delete-system-template a seguir exclui um sistema.

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para implementar uma instância de sistema

O exemplo delete-system-template a seguir implementa uma instância de sistema.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Como descontinuar um fluxo

O exemplo deprecate-flow-template a seguir descontinua um fluxo (fluxo de trabalho).

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para descontinuar um sistema

O exemplo deprecate-system-template a seguir descontinua um sistema.

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

Este comando não produz saída.

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para obter uma descrição do namespace

O exemplo describe-namespace a seguir obtém uma descrição do namespace.

aws iotthingsgraph describe-namespace

Saída:

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

Para obter mais informações, consulte Namespaces no Guia do usuário do AWS IoT Things Graph.

Para desassociar um item de um dispositivo

O exemplo dissociate-entity-from-thing a seguir desassocia um item de um dispositivo.

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

Este comando não produz saída.

Para obter mais informações, consulte Criar e fazer upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para obter definições para entidades

O exemplo get-entities a seguir obtém uma definição para um modelo de dispositivo.

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

Saída:

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

Para obter mais informações, consulte Criar e fazer upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para obter informações de revisão sobre um fluxo

O exemplo get-flow-template-revisions a seguir obtém informações de revisão sobre um fluxo (fluxo de trabalho).

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

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para criar uma definição de fluxo

O exemplo get-flow-template a seguir obtém uma definição para um fluxo (fluxo de trabalho).

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

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para obter o status da tarefa de exclusão do namespace

O exemplo get-namespace-deletion-status a seguir obtém o status da tarefa de exclusão do namespace.

aws iotthingsgraph get-namespace-deletion-status

Saída:

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

Para obter mais informações, consulte Namespaces no Guia do usuário do AWS IoT Things Graph.

Para obter uma instância de sistema

O exemplo get-system-instance a seguir obtém uma definição para uma instância do sistema.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para obter informações de revisão sobre um sistema

O exemplo get-system-template-revisions a seguir obtém informações de revisão sobre um sistema.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para obter um sistema

O exemplo get-system-template a seguir obtém uma definição para um sistema.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para obter o status de upload de uma entidade

O exemplo get-upload-status a seguir obtém o status da operação de upload da entidade. O valor de MyUploadId é o valor do ID retornado pela operação upload-entity-definitions.

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

Saída:

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

Para obter mais informações, consulte Modelar entidades no Guia do usuário do AWS IoT Things Graph.

Para obter informações sobre eventos em uma execução de fluxo

O exemplo list-flow-execution-messages a seguir obtém informações sobre eventos em uma execução de fluxo.

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"

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para listar todas as tags de um recurso

O exemplo list-tags-for-resource a seguir lista todas as tags de um recurso do AWS IoT Things Graph.

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

Saída:

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

Para obter mais informações, consulte Adicionar tags aos recursos do AWS IoT Things Graph, no Guia do usuário do AWS IoT Things Graph.

Para pesquisar entidades

O exemplo search-entities a seguir pesquisa todas as entidades do tipo EVENT.

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

Saída:

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

Para obter mais informações, consulte Referência de modelos de dados do AWS IoT Things Graph, no Guia do usuário do AWS IoT Things Graph.

Para pesquisar execuções de fluxo

O exemplo search-flow-executions a seguir pesquisa todas as execuções de um fluxo em uma instância do sistema especificada.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para pesquisar fluxos (ou fluxos de trabalho)

O exemplo search-flow-templates a seguir pesquisa todos os fluxos (fluxos de trabalho) que contêm o modelo do dispositivo Camera.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para pesquisar instâncias do sistema

O exemplo search-system-instances a seguir pesquisa todas as instâncias do sistema que contêm o sistema especificado.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para pesquisar sistemas

O exemplo search-system-templates a seguir pesquisa todos os sistemas que contenham o fluxo especificado.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para pesquisar itens associados a dispositivos e modelos de dispositivos

O exemplo search-things a seguir pesquisa todos os itens associadas ao dispositivo HCSR501MotionSensor.

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

Saída:

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

Para obter mais informações, consulte Criar e fazer upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para criar uma tag para um recurso

O exemplo tag-resource a seguir cria uma tag para o recurso especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Adicionar tags aos recursos do AWS IoT Things Graph, no Guia do usuário do AWS IoT Things Graph.

Para desimplantar uma instância do sistema de seu alvo

O exemplo undeploy-system-instance a seguir remove uma instância do sistema de seu alvo.

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

Saída:

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

Para obter mais informações, consulte Gerenciar o ciclo de vida de entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do AWS IoT Things Graph.

Para remover uma tag de um recurso

O exemplo untag-resource a seguir remove uma tag do recurso especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Adicionar tags aos recursos do AWS IoT Things Graph, no Guia do usuário do AWS IoT Things Graph.

Para atualizar um fluxo

O exemplo update-flow-template a seguir atualiza um fluxo (fluxo de trabalho). O valor de MyFlowDefinition é o GraphQL que modela o fluxo.

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

Saída:

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

Para obter mais informações, consulte Trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para atualizar um sistema

O exemplo update-system-template a seguir atualiza um sistema. O valor de MySystemDefinition é o GraphQL que modela o sistema.

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

Saída:

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

Para obter mais informações, consulte Criar sistemas no Guia do usuário do AWS IoT Things Graph.

Para carregar definições de entidade

O exemplo upload-entity-definitions a seguir carrega as definições de entidade ao namespace. O valor de MyEntityDefinitions é o GraphQL que modela as entidades.

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

Saída:

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

Para obter mais informações, consulte Modelar entidades no Guia do usuário do AWS IoT Things Graph.