Exemples d’utilisation de l’AWS CLI avec AWS IoT Analytics

Pour envoyer un message à un canal

L’exemple batch-put-message 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 BatchPutMessage dans la Référence des API d’AWS IoT Analytics.

Pour annuler le retraitement des données via un pipeline

L’exemple cancel-pipeline-reprocessing 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 aucune sortie.

Pour plus d’informations, consultez CancelPipelineReprocessing dans la Référence des API d’AWS IoT Analytics.

Pour créer un canal

L’exemple create-channel 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 CreateChannel dans la Référence des API d’AWS IoT Analytics.

Pour créer le contenu d’un jeu de données

L’exemple create-dataset-content suivant crée le contenu du jeu de données spécifié en appliquant une action queryAction (requête SQL) ou containerAction (qui exécute une application conteneurisée).

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

Sortie :

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

Pour plus d’informations, consultez CreateDatasetContent dans la Référence des API d’AWS IoT Analytics.

Pour créer un jeu de données

L’exemple create-dataset suivant crée un jeu de données. Un jeu de données stocke les données extraites d’un magasin de données en appliquant une action queryAction (requête SQL) ou containerAction (qui exécute une application conteneurisée). Cette opération crée le squelette d’un jeu de données. Vous pouvez remplir le jeu de données manuellement en appelant CreateDatasetContent ou automatiquement selon un 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 CreateDataset dans la Référence des API d’AWS IoT Analytics.

Pour créer un magasin de données

L’exemple create-datastore 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 CreateDatastore dans la Référence des API d’AWS IoT Analytics.

Pour créer un pipeline IoT Analytics

L’exemple create-pipeline 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 un canal et une activité de magasin de données une activité et, éventuellement, jusqu’à 23 activités supplémentaires dans le tableau pipelineActivities.

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 CreatePipeline dans la Référence des API d’AWS IoT Analytics.

Suppression d’un canal IoT Analytics

L’exemple delete-channel suivant supprime le canal spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteChannel dans la Référence des API d’AWS IoT Analytics.

Pour supprimer le contenu d’un jeu de données

L’exemple delete-dataset-content suivant supprime le contenu du jeu de données spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteDatasetContent dans la Référence des API d’AWS IoT Analytics.

Supprimer un jeu de données

L’exemple delete-dataset suivant supprime le jeu de données spécifié. Vous n’avez pas besoin de supprimer le contenu du jeu de données avant d’effectuer cette opération.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteDataset dans la Référence des API d’AWS IoT Analytics.

Pour supprimer un magasin de données

L’exemple delete-datastore suivant supprime le magasin de données spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeleteDatastore dans la Référence des API d’AWS IoT Analytics.

Pour supprimer un pipeline

L’exemple delete-pipeline suivant supprime le pipeline spécifié.

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

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez DeletePipeline dans la Référence des API d’AWS IoT Analytics.

Pour récupérer les informations d’un canal

L’exemple describe-channel 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 DescribeChannel dans la Référence des API d’AWS IoT Analytics.

Pour récupérer les informations sur un jeu de données

L’exemple describe-dataset suivant affiche les détails du jeu 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 DescribeDataset dans la Référence des API d’AWS IoT Analytics.

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

L’exemple describe-datastore suivant affiche les détails, y compris les statistiques, pour le 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 DescribeDatastore dans la Référence des API d’AWS IoT Analytics.

Pour récupérer les options de journalisation actuelles

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

aws iotanalytics describe-logging-options

Cette commande ne produit aucune sortie. Sortie :

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

Pour plus d’informations, consultez DescribeLoggingOptions dans la Référence des API d’AWS IoT Analytics.

Pour récupérer les informations sur un pipeline

L’exemple describe-pipeline 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 DescribePipeline dans la Référence des API d’AWS IoT Analytics.

Pour récupérer le contenu d’un jeu de données

L’exemple get-dataset-content suivant récupère le contenu d’un jeu de données sous forme d’URI présignées.

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 GetDatasetContent dans le guide.

