AWS IoT Things Graph exemplos usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface with AWS IoT Things Graph.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, é possível ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

Ações

O código de exemplo a seguir mostra como usar associate-entity-to-thing.

AWS CLI

Para associar algo a um dispositivo

O associate-entity-to-thing exemplo a seguir associa uma coisa 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 Criação e upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte AssociateEntityToThingna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-flow-template.

AWS CLI

Para criar um fluxo

O create-flow-template exemplo 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte CreateFlowTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-system-instance.

AWS CLI

Para criar uma instância do sistema

O create-system-instance exemplo a seguir cria uma instância do 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte CreateSystemInstancena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar create-system-template.

AWS CLI

Para criar um sistema

O create-system-template exemplo 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 Criação de sistemas no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte CreateSystemTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-flow-template.

AWS CLI

Para excluir um fluxo

O delete-flow-template exemplo a seguir exclui 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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte DeleteFlowTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-namespace.

AWS CLI

Para excluir um namespace

O delete-namespace exemplo 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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte DeleteNamespacena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-system-instance.

AWS CLI

Para excluir uma instância do sistema

O delete-system-instance exemplo a seguir exclui uma instância do 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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte DeleteSystemInstancena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar delete-system-template.

AWS CLI

Para excluir um sistema

O delete-system-template exemplo 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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte DeleteSystemTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar deploy-system-instance.

AWS CLI

Para implantar uma instância do sistema

O delete-system-template exemplo a seguir implanta uma instância do 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte DeploySystemInstancena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar deprecate-flow-template.

AWS CLI

Para descontinuar um fluxo

O deprecate-flow-template exemplo a seguir desaprova 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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte DeprecateFlowTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar deprecate-system-template.

AWS CLI

Para descontinuar um sistema

O deprecate-system-template exemplo a seguir desaprova 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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte DeprecateSystemTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar describe-namespace.

AWS CLI

Para obter uma descrição do seu namespace

O describe-namespace exemplo a seguir obtém uma descrição do seu 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 API obter detalhes, consulte DescribeNamespacena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar dissociate-entity-from-thing.

AWS CLI

Para dissociar uma coisa de um dispositivo

O dissociate-entity-from-thing exemplo a seguir dissocia uma coisa 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 Criação e upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte DissociateEntityFromThingna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-entities.

AWS CLI

Para obter definições para entidades

O get-entities exemplo 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 Criação e upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetEntitiesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-flow-template-revisions.

AWS CLI

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

O get-flow-template-revisions exemplo 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetFlowTemplateRevisionsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-flow-template.

AWS CLI

Para obter uma definição de fluxo

O get-flow-template exemplo 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetFlowTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-namespace-deletion-status.

AWS CLI

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

O get-namespace-deletion-status exemplo 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 API obter detalhes, consulte GetNamespaceDeletionStatusna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-system-instance.

AWS CLI

Para obter uma instância do sistema

O get-system-instance exemplo 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetSystemInstancena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-system-template-revisions.

AWS CLI

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

O get-system-template-revisions exemplo 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetSystemTemplateRevisionsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-system-template.

AWS CLI

Para obter um sistema

O get-system-template exemplo 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetSystemTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar get-upload-status.

AWS CLI

Para obter o status da sua entidade, faça o upload

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


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 Modelagem de entidades no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte GetUploadStatusna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-flow-execution-messages.

AWS CLI

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

O list-flow-execution-messages exemplo 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte ListFlowExecutionMessagesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar list-tags-for-resource.

AWS CLI

Para listar todas as tags de um recurso

O list-tags-for-resource exemplo 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 Como marcar seus recursos do AWS IoT Things Graph no Guia do usuário AWS do IoT Things Graph.

Para API obter detalhes, consulte ListTagsForResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar search-entities.

AWS CLI

Para pesquisar entidades

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


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 do modelo de dados do AWS IoT Things Graph no Guia AWS do usuário do IoT Things Graph.

Para API obter detalhes, consulte SearchEntitiesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar search-flow-executions.

AWS CLI

Para pesquisar execuções de fluxo

O search-flow-executions exemplo 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte SearchFlowExecutionsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar search-flow-templates.

AWS CLI

Para pesquisar fluxos (ou fluxos de trabalho)

O search-flow-templates exemplo 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte SearchFlowTemplatesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar search-system-instances.

AWS CLI

Para pesquisar instâncias do sistema

O search-system-instances exemplo 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 Como trabalhar com sistemas e configurações de fluxo no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte SearchSystemInstancesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar search-system-templates.

AWS CLI

Para pesquisar o sistema

O search-system-templates exemplo a seguir pesquisa todos os sistemas que contêm 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte SearchSystemTemplatesna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar search-things.

AWS CLI

Para pesquisar itens associados a dispositivos e modelos de dispositivos

O search-things exemplo a seguir pesquisa todas as coisas associadas ao MotionSensor dispositivo HCSR5 01.


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 Criação e upload de modelos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte SearchThingsna Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar tag-resource.

AWS CLI

Para criar uma tag para um recurso

O tag-resource exemplo 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 Como marcar seus recursos do AWS IoT Things Graph no Guia do usuário AWS do IoT Things Graph.

Para API obter detalhes, consulte TagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar undeploy-system-instance.

AWS CLI

Para desimplantar uma instância do sistema de seu destino

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


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 Gerenciamento do ciclo de vida para entidades, fluxos, sistemas e implantações do AWS IoT Things Graph no Guia do usuário do IoT Things AWS Graph.

Para API obter detalhes, consulte UndeploySystemInstancena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar untag-resource.

AWS CLI

Para remover uma tag de um recurso

O untag-resource exemplo a seguir remove uma tag para o 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 Como marcar seus recursos do AWS IoT Things Graph no Guia do usuário AWS do IoT Things Graph.

Para API obter detalhes, consulte UntagResourcena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-flow-template.

AWS CLI

Para atualizar um fluxo

O update-flow-template exemplo 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 Como trabalhar com fluxos no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte UpdateFlowTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar update-system-template.

AWS CLI

Para atualizar um sistema

O update-system-template exemplo 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 Criação de sistemas no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte UpdateSystemTemplatena Referência de AWS CLI Comandos.

O código de exemplo a seguir mostra como usar upload-entity-definitions.

AWS CLI

Para fazer upload de definições de entidade

O upload-entity-definitions exemplo a seguir carrega as definições de entidade no seu 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 Modelagem de entidades no Guia do usuário do AWS IoT Things Graph.

Para API obter detalhes, consulte UploadEntityDefinitionsna Referência de AWS CLI Comandos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

AWS IoT SiteWise

AWS IoT Wireless