AWS IoT Analytics ejemplos que utilizan AWS CLI

Para enviar un mensaje a un canal

En el siguiente batch-put-message ejemplo, se envía un mensaje al canal especificado.

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

Contenidos de batch-put-message.json:

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

Salida:

{
    "batchPutMessageErrorEntries": []
}

Para obtener más información, consulte BatchPutMessagela APIReferencia de AWS IoT Analytics.

Para cancelar el reprocesamiento de datos a través de una canalización

El siguiente cancel-pipeline-reprocessing ejemplo cancela el reprocesamiento de los datos a través de la canalización especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte CancelPipelineReprocessingla APIReferencia de AWS IoT Analytics.

Para crear un canal

El siguiente create-channel ejemplo crea un canal con la configuración especificada. Un canal recopila datos de un MQTT tema y archiva los mensajes sin procesar y sin procesar antes de publicarlos en una canalización.

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

Contenidos de create-channel.json:

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

Salida:

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

Para obtener más información, consulte CreateChannella APIReferencia de AWS IoT Analytics.

Para crear el contenido de un conjunto de datos

El siguiente create-dataset-content ejemplo crea el contenido del conjunto de datos especificado mediante la aplicación de una queryAction (una SQL consulta) o una containerAction (la ejecución de una aplicación contenerizada).

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

Salida:

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

Para obtener más información, consulte CreateDatasetContentla APIReferencia de AWS IoT Analytics.

Para crear un conjunto de datos

El siguiente create-dataset ejemplo crea un conjunto de datos. Un conjunto de datos almacena los datos recuperados de un banco de datos mediante la aplicación de una queryAction (una SQL consulta) o una containerAction (la ejecución de una aplicación contenerizada). Esta operación crea el esqueleto de un conjunto de datos. Puede rellenar el conjunto de datos manualmente mediante una trigger llamada CreateDatasetContent o automáticamente según lo que especifique.

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

Contenidos de create-dataset.json:

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

Salida:

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

Para obtener más información, consulte CreateDatasetla APIReferencia de AWS IoT Analytics.

Creación de un almacén de datos

En el siguiente create-datastore ejemplo, se crea un almacén de datos, que es un repositorio de mensajes.

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

Contenidos de create-datastore.json:

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

Salida:

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

Para obtener más información, consulte CreateDatastorela APIReferencia de AWS IoT Analytics.

Cree una canalización de IoT Analytics

En el siguiente create-pipeline ejemplo, se crea una canalización. Una canalización consume mensajes de un canal y permite procesar los mensajes antes de guardarlos en un almacén de datos. Debe especificar tanto un canal como una actividad de almacén de datos y, de forma opcional, hasta 23 actividades adicionales en la pipelineActivities matriz.

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

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

Salida:

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

Para obtener más información, consulte CreatePipelinela APIReferencia de AWS IoT Analytics.

Eliminar un canal de IoT Analytics

El siguiente delete-channel ejemplo elimina el canal especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteChannella APIReferencia de AWS IoT Analytics.

Para eliminar el contenido del conjunto de datos

En el siguiente delete-dataset-content ejemplo, se elimina el contenido del conjunto de datos especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteDatasetContentla APIReferencia de AWS IoT Analytics.

Para eliminar un conjunto de datos

En el siguiente delete-dataset ejemplo, se elimina el conjunto de datos especificado. No es necesario eliminar el contenido del conjunto de datos antes de realizar esta operación.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteDatasetla APIReferencia de AWS IoT Analytics.

Eliminación de un almacén de datos

En el siguiente delete-datastore ejemplo, se elimina el banco de datos especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteDatastorela APIReferencia de AWS IoT Analytics.

Para eliminar una canalización

En el siguiente delete-pipeline ejemplo, se elimina la canalización especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeletePipelinela APIReferencia de AWS IoT Analytics.

Para recuperar información sobre un canal

En el siguiente describe-channel ejemplo, se muestran los detalles, incluidas las estadísticas, del canal especificado.

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

Salida:

{
    "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 obtener más información, consulte DescribeChannella APIReferencia de AWS IoT Analytics.

Para recuperar información sobre un conjunto de datos

En el siguiente describe-dataset ejemplo, se muestran los detalles del conjunto de datos especificado.

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

Salida:

{
    "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 obtener más información, consulte DescribeDatasetla APIReferencia de AWS IoT Analytics.

Para recuperar información sobre un banco de datos

En el siguiente describe-datastore ejemplo, se muestran los detalles, incluidas las estadísticas, del banco de datos especificado.

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

Salida:

{
    "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 obtener más información, consulte DescribeDatastorela APIReferencia de AWS IoT Analytics.

Para recuperar las opciones de registro actuales

El siguiente describe-logging-options ejemplo muestra las opciones de registro actuales de AWS IoT Analytics.

aws iotanalytics describe-logging-options

Este comando no genera ninguna salida. Salida:

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

Para obtener más información, consulte DescribeLoggingOptionsla APIReferencia de AWS IoT Analytics.

Para recuperar información sobre una canalización

En el siguiente describe-pipeline ejemplo, se muestran los detalles de la canalización especificada.

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

Salida:

{
    "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 obtener más información, consulte DescribePipelinela APIReferencia de AWS IoT Analytics.

Para recuperar el contenido de un conjunto de datos

El siguiente get-dataset-content ejemplo recupera el contenido de un conjunto de datos tal como está URIs prefirmado.

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

Salida:

{
    "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 obtener más información, consulte GetDatasetContentla guía.

Para recuperar una lista de canales

El siguiente list-channels ejemplo muestra información resumida de los canales disponibles.

aws iotanalytics list-channels

Salida:

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

Para obtener más información, consulte ListChannelsla APIReferencia de AWS IoT Analytics.

Para mostrar información sobre el contenido del conjunto de datos

En el siguiente list-dataset-contents ejemplo, se muestra información sobre el contenido del conjunto de datos que se ha creado.

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

Salida:

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

Para obtener más información, consulte ListDatasetContentsla APIReferencia de AWS IoT Analytics.

Para recuperar información sobre conjuntos de datos

En el siguiente list-datasets ejemplo, se muestra un resumen de la información sobre los conjuntos de datos disponibles.

aws iotanalytics list-datasets

Salida:

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

Para obtener más información, consulte ListDatasetsla APIReferencia de AWS IoT Analytics.

Para recuperar una lista de almacenes de datos

El siguiente list-datastores ejemplo muestra información resumida sobre los bancos de datos disponibles.

aws iotanalytics list-datastores

Salida:

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

Para obtener más información, consulte ListDatastoresla APIReferencia de AWS IoT Analytics.

Para recuperar una lista de canalizaciones

En el siguiente list-pipelines ejemplo, se muestra una lista de las canalizaciones disponibles.

aws iotanalytics list-pipelines

Salida:

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

Para obtener más información, consulte ListPipelinesla APIReferencia de AWS IoT Analytics.

Para enumerar las etiquetas de un recurso

En el siguiente list-tags-for-resource ejemplo, se enumeran las etiquetas que ha adjuntado al recurso especificado.

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

Salida:

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

Para obtener más información, consulte ListTagsForResourcela APIReferencia de AWS IoT Analytics.

Para configurar o actualizar las opciones de registro

El siguiente put-logging-options ejemplo establece o actualiza las opciones de registro de AWS IoT Analytics. Si actualiza el valor de cualquier loggingOptions campo, el cambio puede tardar hasta un minuto en surtir efecto. Además, si cambias la política asociada a la función que especificaste en el campo roleArn «» (por ejemplo, para corregir una política no válida), el cambio puede tardar hasta cinco minutos en surtir efecto.

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

Contenidos de put-logging-options.json:

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

Este comando no genera ninguna salida.

Para obtener más información, consulte PutLoggingOptionsla APIReferencia de AWS IoT Analytics.

Para simular una actividad de canalización

El siguiente run-pipeline-activity ejemplo simula los resultados de ejecutar una actividad de canalización en una carga útil de mensajes.

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

Contenidos de maths.json:

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

Contenidos de payloads.json:

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

Salida:

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

Para obtener más información, consulte RunPipelineActivityla APIReferencia de AWS IoT Analytics.

Para recuperar mensajes de muestra de un canal

El siguiente sample-channel-data ejemplo recupera una muestra de mensajes del canal especificado ingeridos durante el período de tiempo especificado. Puede recuperar hasta 10 mensajes.

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

Salida:

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

Para obtener más información, consulte SampleChannelDatala APIReferencia de AWS IoT Analytics.

Para iniciar el reprocesamiento de la canalización

En el siguiente start-pipeline-reprocessing ejemplo, se inicia el reprocesamiento de los datos de los mensajes sin procesar a través de la canalización especificada.

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

Salida:

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

Para obtener más información, consulte StartPipelineReprocessingla APIReferencia de AWS IoT Analytics.

Para añadir o modificar las etiquetas de un recurso

En el siguiente tag-resource ejemplo, se agregan o modifican las etiquetas adjuntas al recurso especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte TagResourcela APIReferencia de AWS IoT Analytics.

Cómo eliminar etiquetas de un recurso

En el siguiente untag-resource ejemplo, se eliminan las etiquetas con los nombres de clave especificados del recurso especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte UntagResource < https://docs.aws.amazon.com/iotanalytics/ latest/APIReference/API _ UntagResource .html > en la APIReferencia de AWS IoT Analytics.

Para modificar un canal

En el siguiente update-channel ejemplo, se modifican los ajustes del canal especificado.

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

Contenidos de update-channel.json:

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

Este comando no genera ninguna salida.

Para obtener más información, consulte UpdateChannella APIReferencia de AWS IoT Analytics.

Para actualizar un conjunto de datos

El siguiente update-dataset ejemplo modifica la configuración del conjunto de datos especificado.

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

Contenidos de update-dataset.json:

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

Este comando no genera ninguna salida.

Para obtener más información, consulte UpdateDataset < https://docs.aws.amazon.com/iotanalytics/ latest/APIReference/API _ UpdateDataset .html > en la APIReferencia de AWS IoT Analytics.

Para actualizar un banco de datos

En el siguiente update-datastore ejemplo, se modifica la configuración del banco de datos especificado.

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

Contenido de update-datastore.json:

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

Este comando no genera ninguna salida.

Para obtener más información, consulte UpdateDatastorela APIReferencia de AWS IoT Analytics.

Para actualizar una canalización

En el siguiente update-pipeline ejemplo, se modifica la configuración de la canalización especificada. Debe especificar un canal y una actividad de almacén de datos y, opcionalmente, hasta 23 actividades adicionales en la pipelineActivities matriz.

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

Contenido 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 no genera ninguna salida.

Para obtener más información, consulte UpdatePipelinela APIReferencia de AWS IoT Analytics.