AWS IoT Analytics examples using AWS CLI

チャネルにメッセージを送信するには

次の batch-put-message の例では、指定されたチャネルにメッセージを送信します。

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

batch-put-message.json の内容:

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

出力:

{
    "batchPutMessageErrorEntries": []
}

詳細については、「AWS IoT Analytics API リファレンス」の「BatchPutMessage」を参照してください。

パイプラインによるデータの再処理をキャンセルするには

次の cancel-pipeline-reprocessing の例では、指定されたパイプラインによるデータの再処理をキャンセルします。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「CancelPipelineReprocessing」を参照してください。

チャネルを作成するには

次の create-channel の例では、指定された設定でチャネルを作成します。チャネルは、MQTT トピックからデータを収集し、未処理の raw メッセージをアーカイブしてから、データをパイプラインに発行します。

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

create-channel.json の内容:

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「CreateChannel」を参照してください。

データセットのコンテンツを作成するには

次の create-dataset-content の例では、queryAction (SQL クエリ) または containerAction (コンテナ化されたアプリケーションを実行) を適用して、指定されたデータセットのコンテンツを作成します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「CreateDatasetContent」を参照してください。

データセットを作成するには

次の create-dataset の例では、データセットを作成します。データセットにより、queryAction SQL クエリまたは containerAction コンテナ化されたアプリケーションの実行を適用してデータストアから取得されたデータを保存します。このオペレーションによりデータセットのスケルトンが作成されます。データセットには、CreateDatasetContent を呼び出して手動で入力するか、指定した trigger に従って自動的に入力できます。

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

create-dataset.json の内容:

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「CreateDataset」を参照してください。

データストアを作成するには

次の create-datastore の例では、メッセージのリポジトリであるデータストアを作成します。

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

create-datastore.json の内容:

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「CreateDatastore」を参照してください。

IoT Analytics パイプラインを作成する

次の create-pipeline の例では、パイプラインを作成します。パイプラインではチャネルからのメッセージが消費されるため、メッセージをデータストアに保存する前に処理できます。pipelineActivities 配列に、チャネルとデータストアの両方のアクティビティと、必要に応じて最大 23 個の追加のアクティビティを指定する必要があります。

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

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「CreatePipeline」を参照してください。

IoT Analytics チャネルを削除する

次の delete-channel の例では、指定されたチャネルを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「DeleteChannel」を参照してください。

データセットのコンテンツを削除するには

次の delete-dataset-content の例では、指定されたデータセットのコンテンツを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「DeleteDatasetContent」を参照してください。

データセットを削除するには

次の delete-dataset の例では、指定されたデータセットを削除します。このオペレーションの実行前にデータセットのコンテンツを消去する必要はありません。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「DeleteDataset」を参照してください。

データストアを削除するには

次の delete-datastore の例では、指定されたデータストアを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「DeleteDatastore」を参照してください。

パイプラインを削除するには

次の delete-pipeline の例では、指定されたパイプラインを削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「DeletePipeline」を参照してください。

チャネルに関する情報を取得するには

次の describe-channel の例では、指定されたチャネルの詳細 (統計を含む) を表示します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「DescribeChannel」を参照してください。

データセットに関する情報を取得するには

次の describe-dataset の例では、指定されたデータセットの詳細を表示します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「DescribeDataset」を参照してください。

データストアに関する情報を取得するには

次の describe-datastore の例では、指定されたデータストアの詳細 (統計を含む) を表示します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「DescribeDatastore」を参照してください。

現在のログ記録オプションを取得するには

次の describe-logging-options の例では、現在の AWS IoT Analytics ログ記録オプションを表示します。

aws iotanalytics describe-logging-options

このコマンドでは何も出力されません。出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「DescribeLoggingOptions」を参照してください。

パイプラインに関する情報を取得するには

次の describe-pipeline の例では、指定されたパイプラインの詳細を表示します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「DescribePipeline」を参照してください。

データセットのコンテンツを取得するには

