AWS IoT Analytics exemples utilisant AWS CLI

Pour envoyer un message à une chaîne

L'batch-put-messageexemple suivant envoie un message au canal spécifié.

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

Contenu de batch-put-message.json :

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

Sortie :

{
    "batchPutMessageErrorEntries": []
}

Pour plus d'informations, consultez BatchPutMessagela référence des API AWS IoT Analytics.

Pour annuler le retraitement des données via un pipeline

L'cancel-pipeline-reprocessingexemple suivant annule le retraitement des données via le pipeline spécifié.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez CancelPipelineReprocessingla référence des API AWS IoT Analytics.

Pour créer une chaîne

L'create-channelexemple suivant crée un canal avec la configuration spécifiée. Un canal collecte des données à partir d'une rubrique MQTT et archive les messages bruts non traités avant de publier les données dans un pipeline.

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

Contenu de create-channel.json :

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

Sortie :

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

Pour plus d'informations, consultez CreateChannella référence des API AWS IoT Analytics.

Pour créer le contenu d'un ensemble de données

L'create-dataset-contentexemple suivant crée le contenu de l'ensemble de données spécifié en appliquant a queryAction (requête SQL) ou a containerAction (exécution d'une application conteneurisée).

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

Sortie :

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

Pour plus d'informations, consultez CreateDatasetContentla référence des API AWS IoT Analytics.

Pour créer un jeu de données

L'create-datasetexemple suivant crée un ensemble de données. Un ensemble de données stocke les données extraites d'un magasin de données en appliquant une queryAction (requête SQL) ou a containerAction (exécution d'une application conteneurisée). Cette opération crée le squelette d'un ensemble de données. Vous pouvez remplir le jeu de données manuellement en appelant CreateDatasetContent ou automatiquement selon un paramètre trigger que vous spécifiez.

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

Contenu de create-dataset.json :

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

Sortie :

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

Pour plus d'informations, consultez CreateDatasetla référence des API AWS IoT Analytics.

Pour créer un magasin de données

L'create-datastoreexemple suivant crée un magasin de données, qui est un référentiel pour les messages.

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

Contenu de create-datastore.json :

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

Sortie :

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

Pour plus d'informations, consultez CreateDatastorela référence des API AWS IoT Analytics.

Création d'un pipeline d'analyse IoT

L'create-pipelineexemple suivant crée un pipeline. Un pipeline consomme les messages à partir d'un canal et vous permet de traiter les messages avant de les stocker dans un magasin de données. Vous devez spécifier à la fois une activité de canal et une activité de stockage de données et, éventuellement, jusqu'à 23 activités supplémentaires dans le pipelineActivities tableau.

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

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

Sortie :

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

Pour plus d'informations, consultez CreatePipelinela référence des API AWS IoT Analytics.

Supprimer un canal IoT Analytics

L'delete-channelexemple suivant supprime le canal spécifié.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez DeleteChannella référence des API AWS IoT Analytics.

Pour supprimer le contenu d'un ensemble de données

L'delete-dataset-contentexemple suivant supprime le contenu de l'ensemble de données spécifié.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez DeleteDatasetContentla référence des API AWS IoT Analytics.

Pour supprimer un ensemble de données

L'delete-datasetexemple suivant supprime l'ensemble de données spécifié. Il n'est pas nécessaire de supprimer le contenu de l'ensemble de données avant d'effectuer cette opération.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez DeleteDatasetla référence des API AWS IoT Analytics.

Pour supprimer un magasin de données

L'delete-datastoreexemple suivant supprime le magasin de données spécifié.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez DeleteDatastorela référence des API AWS IoT Analytics.

Pour supprimer un pipeline

L'delete-pipelineexemple suivant supprime le pipeline spécifié.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez DeletePipelinela référence des API AWS IoT Analytics.

Pour récupérer des informations sur une chaîne

L'describe-channelexemple suivant affiche les détails, y compris les statistiques, pour le canal spécifié.

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

Sortie :

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

Pour plus d'informations, consultez DescribeChannella référence des API AWS IoT Analytics.

Pour récupérer des informations sur un ensemble de données

L'describe-datasetexemple suivant affiche les détails de l'ensemble de données spécifié.

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

Sortie :

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

Pour plus d'informations, consultez DescribeDatasetla référence des API AWS IoT Analytics.

Pour récupérer des informations sur un magasin de données

L'describe-datastoreexemple suivant affiche les détails, y compris les statistiques, du magasin de données spécifié.

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

Sortie :

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

Pour plus d'informations, consultez DescribeDatastorela référence des API AWS IoT Analytics.

Pour récupérer les options de journalisation actuelles

L'describe-logging-optionsexemple suivant affiche les options de journalisation actuelles d' AWS IoT Analytics.

aws iotanalytics describe-logging-options

Cette commande ne produit aucun résultat. Sortie :

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

Pour plus d'informations, consultez DescribeLoggingOptionsla référence des API AWS IoT Analytics.

Pour récupérer des informations sur un pipeline

L'describe-pipelineexemple suivant affiche les détails du pipeline spécifié.

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

Sortie :

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

Pour plus d'informations, consultez DescribePipelinela référence des API AWS IoT Analytics.

Pour récupérer le contenu d'un ensemble de données

L'get-dataset-contentexemple suivant récupère le contenu d'un ensemble de données tel que URIs présigné.

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

Sortie :

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

Pour plus d'informations, consultez GetDatasetContentle guide.

Pour récupérer une liste de chaînes

L'list-channelsexemple suivant affiche des informations récapitulatives sur les chaînes disponibles.

aws iotanalytics list-channels

Sortie :

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

Pour plus d'informations, consultez ListChannelsla référence des API AWS IoT Analytics.

Pour répertorier les informations relatives au contenu du jeu de données

L'list-dataset-contentsexemple suivant répertorie les informations relatives au contenu des ensembles de données qui ont été créés.

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

Sortie :

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

Pour plus d'informations, consultez ListDatasetContentsla référence des API AWS IoT Analytics.

Pour récupérer des informations sur les ensembles de données

L'list-datasetsexemple suivant répertorie des informations récapitulatives sur les ensembles de données disponibles.

aws iotanalytics list-datasets

Sortie :

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

Pour plus d'informations, consultez ListDatasetsla référence des API AWS IoT Analytics.

Pour récupérer une liste de magasins de données

L'list-datastoresexemple suivant affiche des informations récapitulatives sur les magasins de données disponibles.

aws iotanalytics list-datastores

Sortie :

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

Pour plus d'informations, consultez ListDatastoresla référence des API AWS IoT Analytics.

Pour récupérer une liste de pipelines

L'list-pipelinesexemple suivant affiche la liste des pipelines disponibles.

aws iotanalytics list-pipelines

Sortie :

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

Pour plus d'informations, consultez ListPipelinesla référence des API AWS IoT Analytics.

Pour répertorier les balises d'une ressource

L'list-tags-for-resourceexemple suivant répertorie les balises que vous avez attachées à la ressource spécifiée.

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

Sortie :

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

Pour plus d'informations, consultez ListTagsForResourcela référence des API AWS IoT Analytics.

Pour définir ou mettre à jour les options de journalisation

L'put-logging-optionsexemple suivant définit ou met à jour les options de journalisation d' AWS IoT Analytics. Si vous mettez à jour la valeur d'un loggingOptions champ, la modification peut prendre jusqu'à une minute pour prendre effet. De même, si vous modifiez la politique associée au rôle que vous avez spécifié dans le champ « ROLearn » (par exemple, pour corriger une politique non valide), la prise en compte de cette modification peut prendre jusqu'à cinq minutes.

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

Contenu de put-logging-options.json :

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez PutLoggingOptionsla référence des API AWS IoT Analytics.

Pour simuler une activité de pipeline

L'run-pipeline-activityexemple suivant simule les résultats de l'exécution d'une activité de pipeline sur la charge utile d'un message.

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

Contenu de maths.json :

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

Contenu de payloads.json :

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

Sortie :

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

Pour plus d'informations, consultez RunPipelineActivityla référence des API AWS IoT Analytics.

Pour récupérer des exemples de messages depuis un canal

L'sample-channel-dataexemple suivant extrait un échantillon de messages provenant du canal spécifié ingérés pendant la période spécifiée. Vous pouvez récupérer jusqu'à 10 messages.

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

Sortie :

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

Pour plus d'informations, consultez SampleChannelDatala référence des API AWS IoT Analytics.

Pour démarrer le retraitement du pipeline

L'start-pipeline-reprocessingexemple suivant lance le retraitement des données de message brutes via le pipeline spécifié.

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

Sortie :

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

Pour plus d'informations, consultez StartPipelineReprocessingla référence des API AWS IoT Analytics.

Pour ajouter ou modifier des balises pour une ressource

L'tag-resourceexemple suivant ajoute ou modifie les balises associées à la ressource spécifiée.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez TagResourcela référence des API AWS IoT Analytics.

Pour supprimer des balises d'une ressource

L'untag-resourceexemple suivant supprime les balises portant les noms de clé spécifiés de la ressource spécifiée.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez UntagResource < https://docs.aws.amazon.com/iotanalytics/ latest/APIReference/API _ UntagResource .html > dans le manuel AWS IoT Analytics API Reference.

Pour modifier une chaîne

L'update-channelexemple suivant modifie les paramètres du canal spécifié.

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

Contenu de update-channel.json :

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez UpdateChannella référence des API AWS IoT Analytics.

Pour mettre à jour un ensemble de données

L'update-datasetexemple suivant modifie les paramètres de l'ensemble de données spécifié.

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

Contenu de update-dataset.json :

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez UpdateDataset < https://docs.aws.amazon.com/iotanalytics/ latest/APIReference/API _ UpdateDataset .html > dans le manuel AWS IoT Analytics API Reference.

Pour mettre à jour un magasin de données

L'update-datastoreexemple suivant modifie les paramètres du magasin de données spécifié.

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

Contenu du fichier update-datastore.json :

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez UpdateDatastorela référence des API AWS IoT Analytics.

Pour mettre à jour un pipeline

L'update-pipelineexemple suivant modifie les paramètres du pipeline spécifié. Vous devez spécifier à la fois une activité de canal et une activité de stockage de données et, éventuellement, jusqu'à 23 activités supplémentaires, dans le pipelineActivities tableau.

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

Contenu du fichier 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"
            }
        }
    ]
}

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez UpdatePipelinela référence des API AWS IoT Analytics.