Exemplos de AWS IoT Analytics usando a AWS CLI

Para enviar uma mensagem para um canal

O exemplo batch-put-message a seguir envia uma mensagem para o canal especificado.

aws iotanalytics batch-put-message \
    --cli-binary-format raw-in-base64-out \
    --cli-input-json file://batch-put-message.json

Conteúdo de batch-put-message.json:

{
    "channelName": "mychannel",
    "messages": [
        {
            "messageId": "0001",
            "payload": "eyAidGVtcGVyYXR1cmUiOiAyMCB9"
        }
    ]
}

Saída:

{
    "batchPutMessageErrorEntries": []
}

Para obter mais informações, consulte BatchPutMessage na Referência da API do AWS IoT Analytics.

Para cancelar o reprocessamento de dados por meio do pipeline

O exemplo cancel-pipeline-reprocessing a seguir cancela o reprocessamento de dados por meio do pipeline especificado.

aws iotanalytics cancel-pipeline-reprocessing \
    --pipeline-name mypipeline \
    --reprocessing-id "6ad2764f-fb13-4de3-b101-4e74af03b043"

Este comando não produz saída.

Para obter mais informações, consulte CancelPipelineReprocessing na Referência da API do AWS IoT Analytics.

Para criar um canal

O exemplo create-channel a seguir cria um canal com a configuração especificada. Um canal coleta dados de um tópico MQTT e arquiva as mensagens brutas não processadas antes de publicar os dados em uma pipeline.

aws iotanalytics create-channel \
    --cli-input-json file://create-channel.json

Conteúdo de create-channel.json:

{
    "channelName": "mychannel",
    "retentionPeriod": {
        "unlimited": true
    },
    "tags": [
        {
            "key": "Environment",
            "value": "Production"
        }
    ]
}

Saída:

{
    "channelArn": "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel",
    "channelName": "mychannel",
    "retentionPeriod": {
        "unlimited": true
    }
}

Para obter mais informações, consulte CreateChannel no Guia de referência da API do AWS IoT Analytics.

Para criar o conteúdo de um conjunto de dados

O exemplo create-dataset-content a seguir cria o conteúdo do conjunto de dados especificado aplicando uma queryAction (uma consulta SQL) ou uma containerAction (executando um aplicativo em contêiner).

aws iotanalytics create-dataset-content \
    --dataset-name mydataset

Saída:

{
    "versionId": "d494b416-9850-4670-b885-ca22f1e89d62"
}

Para obter mais informações, consulte CreateDatasetContent no Guia de referência da API do AWS IoT Analytics.

Para criar um conjunto de dados

O create-dataset a seguir cria um conjunto de dados. Um conjunto de dados armazena dados recuperados de um datastore aplicando uma queryAction (uma consulta SQL) ou uma containerAction (executando uma aplicação em contêiner). Esta operação cria o esqueleto de um conjunto de dados. O conjunto de dados pode ser preenchido manualmente chamando CreateDatasetContent ou automaticamente, de acordo com um trigger especificado.

aws iotanalytics create-dataset \
    --cli-input-json file://create-dataset.json

Conteúdo de create-dataset.json:

{
    "datasetName": "mydataset",
    "actions": [
        {
            "actionName": "myDatasetAction",
            "queryAction": {
                "sqlQuery": "SELECT * FROM mydatastore"
            }
        }
    ],
    "retentionPeriod": {
        "unlimited": true
    },
    "tags": [
        {
            "key": "Environment",
            "value": "Production"
        }
    ]
}

Saída:

{
    "datasetName": "mydataset",
    "retentionPeriod": {
        "unlimited": true
    },
    "datasetArn": "arn:aws:iotanalytics:us-west-2:123456789012:dataset/mydataset"
}

Para obter mais informações, consulte CreateDataset no Guia de referência da API do AWS IoT Analytics.

Para criar um armazenamento de dados

O exemplo create-datastore a seguir cria um armazenamento de dados, que é um repositório de mensagens.

aws iotanalytics create-datastore \
    --cli-input-json file://create-datastore.json

Conteúdo de create-datastore.json:

{
    "datastoreName": "mydatastore",
    "retentionPeriod": {
        "numberOfDays": 90
    },
    "tags": [
        {
            "key": "Environment",
            "value": "Production"
        }
    ]
}

Saída:

{
    "datastoreName": "mydatastore",
    "datastoreArn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore",
    "retentionPeriod": {
        "numberOfDays": 90,
        "unlimited": false
    }
}

Para obter mais informações, consulte CreateDatastore no Guia de referência da API do AWS IoT Analytics.

Criar um pipeline do IoT Analytics

O create-pipeline a seguir cria um pipeline simples. Um pipeline consome mensagens de um canal e permite que você as processe antes de armazená-las em um datastore. É necessário especificar um canal e uma atividade de armazenamento de dados, e opcionalmente, até 23 atividades adicionais na matriz pipelineActivities.

aws iotanalytics create-pipeline \
    --cli-input-json file://create-pipeline.json

Conteúdo de create-pipeline.json:

{
    "pipelineName": "mypipeline",
    "pipelineActivities": [
        {
            "channel": {
                "name": "myChannelActivity",
                "channelName": "mychannel",
                "next": "myMathActivity"
            }
        },
        {
            "datastore": {
                "name": "myDatastoreActivity",
                "datastoreName": "mydatastore"
            }
        },
        {
            "math": {
                "name": "myMathActivity",
                "math": "((temp - 32) * 5.0) / 9.0",
                "attribute": "tempC",
                "next": "myDatastoreActivity"
            }
        }
    ],
    "tags": [
        {
            "key": "Environment",
            "value": "Beta"
        }
    ]
}

Saída:

{
    "pipelineArn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline",
    "pipelineName": "mypipeline"
}

Para obter mais informações, consulte CreatePipeline no Guia de referência da API do AWS IoT Analytics.

Excluir um canal do IoT Analytics

O exemplo delete-channel a seguir exclui o canal especificado.

aws iotanalytics delete-channel \
    --channel-name mychannel

Este comando não produz saída.

Para obter mais informações, consulte DeleteChannel no Guia de referência da API do AWS IoT Analytics.

Para excluir o conteúdo do conjunto de dados

O exemplo delete-dataset-content a seguir exclui o conteúdo do conjunto de dados especificado.

aws iotanalytics delete-dataset-content \
    --dataset-name mydataset

Este comando não produz saída.

Para obter mais informações, consulte DeleteDatasetContent no Guia de referência da API do AWS IoT Analytics.

Para excluir um conjunto de dados

O exemplo delete-dataset a seguir exclui o conjunto de dados especificado. Você não precisa excluir o conteúdo do conjunto de dados antes de executar esta operação.

aws iotanalytics delete-dataset \
    --dataset-name mydataset

Este comando não produz saída.

Para obter mais informações, consulte DeleteDataset no Guia de referência da API do AWS IoT Analytics.

Para excluir um armazenamento de dados

O exemplo delete-datastore a seguir exclui o datastore especificado.

aws iotanalytics delete-datastore \
    --datastore-name mydatastore

Este comando não produz saída.

Para obter mais informações, consulte DeleteDatastore no Guia de referência da API do AWS IoT Analytics.

Para excluir um pipeline

O exemplo delete-pipeline a seguir exclui o pipeline especificado.

aws iotanalytics delete-pipeline \
    --pipeline-name mypipeline

Este comando não produz saída.

Para obter mais informações, consulte DeletePipeline no Guia de referência da API do AWS IoT Analytics.

Para recuperar informações sobre um canal

O exemplo describe-channel a seguir exibe detalhes, incluindo estatísticas, do canal especificado.

aws iotanalytics describe-channel \
    --channel-name mychannel \
    --include-statistics

Saída:

{
    "statistics": {
        "size": {
            "estimatedSizeInBytes": 402.0,
            "estimatedOn": 1561504380.0
        }
    },
    "channel": {
        "status": "ACTIVE",
        "name": "mychannel",
        "lastUpdateTime": 1557860351.001,
        "creationTime": 1557860351.001,
        "retentionPeriod": {
            "unlimited": true
        },
        "arn": "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel"
    }
}

Para obter mais informações, consulte DescribeChannel na Referência da API do AWS IoT Analytics.

Para recuperar informações sobre um conjunto de dados

O exemplo describe-dataset a seguir exibe os detalhes do conjunto de dados especificado.

aws iotanalytics describe-dataset \
    --dataset-name mydataset

Saída:

{
    "dataset": {
        "status": "ACTIVE",
        "contentDeliveryRules": [],
        "name": "mydataset",
        "lastUpdateTime": 1557859240.658,
        "triggers": [],
        "creationTime": 1557859240.658,
        "actions": [
            {
                "actionName": "query_32",
                "queryAction": {
                    "sqlQuery": "SELECT * FROM mydatastore",
                    "filters": []
                }
            }
        ],
        "retentionPeriod": {
            "numberOfDays": 90,
            "unlimited": false
        },
        "arn": "arn:aws:iotanalytics:us-west-2:123456789012:dataset/mydataset"
    }
}

Para obter mais informações, consulte DescribeDataset na Referência da API do AWS IoT Analytics.

Para recuperar informações sobre um datastore

O exemplo describe-datastore a seguir exibe detalhes, incluindo estatísticas, do datastore especificado.

aws iotanalytics describe-datastore \
    --datastore-name mydatastore \
    --include-statistics

Saída:

{
    "datastore": {
        "status": "ACTIVE",
        "name": "mydatastore",
        "lastUpdateTime": 1557858971.02,
        "creationTime": 1557858971.02,
        "retentionPeriod": {
            "unlimited": true
        },
        "arn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore"
    },
    "statistics": {
        "size": {
            "estimatedSizeInBytes": 397.0,
            "estimatedOn": 1561592040.0
        }
    }
}

Para obter mais informações, consulte DescribeDatastore na Referência da API do AWS IoT Analytics.

Para recuperar as opções de log atuais

O exemplo describe-logging-options a seguir exibe as opções atuais de log do AWS IoT Analytics.

aws iotanalytics describe-logging-options

Este comando não produz saída. Saída:

{
    "loggingOptions": {
        "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole",
        "enabled": true,
        "level": "ERROR"
    }
}

Para obter mais informações, consulte DescribeLoggingOptions na Referência da API do AWS IoT Analytics.

Para recuperar informações sobre um pipeline

O exemplo describe-pipeline a seguir exibe os detalhes do pipeline especificado.

aws iotanalytics describe-pipeline \
    --pipeline-name mypipeline

Saída:

{
    "pipeline": {
        "activities": [
            {
                "channel": {
                    "channelName": "mychannel",
                    "name": "mychannel_28",
                    "next": "mydatastore_29"
                }
            },
            {
                "datastore": {
                    "datastoreName": "mydatastore",
                    "name": "mydatastore_29"
                }
            }
        ],
        "name": "mypipeline",
        "lastUpdateTime": 1561676362.515,
        "creationTime": 1557859124.432,
        "reprocessingSummaries": [
            {
                "status": "SUCCEEDED",
                "creationTime": 1561676362.189,
                "id": "6ad2764f-fb13-4de3-b101-4e74af03b043"
            }
        ],
        "arn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline"
    }
}

Para obter mais informações, consulte DescribePipeline na Referência da API do AWS IoT Analytics.

Para recuperar o conteúdo de um conjunto de dados

O exemplo get-dataset-content a seguir recupera o conteúdo de um conjunto de dados como URIs pré-assinados.

aws iotanalytics get-dataset-content --dataset-name mydataset

Saída:

{
    "status": {
        "state": "SUCCEEDED"
    },
    "timestamp": 1557863215.995,
    "entries": [
        {
            "dataURI": "https://aws-radiant-dataset-12345678-1234-1234-1234-123456789012.s3.us-west-2.amazonaws.com/results/12345678-e8b3-46ba-b2dd-efe8d86cf385.csv?X-Amz-Security-Token=...-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190628T173437Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=...F20190628%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=..."
        }
    ]
}

Para obter mais informações, consulte GetDatasetContent no guia.

Para recuperar uma lista de canais

O exemplo list-channels a seguir exibe informações resumidas sobre os canais disponíveis.

aws iotanalytics list-channels

Saída:

{
    "channelSummaries": [
        {
            "status": "ACTIVE",
            "channelName": "mychannel",
            "creationTime": 1557860351.001,
            "lastUpdateTime": 1557860351.001
        }
    ]
}

Para obter mais informações, consulte ListChannels na Referência da API do AWS IoT Analytics.

Para listar informações sobre o conteúdo do conjunto de dados

O exemplo list-dataset-contents a seguir lista informações sobre o conteúdo do conjunto de dados criado.

aws iotanalytics list-dataset-contents \
    --dataset-name mydataset

Saída:

{
    "datasetContentSummaries": [
        {
            "status": {
                "state": "SUCCEEDED"
            },
            "scheduleTime": 1557863215.995,
            "version": "b10ea2a9-66c1-4d99-8d1f-518113b738d0",
            "creationTime": 1557863215.995
        }
    ]
}

Para obter mais informações, consulte ListDatasetContents na Referência da API do AWS IoT Analytics.

Para recuperar informações sobre um conjunto de dados

O exemplo list-datasets a seguir lista informações resumidas sobre os conjuntos de dados disponíveis.

aws iotanalytics list-datasets

Saída:

{
    "datasetSummaries": [
        {
            "status": "ACTIVE",
            "datasetName": "mydataset",
            "lastUpdateTime": 1557859240.658,
            "triggers": [],
            "creationTime": 1557859240.658,
            "actions": [
                {
                    "actionName": "query_32",
                    "actionType": "QUERY"
                }
            ]
        }
    ]
}

Para obter mais informações, consulte ListDatasets na Referência da API do AWS IoT Analytics.

Para recuperar uma lista de datastores

O exemplo list-datastores a seguir lista informações resumidas sobre os datastores disponíveis.

aws iotanalytics list-datastores

Saída:

{
    "datastoreSummaries": [
        {
            "status": "ACTIVE",
            "datastoreName": "mydatastore",
            "creationTime": 1557858971.02,
            "lastUpdateTime": 1557858971.02
        }
    ]
}

Para obter mais informações, consulte ListDatastores na Referência da API do AWS IoT Analytics.

Para recuperar uma lista de pipelines

O exemplo list-pipelines a seguir exibe uma lista de pipelines disponíveis.

aws iotanalytics list-pipelines

Saída:

{
    "pipelineSummaries": [
        {
            "pipelineName": "mypipeline",
            "creationTime": 1557859124.432,
            "lastUpdateTime": 1557859124.432,
            "reprocessingSummaries": []
        }
    ]
}

Para obter mais informações, consulte ListPipelines na Referência da API do AWS IoT Analytics.

Para listar as tags para um recurso

O exemplo list-tags-for-resource a seguir lista as tags anexadas ao recurso especificado.

aws iotanalytics list-tags-for-resource \
    --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel"

Saída:

{
    "tags": [
        {
            "value": "bar",
            "key": "foo"
        }
    ]
}

Para obter mais informações, consulte ListTagsForResource na Referência da API do AWS IoT Analytics.

Para definir ou atualizar as opções de log

O exemplo put-logging-options a seguir recupera as opções atuais de log do AWS IoT Analytics. Se o valor de qualquer campo loggingOptions for atualizado, levará até um minuto para a mudança entrar em vigor. Além disso, a política anexada à função especificada no campo "roleArn" for alterada (por exemplo, para corrigir uma política inválida), levará até 5 minutos para que a mudança entre em vigor.

aws iotanalytics put-logging-options \
    --cli-input-json file://put-logging-options.json

Conteúdo de put-logging-options.json:

{
    "loggingOptions": {
        "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole",
        "level": "ERROR",
        "enabled": true
    }
}

Este comando não produz saída.

Para obter mais informações, consulte PutLoggingOptions na Referência da API do AWS IoT Analytics.

Para simular uma atividade de pipeline

O exemplo run-pipeline-activity a seguir simula os resultados da execução de uma atividade de pipeline em uma carga útil de mensagem.

aws iotanalytics run-pipeline-activity \
    --pipeline-activity file://maths.json \
    --payloads file://payloads.json

Conteúdo de maths.json:

{
    "math": {
        "name": "MyMathActivity",
        "math": "((temp - 32) * 5.0) / 9.0",
        "attribute": "tempC"
    }
}

Conteúdo de payloads.json:

[
    "{\"humidity\": 52, \"temp\": 68 }",
    "{\"humidity\": 52, \"temp\": 32 }"
]

Saída:

{
    "logResult": "",
    "payloads": [
        "eyJodW1pZGl0eSI6NTIsInRlbXAiOjY4LCJ0ZW1wQyI6MjB9",
        "eyJodW1pZGl0eSI6NTIsInRlbXAiOjMyLCJ0ZW1wQyI6MH0="
    ]
}

Para obter mais informações, consulte RunPipelineActivity na Referência da API do AWS IoT Analytics.

Para recuperar mensagens de amostra de um canal

O exemplo sample-channel-data a seguir recupera uma amostra de mensagens do canal especificado ingeridas durante o período de tempo especificado. Até 10 mensagens podem ser recuperadas.

