Esempi di AWS IoT Analytics con la AWS CLI

Come inviare un messaggio a un canale

L’esempio batch-put-message seguente invia un messaggio al canale specificato.

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

Contenuto di batch-put-message.json:

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

Output:

{
    "batchPutMessageErrorEntries": []
}

Per ulteriori informazioni, consulta BatchPutMessage nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come annullare la rielaborazione dei dati tramite una pipeline

L’esempio cancel-pipeline-reprocessing seguente annulla la rielaborazione dei dati tramite la pipeline specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta CancelPipelineReprocessing nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come creare un canale

L’esempio create-channel seguente crea un canale con la configurazione specificata. Un canale raccoglie dati da un argomento MQTT e archivia i messaggi non elaborati prima di pubblicarli in una pipeline.

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

Contenuto di create-channel.json:

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

Output:

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

Per ulteriori informazioni, consulta CreateChannel nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come creare il contenuto di un set di dati

L’esempio create-dataset-content seguente crea i contenuti del set di dati specificato applicando queryAction (una query SQL) o containerAction (che esegue un’applicazione containerizzata).

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

Output:

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

Per ulteriori informazioni, consulta CreateDatasetContent nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come creare un set di dati

Nell’esempio seguente, create-dataset crea un set di dati. Un set di dati archivia i dati recuperati da un datastore applicando queryAction (una query SQL) o containerAction (che esegue un’applicazione containerizzata). Questa operazione crea lo skeleton di un set di dati. Puoi popolare il set di dati manualmente chiamando CreateDatasetContent o automaticamente in base a un trigger specificato.

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

Contenuto di create-dataset.json:

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

Output:

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

Per ulteriori informazioni, consulta CreateDataset nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come creare un datastore

Nell’esempio seguente, create-datastore crea un datastore, che funge da repository per i messaggi.

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

Contenuto di create-datastore.json:

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

Output:

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

Per ulteriori informazioni, consulta CreateDatastore nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come creare una pipeline di IoT Analytics

Nell’esempio seguente, create-pipeline crea una pipeline. Una pipeline utilizza i messaggi provenienti da un canale e permette di elaborarli prima di archiviarli in un datastore. È necessario specificare un canale e un’attività datastore e, facoltativamente, fino a 23 attività aggiuntive nell’array pipelineActivities.

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

Contenuto di 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"
        }
    ]
}

Output:

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

Per ulteriori informazioni, consulta CreatePipeline nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come eliminare un canale di IoT Analytics

Nell’esempio seguente, delete-channel elimina il canale specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta DeleteChannel nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come eliminare il contenuto di un set di dati

Nell’esempio seguente, delete-dataset-content elimina i contenuti del set di dati specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta DeleteDatasetContent nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come eliminare un set di dati

Nell’esempio seguente, delete-dataset elimina il set di dati specificato. Non è necessario eliminare i contenuti del set di dati prima di eseguire questa operazione.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta DeleteDataset nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come eliminare un data store

Nell’esempio seguente, delete-datastore elimina il datastore specificato.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta DeleteDatastore nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come eliminare una pipeline

Nell’esempio seguente, delete-pipeline elimina la pipeline specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta DeletePipeline nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare le informazioni su un canale

L’esempio describe-channel seguente mostra i dettagli, incluse le statistiche, del canale specificato.

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

Output:

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

Per ulteriori informazioni, consulta DescribeChannel nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare le informazioni su un set di dati

Nell’esempio seguente, describe-dataset visualizza i dettagli del set di dati specificato.

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

Output:

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

Per ulteriori informazioni, consulta DescribeDataset nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare le informazioni su un datastore

L’esempio describe-datastore seguente mostra i dettagli, incluse le statistiche, del datastore specificato.

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

Output:

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

Per ulteriori informazioni, consulta DescribeDatastore nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare le opzioni di registrazione dei log attuali

L’esempio describe-logging-options seguente mostra le attuali opzioni di registrazione dei log di AWS IoT Analytics.

aws iotanalytics describe-logging-options

Questo comando non produce alcun output. Output:

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

Per ulteriori informazioni, consulta DescribeLoggingOptions nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare le informazioni su una pipeline

Nell’esempio seguente, describe-pipeline visualizza i dettagli della pipeline specificata.

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

Output:

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

Per ulteriori informazioni, consulta DescribePipeline nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare il contenuto di un set di dati

L’esempio get-dataset-content seguente recupera il contenuto di un set di dati sotto forma di URI prefirmati.

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

