Ejemplos de AWS IoT Analytics usando AWS CLI

Para enviar un mensaje a un canal

En el siguiente ejemplo de batch-put-message, 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

Contenido de batch-put-message.json:

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

Salida:

{
    "batchPutMessageErrorEntries": []
}

Para obtener más información, consulte BatchPutMessage en la Referencia de la API de AWS IoT Analytics.

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

En el siguiente ejemplo de cancel-pipeline-reprocessing, se cancela el reprocesamiento de 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 CancelPipelineReprocessing en la Referencia de la API de AWS IoT Analytics.

Para crear un canal

En el siguiente ejemplo de create-channel, se crea un canal con la configuración especificada. Un canal recopila datos desde un tema MQTT y archiva los mensajes sin procesar antes de publicar los datos en una canalización.

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

Contenido 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 CreateChannel en la Guía de referencia de la API de AWS IoT Analytics.

Para crear el contenido de un conjunto de datos

En el siguiente ejemplo de create-dataset-content, se crea el contenido del conjunto de datos especificado aplicando una queryAction (una consulta SQL) o una containerAction (ejecutando 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 CreateDatasetContent en la Guía de referencia de la API de AWS IoT Analytics.

Para crear un conjunto de datos

En el siguiente ejemplo de create-dataset, se crea un conjunto de datos. Un conjunto de datos almacena datos recuperados de un almacén de datos aplicando una queryAction (una consulta SQL) o una containerAction (ejecución de una aplicación en contenedores). Esta operación crea el esqueleto de un conjunto de datos. El conjunto de datos se puede rellenar manualmente llamando a CreateDatasetContent o automáticamente de acuerdo con el trigger especificado.

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

Contenido 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 CreateDataset en la Guía de referencia de la API de AWS IoT Analytics.

Creación de un almacén de datos

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

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

Contenido 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 CreateDatastore en la Guía de referencia de la API de AWS IoT Analytics.

Para crear una canalización de IoT Analytics

En el siguiente ejemplo de create-pipeline, 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 un canal y una actividad del almacén de datos y, si lo desea, hasta 23 actividades adicionales en la matriz pipelineActivities.

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

Contenido 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 CreatePipeline en la Referencia de la API de AWS IoT Analytics.

Para eliminar un canal de IoT Analytics

En el siguiente ejemplo de delete-channel, se elimina el canal especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteChannel en la Referencia de la API de AWS IoT Analytics.

Para eliminar el contenido del conjunto de datos

En el siguiente ejemplo de delete-dataset-content, 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 DeleteDatasetContent en la Referencia de la API de AWS IoT Analytics.

Para eliminar un conjunto de datos

En el siguiente ejemplo de delete-dataset, 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 DeleteDataset en la Referencia de la API de AWS IoT Analytics.

Eliminación de un almacén de datos

En el siguiente ejemplo de delete-datastore, se elimina el almacén de datos especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte DeleteDatastore en la Referencia de la API de AWS IoT Analytics.

Para eliminar una canalización

En el siguiente ejemplo de delete-pipeline, 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 DeletePipeline en la Referencia de la API de AWS IoT Analytics.

Para recuperar información sobre un canal

En el siguiente ejemplo de describe-channel, 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 DescribeChannel en la Referencia de la API de AWS IoT Analytics.

Para recuperar información sobre un conjunto de datos

En el siguiente ejemplo de describe-dataset, 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 DescribeDataset en la Referencia de la API de AWS IoT Analytics.

Para recuperar información sobre un almacén de datos

En el siguiente ejemplo de describe-datastore, se muestran los detalles, incluidas las estadísticas, del almacén 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 DescribeDatastore en la Referencia de la API de AWS IoT Analytics.

Para recuperar las opciones de registro actuales

En el siguiente ejemplo de describe-logging-options, se muestran 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 DescribeLoggingOptions en la Referencia de la API de AWS IoT Analytics.

Para recuperar información sobre una canalización

En el siguiente ejemplo de describe-pipeline, 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 DescribePipeline en la Referencia de la API de AWS IoT Analytics.

Para recuperar el contenido de un conjunto de datos

En el siguiente ejemplo de get-dataset-content, se recupera el contenido de un conjunto de datos como URI prefirmados.

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 GetDatasetContent en la guía.

Para recuperar una lista de canales

En el siguiente ejemplo de list-channels, se 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 ListChannels en la Referencia de la API de AWS IoT Analytics.

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

En el siguiente ejemplo de list-dataset-contents, se numera información sobre el contenido de los 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 ListDatasetContents en la Referencia de la API de AWS IoT Analytics.

Para recuperar información sobre conjuntos de datos

En el siguiente ejemplo de list-datasets, 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 ListDatasets en la Referencia de la API de AWS IoT Analytics.

Para recuperar una lista de almacenes de datos

En el siguiente ejemplo de list-datastores, se muestra información resumida sobre los almacenes 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 ListDatastores en la Referencia de la API de AWS IoT Analytics.

Para recuperar una lista de canalizaciones

En el siguiente ejemplo de list-pipelines, 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 ListPipelines en la Referencia de la API de AWS IoT Analytics.

Para enumerar las etiquetas de un recurso

En el siguiente ejemplo de list-tags-for-resource, se muestran las etiquetas que ha asociado 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 ListTagsForResource en la Referencia de la API de AWS IoT Analytics.

Para configurar o actualizar las opciones de registro

En el siguiente ejemplo de put-logging-options, se definen o actualizan las opciones de registro actuales de AWS IoT Analytics. Si actualiza el valor de cualquier campo loggingOptions, los cambios pueden tardar hasta un minuto en surtir efecto. Por otra parte, si cambia la política asociada al rol que ha especificado en el campo roleArn (por ejemplo, para corregir una política no válida), el cambio puede tardar hasta 5 minutos en surtir efecto.

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

Contenido 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 PutLoggingOptions en la Referencia de la API de AWS IoT Analytics.

Para simular una actividad de canalización

En el siguiente ejemplo de run-pipeline-activity, se simulan los resultados de la ejecución de 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

Contenido de maths.json:

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

Contenido de payloads.json:

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

Salida:

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

Para obtener más información, consulte RunPipelineActivity en la Referencia de la API de AWS IoT Analytics.

Para recuperar mensajes de muestra de un canal

En el siguiente ejemplo de sample-channel-data, se recupera una muestra de mensajes del canal especificado ingeridos durante el período de tiempo especificado. Se pueden recuperar hasta diez mensajes.

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

Salida:

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

Para obtener más información, consulte SampleChannelData en la Referencia de la API de AWS IoT Analytics.

Para iniciar el reprocesamiento de la canalización

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

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

Salida:

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

Para obtener más información, consulte StartPipelineReprocessing en la Referencia de la API de AWS IoT Analytics.

Para agregar o modificar etiquetas en un recurso

En el siguiente ejemplo de tag-resource, se agregan o modifican las etiquetas asociadas 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 TagResource en la Referencia de la API de AWS IoT Analytics.

Para eliminar etiquetas de un recurso

En el siguiente ejemplo de untag-resource, se eliminan las etiquetas con el nombre de clave especificado del recurso indicado.

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 Referencia de API de AWS IoT Analytics.

Para modificar un canal

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

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

Contenido de update-channel.json:

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

Este comando no genera ninguna salida.

Para obtener más información, consulte UpdateChannel en la Referencia de la API de AWS IoT Analytics.

Para actualizar un conjunto de datos

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

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

Contenido 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 Referencia de API de AWS IoT Analytics.

Para actualizar un almacén de datos

En el siguiente ejemplo de update-datastore, se modifica la configuración del almacén 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 UpdateDatastore en la Referencia de la API de AWS IoT Analytics.

Para actualizar una canalización

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

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 UpdatePipeline en la Referencia de la API de AWS IoT Analytics.