次の get-dataset-content の例では、データセットのコンテンツを署名付き URI として取得します。

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

出力:

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

詳細については、ガイドの「GetDatasetContent」を参照してください。

チャネルのリストを取得するには

次の list-channels の例では、使用可能なチャネルの概要情報を表示します。

aws iotanalytics list-channels

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「ListChannels」を参照してください。

データセットのコンテンツに関する情報を一覧表示するには

次の list-dataset-contents の例では、作成されたデータセットのコンテンツに関する情報を一覧表示します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「ListDatasetContents」を参照してください。

データセットに関する情報を取得するには

次の list-datasets の例では、使用可能なデータセットに関する概要情報を一覧表示します。

aws iotanalytics list-datasets

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「ListDatasets」を参照してください。

データストアのリストを取得するには

次の list-datastores の例では、使用可能なデータストアに関する概要情報を表示します。

aws iotanalytics list-datastores

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「ListDatastores」を参照してください。

パイプラインのリストを取得するには

次の list-pipelines の例では、使用可能なパイプラインのリストを表示します。

aws iotanalytics list-pipelines

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「ListPipelines」を参照してください。

リソースのタグを一覧表示するには

次の list-tags-for-resource の例では、指定されたリソースにアタッチしたタグを一覧表示します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「ListTagsForResource」を参照してください。

ログ記録オプションを設定または更新するには

次の put-logging-options の例では、AWS IoT Analytics ログ記録オプションを設定または更新します。loggingOptions のいずれかのフィールドの値を更新する場合、変更が有効になるまでに最大で 1 分かかることがあります。また、"roleArn" フィールドで指定したロールにアタッチされるポリシーを変更する場合 (たとえば、無効なポリシーを修正するなど)、この変更が有効になるまでには最大で 5 分かかります。

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

put-logging-options.json の内容:

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「PutLoggingOptions」を参照してください。

パイプラインアクティビティをシミュレートするには

次の run-pipeline-activity の例では、メッセージペイロードに対してパイプラインアクティビティを実行した結果をシミュレートします。

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

maths.json の内容:

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

payloads.json の内容:

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「RunPipelineActivity」を参照してください。

チャネルからサンプルメッセージを取得するには

次の sample-channel-data の例では、指定したチャネルのメッセージのうち、指定した時間枠内に取り込まれたもののサンプルを取得します。最大 10 個のメッセージを取得できます。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「SampleChannelData」を参照してください。

パイプラインの再処理を開始するには

次の start-pipeline-reprocessing の例では、指定されたパイプラインによる raw メッセージデータの再処理を開始します。

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

出力:

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

詳細については、「AWS IoT Analytics API リファレンス」の「StartPipelineReprocessing」を参照してください。

リソースのタグを追加または変更するには

次の tag-resource の例では、指定されたリソースにアタッチされたタグを追加または変更します。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「TagResource」を参照してください。

リソースからタグを削除する

次の untag-resource の例では、指定されたキー名を持つタグを指定されたリソースから削除します。

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API Reference」の「UntagResource」<https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UntagResource.html >を参照してください。

チャネルを変更するには

次の update-channel の例では、指定されたチャネルの設定を変更します。

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

update-channel.json の内容:

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「UpdateChannel」を参照してください。

データセットを更新するには

次の update-dataset の例では、指定されたデータセットの設定を変更します。

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

update-dataset.json の内容:

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API Reference」の「UpdateDataset」<https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_UpdateDataset.html >を参照してください。

データストアを更新するには

次の update-datastore の例では、指定されたデータストアの設定を変更します。

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

update-datastore.json の内容:

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「UpdateDatastore」を参照してください。

パイプラインを更新するには

次の update-pipeline の例では、指定されたパイプラインの設定を変更します。pipelineActivities 配列に、チャネルとデータストアの両方のアクティビティと、必要に応じて最大 23 個の追加のアクティビティを指定する必要があります。

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

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

このコマンドでは何も出力されません。

詳細については、「AWS IoT Analytics API リファレンス」の「UpdatePipeline」を参照してください。