diff --git a/.changes/next-release/api-change-iotanalytics-97431.json b/.changes/next-release/api-change-iotanalytics-97431.json new file mode 100644 index 000000000000..546e5217bc99 --- /dev/null +++ b/.changes/next-release/api-change-iotanalytics-97431.json @@ -0,0 +1,5 @@ +{ + "type": "api-change", + "category": "``iotanalytics``", + "description": "The iotanalytics client has been removed following the deprecation of the service." +} diff --git a/awscli/examples/iotanalytics/batch-put-message.rst b/awscli/examples/iotanalytics/batch-put-message.rst deleted file mode 100644 index c19259913d45..000000000000 --- a/awscli/examples/iotanalytics/batch-put-message.rst +++ /dev/null @@ -1,27 +0,0 @@ -**To send a message to a channel** - -The following ``batch-put-message`` example sends a message to the specified channel. :: - - aws iotanalytics batch-put-message \ - --cli-binary-format raw-in-base64-out \ - --cli-input-json file://batch-put-message.json - -Contents of ``batch-put-message.json``:: - - { - "channelName": "mychannel", - "messages": [ - { - "messageId": "0001", - "payload": "eyAidGVtcGVyYXR1cmUiOiAyMCB9" - } - ] - } - -Output:: - - { - "batchPutMessageErrorEntries": [] - } - -For more information, see `BatchPutMessage `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst b/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst deleted file mode 100644 index 982a8cce0b91..000000000000 --- a/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst +++ /dev/null @@ -1,11 +0,0 @@ -**To cancel the reprocessing of data through a pipeline** - -The following ``cancel-pipeline-reprocessing`` example cancels the reprocessing of data through the specified pipeline. :: - - aws iotanalytics cancel-pipeline-reprocessing \ - --pipeline-name mypipeline \ - --reprocessing-id "6ad2764f-fb13-4de3-b101-4e74af03b043" - -This command produces no output. - -For more information, see `CancelPipelineReprocessing `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/create-channel.rst b/awscli/examples/iotanalytics/create-channel.rst deleted file mode 100644 index c2f643def08b..000000000000 --- a/awscli/examples/iotanalytics/create-channel.rst +++ /dev/null @@ -1,33 +0,0 @@ -**To create a channel** - -The following ``create-channel`` example creates a channel with the specified configuration. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. :: - - aws iotanalytics create-channel \ - --cli-input-json file://create-channel.json - -Contents of ``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 - } - } - -For more information, see `CreateChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/create-dataset-content.rst b/awscli/examples/iotanalytics/create-dataset-content.rst deleted file mode 100644 index 66b888723eb1..000000000000 --- a/awscli/examples/iotanalytics/create-dataset-content.rst +++ /dev/null @@ -1,14 +0,0 @@ -**To create the content of a dataset** - -The following ``create-dataset-content`` example creates the content of the specified dataset by applying a ``queryAction`` (an SQL query) or a ``containerAction`` (executing a containerized application). :: - - aws iotanalytics create-dataset-content \ - --dataset-name mydataset - -Output:: - - { - "versionId": "d494b416-9850-4670-b885-ca22f1e89d62" - } - -For more information, see `CreateDatasetContent `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/create-dataset.rst b/awscli/examples/iotanalytics/create-dataset.rst deleted file mode 100644 index f376001f5939..000000000000 --- a/awscli/examples/iotanalytics/create-dataset.rst +++ /dev/null @@ -1,41 +0,0 @@ -**To create a dataset** - -The following ``create-dataset`` example creates a dataset. A dataset stores data retrieved from a data store by applying a ``queryAction`` (a SQL query) or a ``containerAction`` (executing a containerized application). This operation creates the skeleton of a dataset. You can populate the dataset manually by calling ``CreateDatasetContent`` or automatically according to a ``trigger`` you specify. :: - - aws iotanalytics create-dataset \ - --cli-input-json file://create-dataset.json - -Contents of ``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" - } - -For more information, see `CreateDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/create-datastore.rst b/awscli/examples/iotanalytics/create-datastore.rst deleted file mode 100644 index 9588f1b0dee5..000000000000 --- a/awscli/examples/iotanalytics/create-datastore.rst +++ /dev/null @@ -1,34 +0,0 @@ -**To create a data store** - -The following ``create-datastore`` example creates a data store, which is a repository for messages. :: - - aws iotanalytics create-datastore \ - --cli-input-json file://create-datastore.json - -Contents of ``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 - } - } - -For more information, see `CreateDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/create-pipeline.rst b/awscli/examples/iotanalytics/create-pipeline.rst deleted file mode 100644 index 58991c564d2f..000000000000 --- a/awscli/examples/iotanalytics/create-pipeline.rst +++ /dev/null @@ -1,50 +0,0 @@ -**Create an IoT Analytics Pipeline** - -The following ``create-pipeline`` example creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a data store activity and, optionally, as many as 23 additional activities in the ``pipelineActivities`` array. :: - - aws iotanalytics create-pipeline \ - --cli-input-json file://create-pipeline.json - -Contents of ``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" - } - -For more information, see `CreatePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/delete-channel.rst b/awscli/examples/iotanalytics/delete-channel.rst deleted file mode 100644 index 74e5f0f07c37..000000000000 --- a/awscli/examples/iotanalytics/delete-channel.rst +++ /dev/null @@ -1,10 +0,0 @@ -**Delete an IoT Analytics Channel** - -The following ``delete-channel`` example deletes the specified channel. :: - - aws iotanalytics delete-channel \ - --channel-name mychannel - -This command produces no output. - -For more information, see `DeleteChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/delete-dataset-content.rst b/awscli/examples/iotanalytics/delete-dataset-content.rst deleted file mode 100644 index 0315d7ac7e0e..000000000000 --- a/awscli/examples/iotanalytics/delete-dataset-content.rst +++ /dev/null @@ -1,10 +0,0 @@ -**To delete dataset content** - -The following ``delete-dataset-content`` example deletes the content of the specified dataset. :: - - aws iotanalytics delete-dataset-content \ - --dataset-name mydataset - -This command produces no output. - -For more information, see `DeleteDatasetContent `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/delete-dataset.rst b/awscli/examples/iotanalytics/delete-dataset.rst deleted file mode 100644 index bb7f10cced6f..000000000000 --- a/awscli/examples/iotanalytics/delete-dataset.rst +++ /dev/null @@ -1,10 +0,0 @@ -**To delete a dataset** - -The following ``delete-dataset`` example deletes the specified dataset. You don't have to delete the content of the dataset before you perform this operation. :: - - aws iotanalytics delete-dataset \ - --dataset-name mydataset - -This command produces no output. - -For more information, see `DeleteDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/delete-datastore.rst b/awscli/examples/iotanalytics/delete-datastore.rst deleted file mode 100644 index d7ef47af9695..000000000000 --- a/awscli/examples/iotanalytics/delete-datastore.rst +++ /dev/null @@ -1,11 +0,0 @@ -**To delete a data store** - -The following ``delete-datastore`` example deletes the specified data store. :: - - aws iotanalytics delete-datastore \ - --datastore-name mydatastore - - -This command produces no output. - -For more information, see `DeleteDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/delete-pipeline.rst b/awscli/examples/iotanalytics/delete-pipeline.rst deleted file mode 100644 index 4273d6aa59a5..000000000000 --- a/awscli/examples/iotanalytics/delete-pipeline.rst +++ /dev/null @@ -1,10 +0,0 @@ -**To delete a pipeline** - -The following ``delete-pipeline`` example deletes the specified pipeline. :: - - aws iotanalytics delete-pipeline \ - --pipeline-name mypipeline - -This command produces no output. - -For more information, see `DeletePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/describe-channel.rst b/awscli/examples/iotanalytics/describe-channel.rst deleted file mode 100644 index 02e188f333c2..000000000000 --- a/awscli/examples/iotanalytics/describe-channel.rst +++ /dev/null @@ -1,30 +0,0 @@ -**To retrieve information about a channel** - -The following ``describe-channel`` example displays details, including statistics, for the specified channel. :: - - 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" - } - } - -For more information, see `DescribeChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/describe-dataset.rst b/awscli/examples/iotanalytics/describe-dataset.rst deleted file mode 100644 index 95fb795472dd..000000000000 --- a/awscli/examples/iotanalytics/describe-dataset.rst +++ /dev/null @@ -1,35 +0,0 @@ -**To retrieve information about a dataset** - -The following ``describe-dataset`` example displays details for the specified dataset. :: - - 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" - } - } - -For more information, see `DescribeDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/describe-datastore.rst b/awscli/examples/iotanalytics/describe-datastore.rst deleted file mode 100644 index 65af88877ce2..000000000000 --- a/awscli/examples/iotanalytics/describe-datastore.rst +++ /dev/null @@ -1,30 +0,0 @@ -**To retrieve information about a data store** - -The following ``describe-datastore`` example displays details, including statistics, for the specified data store. :: - - 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 - } - } - } - -For more information, see `DescribeDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/describe-logging-options.rst b/awscli/examples/iotanalytics/describe-logging-options.rst deleted file mode 100644 index 63fdadf0ef05..000000000000 --- a/awscli/examples/iotanalytics/describe-logging-options.rst +++ /dev/null @@ -1,18 +0,0 @@ -**To retrieve the current logging options** - -The following ``describe-logging-options`` example displays the current AWS IoT Analytics logging options. :: - - aws iotanalytics describe-logging-options - -This command produces no output. -Output:: - - { - "loggingOptions": { - "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole", - "enabled": true, - "level": "ERROR" - } - } - -For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/describe-pipeline.rst b/awscli/examples/iotanalytics/describe-pipeline.rst deleted file mode 100644 index 2ef4064343fd..000000000000 --- a/awscli/examples/iotanalytics/describe-pipeline.rst +++ /dev/null @@ -1,41 +0,0 @@ -**To retrieve information about a pipeline** - -The following ``describe-pipeline`` example displays details for the specified pipeline. :: - - 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" - } - } - -For more information, see `DescribePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/get-dataset-content.rst b/awscli/examples/iotanalytics/get-dataset-content.rst deleted file mode 100644 index b12740e74a23..000000000000 --- a/awscli/examples/iotanalytics/get-dataset-content.rst +++ /dev/null @@ -1,21 +0,0 @@ -**To retrieve the contents of a dataset** - -The following ``get-dataset-content`` example retrieves the contents of a dataset as presigned URIs. :: - - 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=..." - } - ] - } - -For more information, see `GetDatasetContent `__ in the *guide*. diff --git a/awscli/examples/iotanalytics/list-channels.rst b/awscli/examples/iotanalytics/list-channels.rst deleted file mode 100644 index 66c23a8e09c9..000000000000 --- a/awscli/examples/iotanalytics/list-channels.rst +++ /dev/null @@ -1,20 +0,0 @@ -**To retrieve a list of channels** - -The following ``list-channels`` example displays summary information for the available channels. :: - - aws iotanalytics list-channels - -Output:: - - { - "channelSummaries": [ - { - "status": "ACTIVE", - "channelName": "mychannel", - "creationTime": 1557860351.001, - "lastUpdateTime": 1557860351.001 - } - ] - } - -For more information, see `ListChannels `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/list-dataset-contents.rst b/awscli/examples/iotanalytics/list-dataset-contents.rst deleted file mode 100644 index 899329e7c82b..000000000000 --- a/awscli/examples/iotanalytics/list-dataset-contents.rst +++ /dev/null @@ -1,23 +0,0 @@ -**To list information about dataset contents** - -The following ``list-dataset-contents`` example lists information about dataset contents that have been created. :: - - 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 - } - ] - } - -For more information, see `ListDatasetContents `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/list-datasets.rst b/awscli/examples/iotanalytics/list-datasets.rst deleted file mode 100644 index 0985d3c1ace2..000000000000 --- a/awscli/examples/iotanalytics/list-datasets.rst +++ /dev/null @@ -1,27 +0,0 @@ -**To retrieve information about datasets** - -The following ``list-datasets`` example lists summary information about available datasets. :: - - aws iotanalytics list-datasets - -Output:: - - { - "datasetSummaries": [ - { - "status": "ACTIVE", - "datasetName": "mydataset", - "lastUpdateTime": 1557859240.658, - "triggers": [], - "creationTime": 1557859240.658, - "actions": [ - { - "actionName": "query_32", - "actionType": "QUERY" - } - ] - } - ] - } - -For more information, see `ListDatasets `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/list-datastores.rst b/awscli/examples/iotanalytics/list-datastores.rst deleted file mode 100644 index f002038b1213..000000000000 --- a/awscli/examples/iotanalytics/list-datastores.rst +++ /dev/null @@ -1,20 +0,0 @@ -**To retrieve a list of data stores** - -The following ``list-datastores`` example displays summary information about the available data stores. :: - - aws iotanalytics list-datastores - -Output:: - - { - "datastoreSummaries": [ - { - "status": "ACTIVE", - "datastoreName": "mydatastore", - "creationTime": 1557858971.02, - "lastUpdateTime": 1557858971.02 - } - ] - } - -For more information, see `ListDatastores `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/list-pipelines.rst b/awscli/examples/iotanalytics/list-pipelines.rst deleted file mode 100644 index 32e3891593fa..000000000000 --- a/awscli/examples/iotanalytics/list-pipelines.rst +++ /dev/null @@ -1,20 +0,0 @@ -**To retrieve a list of pipelines** - -The following ``list-pipelines`` example displays a list of available pipelines. :: - - aws iotanalytics list-pipelines - -Output:: - - { - "pipelineSummaries": [ - { - "pipelineName": "mypipeline", - "creationTime": 1557859124.432, - "lastUpdateTime": 1557859124.432, - "reprocessingSummaries": [] - } - ] - } - -For more information, see `ListPipelines `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/list-tags-for-resource.rst b/awscli/examples/iotanalytics/list-tags-for-resource.rst deleted file mode 100644 index 4f1d5aa75e19..000000000000 --- a/awscli/examples/iotanalytics/list-tags-for-resource.rst +++ /dev/null @@ -1,19 +0,0 @@ -**To list tags for a resource** - -The following ``list-tags-for-resource`` example Lists the tags that you have attached to the specified resource. :: - - aws iotanalytics list-tags-for-resource \ - --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" - -Output:: - - { - "tags": [ - { - "value": "bar", - "key": "foo" - } - ] - } - -For more information, see `ListTagsForResource `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/put-logging-options.rst b/awscli/examples/iotanalytics/put-logging-options.rst deleted file mode 100644 index 919e51327936..000000000000 --- a/awscli/examples/iotanalytics/put-logging-options.rst +++ /dev/null @@ -1,20 +0,0 @@ -**To set or update logging options** - -The following ``put-logging-options`` example sets or updates the AWS IoT Analytics logging options. If you update the value of any ``loggingOptions`` field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the "roleArn" field (for example, to correct an invalid policy) it can take up to five minutes for that change to take effect. :: - - aws iotanalytics put-logging-options \ - --cli-input-json file://put-logging-options.json - -Contents of ``put-logging-options.json``:: - - { - "loggingOptions": { - "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole", - "level": "ERROR", - "enabled": true - } - } - -This command produces no output. - -For more information, see `PutLoggingOptions `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/run-pipeline-activity.rst b/awscli/examples/iotanalytics/run-pipeline-activity.rst deleted file mode 100644 index d9fd34a4d8d1..000000000000 --- a/awscli/examples/iotanalytics/run-pipeline-activity.rst +++ /dev/null @@ -1,36 +0,0 @@ -**To simulate a pipeline activity** - -The following ``run-pipeline-activity`` example simulates the results of running a pipeline activity on a message payload. :: - - aws iotanalytics run-pipeline-activity \ - --pipeline-activity file://maths.json \ - --payloads file://payloads.json - -Contents of ``maths.json``:: - - { - "math": { - "name": "MyMathActivity", - "math": "((temp - 32) * 5.0) / 9.0", - "attribute": "tempC" - } - } - -Contents of ``payloads.json``:: - - [ - "{\"humidity\": 52, \"temp\": 68 }", - "{\"humidity\": 52, \"temp\": 32 }" - ] - -Output:: - - { - "logResult": "", - "payloads": [ - "eyJodW1pZGl0eSI6NTIsInRlbXAiOjY4LCJ0ZW1wQyI6MjB9", - "eyJodW1pZGl0eSI6NTIsInRlbXAiOjMyLCJ0ZW1wQyI6MH0=" - ] - } - -For more information, see `RunPipelineActivity `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/sample-channel-data.rst b/awscli/examples/iotanalytics/sample-channel-data.rst deleted file mode 100644 index 98a547b2883a..000000000000 --- a/awscli/examples/iotanalytics/sample-channel-data.rst +++ /dev/null @@ -1,17 +0,0 @@ -**To retrieve sample messages from a channel** - -The following ``sample-channel-data`` example retrieves a sample of messages from the specified channel ingested during the specified timeframe. You can retrieve up to 10 messages. :: - - aws iotanalytics sample-channel-data \ - --channel-name mychannel - -Output:: - - { - "payloads": [ - "eyAidGVtcGVyYXR1cmUiOiAyMCB9", - "eyAiZm9vIjogImJhciIgfQ==" - ] - } - -For more information, see `SampleChannelData `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst b/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst deleted file mode 100644 index 82bcc01651e6..000000000000 --- a/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst +++ /dev/null @@ -1,14 +0,0 @@ -**To start pipeline reprocessing** - -The following ``start-pipeline-reprocessing`` example starts the reprocessing of raw message data through the specified pipeline. :: - - aws iotanalytics start-pipeline-reprocessing \ - --pipeline-name mypipeline - -Output:: - - { - "reprocessingId": "6ad2764f-fb13-4de3-b101-4e74af03b043" - } - -For more information, see `StartPipelineReprocessing `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/tag-resource.rst b/awscli/examples/iotanalytics/tag-resource.rst deleted file mode 100644 index 4bae4998e69b..000000000000 --- a/awscli/examples/iotanalytics/tag-resource.rst +++ /dev/null @@ -1,11 +0,0 @@ -**To add or modify tags for a resource** - -The following ``tag-resource`` example adds to or modifies the tags attached to the specified resource. :: - - aws iotanalytics tag-resource \ - --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \ - --tags "[{\"key\": \"Environment\", \"value\": \"Production\"}]" - -This command produces no output. - -For more information, see `TagResource `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/untag-resource.rst b/awscli/examples/iotanalytics/untag-resource.rst deleted file mode 100644 index cc0076d00c8a..000000000000 --- a/awscli/examples/iotanalytics/untag-resource.rst +++ /dev/null @@ -1,12 +0,0 @@ -**To remove tags from a resource** - -The following ``untag-resource`` example removes the tags with the specified key names from the specified resource. :: - - aws iotanalytics untag-resource \ - --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \ - --tag-keys "[\"Environment\"]" - -This command produces no output. - -For more information, see `UntagResource `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/update-channel.rst b/awscli/examples/iotanalytics/update-channel.rst deleted file mode 100644 index 2de24c84c879..000000000000 --- a/awscli/examples/iotanalytics/update-channel.rst +++ /dev/null @@ -1,19 +0,0 @@ -**To modify a channel** - -The following ``update-channel`` example modifies the settings for the specified channel. :: - - aws iotanalytics update-channel \ - --cli-input-json file://update-channel.json - -Contents of ``update-channel.json``:: - - { - "channelName": "mychannel", - "retentionPeriod": { - "numberOfDays": 92 - } - } - -This command produces no output. - -For more information, see `UpdateChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/update-dataset.rst b/awscli/examples/iotanalytics/update-dataset.rst deleted file mode 100644 index 46c27fb61a8e..000000000000 --- a/awscli/examples/iotanalytics/update-dataset.rst +++ /dev/null @@ -1,28 +0,0 @@ -**To update a dataset** - -The following ``update-dataset`` example modifies the settings of the specified dataset. :: - - aws iotanalytics update-dataset \ - --cli-input-json file://update-dataset.json - -Contents of ``update-dataset.json``:: - - { - "datasetName": "mydataset", - "actions": [ - { - "actionName": "myDatasetUpdateAction", - "queryAction": { - "sqlQuery": "SELECT * FROM mydatastore" - } - } - ], - "retentionPeriod": { - "numberOfDays": 92 - } - } - -This command produces no output. - -For more information, see `UpdateDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/update-datastore.rst b/awscli/examples/iotanalytics/update-datastore.rst deleted file mode 100644 index b0a57ed8fd2d..000000000000 --- a/awscli/examples/iotanalytics/update-datastore.rst +++ /dev/null @@ -1,19 +0,0 @@ -**To update a data store** - -The following ``update-datastore`` example modifies the settings of the specified data store. :: - - aws iotanalytics update-datastore \ - --cli-input-json file://update-datastore.json - -Contents of update-datastore.json:: - - { - "datastoreName": "mydatastore", - "retentionPeriod": { - "numberOfDays": 93 - } - } - -This command produces no output. - -For more information, see `UpdateDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/awscli/examples/iotanalytics/update-pipeline.rst b/awscli/examples/iotanalytics/update-pipeline.rst deleted file mode 100644 index 5649cb2f10c7..000000000000 --- a/awscli/examples/iotanalytics/update-pipeline.rst +++ /dev/null @@ -1,39 +0,0 @@ -**To update a pipeline** - -The following ``update-pipeline`` example modifies the settings of the specified pipeline. You must specify both a channel and a data store activity and, optionally, as many as 23 additional activities, in the ``pipelineActivities`` array. :: - - aws iotanalytics update-pipeline \ - --cli-input-json file://update-pipeline.json - -Contents of 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" - } - } - ] - } - -This command produces no output. - -For more information, see `UpdatePipeline `__ in the *AWS IoT Analytics API Reference*.