Output:

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

Per ulteriori informazioni, consulta GetDatasetContent nella guida.

Come recuperare un elenco di canali

L’esempio list-channels seguente visualizza le informazioni di riepilogo per i canali disponibili.

aws iotanalytics list-channels

Output:

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

Per ulteriori informazioni, consulta ListChannels nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come elencare informazioni sui contenuti di un set di dati

Nell’esempio seguente, list-dataset-contents elenca le informazioni sui contenuti del set di dati che sono stati creati.

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

Output:

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

Per ulteriori informazioni, consulta ListDatasetContents nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare le informazioni su un set di dati

L’esempio list-datasets seguente elenca le informazioni di riepilogo sui set di dati disponibili.

aws iotanalytics list-datasets

Output:

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

Per ulteriori informazioni, consulta ListDatasets nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare un elenco di datastore

L’esempio list-datastores seguente visualizza le informazioni di riepilogo sui datastore disponibili.

aws iotanalytics list-datastores

Output:

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

Per ulteriori informazioni, consulta ListDatastores nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare un elenco di pipeline

L’esempio list-pipelines seguente visualizza un elenco di pipeline disponibili.

aws iotanalytics list-pipelines

Output:

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

Per ulteriori informazioni, consulta ListPipelines nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come elencare i tag per una risorsa

L’esempio list-tags-for-resource seguente elenca i tag associati alla risorsa specificata.

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

Output:

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

Per ulteriori informazioni, consulta ListTagsForResource nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come impostare o aggiornare le opzioni di registrazione dei log

Nell’esempio seguente, put-logging-options imposta o aggiorna le opzioni di registrazione dei log di AWS IoT Analytics. Se aggiorni il valore di qualsiasi campo loggingOptions, dovrai attendere fino a un minuto affinché la modifica abbia effetto. Inoltre, se modifichi la policy collegata al ruolo specificato nel campo “roleArn” (ad esempio per correggere una policy non valida), dovrai attendere fino a cinque minuti affinché la modifica abbia effetto.

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

Contenuto di put-logging-options.json:

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta PutLoggingOptions nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come simulare un’attività di pipeline

Nell’esempio seguente, run-pipeline-activity simula i risultati dell’esecuzione di un’attività di pipeline sul payload di un messaggio.

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

Contenuto di maths.json:

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

Contenuto di payloads.json:

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

Output:

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

Per ulteriori informazioni, consulta RunPipelineActivity nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come recuperare messaggi di esempio da un canale

Nell’esempio seguente, sample-channel-data recupera dal canale specificato un campione di messaggi elaborati durante l’intervallo di tempo specificato. Puoi recuperare fino a 10 messaggi.

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

Output:

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

Per ulteriori informazioni, consulta SampleChannelData nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come avviare la rielaborazione della pipeline

Nell’esempio seguente, start-pipeline-reprocessing avvia la rielaborazione dei dati grezzi tramite la pipeline specificata.

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

Output:

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

Per ulteriori informazioni, consulta StartPipelineReprocessing nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come aggiungere o modificare i tag associati a una risorsa

L’esempio tag-resource seguente aggiunge o modifica i tag associati alla risorsa specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta TagResource nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come rimuovere tag da una risorsa

L’esempio untag-resource seguente rimuove i tag con i nomi di chiave specificati dalla risorsa specificata.

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta UntagResource <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UntagResource.html > nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come modificare un canale

L’esempio update-channel seguente modifica le impostazioni del canale specificato.

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

Contenuto di update-channel.json:

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta UpdateChannel nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come aggiornare un set di dati

L’esempio update-dataset seguente modifica le impostazioni del set di dati specificato.

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

Contenuto di update-dataset.json:

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta UpdateDataset <https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UpdateDataset.html > nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come aggiornare un datastore

L’esempio update-datastore seguente modifica le impostazioni del datastore specificato.

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

Contenuto di update-datastore.json:

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

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta UpdateDatastore nella Documentazione di riferimento delle API di AWS IoT Analytics.

Come aggiornare una pipeline

L’esempio update-pipeline seguente modifica le impostazioni della pipeline specificata. È necessario specificare un canale e un’attività datastore e, facoltativamente, fino a 23 attività aggiuntive nell’array pipelineActivities.

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

Contenuto di 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"
            }
        }
    ]
}

Questo comando non produce alcun output.

Per ulteriori informazioni, consulta UpdatePipeline nella Documentazione di riferimento delle API di AWS IoT Analytics.