AWS IoT Analytics 使用 的範例 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 主題收集資料，並會在將資料發佈到管道前，先將未處理的原始訊息封存。

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範例會將資料集的內容擷取為預先簽章URIs。

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欄位的值，變更最多可能需要一分鐘才會生效。此外，如果您變更附加至您在「roleArn」欄位中指定之角色的政策 （例如，更正無效政策），則該變更最多可能需要五分鐘才會生效。

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範例會透過指定的管道開始重新處理原始訊息資料。

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 參考中的 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 參考中的 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。