Pour récupérer une liste de canaux

L’exemple list-channels suivant affiche les informations récapitulatives sur les canaux disponibles.

aws iotanalytics list-channels

Sortie :

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

Pour plus d’informations, consultez ListChannels dans la Référence des API d’AWS IoT Analytics.

Pour répertorier les informations sur le contenu des jeux de données

L’exemple list-dataset-contents suivant répertorie les informations relatives aux contenus des jeux 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 ListDatasetContents dans la Référence des API d’AWS IoT Analytics.

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

L’exemple list-datasets suivant répertorie des informations récapitulatives sur les jeux 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 ListDatasets dans la Référence des API d’AWS IoT Analytics.

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

L’exemple list-datastores suivant affiche les 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 ListDatastores dans la Référence des API d’AWS IoT Analytics.

Pour récupérer une liste de pipelines

L’exemple list-pipelines suivant affiche une liste des pipelines disponibles.

aws iotanalytics list-pipelines

Sortie :

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

Pour plus d’informations, consultez ListPipelines dans la Référence des API d’AWS IoT Analytics.

Pour répertorier les balises d’une ressource

L’exemple list-tags-for-resource 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 ListTagsForResource dans la Référence des API d’AWS IoT Analytics.

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

L’exemple put-logging-options suivant définit ou met à jour les options de journalisation d’AWS IoT Analytics. Si vous mettez à jour la valeur de n’importe quel champ loggingOptions, la modification peut nécessiter jusqu’à une minute pour prendre effet. En outre, si vous modifiez la stratégie attachée au rôle que vous avez spécifié dans le champ « roleArn » (par exemple, pour corriger une stratégie non valide), la modification peut nécessiter jusqu’à cinq minutes pour prendre effet.

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 aucune sortie.

Pour plus d’informations, consultez PutLoggingOptions dans la Référence des API d’AWS IoT Analytics.

Pour simuler une activité de pipeline

L’exemple run-pipeline-activity suivant simule les résultats de l’exécution d’une activité de pipeline sur des données utiles de 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 RunPipelineActivity dans la Référence des API d’AWS IoT Analytics.

Pour récupérer des exemples de messages d’un canal

L’exemple sample-channel-data suivant récupère un échantillon de messages depuis le canal spécifié ingéré au cours de la période spécifiée. Jusqu’à 10 messages peuvent être extraits.

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

Sortie :

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

Pour plus d’informations, consultez SampleChannelData dans la Référence des API d’AWS IoT Analytics.

Pour démarrer le retraitement du pipeline

L’exemple start-pipeline-reprocessing suivant démarre 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 StartPipelineReprocessing dans la Référence des API d’AWS IoT Analytics.

Pour ajouter ou modifier des balises sur une ressource

L’exemple tag-resource suivant ajoute ou modifie les balises attaché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 aucune sortie.

Pour plus d’informations, consultez TagResource dans la Référence des API d’AWS IoT Analytics.

Pour supprimer des balises d'une ressource

L’exemple untag-resource 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 aucune sortie.

Pour plus d’informations, consultez UntagResource <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UntagResource.html > dans la Référence des API d’AWS IoT Analytics.

Pour modifier un canal

L’exemple update-channel 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 aucune sortie.

Pour plus d’informations, consultez UpdateChannel dans la Référence des API d’AWS IoT Analytics.

Pour mettre à jour un jeu de données

L’exemple update-dataset suivant modifie les paramètres du jeu 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 aucune sortie.

Pour plus d’informations, consultez UpdateDataset <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UpdateDataset.html > dans la Référence des API d’AWS IoT Analytics.

Pour mettre à jour un magasin de données

L’exemple update-datastore 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 aucune sortie.

Pour plus d’informations, consultez UpdateDatastore dans la Référence des API d’AWS IoT Analytics.

Pour mettre à jour un pipeline

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

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 aucune sortie.

Pour plus d’informations, consultez UpdatePipeline dans la Référence des API d’AWS IoT Analytics.