aws iotanalytics sample-channel-data \
    --channel-name mychannel

Saída:

{
    "payloads": [
        "eyAidGVtcGVyYXR1cmUiOiAyMCB9",
        "eyAiZm9vIjogImJhciIgfQ=="
    ]
}

Para obter mais informações, consulte SampleChannelData na Referência da API do AWS IoT Analytics.

Para iniciar o reprocessamento do pipeline

O exemplo start-pipeline-reprocessing a seguir inicia o reprocessamento de dados brutos de mensagem por meio do pipeline especificado.

aws iotanalytics start-pipeline-reprocessing \
    --pipeline-name mypipeline

Saída:

{
    "reprocessingId": "6ad2764f-fb13-4de3-b101-4e74af03b043"
}

Para obter mais informações, consulte a StartPipelineReprocessing na Referência da API do AWS IoT Analytics.

Para adicionar ou modificar tags em um recurso

O exemplo tag-resource a seguir adiciona ou modifica as tags anexadas ao recurso especificado.

aws iotanalytics tag-resource \
    --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \
    --tags "[{\"key\": \"Environment\", \"value\": \"Production\"}]"

Este comando não produz saída.

Para obter mais informações, consulte TagResource na Referência da API do AWS IoT Analytics.

Como remover as tags de um recurso

O exemplo untag-resource a seguir remove as tags com as chaves de nome determinadas do recurso especificado.

aws iotanalytics untag-resource \
    --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \
    --tag-keys "[\"Environment\"]"

Este comando não produz saída.

Para obter mais informações, consulte UntagResource <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UntagResource.html > na Referência da API do AWS IoT Analytics.

Para modificar um canal

O exemplo update-channel a seguir modifica as configurações do canal especificado.

aws iotanalytics update-channel \
    --cli-input-json file://update-channel.json

Conteúdo de update-channel.json:

{
    "channelName": "mychannel",
    "retentionPeriod": {
        "numberOfDays": 92
    }
}

Este comando não produz saída.

Para obter mais informações, consulte UpdateChannel na Referência da API do AWS IoT Analytics.

Para atualizar um conjunto de dados

O exemplo update-dataset a seguir modifica as configurações do conjunto de dados especificado.

aws iotanalytics update-dataset \
    --cli-input-json file://update-dataset.json

Conteúdo de update-dataset.json:

{
    "datasetName": "mydataset",
    "actions": [
        {
            "actionName": "myDatasetUpdateAction",
            "queryAction": {
                "sqlQuery": "SELECT * FROM mydatastore"
            }
        }
    ],
    "retentionPeriod": {
        "numberOfDays": 92
    }
}

Este comando não produz saída.

Para obter mais informações, consulte UpdateDataset <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UpdateDataset.html > na Referência da API do AWS IoT Analytics.

Para criar um datastore

O exemplo update-datastore a seguir modifica as configurações do datastore especificado.

aws iotanalytics update-datastore \
    --cli-input-json file://update-datastore.json

Conteúdo de update-datastore.json:

{
    "datastoreName": "mydatastore",
    "retentionPeriod": {
        "numberOfDays": 93
    }
}

Este comando não produz saída.

Para obter mais informações, consulte UpdateDatastore na Referência da API do AWS IoT Analytics.

Para atualizar um pipeline

O exemplo update-pipeline a seguir modifica as configurações do pipeline especificado. É necessário especificar um canal e uma atividade de armazenamento de dados, e opcionalmente, até 23 atividades adicionais na matriz pipelineActivities.

aws iotanalytics update-pipeline \
    --cli-input-json file://update-pipeline.json

Conteúdo de update-pipeline.json:

{
    "pipelineName": "mypipeline",
    "pipelineActivities": [
        {
            "channel": {
                "name": "myChannelActivity",
                "channelName": "mychannel",
                "next": "myMathActivity"
            }
        },
        {
            "datastore": {
                "name": "myDatastoreActivity",
                "datastoreName": "mydatastore"
            }
        },
        {
            "math": {
                "name": "myMathActivity",
                "math": "(((temp - 32) * 5.0) / 9.0) + 273.15",
                "attribute": "tempK",
                "next": "myDatastoreActivity"
            }
        }
    ]
}

Este comando não produz saída.

Para obter mais informações, consulte UpdatePipeline na Referência da API do AWS IoT Analytics.