0% found this document useful (0 votes)

125 views

Aws Iot Analytics API

AWS

Uploaded by

park hyo

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

125 views

Aws Iot Analytics API

AWS

Uploaded by

park hyo

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 185

AWS IoT Analytics

AWS IoT Analytics Documentation

API Version 2017-11-27
AWS IoT Analytics AWS IoT Analytics Documentation

AWS IoT Analytics: AWS IoT Analytics Documentation

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not
Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or
discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may
or may not be aﬃliated with, connected to, or sponsored by Amazon.
AWS IoT Analytics AWS IoT Analytics Documentation

Table of Contents
Welcome ........................................................................................................................................... 1
Actions ............................................................................................................................................. 2
BatchPutMessage ....................................................................................................................... 3
Request Syntax .................................................................................................................. 3
URI Request Parameters ...................................................................................................... 3
Request Body .................................................................................................................... 3
Response Syntax ................................................................................................................ 4
Response Elements ............................................................................................................. 4
Errors ............................................................................................................................... 4
See Also ............................................................................................................................ 5
CancelPipelineReprocessing ......................................................................................................... 6
Request Syntax .................................................................................................................. 6
URI Request Parameters ...................................................................................................... 6
Request Body .................................................................................................................... 6
Response Syntax ................................................................................................................ 6
Response Elements ............................................................................................................. 6
Errors ............................................................................................................................... 6
See Also ............................................................................................................................ 7
CreateChannel ........................................................................................................................... 8
Request Syntax .................................................................................................................. 8
URI Request Parameters ...................................................................................................... 8
Request Body .................................................................................................................... 8
Response Syntax ................................................................................................................ 9
Response Elements ............................................................................................................. 9
Errors .............................................................................................................................. 10
See Also .......................................................................................................................... 10
CreateDataset .......................................................................................................................... 11
Request Syntax ................................................................................................................ 11
URI Request Parameters .................................................................................................... 12
Request Body ................................................................................................................... 12
Response Syntax .............................................................................................................. 13
Response Elements ........................................................................................................... 14
Errors .............................................................................................................................. 14
See Also .......................................................................................................................... 15
CreateDatasetContent ............................................................................................................... 16
Request Syntax ................................................................................................................ 16
URI Request Parameters .................................................................................................... 16
Request Body ................................................................................................................... 16
Response Syntax .............................................................................................................. 16
Response Elements ........................................................................................................... 16
Errors .............................................................................................................................. 16
See Also .......................................................................................................................... 17
CreateDatastore ....................................................................................................................... 18
Request Syntax ................................................................................................................ 18
URI Request Parameters .................................................................................................... 18
Request Body ................................................................................................................... 18
Response Syntax .............................................................................................................. 19
Response Elements ........................................................................................................... 19
Errors .............................................................................................................................. 20
See Also .......................................................................................................................... 20
CreatePipeline .......................................................................................................................... 21
Request Syntax ................................................................................................................ 21
URI Request Parameters .................................................................................................... 22
Request Body ................................................................................................................... 22

API Version 2017-11-27

iii
AWS IoT Analytics AWS IoT Analytics Documentation

Response Syntax .............................................................................................................. 23

Response Elements ........................................................................................................... 23
Errors .............................................................................................................................. 23
See Also .......................................................................................................................... 24
DeleteChannel ......................................................................................................................... 25
Request Syntax ................................................................................................................ 25
URI Request Parameters .................................................................................................... 25
Request Body ................................................................................................................... 25
Response Syntax .............................................................................................................. 25
Response Elements ........................................................................................................... 25
Errors .............................................................................................................................. 25
See Also .......................................................................................................................... 26
DeleteDataset .......................................................................................................................... 27
Request Syntax ................................................................................................................ 27
URI Request Parameters .................................................................................................... 27
Request Body ................................................................................................................... 27
Response Syntax .............................................................................................................. 27
Response Elements ........................................................................................................... 27
Errors .............................................................................................................................. 27
See Also .......................................................................................................................... 28
DeleteDatasetContent ............................................................................................................... 29
Request Syntax ................................................................................................................ 29
URI Request Parameters .................................................................................................... 29
Request Body ................................................................................................................... 29
Response Syntax .............................................................................................................. 29
Response Elements ........................................................................................................... 29
Errors .............................................................................................................................. 29
See Also .......................................................................................................................... 30
DeleteDatastore ....................................................................................................................... 31
Request Syntax ................................................................................................................ 31
URI Request Parameters .................................................................................................... 31
Request Body ................................................................................................................... 31
Response Syntax .............................................................................................................. 31
Response Elements ........................................................................................................... 31
Errors .............................................................................................................................. 31
See Also .......................................................................................................................... 32
DeletePipeline .......................................................................................................................... 33
Request Syntax ................................................................................................................ 33
URI Request Parameters .................................................................................................... 33
Request Body ................................................................................................................... 33
Response Syntax .............................................................................................................. 33
Response Elements ........................................................................................................... 33
Errors .............................................................................................................................. 33
See Also .......................................................................................................................... 34
DescribeChannel ....................................................................................................................... 35
Request Syntax ................................................................................................................ 35
URI Request Parameters .................................................................................................... 35
Request Body ................................................................................................................... 35
Response Syntax .............................................................................................................. 35
Response Elements ........................................................................................................... 36
Errors .............................................................................................................................. 36
See Also .......................................................................................................................... 36
DescribeDataset ....................................................................................................................... 38
Request Syntax ................................................................................................................ 38
URI Request Parameters .................................................................................................... 38
Request Body ................................................................................................................... 38
Response Syntax .............................................................................................................. 38

API Version 2017-11-27

iv
AWS IoT Analytics AWS IoT Analytics Documentation

Response Elements ........................................................................................................... 39

Errors .............................................................................................................................. 40
See Also .......................................................................................................................... 40
DescribeDatastore ..................................................................................................................... 41
Request Syntax ................................................................................................................ 41
URI Request Parameters .................................................................................................... 41
Request Body ................................................................................................................... 41
Response Syntax .............................................................................................................. 41
Response Elements ........................................................................................................... 42
Errors .............................................................................................................................. 42
See Also .......................................................................................................................... 42
DescribeLoggingOptions ............................................................................................................ 44
Request Syntax ................................................................................................................ 44
URI Request Parameters .................................................................................................... 44
Request Body ................................................................................................................... 44
Response Syntax .............................................................................................................. 44
Response Elements ........................................................................................................... 44
Errors .............................................................................................................................. 44
See Also .......................................................................................................................... 45
DescribePipeline ....................................................................................................................... 46
Request Syntax ................................................................................................................ 46
URI Request Parameters .................................................................................................... 46
Request Body ................................................................................................................... 46
Response Syntax .............................................................................................................. 46
Response Elements ........................................................................................................... 47
Errors .............................................................................................................................. 48
See Also .......................................................................................................................... 48
GetDatasetContent ................................................................................................................... 49
Request Syntax ................................................................................................................ 49
URI Request Parameters .................................................................................................... 49
Request Body ................................................................................................................... 49
Response Syntax .............................................................................................................. 49
Response Elements ........................................................................................................... 49
Errors .............................................................................................................................. 50
See Also .......................................................................................................................... 50
ListChannels ............................................................................................................................ 52
Request Syntax ................................................................................................................ 52
URI Request Parameters .................................................................................................... 52
Request Body ................................................................................................................... 52
Response Syntax .............................................................................................................. 52
Response Elements ........................................................................................................... 52
Errors .............................................................................................................................. 53
See Also .......................................................................................................................... 53
ListDatasetContents .................................................................................................................. 54
Request Syntax ................................................................................................................ 54
URI Request Parameters .................................................................................................... 54
Request Body ................................................................................................................... 54
Response Syntax .............................................................................................................. 54
Response Elements ........................................................................................................... 55
Errors .............................................................................................................................. 55
See Also .......................................................................................................................... 56
ListDatasets ............................................................................................................................. 57
Request Syntax ................................................................................................................ 57
URI Request Parameters .................................................................................................... 57
Request Body ................................................................................................................... 57
Response Syntax .............................................................................................................. 57
Response Elements ........................................................................................................... 58

API Version 2017-11-27

v
AWS IoT Analytics AWS IoT Analytics Documentation

Errors .............................................................................................................................. 58
See Also .......................................................................................................................... 58
ListDatastores .......................................................................................................................... 60
Request Syntax ................................................................................................................ 60
URI Request Parameters .................................................................................................... 60
Request Body ................................................................................................................... 60
Response Syntax .............................................................................................................. 60
Response Elements ........................................................................................................... 60
Errors .............................................................................................................................. 61
See Also .......................................................................................................................... 61
ListPipelines ............................................................................................................................. 62
Request Syntax ................................................................................................................ 62
URI Request Parameters .................................................................................................... 62
Request Body ................................................................................................................... 62
Response Syntax .............................................................................................................. 62
Response Elements ........................................................................................................... 62
Errors .............................................................................................................................. 63
See Also .......................................................................................................................... 63
ListTagsForResource .................................................................................................................. 64
Request Syntax ................................................................................................................ 64
URI Request Parameters .................................................................................................... 64
Request Body ................................................................................................................... 64
Response Syntax .............................................................................................................. 64
Response Elements ........................................................................................................... 64
Errors .............................................................................................................................. 64
See Also .......................................................................................................................... 65
PutLoggingOptions ................................................................................................................... 66
Request Syntax ................................................................................................................ 66
URI Request Parameters .................................................................................................... 66
Request Body ................................................................................................................... 66
Response Syntax .............................................................................................................. 66
Response Elements ........................................................................................................... 66
Errors .............................................................................................................................. 66
See Also .......................................................................................................................... 67
RunPipelineActivity ................................................................................................................... 68
Request Syntax ................................................................................................................ 68
URI Request Parameters .................................................................................................... 69
Request Body ................................................................................................................... 69
Response Syntax .............................................................................................................. 69
Response Elements ........................................................................................................... 69
Errors .............................................................................................................................. 70
See Also .......................................................................................................................... 70
SampleChannelData .................................................................................................................. 71
Request Syntax ................................................................................................................ 71
URI Request Parameters .................................................................................................... 71
Request Body ................................................................................................................... 71
Response Syntax .............................................................................................................. 71
Response Elements ........................................................................................................... 71
Errors .............................................................................................................................. 72
See Also .......................................................................................................................... 72
StartPipelineReprocessing .......................................................................................................... 73
Request Syntax ................................................................................................................ 73
URI Request Parameters .................................................................................................... 73
Request Body ................................................................................................................... 73
Response Syntax .............................................................................................................. 73
Response Elements ........................................................................................................... 74
Errors .............................................................................................................................. 74

API Version 2017-11-27

vi
AWS IoT Analytics AWS IoT Analytics Documentation

API Version 2017-11-27

vii
AWS IoT Analytics AWS IoT Analytics Documentation

Contents ......................................................................................................................... 97
See Also .......................................................................................................................... 98
ChannelActivity ........................................................................................................................ 99
Contents ......................................................................................................................... 99
See Also .......................................................................................................................... 99
ChannelStatistics .................................................................................................................... 100
Contents ........................................................................................................................ 100
See Also ........................................................................................................................ 100
ChannelStorage ...................................................................................................................... 101
Contents ........................................................................................................................ 101
See Also ........................................................................................................................ 101
ChannelStorageSummary ........................................................................................................ 102
Contents ........................................................................................................................ 102
See Also ........................................................................................................................ 102
ChannelSummary ................................................................................................................... 103
Contents ........................................................................................................................ 103
See Also ........................................................................................................................ 103
ContainerDatasetAction ........................................................................................................... 105
Contents ........................................................................................................................ 105
See Also ........................................................................................................................ 105
CustomerManagedChannelS3Storage ........................................................................................ 107
Contents ........................................................................................................................ 107
See Also ........................................................................................................................ 107
CustomerManagedChannelS3StorageSummary ........................................................................... 108
Contents ........................................................................................................................ 108
See Also ........................................................................................................................ 108
CustomerManagedDatastoreS3Storage ...................................................................................... 109
Contents ........................................................................................................................ 109
See Also ........................................................................................................................ 109
CustomerManagedDatastoreS3StorageSummary ......................................................................... 110
Contents ........................................................................................................................ 110
See Also ........................................................................................................................ 110
Dataset ................................................................................................................................. 111
Contents ........................................................................................................................ 111
See Also ........................................................................................................................ 112
DatasetAction ......................................................................................................................... 113
Contents ........................................................................................................................ 113
See Also ........................................................................................................................ 113
DatasetActionSummary ........................................................................................................... 114
Contents ........................................................................................................................ 114
See Also ........................................................................................................................ 114
DatasetContentDeliveryDestination ........................................................................................... 115
Contents ........................................................................................................................ 115
See Also ........................................................................................................................ 115
DatasetContentDeliveryRule ..................................................................................................... 116
Contents ........................................................................................................................ 116
See Also ........................................................................................................................ 116
DatasetContentStatus ............................................................................................................. 117
Contents ........................................................................................................................ 117
See Also ........................................................................................................................ 117
DatasetContentSummary ......................................................................................................... 118
Contents ........................................................................................................................ 118
See Also ........................................................................................................................ 118
DatasetContentVersionValue .................................................................................................... 119
Contents ........................................................................................................................ 119
See Also ........................................................................................................................ 119
DatasetEntry .......................................................................................................................... 120

API Version 2017-11-27

viii
AWS IoT Analytics AWS IoT Analytics Documentation

Contents ........................................................................................................................ 120

See Also ........................................................................................................................ 120
DatasetSummary .................................................................................................................... 121
Contents ........................................................................................................................ 121
See Also ........................................................................................................................ 122
DatasetTrigger ........................................................................................................................ 123
Contents ........................................................................................................................ 123
See Also ........................................................................................................................ 123
Datastore ............................................................................................................................... 124
Contents ........................................................................................................................ 124
See Also ........................................................................................................................ 125
DatastoreActivity .................................................................................................................... 126
Contents ........................................................................................................................ 126
See Also ........................................................................................................................ 126
DatastoreStatistics .................................................................................................................. 127
Contents ........................................................................................................................ 127
See Also ........................................................................................................................ 127
DatastoreStorage .................................................................................................................... 128
Contents ........................................................................................................................ 128
See Also ........................................................................................................................ 128
DatastoreStorageSummary ...................................................................................................... 129
Contents ........................................................................................................................ 129
See Also ........................................................................................................................ 129
DatastoreSummary ................................................................................................................. 130
Contents ........................................................................................................................ 130
See Also ........................................................................................................................ 130
DeltaTime .............................................................................................................................. 132
Contents ........................................................................................................................ 132
See Also ........................................................................................................................ 132
DeviceRegistryEnrichActivity ..................................................................................................... 133
Contents ........................................................................................................................ 133
See Also ........................................................................................................................ 133
DeviceShadowEnrichActivity ..................................................................................................... 135
Contents ........................................................................................................................ 135
See Also ........................................................................................................................ 135
EstimatedResourceSize ............................................................................................................ 137
Contents ........................................................................................................................ 137
See Also ........................................................................................................................ 137
FilterActivity .......................................................................................................................... 138
Contents ........................................................................................................................ 138
See Also ........................................................................................................................ 138
GlueConﬁguration ................................................................................................................... 139
Contents ........................................................................................................................ 139
See Also ........................................................................................................................ 139
IotEventsDestinationConﬁguration ............................................................................................ 140
Contents ........................................................................................................................ 140
See Also ........................................................................................................................ 140
LambdaActivity ...................................................................................................................... 141
Contents ........................................................................................................................ 141
See Also ........................................................................................................................ 141
LoggingOptions ...................................................................................................................... 143
Contents ........................................................................................................................ 143
See Also ........................................................................................................................ 143
MathActivity .......................................................................................................................... 144
Contents ........................................................................................................................ 144
See Also ........................................................................................................................ 144
Message ................................................................................................................................ 145

API Version 2017-11-27

ix
AWS IoT Analytics AWS IoT Analytics Documentation

Contents ........................................................................................................................ 145

See Also ........................................................................................................................ 145
OutputFileUriValue ................................................................................................................. 146
Contents ........................................................................................................................ 146
See Also ........................................................................................................................ 146
Pipeline ................................................................................................................................. 147
Contents ........................................................................................................................ 147
See Also ........................................................................................................................ 147
PipelineActivity ....................................................................................................................... 149
Contents ........................................................................................................................ 149
See Also ........................................................................................................................ 150
PipelineSummary .................................................................................................................... 151
Contents ........................................................................................................................ 151
See Also ........................................................................................................................ 151
QueryFilter ............................................................................................................................ 152
Contents ........................................................................................................................ 152
See Also ........................................................................................................................ 152
RemoveAttributesActivity ......................................................................................................... 153
Contents ........................................................................................................................ 153
See Also ........................................................................................................................ 153
ReprocessingSummary ............................................................................................................. 154
Contents ........................................................................................................................ 154
See Also ........................................................................................................................ 154
ResourceConﬁguration ............................................................................................................ 155
Contents ........................................................................................................................ 155
See Also ........................................................................................................................ 155
RetentionPeriod ...................................................................................................................... 156
Contents ........................................................................................................................ 156
See Also ........................................................................................................................ 156
S3DestinationConﬁguration ..................................................................................................... 157
Contents ........................................................................................................................ 157
See Also ........................................................................................................................ 157
Schedule ............................................................................................................................... 159
Contents ........................................................................................................................ 159
See Also ........................................................................................................................ 159
SelectAttributesActivity ........................................................................................................... 160
Contents ........................................................................................................................ 160
See Also ........................................................................................................................ 160
ServiceManagedChannelS3Storage ............................................................................................ 161
Contents ........................................................................................................................ 161
See Also ........................................................................................................................ 161
ServiceManagedChannelS3StorageSummary .............................................................................. 162
Contents ........................................................................................................................ 162
See Also ........................................................................................................................ 162
ServiceManagedDatastoreS3Storage ......................................................................................... 163
Contents ........................................................................................................................ 163
See Also ........................................................................................................................ 163
ServiceManagedDatastoreS3StorageSummary ............................................................................ 164
Contents ........................................................................................................................ 164
See Also ........................................................................................................................ 164
SqlQueryDatasetAction ............................................................................................................ 165
Contents ........................................................................................................................ 165
See Also ........................................................................................................................ 165
Tag ....................................................................................................................................... 166
Contents ........................................................................................................................ 166
See Also ........................................................................................................................ 166
TriggeringDataset ................................................................................................................... 167

API Version 2017-11-27

x
AWS IoT Analytics AWS IoT Analytics Documentation

Contents ........................................................................................................................ 167

See Also ........................................................................................................................ 167
Variable ................................................................................................................................. 168
Contents ........................................................................................................................ 168
See Also ........................................................................................................................ 168
VersioningConﬁguration .......................................................................................................... 170
Contents ........................................................................................................................ 170
See Also ........................................................................................................................ 170
Common Parameters ...................................................................................................................... 171
Common Errors .............................................................................................................................. 173

API Version 2017-11-27

xi
AWS IoT Analytics AWS IoT Analytics Documentation

Welcome
AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them.
You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced
data exploration through integration with Jupyter Notebooks and data visualization through integration
with Amazon QuickSight.

Traditional analytics and business intelligence tools are designed to process structured data. IoT data
often comes from devices that record noisy processes (such as temperature, motion, or sound). As a
result the data from these devices can have signiﬁcant gaps, corrupted messages, and false readings that
must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of
other data from external sources.

AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics
ﬁlters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can
set up the service to collect only the data you need from your devices, apply mathematical transforms
to process the data, and enrich the data with device-speciﬁc metadata such as device type and location
before storing it. Then, you can analyze your data by running queries using the built-in SQL query
engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes
pre-built models for common IoT use cases so you can answer questions like which devices are about to
fail or which customers are at risk of abandoning their wearable devices.

This document was last published on July 16, 2019.

API Version 2017-11-27

1
AWS IoT Analytics AWS IoT Analytics Documentation

Actions
The following actions are supported:

• BatchPutMessage (p. 3)
• CancelPipelineReprocessing (p. 6)
• CreateChannel (p. 8)
• CreateDataset (p. 11)
• CreateDatasetContent (p. 16)
• CreateDatastore (p. 18)
• CreatePipeline (p. 21)
• DeleteChannel (p. 25)
• DeleteDataset (p. 27)
• DeleteDatasetContent (p. 29)
• DeleteDatastore (p. 31)
• DeletePipeline (p. 33)
• DescribeChannel (p. 35)
• DescribeDataset (p. 38)
• DescribeDatastore (p. 41)
• DescribeLoggingOptions (p. 44)
• DescribePipeline (p. 46)
• GetDatasetContent (p. 49)
• ListChannels (p. 52)
• ListDatasetContents (p. 54)
• ListDatasets (p. 57)
• ListDatastores (p. 60)
• ListPipelines (p. 62)
• ListTagsForResource (p. 64)
• PutLoggingOptions (p. 66)
• RunPipelineActivity (p. 68)
• SampleChannelData (p. 71)
• StartPipelineReprocessing (p. 73)
• TagResource (p. 76)
• UntagResource (p. 78)
• UpdateChannel (p. 80)
• UpdateDataset (p. 83)
• UpdateDatastore (p. 87)
• UpdatePipeline (p. 90)

API Version 2017-11-27

2
AWS IoT Analytics AWS IoT Analytics Documentation
BatchPutMessage

BatchPutMessage
Sends messages to a channel.

Request Syntax
POST /messages/batch HTTP/1.1
Content-type: application/json

{
"channelName": "string",
"messages": [
{
"messageId": "string",
"payload": blob
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

channelName (p. 3)

The name of the channel where the messages are sent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
messages (p. 3)

The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload":
"string"}'.

Note that the ﬁeld names of message payloads (data) that you send to AWS IoT Analytics:
• Must contain only alphanumeric characters and undescores (_); no other special characters are
allowed.
• Must begin with an alphabetic character or single underscore (_).
• Cannot contain hyphens (-).
• In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
• Cannot be greater than 255 characters.
• Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered
duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or
{"__temp_01": 29} are invalid in message payloads.

API Version 2017-11-27

3
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Type: Array of Message (p. 145) objects

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"batchPutMessageErrorEntries": [
{
"errorCode": "string",
"errorMessage": "string",
"messageId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

batchPutMessageErrorEntries (p. 4)

A list of any errors encountered when sending the messages to the channel.

Type: Array of BatchPutMessageErrorEntry (p. 96) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

API Version 2017-11-27

4
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V2

API Version 2017-11-27

5
AWS IoT Analytics AWS IoT Analytics Documentation
CancelPipelineReprocessing

CancelPipelineReprocessing
Cancels the reprocessing of data through the pipeline.

Request Syntax
DELETE /pipelines/pipelineName/reprocessing/reprocessingId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

pipelineName (p. 6)

The name of pipeline for which data reprocessing is canceled.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
reprocessingId (p. 6)

The ID of the reprocessing task (returned by "StartPipelineReprocessing").

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

API Version 2017-11-27

6
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

7
AWS IoT Analytics AWS IoT Analytics Documentation
CreateChannel

CreateChannel
Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed
messages before publishing the data to a pipeline.

Request Syntax
POST /channels HTTP/1.1
Content-type: application/json

{
"channelName": "string",
"channelStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

channelName (p. 8)

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
channelStorage (p. 8)

Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3"
storage. If not speciﬁed, the default is "serviceManagedS3". This cannot be changed after creation of
the channel.

API Version 2017-11-27

8
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Type: ChannelStorage (p. 101) object

Required: No
retentionPeriod (p. 8)

How long, in days, message data is kept for the channel. When "customerManagedS3" storage is
selected, this parameter is ignored.

Type: RetentionPeriod (p. 156) object

Required: No
tags (p. 8)

Metadata which can be used to manage the channel.

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"channelArn": "string",
"channelName": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

channelArn (p. 9)

The ARN of the channel.

Type: String
channelName (p. 9)

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
retentionPeriod (p. 9)

How long, in days, message data is kept for the channel.

API Version 2017-11-27

9
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

Type: RetentionPeriod (p. 156) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceAlreadyExistsException

A resource with the same name already exists.

HTTP Status Code: 409

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

10
AWS IoT Analytics AWS IoT Analytics Documentation
CreateDataset

CreateDataset
Creates a data set. A data set 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 data set. The data set can be populated manually by calling "CreateDatasetContent" or
automatically according to a "trigger" you specify.

Request Syntax
POST /datasets HTTP/1.1
Content-type: application/json

{
"actions": [
{
"actionName": "string",
"containerAction": {
"executionRoleArn": "string",
"image": "string",
"resourceConfiguration": {
"computeType": "string",
"volumeSizeInGB": number
},
"variables": [
{
"datasetContentVersionValue": {
"datasetName": "string"
},
"doubleValue": number,
"name": "string",
"outputFileUriValue": {
"fileName": "string"
},
"stringValue": "string"
}
]
},
"queryAction": {
"filters": [
{
"deltaTime": {
"offsetSeconds": number,
"timeExpression": "string"
}
}
],
"sqlQuery": "string"
}
}
],
"contentDeliveryRules": [
{
"destination": {
"iotEventsDestinationConfiguration": {
"inputName": "string",
"roleArn": "string"
},
"s3DestinationConfiguration": {
"bucket": "string",
"glueConfiguration": {
"databaseName": "string",
"tableName": "string"

API Version 2017-11-27

11
AWS IoT Analytics AWS IoT Analytics Documentation
URI Request Parameters

},
"key": "string",
"roleArn": "string"
}
},
"entryName": "string"
}
],
"datasetName": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"tags": [
{
"key": "string",
"value": "string"
}
],
"triggers": [
{
"dataset": {
"name": "string"
},
"schedule": {
"expression": "string"
}
}
],
"versioningConfiguration": {
"maxVersions": number,
"unlimited": boolean
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

actions (p. 11)

A list of actions that create the data set contents.

Type: Array of DatasetAction (p. 113) objects

Array Members: Fixed number of 1 item.

Required: Yes
contentDeliveryRules (p. 11)

When data set contents are created they are delivered to destinations speciﬁed here.

Type: Array of DatasetContentDeliveryRule (p. 116) objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No

API Version 2017-11-27

12
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

datasetName (p. 11)

The name of the data set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
retentionPeriod (p. 11)

[Optional] How long, in days, versions of data set contents are kept for the data set. If not speciﬁed
or set to null, versions of data set contents are retained for at most 90 days. The number of versions
of data set contents retained is determined by the versioningConfiguration parameter.
(For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-
started.html#aws-iot-analytics-dataset-versions)

Type: RetentionPeriod (p. 156) object

Required: No
tags (p. 11)

Metadata which can be used to manage the data set.

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No
triggers (p. 11)

A list of triggers. A trigger causes data set contents to be populated at a speciﬁed time interval or
when another data set's contents are created. The list of triggers can be empty or contain up to ﬁve
DataSetTrigger objects.

Type: Array of DatasetTrigger (p. 123) objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No
versioningConﬁguration (p. 11)

[Optional] How many versions of data set contents are kept. If not specified or set to null,
only the latest version plus the latest succeeded version (if they are different) are kept for the
time period specified by the "retentionPeriod" parameter. (For more information, see https://
docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-
dataset-versions)

Type: VersioningConﬁguration (p. 170) object

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

API Version 2017-11-27

13
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

{
"datasetArn": "string",
"datasetName": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

datasetArn (p. 13)

The ARN of the data set.

Type: String
datasetName (p. 13)

The name of the data set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
retentionPeriod (p. 13)

How long, in days, data set contents are kept for the data set.

Type: RetentionPeriod (p. 156) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceAlreadyExistsException

A resource with the same name already exists.

API Version 2017-11-27

14
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 409

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

15
AWS IoT Analytics AWS IoT Analytics Documentation
CreateDatasetContent

CreateDatasetContent
Creates the content of a data set by applying a "queryAction" (a SQL query) or a
"containerAction" (executing a containerized application).

Request Syntax
POST /datasets/datasetName/content HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 16)

The name of the data set.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"versionId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

versionId (p. 16)

The version ID of the data set contents which are being created.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 36.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

API Version 2017-11-27

16
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

17
AWS IoT Analytics AWS IoT Analytics Documentation
CreateDatastore

CreateDatastore
Creates a data store, which is a repository for messages.

Request Syntax
POST /datastores HTTP/1.1
Content-type: application/json

{
"datastoreName": "string",
"datastoreStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

datastoreName (p. 18)

The name of the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
datastoreStorage (p. 18)

Where data store data is stored. You may choose one of "serviceManagedS3" or
"customerManagedS3" storage. If not speciﬁed, the default is "serviceManagedS3". This cannot be
changed after the data store is created.

Type: DatastoreStorage (p. 128) object

API Version 2017-11-27

18
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Required: No
retentionPeriod (p. 18)

How long, in days, message data is kept for the data store. When "customerManagedS3" storage is
selected, this parameter is ignored.

Type: RetentionPeriod (p. 156) object

Required: No
tags (p. 18)

Metadata which can be used to manage the data store.

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"datastoreArn": "string",
"datastoreName": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

datastoreArn (p. 19)

The ARN of the data store.

Type: String
datastoreName (p. 19)

The name of the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
retentionPeriod (p. 19)

How long, in days, message data is kept for the data store.

Type: RetentionPeriod (p. 156) object

API Version 2017-11-27

19
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceAlreadyExistsException

A resource with the same name already exists.

HTTP Status Code: 409

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

20
AWS IoT Analytics AWS IoT Analytics Documentation
CreatePipeline

CreatePipeline
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 datastore
activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

Request Syntax
POST /pipelines HTTP/1.1
Content-type: application/json

{
"pipelineActivities": [
{
"addAttributes": {
"attributes": {
"string" : "string"
},
"name": "string",
"next": "string"
},
"channel": {
"channelName": "string",
"name": "string",
"next": "string"
},
"datastore": {
"datastoreName": "string",
"name": "string"
},
"deviceRegistryEnrich": {
"attribute": "string",
"name": "string",
"next": "string",
"roleArn": "string",
"thingName": "string"
},
"deviceShadowEnrich": {
"attribute": "string",
"name": "string",
"next": "string",
"roleArn": "string",
"thingName": "string"
},
"filter": {
"filter": "string",
"name": "string",
"next": "string"
},
"lambda": {
"batchSize": number,
"lambdaName": "string",
"name": "string",
"next": "string"
},
"math": {
"attribute": "string",
"math": "string",
"name": "string",
"next": "string"
},
"removeAttributes": {

API Version 2017-11-27

21
AWS IoT Analytics AWS IoT Analytics Documentation
URI Request Parameters

"attributes": [ "string" ],
"name": "string",
"next": "string"
},
"selectAttributes": {
"attributes": [ "string" ],
"name": "string",
"next": "string"
}
}
],
"pipelineName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

pipelineActivities (p. 21)

A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as

removing, renaming or adding message attributes; ﬁltering messages based on attribute values;
invoking your Lambda functions on messages for advanced processing; or performing mathematical
transformations to normalize device data.

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore
activity. Each entry in the list must contain only one activity, for example:

pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

Type: Array of PipelineActivity (p. 149) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes
pipelineName (p. 21)

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
tags (p. 21)

Metadata which can be used to manage the pipeline.

API Version 2017-11-27

22
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax
HTTP/1.1 201
Content-type: application/json

{
"pipelineArn": "string",
"pipelineName": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

pipelineArn (p. 23)

The ARN of the pipeline.

Type: String
pipelineName (p. 23)

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

API Version 2017-11-27

23
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

ResourceAlreadyExistsException

A resource with the same name already exists.

HTTP Status Code: 409

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

24
AWS IoT Analytics AWS IoT Analytics Documentation
DeleteChannel

DeleteChannel
Deletes the speciﬁed channel.

Request Syntax
DELETE /channels/channelName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

channelName (p. 25)

The name of the channel to delete.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

API Version 2017-11-27

25
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

26
AWS IoT Analytics AWS IoT Analytics Documentation
DeleteDataset

DeleteDataset
Deletes the speciﬁed data set.

You do not have to delete the content of the data set before you perform this operation.

Request Syntax
DELETE /datasets/datasetName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 27)

The name of the data set to delete.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

API Version 2017-11-27

27
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

28
AWS IoT Analytics AWS IoT Analytics Documentation
DeleteDatasetContent

DeleteDatasetContent
Deletes the content of the speciﬁed data set.

Request Syntax
DELETE /datasets/datasetName/content?versionId=versionId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 29)

The name of the data set whose content is deleted.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
versionId (p. 29)

The version of the data set whose content is deleted. You can also use the strings "$LATEST"
or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not
speciﬁed, "$LATEST_SUCCEEDED" is the default.

Length Constraints: Minimum length of 7. Maximum length of 36.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

API Version 2017-11-27

29
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

30
AWS IoT Analytics AWS IoT Analytics Documentation
DeleteDatastore

DeleteDatastore
Deletes the speciﬁed data store.

Request Syntax
DELETE /datastores/datastoreName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datastoreName (p. 31)

The name of the data store to delete.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

API Version 2017-11-27

31
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

32
AWS IoT Analytics AWS IoT Analytics Documentation
DeletePipeline

DeletePipeline
Deletes the speciﬁed pipeline.

Request Syntax
DELETE /pipelines/pipelineName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

pipelineName (p. 33)

The name of the pipeline to delete.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

API Version 2017-11-27

33
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

34
AWS IoT Analytics AWS IoT Analytics Documentation
DescribeChannel

DescribeChannel
Retrieves information about a channel.

Request Syntax
GET /channels/channelName?includeStatistics=includeStatistics HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

channelName (p. 35)

The name of the channel whose information is retrieved.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
includeStatistics (p. 35)

If true, additional statistical information about the channel is included in the response. This feature
cannot be used with a channel whose S3 storage is customer-managed.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"channel": {
"arn": "string",
"creationTime": number,
"lastUpdateTime": number,
"name": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"status": "string",
"storage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
}
},
"statistics": {
"size": {

API Version 2017-11-27

35
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

"estimatedOn": number,
"estimatedSizeInBytes": number
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

channel (p. 35)

An object that contains information about the channel.

Type: Channel (p. 97) object

statistics (p. 35)

Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.

Type: ChannelStatistics (p. 100) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2017-11-27

36
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS Command Line Interface

API Version 2017-11-27

37
AWS IoT Analytics AWS IoT Analytics Documentation
DescribeDataset

DescribeDataset
Retrieves information about a data set.

Request Syntax
GET /datasets/datasetName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 38)

The name of the data set whose information is retrieved.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"dataset": {
"actions": [
{
"actionName": "string",
"containerAction": {
"executionRoleArn": "string",
"image": "string",
"resourceConfiguration": {
"computeType": "string",
"volumeSizeInGB": number
},
"variables": [
{
"datasetContentVersionValue": {
"datasetName": "string"
},
"doubleValue": number,
"name": "string",
"outputFileUriValue": {
"fileName": "string"
},
"stringValue": "string"
}
]
},

API Version 2017-11-27

38
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

"queryAction": {
"filters": [
{
"deltaTime": {
"offsetSeconds": number,
"timeExpression": "string"
}
}
],
"sqlQuery": "string"
}
}
],
"arn": "string",
"contentDeliveryRules": [
{
"destination": {
"iotEventsDestinationConfiguration": {
"inputName": "string",
"roleArn": "string"
},
"s3DestinationConfiguration": {
"bucket": "string",
"glueConfiguration": {
"databaseName": "string",
"tableName": "string"
},
"key": "string",
"roleArn": "string"
}
},
"entryName": "string"
}
],
"creationTime": number,
"lastUpdateTime": number,
"name": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"status": "string",
"triggers": [
{
"dataset": {
"name": "string"
},
"schedule": {
"expression": "string"
}
}
],
"versioningConfiguration": {
"maxVersions": number,
"unlimited": boolean
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

API Version 2017-11-27

39
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

dataset (p. 38)

An object that contains information about the data set.

Type: Dataset (p. 111) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

40
AWS IoT Analytics AWS IoT Analytics Documentation
DescribeDatastore

DescribeDatastore
Retrieves information about a data store.

Request Syntax
GET /datastores/datastoreName?includeStatistics=includeStatistics HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datastoreName (p. 41)

The name of the data store

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
includeStatistics (p. 41)

If true, additional statistical information about the data store is included in the response. This
feature cannot be used with a data store whose S3 storage is customer-managed.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"datastore": {
"arn": "string",
"creationTime": number,
"lastUpdateTime": number,
"name": "string",
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"status": "string",
"storage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
}
},
"statistics": {
"size": {

API Version 2017-11-27

41
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

"estimatedOn": number,
"estimatedSizeInBytes": number
}
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

datastore (p. 41)

Information about the data store.

Type: Datastore (p. 124) object

statistics (p. 41)

Additional statistical information about the data store. Included if the 'includeStatistics' parameter is
set to true in the request.

Type: DatastoreStatistics (p. 127) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2017-11-27

42
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS Command Line Interface

API Version 2017-11-27

43
AWS IoT Analytics AWS IoT Analytics Documentation
DescribeLoggingOptions

DescribeLoggingOptions
Retrieves the current settings of the AWS IoT Analytics logging options.

Request Syntax
GET /logging HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"loggingOptions": {
"enabled": boolean,
"level": "string",
"roleArn": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

loggingOptions (p. 44)

The current settings of the AWS IoT Analytics logging options.

Type: LoggingOptions (p. 143) object

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

API Version 2017-11-27

44
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

45
AWS IoT Analytics AWS IoT Analytics Documentation
DescribePipeline

DescribePipeline
Retrieves information about a pipeline.

Request Syntax
GET /pipelines/pipelineName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

pipelineName (p. 46)

The name of the pipeline whose information is retrieved.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"pipeline": {
"activities": [
{
"addAttributes": {
"attributes": {
"string" : "string"
},
"name": "string",
"next": "string"
},
"channel": {
"channelName": "string",
"name": "string",
"next": "string"
},
"datastore": {
"datastoreName": "string",
"name": "string"
},
"deviceRegistryEnrich": {
"attribute": "string",
"name": "string",
"next": "string",
"roleArn": "string",
"thingName": "string"

API Version 2017-11-27

46
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

},
"deviceShadowEnrich": {
"attribute": "string",
"name": "string",
"next": "string",
"roleArn": "string",
"thingName": "string"
},
"filter": {
"filter": "string",
"name": "string",
"next": "string"
},
"lambda": {
"batchSize": number,
"lambdaName": "string",
"name": "string",
"next": "string"
},
"math": {
"attribute": "string",
"math": "string",
"name": "string",
"next": "string"
},
"removeAttributes": {
"attributes": [ "string" ],
"name": "string",
"next": "string"
},
"selectAttributes": {
"attributes": [ "string" ],
"name": "string",
"next": "string"
}
}
],
"arn": "string",
"creationTime": number,
"lastUpdateTime": number,
"name": "string",
"reprocessingSummaries": [
{
"creationTime": number,
"id": "string",
"status": "string"
}
]
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipeline (p. 46)

A "Pipeline" object that contains information about the pipeline.

Type: Pipeline (p. 147) object

API Version 2017-11-27

47
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

48
AWS IoT Analytics AWS IoT Analytics Documentation
GetDatasetContent

GetDatasetContent
Retrieves the contents of a data set as pre-signed URIs.

Request Syntax
GET /datasets/datasetName/content?versionId=versionId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 49)

The name of the data set whose contents are retrieved.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
versionId (p. 49)

The version of the data set whose contents are retrieved. You can also use the strings "$LATEST" or
"$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed data
set. If not speciﬁed, "$LATEST_SUCCEEDED" is the default.

Length Constraints: Minimum length of 7. Maximum length of 36.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"entries": [
{
"dataURI": "string",
"entryName": "string"
}
],
"status": {
"reason": "string",
"state": "string"
},
"timestamp": number
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2017-11-27

49
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

The following data is returned in JSON format by the service.

entries (p. 49)

A list of "DatasetEntry" objects.

Type: Array of DatasetEntry (p. 120) objects

status (p. 49)

The status of the data set content.

Type: DatasetContentStatus (p. 117) object

timestamp (p. 49)

The time when the request was made.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

API Version 2017-11-27

50
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Go

• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V2

API Version 2017-11-27

51
AWS IoT Analytics AWS IoT Analytics Documentation
ListChannels

ListChannels
Retrieves a list of channels.

Request Syntax
GET /channels?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults (p. 52)

The maximum number of results to return in this request.

The default value is 100.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 52)

The token for the next set of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"channelSummaries": [
{
"channelName": "string",
"channelStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"creationTime": number,
"lastUpdateTime": number,
"status": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2017-11-27

52
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

The following data is returned in JSON format by the service.

channelSummaries (p. 52)

A list of "ChannelSummary" objects.

Type: Array of ChannelSummary (p. 103) objects

nextToken (p. 52)

The token to retrieve the next set of results, or null if there are no more results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

53
AWS IoT Analytics AWS IoT Analytics Documentation
ListDatasetContents

ListDatasetContents
Lists information about data set contents that have been created.

Request Syntax
GET /datasets/datasetName/contents?
maxResults=maxResults&nextToken=nextToken&scheduledBefore=scheduledBefore&scheduledOnOrAfter=scheduledO
HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 54)

The name of the data set whose contents information you want to list.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
maxResults (p. 54)

The maximum number of results to return in this request.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 54)

The token for the next set of results.

scheduledBefore (p. 54)

A ﬁlter to limit results to those data set contents whose creation is scheduled before the given time.
See the ﬁeld triggers.schedule in the CreateDataset request. (timestamp)
scheduledOnOrAfter (p. 54)

A ﬁlter to limit results to those data set contents whose creation is scheduled on or after the given
time. See the ﬁeld triggers.schedule in the CreateDataset request. (timestamp)

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"datasetContentSummaries": [
{
"creationTime": number,
"scheduleTime": number,

API Version 2017-11-27

54
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

"status": {
"reason": "string",
"state": "string"
},
"version": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

datasetContentSummaries (p. 54)

Summary information about data set contents that have been created.

Type: Array of DatasetContentSummary (p. 118) objects

nextToken (p. 54)

The token to retrieve the next set of results, or null if there are no more results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

API Version 2017-11-27

55
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

56
AWS IoT Analytics AWS IoT Analytics Documentation
ListDatasets

ListDatasets
Retrieves information about data sets.

Request Syntax
GET /datasets?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults (p. 57)

The maximum number of results to return in this request.

The default value is 100.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 57)

The token for the next set of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"datasetSummaries": [
{
"actions": [
{
"actionName": "string",
"actionType": "string"
}
],
"creationTime": number,
"datasetName": "string",
"lastUpdateTime": number,
"status": "string",
"triggers": [
{
"dataset": {
"name": "string"
},
"schedule": {
"expression": "string"
}
}
]
}

API Version 2017-11-27

57
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

datasetSummaries (p. 57)

A list of "DatasetSummary" objects.

Type: Array of DatasetSummary (p. 121) objects

nextToken (p. 57)

The token to retrieve the next set of results, or null if there are no more results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

API Version 2017-11-27

58
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Go - Pilot

• AWS SDK for Java
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V2

API Version 2017-11-27

59
AWS IoT Analytics AWS IoT Analytics Documentation
ListDatastores

ListDatastores
Retrieves a list of data stores.

Request Syntax
GET /datastores?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults (p. 60)

The maximum number of results to return in this request.

The default value is 100.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 60)

The token for the next set of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"datastoreSummaries": [
{
"creationTime": number,
"datastoreName": "string",
"datastoreStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"lastUpdateTime": number,
"status": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2017-11-27

60
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

The following data is returned in JSON format by the service.

datastoreSummaries (p. 60)

A list of "DatastoreSummary" objects.

Type: Array of DatastoreSummary (p. 130) objects

nextToken (p. 60)

The token to retrieve the next set of results, or null if there are no more results.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

61
AWS IoT Analytics AWS IoT Analytics Documentation
ListPipelines

ListPipelines
Retrieves a list of pipelines.

Request Syntax
GET /pipelines?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

maxResults (p. 62)

The maximum number of results to return in this request.

The default value is 100.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 62)

The token for the next set of results.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"nextToken": "string",
"pipelineSummaries": [
{
"creationTime": number,
"lastUpdateTime": number,
"pipelineName": "string",
"reprocessingSummaries": [
{
"creationTime": number,
"id": "string",
"status": "string"
}
]
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

API Version 2017-11-27

62
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

The following data is returned in JSON format by the service.

nextToken (p. 62)

The token to retrieve the next set of results, or null if there are no more results.

Type: String
pipelineSummaries (p. 62)

A list of "PipelineSummary" objects.

Type: Array of PipelineSummary (p. 151) objects

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

63
AWS IoT Analytics AWS IoT Analytics Documentation
ListTagsForResource

ListTagsForResource
Lists the tags (metadata) which you have assigned to the resource.

Request Syntax
GET /tags?resourceArn=resourceArn HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

resourceArn (p. 64)

The ARN of the resource whose tags you want to list.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"tags": [
{
"key": "string",
"value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

tags (p. 64)

The tags (metadata) which you have assigned to the resource.

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

API Version 2017-11-27

64
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

65
AWS IoT Analytics AWS IoT Analytics Documentation
PutLoggingOptions

PutLoggingOptions
Sets or updates the AWS IoT Analytics logging options.

Note that if you update the value of any loggingOptions field, it takes 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 takes up to 5 minutes for that change to take effect.

Request Syntax
PUT /logging HTTP/1.1
Content-type: application/json

{
"loggingOptions": {
"enabled": boolean,
"level": "string",
"roleArn": "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

loggingOptions (p. 66)

The new values of the AWS IoT Analytics logging options.

Type: LoggingOptions (p. 143) object

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

API Version 2017-11-27

66
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

67
AWS IoT Analytics AWS IoT Analytics Documentation
RunPipelineActivity

RunPipelineActivity
Simulates the results of running a pipeline activity on a message payload.

Request Syntax
POST /pipelineactivities/run HTTP/1.1
Content-type: application/json

{
"payloads": [ blob ],
"pipelineActivity": {
"addAttributes": {
"attributes": {
"string" : "string"
},
"name": "string",
"next": "string"
},
"channel": {
"channelName": "string",
"name": "string",
"next": "string"
},
"datastore": {
"datastoreName": "string",
"name": "string"
},
"deviceRegistryEnrich": {
"attribute": "string",
"name": "string",
"next": "string",
"roleArn": "string",
"thingName": "string"
},
"deviceShadowEnrich": {
"attribute": "string",
"name": "string",
"next": "string",
"roleArn": "string",
"thingName": "string"
},
"filter": {
"filter": "string",
"name": "string",
"next": "string"
},
"lambda": {
"batchSize": number,
"lambdaName": "string",
"name": "string",
"next": "string"
},
"math": {
"attribute": "string",
"math": "string",
"name": "string",
"next": "string"
},
"removeAttributes": {
"attributes": [ "string" ],
"name": "string",
"next": "string"

API Version 2017-11-27

68
AWS IoT Analytics AWS IoT Analytics Documentation
URI Request Parameters

},
"selectAttributes": {
"attributes": [ "string" ],
"name": "string",
"next": "string"
}
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

payloads (p. 68)

The sample message payloads on which the pipeline activity is run.

Type: Array of Base64-encoded binary data objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes
pipelineActivity (p. 68)

The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because
these activities are used in a pipeline only to load the original message and to store the (possibly)
transformed message. If a 'lambda' activity is speciﬁed, only short-running Lambda functions (those
with a timeout of less than 30 seconds or less) can be used.

Type: PipelineActivity (p. 149) object

Required: Yes

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"logResult": "string",
"payloads": [ blob ]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

logResult (p. 69)

In case the pipeline activity fails, the log message that is generated.

API Version 2017-11-27

69
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

Type: String
payloads (p. 69)

The enriched or transformed sample message payloads as base64-encoded strings. (The results of
running the pipeline activity on each input sample message payload, encoded in base64.)

Type: Array of Base64-encoded binary data objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

70
AWS IoT Analytics AWS IoT Analytics Documentation
SampleChannelData

SampleChannelData
Retrieves a sample of messages from the speciﬁed channel ingested during the speciﬁed timeframe. Up
to 10 messages can be retrieved.

Request Syntax
GET /channels/channelName/sample?
endTime=endTime&maxMessages=maxMessages&startTime=startTime HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

channelName (p. 71)

The name of the channel whose message samples are retrieved.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$
endTime (p. 71)

The end of the time window from which sample messages are retrieved.
maxMessages (p. 71)

The number of sample messages to be retrieved. The limit is 10, the default is also 10.

Valid Range: Minimum value of 1. Maximum value of 10.

startTime (p. 71)

The start of the time window from which sample messages are retrieved.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"payloads": [ blob ]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

API Version 2017-11-27

71
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

payloads (p. 71)

The list of message samples. Each sample message is returned as a base64-encoded string.

Type: Array of Base64-encoded binary data objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

72
AWS IoT Analytics AWS IoT Analytics Documentation
StartPipelineReprocessing

StartPipelineReprocessing
Starts the reprocessing of raw message data through the pipeline.

Request Syntax
POST /pipelines/pipelineName/reprocessing HTTP/1.1
Content-type: application/json

{
"endTime": number,
"startTime": number
}

URI Request Parameters

The request requires the following URI parameters.

pipelineName (p. 73)

The name of the pipeline on which to start reprocessing.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request accepts the following data in JSON format.

endTime (p. 73)

The end time (exclusive) of raw message data that is reprocessed.

Type: Timestamp

Required: No
startTime (p. 73)

The start time (inclusive) of raw message data that is reprocessed.

Type: Timestamp

Required: No

Response Syntax
HTTP/1.1 200
Content-type: application/json

{
"reprocessingId": "string"
}

API Version 2017-11-27

73
AWS IoT Analytics AWS IoT Analytics Documentation
Response Elements

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

reprocessingId (p. 73)

The ID of the pipeline reprocessing activity that was started.

Type: String

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceAlreadyExistsException

A resource with the same name already exists.

HTTP Status Code: 409

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

API Version 2017-11-27

74
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Go - Pilot

• AWS SDK for Java
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V2

API Version 2017-11-27

75
AWS IoT Analytics AWS IoT Analytics Documentation
TagResource

TagResource
Adds to or modiﬁes the tags of the given resource. Tags are metadata which can be used to manage a
resource.

Request Syntax
POST /tags?resourceArn=resourceArn HTTP/1.1
Content-type: application/json

{
"tags": [
{
"key": "string",
"value": "string"
}
]
}

URI Request Parameters

The request requires the following URI parameters.

resourceArn (p. 76)

The ARN of the resource whose tags you want to modify.

Length Constraints: Minimum length of 20. Maximum length of 2048.

Request Body
The request accepts the following data in JSON format.

tags (p. 76)

The new or modiﬁed tags for the resource.

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

API Version 2017-11-27

76
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

77
AWS IoT Analytics AWS IoT Analytics Documentation
UntagResource

UntagResource
Removes the given tags (metadata) from the resource.

Request Syntax
DELETE /tags?resourceArn=resourceArn&tagKeys=tagKeys HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

resourceArn (p. 78)

The ARN of the resource whose tags you want to remove.

Length Constraints: Minimum length of 20. Maximum length of 2048.

tagKeys (p. 78)

The keys of those tags which you want to remove.

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Request Body
The request does not have a request body.

Response Syntax
HTTP/1.1 204

Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

API Version 2017-11-27

78
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

79
AWS IoT Analytics AWS IoT Analytics Documentation
UpdateChannel

UpdateChannel
Updates the settings of a channel.

Request Syntax
PUT /channels/channelName HTTP/1.1
Content-type: application/json

{
"channelStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}

URI Request Parameters

The request requires the following URI parameters.

channelName (p. 80)

The name of the channel to be updated.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request accepts the following data in JSON format.

channelStorage (p. 80)

Type: ChannelStorage (p. 101) object

Required: No
retentionPeriod (p. 80)

How long, in days, message data is kept for the channel. The retention period cannot be updated if
the channel's S3 storage is customer-managed.

Type: RetentionPeriod (p. 156) object

API Version 2017-11-27

80
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Required: No

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for JavaScript
• AWS SDK for PHP V3

API Version 2017-11-27

81
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Python

• AWS SDK for Ruby V2

API Version 2017-11-27

82
AWS IoT Analytics AWS IoT Analytics Documentation
UpdateDataset

UpdateDataset
Updates the settings of a data set.

Request Syntax
PUT /datasets/datasetName HTTP/1.1
Content-type: application/json

API Version 2017-11-27

83
AWS IoT Analytics AWS IoT Analytics Documentation
URI Request Parameters

},
"entryName": "string"
}
],
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
},
"triggers": [
{
"dataset": {
"name": "string"
},
"schedule": {
"expression": "string"
}
}
],
"versioningConfiguration": {
"maxVersions": number,
"unlimited": boolean
}
}

URI Request Parameters

The request requires the following URI parameters.

datasetName (p. 83)

The name of the data set to update.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request accepts the following data in JSON format.

actions (p. 83)

A list of "DatasetAction" objects.

Type: Array of DatasetAction (p. 113) objects

Array Members: Fixed number of 1 item.

Required: Yes
contentDeliveryRules (p. 83)

When data set contents are created they are delivered to destinations speciﬁed here.

Type: Array of DatasetContentDeliveryRule (p. 116) objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No
retentionPeriod (p. 83)

How long, in days, data set contents are kept for the data set.

API Version 2017-11-27

84
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Type: RetentionPeriod (p. 156) object

Required: No
triggers (p. 83)

A list of "DatasetTrigger" objects. The list can be empty or can contain up to ﬁve DataSetTrigger
objects.

Type: Array of DatasetTrigger (p. 123) objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No
versioningConﬁguration (p. 83)

Type: VersioningConﬁguration (p. 170) object

Required: No

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

API Version 2017-11-27

85
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

86
AWS IoT Analytics AWS IoT Analytics Documentation
UpdateDatastore

UpdateDatastore
Updates the settings of a data store.

Request Syntax
PUT /datastores/datastoreName HTTP/1.1
Content-type: application/json

{
"datastoreStorage": {
"customerManagedS3": {
"bucket": "string",
"keyPrefix": "string",
"roleArn": "string"
},
"serviceManagedS3": {
}
},
"retentionPeriod": {
"numberOfDays": number,
"unlimited": boolean
}
}

URI Request Parameters

The request requires the following URI parameters.

datastoreName (p. 87)

The name of the data store to be updated.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request accepts the following data in JSON format.

datastoreStorage (p. 87)

Type: DatastoreStorage (p. 128) object

Required: No
retentionPeriod (p. 87)

How long, in days, message data is kept for the data store. The retention period cannot be updated
if the data store's S3 storage is customer-managed.

Type: RetentionPeriod (p. 156) object

API Version 2017-11-27

87
AWS IoT Analytics AWS IoT Analytics Documentation
Response Syntax

Required: No

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for JavaScript
• AWS SDK for PHP V3

API Version 2017-11-27

88
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Python

• AWS SDK for Ruby V2

API Version 2017-11-27

89
AWS IoT Analytics AWS IoT Analytics Documentation
UpdatePipeline

UpdatePipeline
Updates the settings of a pipeline. You must specify both a channel and a datastore activity and,
optionally, as many as 23 additional activities in the pipelineActivities array.

Request Syntax
PUT /pipelines/pipelineName HTTP/1.1
Content-type: application/json

API Version 2017-11-27

90
AWS IoT Analytics AWS IoT Analytics Documentation
URI Request Parameters

"name": "string",
"next": "string"
},
"selectAttributes": {
"attributes": [ "string" ],
"name": "string",
"next": "string"
}
}
]
}

URI Request Parameters

The request requires the following URI parameters.

pipelineName (p. 90)

The name of the pipeline to update.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body
The request accepts the following data in JSON format.

pipelineActivities (p. 90)

A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore
activity. Each entry in the list must contain only one activity, for example:

pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]

Type: Array of PipelineActivity (p. 149) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: Yes

Response Syntax
HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

API Version 2017-11-27

91
AWS IoT Analytics AWS IoT Analytics Documentation
Errors

Errors
For information about the errors that are common to all actions, see Common Errors (p. 173).

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410

ResourceNotFoundException

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS Command Line Interface

API Version 2017-11-27

92
AWS IoT Analytics AWS IoT Analytics Documentation

Data Types
The AWS IoT Analytics API contains several data types that various actions use. This section describes
each data type in detail.
Note
The order of each element in a data type structure is not guaranteed. Applications should not
assume a particular order.

The following data types are supported:

• AddAttributesActivity (p. 95)

• BatchPutMessageErrorEntry (p. 96)
• Channel (p. 97)
• ChannelActivity (p. 99)
• ChannelStatistics (p. 100)
• ChannelStorage (p. 101)
• ChannelStorageSummary (p. 102)
• ChannelSummary (p. 103)
• ContainerDatasetAction (p. 105)
• CustomerManagedChannelS3Storage (p. 107)
• CustomerManagedChannelS3StorageSummary (p. 108)
• CustomerManagedDatastoreS3Storage (p. 109)
• CustomerManagedDatastoreS3StorageSummary (p. 110)
• Dataset (p. 111)
• DatasetAction (p. 113)
• DatasetActionSummary (p. 114)
• DatasetContentDeliveryDestination (p. 115)
• DatasetContentDeliveryRule (p. 116)
• DatasetContentStatus (p. 117)
• DatasetContentSummary (p. 118)
• DatasetContentVersionValue (p. 119)
• DatasetEntry (p. 120)
• DatasetSummary (p. 121)
• DatasetTrigger (p. 123)
• Datastore (p. 124)
• DatastoreActivity (p. 126)
• DatastoreStatistics (p. 127)
• DatastoreStorage (p. 128)
• DatastoreStorageSummary (p. 129)
• DatastoreSummary (p. 130)
• DeltaTime (p. 132)
• DeviceRegistryEnrichActivity (p. 133)
• DeviceShadowEnrichActivity (p. 135)
• EstimatedResourceSize (p. 137)
• FilterActivity (p. 138)

API Version 2017-11-27

93
AWS IoT Analytics AWS IoT Analytics Documentation

• GlueConﬁguration (p. 139)

• IotEventsDestinationConfiguration (p. 140)
• LambdaActivity (p. 141)
• LoggingOptions (p. 143)
• MathActivity (p. 144)
• Message (p. 145)
• OutputFileUriValue (p. 146)
• Pipeline (p. 147)
• PipelineActivity (p. 149)
• PipelineSummary (p. 151)
• QueryFilter (p. 152)
• RemoveAttributesActivity (p. 153)
• ReprocessingSummary (p. 154)
• ResourceConfiguration (p. 155)
• RetentionPeriod (p. 156)
• S3DestinationConfiguration (p. 157)
• Schedule (p. 159)
• SelectAttributesActivity (p. 160)
• ServiceManagedChannelS3Storage (p. 161)
• ServiceManagedChannelS3StorageSummary (p. 162)
• ServiceManagedDatastoreS3Storage (p. 163)
• ServiceManagedDatastoreS3StorageSummary (p. 164)
• SqlQueryDatasetAction (p. 165)
• Tag (p. 166)
• TriggeringDataset (p. 167)
• Variable (p. 168)
• VersioningConfiguration (p. 170)

API Version 2017-11-27

94
AWS IoT Analytics AWS IoT Analytics Documentation
AddAttributesActivity

AddAttributesActivity
An activity that adds other attributes based on existing attributes in the message.

Contents
attributes

A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.
Note
The existing attributes remain in the message, so if you want to remove the originals, use
"RemoveAttributeActivity".

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 256.

Value Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'addAttributes' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

95
AWS IoT Analytics AWS IoT Analytics Documentation
BatchPutMessageErrorEntry

BatchPutMessageErrorEntry
Contains informations about errors.

Contents
errorCode

The code associated with the error.

Type: String

Required: No
errorMessage

The message associated with the error.

Type: String

Required: No
messageId

The ID of the message that caused the error. (See the value corresponding to the "messageId" key in
the message object.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

96
AWS IoT Analytics AWS IoT Analytics Documentation
Channel

Channel
A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before
publishing the data to a pipeline.

Contents
arn

The ARN of the channel.

Type: String

Required: No
creationTime

When the channel was created.

Type: Timestamp

Required: No
lastUpdateTime

When the channel was last updated.

Type: Timestamp

Required: No
name

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
retentionPeriod

How long, in days, message data is kept for the channel.

Type: RetentionPeriod (p. 156) object

Required: No
status

The status of the channel.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No
storage

API Version 2017-11-27

97
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

Type: ChannelStorage (p. 101) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

98
AWS IoT Analytics AWS IoT Analytics Documentation
ChannelActivity

ChannelActivity
The activity that determines the source of the messages to be processed.

Contents
channelName

The name of the channel from which the messages are processed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
name

The name of the 'channel' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

99
AWS IoT Analytics AWS IoT Analytics Documentation
ChannelStatistics

ChannelStatistics
Statistics information about the channel.

Contents
size

The estimated size of the channel.

Type: EstimatedResourceSize (p. 137) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

100
AWS IoT Analytics AWS IoT Analytics Documentation
ChannelStorage

ChannelStorage
Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3"
storage. If not speciﬁed, the default is "serviceManagedS3". This cannot be changed after creation of the
channel.

Contents
customerManagedS3

Use this to store channel data in an S3 bucket that you manage. If customer managed storage is
selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-
managed S3 storage cannot be changed after creation of the channel.

Type: CustomerManagedChannelS3Storage (p. 107) object

Required: No
serviceManagedS3

Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice
of service-managed or customer-managed S3 storage cannot be changed after creation of the
channel.

Type: ServiceManagedChannelS3Storage (p. 161) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

101
AWS IoT Analytics AWS IoT Analytics Documentation
ChannelStorageSummary

ChannelStorageSummary
Where channel data is stored.

Contents
customerManagedS3

Used to store channel data in an S3 bucket that you manage.

Type: CustomerManagedChannelS3StorageSummary (p. 108) object

Required: No
serviceManagedS3

Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.

Type: ServiceManagedChannelS3StorageSummary (p. 162) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

102
AWS IoT Analytics AWS IoT Analytics Documentation
ChannelSummary

ChannelSummary
A summary of information about a channel.

Contents
channelName

The name of the channel.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
channelStorage

Where channel data is stored.

Type: ChannelStorageSummary (p. 102) object

Required: No
creationTime

When the channel was created.

Type: Timestamp

Required: No
lastUpdateTime

The last time the channel was updated.

Type: Timestamp

Required: No
status

The status of the channel.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java

API Version 2017-11-27

103
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Ruby V2

API Version 2017-11-27

104
AWS IoT Analytics AWS IoT Analytics Documentation
ContainerDatasetAction

ContainerDatasetAction
Information needed to run the "containerAction" to produce data set contents.

Contents
executionRoleArn

The ARN of the role which gives permission to the system to access needed resources in order to run
the "containerAction". This includes, at minimum, permission to retrieve the data set contents which
are the input to the containerized application.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes
image

The ARN of the Docker container stored in your account. The Docker container contains an
application and needed support libraries and is used to generate data set contents.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes
resourceConﬁguration

Conﬁguration of the resource which executes the "containerAction".

Type: ResourceConﬁguration (p. 155) object

Required: Yes
variables

The values of variables used within the context of the execution of the containerized application
(basically, parameters passed to the application). Each variable must have a name and a value given
by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue".

Type: Array of Variable (p. 168) objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

105
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

API Version 2017-11-27

106
AWS IoT Analytics AWS IoT Analytics Documentation
CustomerManagedChannelS3Storage

CustomerManagedChannelS3Storage
Use this to store channel data in an S3 bucket that you manage. If customer managed storage is
selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-
managed S3 storage cannot be changed after creation of the channel.

Contents
bucket

The name of the Amazon S3 bucket in which channel data is stored.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9.\-_]*$

Required: Yes
keyPreﬁx

[Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon
S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly
one key). The prefix must end with a '/'.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*/$

Required: No
roleArn

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3
resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

107
AWS IoT Analytics AWS IoT Analytics Documentation
CustomerManagedChannelS3StorageSummary

CustomerManagedChannelS3StorageSummary
Used to store channel data in an S3 bucket that you manage.

Contents
bucket

The name of the Amazon S3 bucket in which channel data is stored.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9.\-_]*$

Required: No
keyPreﬁx

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*/$

Required: No
roleArn

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3
resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

108
AWS IoT Analytics AWS IoT Analytics Documentation
CustomerManagedDatastoreS3Storage

CustomerManagedDatastoreS3Storage
Use this to store data store data in an S3 bucket that you manage. When customer managed storage
is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-
managed S3 storage cannot be changed after creation of the data store.

Contents
bucket

The name of the Amazon S3 bucket in which data store data is stored.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9.\-_]*$

Required: Yes
keyPreﬁx

[Optional] The prefix used to create the keys of the data store data objects. Each object in an
Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket
has exactly one key). The prefix must end with a '/'.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*/$

Required: No
roleArn

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3
resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

109
AWS IoT Analytics AWS IoT Analytics Documentation
CustomerManagedDatastoreS3StorageSummary

CustomerManagedDatastoreS3StorageSummary
Used to store data store data in an S3 bucket that you manage.

Contents
bucket

The name of the Amazon S3 bucket in which data store data is stored.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9.\-_]*$

Required: No
keyPreﬁx

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*/$

Required: No
roleArn

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3
resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

110
AWS IoT Analytics AWS IoT Analytics Documentation
Dataset

Dataset
Information about a data set.

Contents
actions

The "DatasetAction" objects that automatically create the data set contents.

Type: Array of DatasetAction (p. 113) objects

Array Members: Fixed number of 1 item.

Required: No
arn

The ARN of the data set.

Type: String

Required: No
contentDeliveryRules

When data set contents are created they are delivered to destinations speciﬁed here.

Type: Array of DatasetContentDeliveryRule (p. 116) objects

Array Members: Minimum number of 0 items. Maximum number of 20 items.

Required: No
creationTime

When the data set was created.

Type: Timestamp

Required: No
lastUpdateTime

The last time the data set was updated.

Type: Timestamp

Required: No
name

The name of the data set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
retentionPeriod

[Optional] How long, in days, message data is kept for the data set.

API Version 2017-11-27

111
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

Type: RetentionPeriod (p. 156) object

Required: No
status

The status of the data set.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No
triggers

The "DatasetTrigger" objects that specify when the data set is automatically updated.

Type: Array of DatasetTrigger (p. 123) objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Required: No
versioningConﬁguration

Type: VersioningConﬁguration (p. 170) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

112
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetAction

DatasetAction
A "DatasetAction" object that speciﬁes how data set contents are automatically created.

Contents
actionName

The name of the data set action by which data set contents are automatically created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
containerAction

Information which allows the system to run a containerized application in order to create the data
set contents. The application must be in a Docker container along with any needed support libraries.

Type: ContainerDatasetAction (p. 105) object

Required: No
queryAction

An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set
contents.

Type: SqlQueryDatasetAction (p. 165) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

113
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetActionSummary

DatasetActionSummary
Information about the action which automatically creates the data set's contents.

Contents
actionName

The name of the action which automatically creates the data set's contents.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
actionType

The type of action by which the data set's contents are automatically created.

Type: String

Valid Values: QUERY | CONTAINER

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

114
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetContentDeliveryDestination

DatasetContentDeliveryDestination
The destination to which data set contents are delivered.

Contents
iotEventsDestinationConﬁguration

Conﬁguration information for delivery of data set contents to AWS IoT Events.

Type: IotEventsDestinationConﬁguration (p. 140) object

Required: No
s3DestinationConﬁguration

Conﬁguration information for delivery of data set contents to Amazon S3.

Type: S3DestinationConﬁguration (p. 157) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

115
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetContentDeliveryRule

DatasetContentDeliveryRule
When data set contents are created they are delivered to destination speciﬁed here.

Contents
destination

The destination to which data set contents are delivered.

Type: DatasetContentDeliveryDestination (p. 115) object

Required: Yes
entryName

The name of the data set content delivery rules entry.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

116
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetContentStatus

DatasetContentStatus
The state of the data set contents and the reason they are in this state.

Contents
reason

The reason the data set contents are in this state.

Type: String

Required: No
state

The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".

Type: String

Valid Values: CREATING | SUCCEEDED | FAILED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

117
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetContentSummary

DatasetContentSummary
Summary information about data set contents.

Contents
creationTime

The actual time the creation of the data set contents was started.

Type: Timestamp

Required: No
scheduleTime

The time the creation of the data set contents was scheduled to start.

Type: Timestamp

Required: No
status

The status of the data set contents.

Type: DatasetContentStatus (p. 117) object

Required: No
version

The version of the data set contents.

Type: String

Length Constraints: Minimum length of 7. Maximum length of 36.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

118
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetContentVersionValue

DatasetContentVersionValue
The data set whose latest contents are used as input to the notebook or application.

Contents
datasetName

The name of the data set whose latest contents are used as input to the notebook or application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

119
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetEntry

DatasetEntry
The reference to a data set entry.

Contents
dataURI

The pre-signed URI of the data set item.

Type: String

Required: No
entryName

The name of the data set item.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

120
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetSummary

DatasetSummary
A summary of information about a data set.

Contents
actions

A list of "DataActionSummary" objects.

Type: Array of DatasetActionSummary (p. 114) objects

Array Members: Fixed number of 1 item.

Required: No
creationTime

The time the data set was created.

Type: Timestamp

Required: No
datasetName

The name of the data set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
lastUpdateTime

The last time the data set was updated.

Type: Timestamp

Required: No
status

The status of the data set.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No
triggers

A list of triggers. A trigger causes data set content to be populated at a speciﬁed time interval
or when another data set is populated. The list of triggers can be empty or contain up to ﬁve
DataSetTrigger objects

Type: Array of DatasetTrigger (p. 123) objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

API Version 2017-11-27

121
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

122
AWS IoT Analytics AWS IoT Analytics Documentation
DatasetTrigger

DatasetTrigger
The "DatasetTrigger" that speciﬁes when the data set is automatically updated.

Contents
dataset

The data set whose content creation triggers the creation of this data set's contents.

Type: TriggeringDataset (p. 167) object

Required: No
schedule

The "Schedule" when the trigger is initiated.

Type: Schedule (p. 159) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

123
AWS IoT Analytics AWS IoT Analytics Documentation
Datastore

Datastore
Information about a data store.

Contents
arn

The ARN of the data store.

Type: String

Required: No
creationTime

When the data store was created.

Type: Timestamp

Required: No
lastUpdateTime

The last time the data store was updated.

Type: Timestamp

Required: No
name

The name of the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
retentionPeriod

How long, in days, message data is kept for the data store. When "customerManagedS3" storage is
selected, this parameter is ignored.

Type: RetentionPeriod (p. 156) object

Required: No
status

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

API Version 2017-11-27

124
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No
storage

Type: DatastoreStorage (p. 128) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

125
AWS IoT Analytics AWS IoT Analytics Documentation
DatastoreActivity

DatastoreActivity
The 'datastore' activity that speciﬁes where to store the processed data.

Contents
datastoreName

The name of the data store where processed messages are stored.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes
name

The name of the 'datastore' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

126
AWS IoT Analytics AWS IoT Analytics Documentation
DatastoreStatistics

DatastoreStatistics
Statistical information about the data store.

Contents
size

The estimated size of the data store.

Type: EstimatedResourceSize (p. 137) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

127
AWS IoT Analytics AWS IoT Analytics Documentation
DatastoreStorage

DatastoreStorage
Where data store data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3"
storage. If not speciﬁed, the default is "serviceManagedS3". This cannot be changed after the data store
is created.

Contents
customerManagedS3

Use this to store data store data in an S3 bucket that you manage. When customer managed storage
is selected, the "retentionPeriod" parameter is ignored. The choice of service-managed or customer-
managed S3 storage cannot be changed after creation of the data store.

Type: CustomerManagedDatastoreS3Storage (p. 109) object

Required: No
serviceManagedS3

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The
choice of service-managed or customer-managed S3 storage cannot be changed after creation of
the data store.

Type: ServiceManagedDatastoreS3Storage (p. 163) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

128
AWS IoT Analytics AWS IoT Analytics Documentation
DatastoreStorageSummary

DatastoreStorageSummary
Where data store data is stored.

Contents
customerManagedS3

Used to store data store data in an S3 bucket that you manage.

Type: CustomerManagedDatastoreS3StorageSummary (p. 110) object

Required: No
serviceManagedS3

Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

Type: ServiceManagedDatastoreS3StorageSummary (p. 164) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

129
AWS IoT Analytics AWS IoT Analytics Documentation
DatastoreSummary

DatastoreSummary
A summary of information about a data store.

Contents
creationTime

When the data store was created.

Type: Timestamp

Required: No
datastoreName

The name of the data store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
datastoreStorage

Where data store data is stored.

Type: DatastoreStorageSummary (p. 129) object

Required: No
lastUpdateTime

The last time the data store was updated.

Type: Timestamp

Required: No
status

The status of the data store.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java

API Version 2017-11-27

130
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Ruby V2

API Version 2017-11-27

131
AWS IoT Analytics AWS IoT Analytics Documentation
DeltaTime

DeltaTime
Used to limit data to that which has arrived since the last execution of the action.

Contents
oﬀsetSeconds

The number of seconds of estimated "in flight" lag time of message data. When you create data
set contents using message data from a specified time frame, some message data may still be "in
flight" when processing begins, and so will not arrive in time to be processed. Use this field to make
allowances for the "in flight" time of your message data, so that data not processed from a previous
time frame will be included with the next time frame. Without this, missed message data would be
excluded from processing during the next time frame as well, because its timestamp places it within
the previous time frame.

Type: Integer

Required: Yes
timeExpression

An expression by which the time of the message data may be determined. This may be the name
of a timestamp ﬁeld, or a SQL expression which is used to derive the time the message data was
generated.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

132
AWS IoT Analytics AWS IoT Analytics Documentation
DeviceRegistryEnrichActivity

DeviceRegistryEnrichActivity
An activity that adds data from the AWS IoT device registry to your message.

Contents
attribute

The name of the attribute that is added to the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'deviceRegistryEnrich' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No
roleArn

The ARN of the role that allows access to the device's registry information.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes
thingName

The name of the IoT device whose registry information is added to the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

API Version 2017-11-27

133
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Go

• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

134
AWS IoT Analytics AWS IoT Analytics Documentation
DeviceShadowEnrichActivity

DeviceShadowEnrichActivity
An activity that adds information from the AWS IoT Device Shadows service to a message.

Contents
attribute

The name of the attribute that is added to the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'deviceShadowEnrich' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No
roleArn

The ARN of the role that allows access to the device's shadow.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes
thingName

The name of the IoT device whose shadow information is added to the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

API Version 2017-11-27

135
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Go

• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

136
AWS IoT Analytics AWS IoT Analytics Documentation
EstimatedResourceSize

EstimatedResourceSize
The estimated size of the resource.

Contents
estimatedOn

The time when the estimate of the size of the resource was made.

Type: Timestamp

Required: No
estimatedSizeInBytes

The estimated size of the resource in bytes.

Type: Double

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

137
AWS IoT Analytics AWS IoT Analytics Documentation
FilterActivity

FilterActivity
An activity that ﬁlters a message based on its attributes.

Contents
ﬁlter

An expression that looks like a SQL WHERE clause that must return a Boolean value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'ﬁlter' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

138
AWS IoT Analytics AWS IoT Analytics Documentation
GlueConﬁguration

GlueConﬁguration
Conﬁguration information for coordination with the AWS Glue ETL (extract, transform and load) service.

Contents
databaseName

The name of the database in your AWS Glue Data Catalog in which the table is located. (An AWS
Glue Data Catalog database contains Glue Data tables.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes
tableName

The name of the table in your AWS Glue Data Catalog which is used to perform the ETL (extract,
transform and load) operations. (An AWS Glue Data Catalog table contains partitioned data and
descriptions of data sources and targets.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 150.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

139
AWS IoT Analytics AWS IoT Analytics Documentation
IotEventsDestinationConﬁguration

IotEventsDestinationConﬁguration
Conﬁguration information for delivery of data set contents to AWS IoT Events.

Contents
inputName

The name of the AWS IoT Events input to which data set contents are delivered.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$

Required: Yes
roleArn

The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an
AWS IoT Events input.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

140
AWS IoT Analytics AWS IoT Analytics Documentation
LambdaActivity

LambdaActivity
An activity that runs a Lambda function to modify the message.

Contents
batchSize

The number of messages passed to the Lambda function for processing.

The AWS Lambda function must be able to process all of these messages within ﬁve minutes, which
is the maximum timeout duration for Lambda functions.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: Yes
lambdaName

The name of the Lambda function that is run on the message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes
name

The name of the 'lambda' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java

API Version 2017-11-27

141
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Ruby V2

API Version 2017-11-27

142
AWS IoT Analytics AWS IoT Analytics Documentation
LoggingOptions

LoggingOptions
Information about logging options.

Contents
enabled

If true, logging is enabled for AWS IoT Analytics.

Type: Boolean

Required: Yes
level

The logging level. Currently, only "ERROR" is supported.

Type: String

Valid Values: ERROR

Required: Yes
roleArn

The ARN of the role that grants permission to AWS IoT Analytics to perform logging.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

143
AWS IoT Analytics AWS IoT Analytics Documentation
MathActivity

MathActivity
An activity that computes an arithmetic expression using the message's attributes.

Contents
attribute

The name of the attribute that contains the result of the math operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
math

An expression that uses one or more existing attributes and must return an integer value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'math' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

144
AWS IoT Analytics AWS IoT Analytics Documentation
Message

Message
Information about a message.

Contents
messageId

The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
payload

The payload of the message. This may be a JSON string or a Base64-encoded string representing
binary data (in which case you must decode it by means of a pipeline activity).

Type: Base64-encoded binary data object

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

145
AWS IoT Analytics AWS IoT Analytics Documentation
OutputFileUriValue

OutputFileUriValue
The value of the variable as a structure that speciﬁes an output ﬁle URI.

Contents
ﬁleName

The URI of the location where data set contents are stored, usually the URI of a ﬁle in an S3 bucket.

Type: String

Pattern: [\w\.-]{1,255}

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

146
AWS IoT Analytics AWS IoT Analytics Documentation
Pipeline

Pipeline
Contains information about a pipeline.

Contents
activities

The activities that perform transformations on the messages.

Type: Array of PipelineActivity (p. 149) objects

Array Members: Minimum number of 1 item. Maximum number of 25 items.

Required: No
arn

The ARN of the pipeline.

Type: String

Required: No
creationTime

When the pipeline was created.

Type: Timestamp

Required: No
lastUpdateTime

The last time the pipeline was updated.

Type: Timestamp

Required: No
name

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
reprocessingSummaries

A summary of information about the pipeline reprocessing.

Type: Array of ReprocessingSummary (p. 154) objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

API Version 2017-11-27

147
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

148
AWS IoT Analytics AWS IoT Analytics Documentation
PipelineActivity

PipelineActivity
An activity that performs a transformation on a message.

Contents
addAttributes

Adds other attributes based on existing attributes in the message.

Type: AddAttributesActivity (p. 95) object

Required: No
channel

Determines the source of the messages to be processed.

Type: ChannelActivity (p. 99) object

Required: No
datastore

Speciﬁes where to store the processed message data.

Type: DatastoreActivity (p. 126) object

Required: No
deviceRegistryEnrich

Adds data from the AWS IoT device registry to your message.

Type: DeviceRegistryEnrichActivity (p. 133) object

Required: No
deviceShadowEnrich

Adds information from the AWS IoT Device Shadows service to a message.

Type: DeviceShadowEnrichActivity (p. 135) object

Required: No
ﬁlter

Filters a message based on its attributes.

Type: FilterActivity (p. 138) object

Required: No
lambda

Runs a Lambda function to modify the message.

Type: LambdaActivity (p. 141) object

Required: No
math

Computes an arithmetic expression using the message's attributes and adds it to the message.

API Version 2017-11-27

149
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

Type: MathActivity (p. 144) object

Required: No
removeAttributes

Removes attributes from a message.

Type: RemoveAttributesActivity (p. 153) object

Required: No
selectAttributes

Creates a new message using only the speciﬁed attributes from the original message.

Type: SelectAttributesActivity (p. 160) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

150
AWS IoT Analytics AWS IoT Analytics Documentation
PipelineSummary

PipelineSummary
A summary of information about a pipeline.

Contents
creationTime

When the pipeline was created.

Type: Timestamp

Required: No
lastUpdateTime

When the pipeline was last updated.

Type: Timestamp

Required: No
pipelineName

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: No
reprocessingSummaries

A summary of information about the pipeline reprocessing.

Type: Array of ReprocessingSummary (p. 154) objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

151
AWS IoT Analytics AWS IoT Analytics Documentation
QueryFilter

QueryFilter
Information which is used to ﬁlter message data, to segregate it according to the time frame in which it
arrives.

Contents
deltaTime

Used to limit data to that which has arrived since the last execution of the action.

Type: DeltaTime (p. 132) object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

152
AWS IoT Analytics AWS IoT Analytics Documentation
RemoveAttributesActivity

RemoveAttributesActivity
An activity that removes attributes from a message.

Contents
attributes

A list of 1-50 attributes to remove from the message.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'removeAttributes' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

153
AWS IoT Analytics AWS IoT Analytics Documentation
ReprocessingSummary

ReprocessingSummary
Information about pipeline reprocessing.

Contents
creationTime

The time the pipeline reprocessing was created.

Type: Timestamp

Required: No
id

The 'reprocessingId' returned by "StartPipelineReprocessing".

Type: String

Required: No
status

The status of the pipeline reprocessing.

Type: String

Valid Values: RUNNING | SUCCEEDED | CANCELLED | FAILED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

154
AWS IoT Analytics AWS IoT Analytics Documentation
ResourceConﬁguration

ResourceConﬁguration
The conﬁguration of the resource used to execute the "containerAction".

Contents
computeType

The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1
(vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

Type: String

Valid Values: ACU_1 | ACU_2

Required: Yes
volumeSizeInGB

The size (in GB) of the persistent storage available to the resource instance used to execute the
"containerAction" (min: 1, max: 50).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

155
AWS IoT Analytics AWS IoT Analytics Documentation
RetentionPeriod

RetentionPeriod
How long, in days, message data is kept.

Contents
numberOfDays

The number of days that message data is kept. The "unlimited" parameter must be false.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
unlimited

If true, message data is kept indeﬁnitely.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

156
AWS IoT Analytics AWS IoT Analytics Documentation
S3DestinationConﬁguration

S3DestinationConﬁguration
Conﬁguration information for delivery of data set contents to Amazon S3.

Contents
bucket

The name of the Amazon S3 bucket to which data set contents are delivered.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 255.

Pattern: ^[a-zA-Z0-9.\-_]*$

Required: Yes
glueConﬁguration

Conﬁguration information for coordination with the AWS Glue ETL (extract, transform and load)
service.

Type: GlueConﬁguration (p. 139) object

Required: No
key

The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is its
unique identiﬁer within the bucket (each object in a bucket has exactly one key). To produce a unique
key, you can use "!{iotanalytics:scheduledTime}" to insert the time of the scheduled SQL query run,
or "!{iotanalytics:versioned} to insert a unique hash identifying the data set, for example: "/DataSet/!
{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv".

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^[a-zA-Z0-9!_.*'()/{}:-]*$

Required: Yes
roleArn

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 and
AWS Glue resources.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

API Version 2017-11-27

157
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Go

• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

158
AWS IoT Analytics AWS IoT Analytics Documentation
Schedule

Schedule
The schedule for when to trigger an update.

Contents
expression

The expression that deﬁnes when to trigger an update. For more information, see Schedule
Expressions for Rules in the Amazon CloudWatch Events User Guide.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

159
AWS IoT Analytics AWS IoT Analytics Documentation
SelectAttributesActivity

SelectAttributesActivity
Creates a new message using only the speciﬁed attributes from the original message.

Contents
attributes

A list of the attributes to select from the message.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
name

The name of the 'selectAttributes' activity.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
next

The next activity in the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

160
AWS IoT Analytics AWS IoT Analytics Documentation
ServiceManagedChannelS3Storage

ServiceManagedChannelS3Storage
Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of
service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

Contents
The members of this structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

161
AWS IoT Analytics AWS IoT Analytics Documentation
ServiceManagedChannelS3StorageSummary

ServiceManagedChannelS3StorageSummary
Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.

Contents
The members of this structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

162
AWS IoT Analytics AWS IoT Analytics Documentation
ServiceManagedDatastoreS3Storage

ServiceManagedDatastoreS3Storage
Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice
of service-managed or customer-managed S3 storage cannot be changed after creation of the data
store.

Contents
The members of this structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

163
AWS IoT Analytics AWS IoT Analytics Documentation
ServiceManagedDatastoreS3StorageSummary

ServiceManagedDatastoreS3StorageSummary
Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

Contents
The members of this structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

164
AWS IoT Analytics AWS IoT Analytics Documentation
SqlQueryDatasetAction

SqlQueryDatasetAction
The SQL query to modify the message.

Contents
ﬁlters

Pre-ﬁlters applied to message data.

Type: Array of QueryFilter (p. 152) objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No
sqlQuery

A SQL query string.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

165
AWS IoT Analytics AWS IoT Analytics Documentation
Tag

Tag
A set of key/value pairs which are used to manage the resource.

Contents
key

The tag's key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
value

The tag's value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

166
AWS IoT Analytics AWS IoT Analytics Documentation
TriggeringDataset

TriggeringDataset
Information about the data set whose content generation triggers the new data set content generation.

Contents
name

The name of the data set whose content generation triggers the new data set content generation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

167
AWS IoT Analytics AWS IoT Analytics Documentation
Variable

Variable
An instance of a variable to be passed to the "containerAction" execution. Each variable must have a
name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue".

Contents
datasetContentVersionValue

The value of the variable as a structure that speciﬁes a data set content version.

Type: DatasetContentVersionValue (p. 119) object

Required: No
doubleValue

The value of the variable as a double (numeric).

Type: Double

Required: No
name

The name of the variable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
outputFileUriValue

The value of the variable as a structure that speciﬁes an output ﬁle URI.

Type: OutputFileUriValue (p. 146) object

Required: No
stringValue

The value of the variable as a string.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java

API Version 2017-11-27

168
AWS IoT Analytics AWS IoT Analytics Documentation
See Also

• AWS SDK for Ruby V2

API Version 2017-11-27

169
AWS IoT Analytics AWS IoT Analytics Documentation
VersioningConﬁguration

VersioningConﬁguration
Information about the versioning of data set contents.

Contents
maxVersions

How many versions of data set contents will be kept. The "unlimited" parameter must be false.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No
unlimited

If true, unlimited versions of data set contents will be kept.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Go - Pilot
• AWS SDK for Java
• AWS SDK for Ruby V2

API Version 2017-11-27

170
AWS IoT Analytics AWS IoT Analytics Documentation

Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4 requests
with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more
information about Signature Version 4, see Signature Version 4 Signing Process in the Amazon Web
Services General Reference.

Action

The action to be performed.

Type: string

Required: Yes
Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: Yes
X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region you
are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is
expressed in the following format: access_key/YYYYMMDD/region/service/aws4_request.

For more information, see Task 2: Create a String to Sign for Signature Version 4 in the Amazon Web
Services General Reference.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format
(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:
20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for
signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is

API Version 2017-11-27

171
AWS IoT Analytics AWS IoT Analytics Documentation

not required. When X-Amz-Date is used, it always overrides the value of the Date header. For
more information, see Handling Dates in Signature Version 4 in the Amazon Web Services General
Reference.

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWS
STS). For a list of services that support temporary security credentials from AWS Security Token
Service, go to AWS Services That Work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from the AWS Security Token Service, you
must include the security token.

Type: string

Required: Conditional
X-Amz-Signature

Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-SignedHeaders

Speciﬁes all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Task 1: Create a Canonical Request For Signature
Version 4 in the Amazon Web Services General Reference.

Condition: Specify this parameter when you include authentication information in a query string
instead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2017-11-27

172
AWS IoT Analytics AWS IoT Analytics Documentation

Common Errors
This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API
action for this service, see the topic for that API action.

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 400

IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400

InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

InvalidClientTokenId

The X.509 certiﬁcate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403

InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400

InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400

MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404

MissingAction

The request is missing an action or a required parameter.

HTTP Status Code: 400

API Version 2017-11-27

173
AWS IoT Analytics AWS IoT Analytics Documentation

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certiﬁcate.

HTTP Status Code: 403

MissingParameter

A required parameter for the speciﬁed action is not supplied.

HTTP Status Code: 400

OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or more
than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp
on the request is more than 15 minutes in the future.

HTTP Status Code: 400

ServiceUnavailable

The request has failed due to a temporary failure of the server.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationError

The input fails to satisfy the constraints speciﬁed by an AWS service.

HTTP Status Code: 400

API Version 2017-11-27

174

AWS Certified Cloud Practitioner CLF-C02 p10
No ratings yet
AWS Certified Cloud Practitioner CLF-C02 p10
14 pages
Technical Analysis from A to Z, 2nd Edition
From Everand
Technical Analysis from A to Z, 2nd Edition
Steven B. Achelis
4.5/5 (19)
SaaS Mastermind Blueprint
100% (1)
SaaS Mastermind Blueprint
35 pages
Black Book On Digital Marketing
No ratings yet
Black Book On Digital Marketing
14 pages
Programming FPGAs: Getting Started with Verilog
From Everand
Programming FPGAs: Getting Started with Verilog
Simon Monk
3.5/5 (2)
Fritzing for Inventors: Take Your Electronics Project from Prototype to Product
From Everand
Fritzing for Inventors: Take Your Electronics Project from Prototype to Product
Simon Monk
No ratings yet
Teardowns: Learn How Electronics Work by Taking Them Apart
From Everand
Teardowns: Learn How Electronics Work by Taking Them Apart
Bryan Bergeron
No ratings yet
Programming the Photon: Getting Started with the Internet of Things
From Everand
Programming the Photon: Getting Started with the Internet of Things
Christopher Rush
5/5 (1)
Financing patterns of European Buy-Outs
From Everand
Financing patterns of European Buy-Outs
Sascha Kaumann
No ratings yet
Copyright for Dummies. Your guide to copyright in Russia.
From Everand
Copyright for Dummies. Your guide to copyright in Russia.
Leontyev, Кonstantin B.
No ratings yet
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet
Programming the Intel Galileo: Getting Started with the Arduino -Compatible Development Board
From Everand
Programming the Intel Galileo: Getting Started with the Arduino -Compatible Development Board
Christopher Rush
5/5 (1)
Gray Hat Hacking the Ethical Hacker's
From Everand
Gray Hat Hacking the Ethical Hacker's
Çağatay Şanlı
5/5 (1)
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
From Everand
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
Michael Basler
No ratings yet
Facility Management: Business Process Integration
From Everand
Facility Management: Business Process Integration
Alexander Redlein
No ratings yet
Microsoft SQL Server 2005: A Beginner''s Guide
From Everand
Microsoft SQL Server 2005: A Beginner''s Guide
Dusan Petkovic
No ratings yet
Open Innovation and Business Success
From Everand
Open Innovation and Business Success
Monika Gawarzynska
No ratings yet
Sourcebook on the Foundations of Social Protection Delivery Systems
From Everand
Sourcebook on the Foundations of Social Protection Delivery Systems
Kathy Lindert
No ratings yet
Programming Arduino: Getting Started with Sketches
From Everand
Programming Arduino: Getting Started with Sketches
Simon Monk
3.5/5 (5)
Buying for Business: Insights in Purchasing and Supply Management
From Everand
Buying for Business: Insights in Purchasing and Supply Management
Christopher Barrat
No ratings yet
Electronics from the Ground Up: Learn by Hacking, Designing, and Inventing
From Everand
Electronics from the Ground Up: Learn by Hacking, Designing, and Inventing
Ronald Quan
3.5/5 (2)
Excel VBA Macro Programming
From Everand
Excel VBA Macro Programming
Richard Shepherd
No ratings yet
The State of Social Safety Nets 2015
From Everand
The State of Social Safety Nets 2015
The World Bank
No ratings yet
Agile Scrum Handbook
From Everand
Agile Scrum Handbook
Frank Turley
No ratings yet
HFMA's Introduction to Hospital Accounting, Fifth Edition
From Everand
HFMA's Introduction to Hospital Accounting, Fifth Edition
Michael Nowicki
No ratings yet
India as Destination for Western retailers: Opportunities, Challenges and Strategic Decisions
From Everand
India as Destination for Western retailers: Opportunities, Challenges and Strategic Decisions
Janine Rößiger
No ratings yet
15 Dangerously Mad Projects for the Evil Genius
From Everand
15 Dangerously Mad Projects for the Evil Genius
Simon Monk
4/5 (7)
How Useful is the Information Ratio to Evaluate the Performance of Portfolio Managers?
From Everand
How Useful is the Information Ratio to Evaluate the Performance of Portfolio Managers?
Christoph Schneider
No ratings yet
Benefits of semantic data models. A study in the European goods transport industry
From Everand
Benefits of semantic data models. A study in the European goods transport industry
Andreas A. Pelekies
No ratings yet
Analyzing Food Security using Household Surveys
From Everand
Analyzing Food Security using Household Surveys
World Bank Staff
No ratings yet
Analyzing Food Security Using Household Survey Data: Streamlined Analysis with ADePT Software
From Everand
Analyzing Food Security Using Household Survey Data: Streamlined Analysis with ADePT Software
Ana Moltedo
No ratings yet
BlockChain for Beginners
From Everand
BlockChain for Beginners
Matthew Smith
No ratings yet
Common Core Connections Language Arts, Grade K
From Everand
Common Core Connections Language Arts, Grade K
Carson Dellosa Education
No ratings yet
CloudAPIGuide-BusinessFlows
No ratings yet
CloudAPIGuide-BusinessFlows
172 pages
South Asian Bond Markets: Developing Long-Term Finance for Growth
From Everand
South Asian Bond Markets: Developing Long-Term Finance for Growth
Kiatchai Sophastienphong
No ratings yet
Amazon API Gateway
0% (1)
Amazon API Gateway
307 pages
The NGINX Real-Time API Handbook
No ratings yet
The NGINX Real-Time API Handbook
26 pages
The NGINX Real-Time API Handb
No ratings yet
The NGINX Real-Time API Handb
26 pages
IICS Spring2018April REST-APIReference en
No ratings yet
IICS Spring2018April REST-APIReference en
205 pages
Programming Arduino: Getting Started with Sketches, Third Edition
From Everand
Programming Arduino: Getting Started with Sketches, Third Edition
Simon Monk
No ratings yet
Tips & Traps for Building Decks, Patios, and Porches
From Everand
Tips & Traps for Building Decks, Patios, and Porches
R. Dodge Woodson
No ratings yet
Some Small Countries Do It Better: Rapid Growth and Its Causes in Singapore, Finland, and Ireland
From Everand
Some Small Countries Do It Better: Rapid Growth and Its Causes in Singapore, Finland, and Ireland
Shahid Yusuf
No ratings yet
Apigateway DG
No ratings yet
Apigateway DG
842 pages
The Business of the State
From Everand
The Business of the State
World Bank
No ratings yet
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
From Everand
Blog Smarter, Not Harder: SEO, Blogging, and AI Strategies to Skyrocket Your Traffic
Jay Nans
No ratings yet
Arduino + Android Projects for the Evil Genius: Control Arduino with Your Smartphone or Tablet
From Everand
Arduino + Android Projects for the Evil Genius: Control Arduino with Your Smartphone or Tablet
Simon Monk
4.5/5 (2)
Programming Arduino Next Steps: Going Further with Sketches, Second Edition
From Everand
Programming Arduino Next Steps: Going Further with Sketches, Second Edition
Simon Monk
3/5 (3)
Re-Cording Lives: Governing Asylum in Switzerland and the Need to Resolve
From Everand
Re-Cording Lives: Governing Asylum in Switzerland and the Need to Resolve
Ephraim Pörtner
No ratings yet
Business Object Modeling (BOM) workbook: A pattern-based approach to creating, managing and using an enterprise data model
From Everand
Business Object Modeling (BOM) workbook: A pattern-based approach to creating, managing and using an enterprise data model
Martine Alaerts
No ratings yet
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
From Everand
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
Matthew C. Smith
No ratings yet
Unlocking Statistics for the Social Sciences
From Everand
Unlocking Statistics for the Social Sciences
Norma Sinclair
No ratings yet
Programming Arduino Next Steps: Going Further with Sketches
From Everand
Programming Arduino Next Steps: Going Further with Sketches
Simon Monk
3/5 (3)
Breakthrough Improvement with QI Macros and Excel: Finding the Invisible Low-Hanging Fruit: Finding the Invisible Low-Hanging Fruit
From Everand
Breakthrough Improvement with QI Macros and Excel: Finding the Invisible Low-Hanging Fruit: Finding the Invisible Low-Hanging Fruit
Jay Arthur
No ratings yet
11 - CT071!3!3-DDAC - Serverless Solutions in Cloud (Part 2)
No ratings yet
11 - CT071!3!3-DDAC - Serverless Solutions in Cloud (Part 2)
99 pages
Networkadvisor 1401 Rest API
No ratings yet
Networkadvisor 1401 Rest API
200 pages
TN_iVantageAPI__T0001403_31_Oct_2023 Rev3
No ratings yet
TN_iVantageAPI__T0001403_31_Oct_2023 Rev3
225 pages
API Driven Devops
100% (2)
API Driven Devops
106 pages
IC Spring2017 DeveloperGuide en
No ratings yet
IC Spring2017 DeveloperGuide en
201 pages
Apigateway Developer Guide
No ratings yet
Apigateway Developer Guide
263 pages
Iot DG PDF
No ratings yet
Iot DG PDF
763 pages
Postman-2
No ratings yet
Postman-2
23 pages
API Design On The Scale of Decades v2.2
No ratings yet
API Design On The Scale of Decades v2.2
153 pages
Complete API Guide
No ratings yet
Complete API Guide
403 pages
Optimizing MySQL On Amazon
No ratings yet
Optimizing MySQL On Amazon
36 pages
AWS Cloud Adoption Framework
No ratings yet
AWS Cloud Adoption Framework
23 pages
Devops and CICD
100% (1)
Devops and CICD
36 pages
Jenkins On AWS
No ratings yet
Jenkins On AWS
52 pages
Deeplens DG
No ratings yet
Deeplens DG
150 pages
Rekognition DG
No ratings yet
Rekognition DG
449 pages
Import Windows Server To Amazon Ec2
No ratings yet
Import Windows Server To Amazon Ec2
20 pages
Running Neo4j Graph Databases On AWS
No ratings yet
Running Neo4j Graph Databases On AWS
26 pages
Power Machine Learning at Scale: Mapping Parallelized Modeling-to-HPC Infrastructure On AWS
No ratings yet
Power Machine Learning at Scale: Mapping Parallelized Modeling-to-HPC Infrastructure On AWS
20 pages
Designing MQTT Topics For Aws Iot Core
No ratings yet
Designing MQTT Topics For Aws Iot Core
32 pages
Translate DG
No ratings yet
Translate DG
92 pages
Amazon Aurora Mysql Database Administrator'S Handbook: Connection Management
No ratings yet
Amazon Aurora Mysql Database Administrator'S Handbook: Connection Management
20 pages
How Managed IT Services Can Benefit Your Dubai Business
No ratings yet
How Managed IT Services Can Benefit Your Dubai Business
9 pages
Restful Key Elements
No ratings yet
Restful Key Elements
8 pages
Application Layer
No ratings yet
Application Layer
5 pages
Samsung All-In-One Security System: Front
No ratings yet
Samsung All-In-One Security System: Front
14 pages
Phishing Pharming and Identity Theft
No ratings yet
Phishing Pharming and Identity Theft
11 pages
Multi-Cloud Secure Data Storage Using Cryptographic Techniques
No ratings yet
Multi-Cloud Secure Data Storage Using Cryptographic Techniques
4 pages
Google Services A-Z
No ratings yet
Google Services A-Z
7 pages
CS101 New Syllabus 2020 Final Term
No ratings yet
CS101 New Syllabus 2020 Final Term
43 pages
E Commerce
No ratings yet
E Commerce
9 pages
Cse Assignment 2
No ratings yet
Cse Assignment 2
8 pages
VoIP & IP Audit Service
No ratings yet
VoIP & IP Audit Service
2 pages
UNIT -6
No ratings yet
UNIT -6
9 pages
What Is Multi-Factor Authentication?: Why MFA?
No ratings yet
What Is Multi-Factor Authentication?: Why MFA?
16 pages
Connect Authentication T: Step 1
No ratings yet
Connect Authentication T: Step 1
3 pages
Microsoft PL 200 Dumps by Jones 09-08-2024 7qa Certsinside
No ratings yet
Microsoft PL 200 Dumps by Jones 09-08-2024 7qa Certsinside
11 pages
Google Meet Guide
No ratings yet
Google Meet Guide
2 pages
01 - 15 Best Practices Enhance Your LinkedIn Strategies 2024
No ratings yet
01 - 15 Best Practices Enhance Your LinkedIn Strategies 2024
21 pages
Stop Automatic Downloads
No ratings yet
Stop Automatic Downloads
6 pages
Artificial Intelligence in
No ratings yet
Artificial Intelligence in
8 pages
System Hacking
No ratings yet
System Hacking
18 pages
AIA Final Exam Notes
100% (1)
AIA Final Exam Notes
4 pages
Ball and Socket (Slotted) Joint
No ratings yet
Ball and Socket (Slotted) Joint
2 pages
NF18ACV XBox Setup Guide PDF
No ratings yet
NF18ACV XBox Setup Guide PDF
6 pages
80 Ways To Find Social Media Clients
No ratings yet
80 Ways To Find Social Media Clients
9 pages
Dynamic Malware Analysis Workshop: Counterfeiting The Pipes With Fakenet
No ratings yet
Dynamic Malware Analysis Workshop: Counterfeiting The Pipes With Fakenet
50 pages
Savitha Banakar CV
No ratings yet
Savitha Banakar CV
2 pages
HTML Brochure English
No ratings yet
HTML Brochure English
2 pages

Aws Iot Analytics API

Uploaded by

Aws Iot Analytics API

Uploaded by

AWS IoT Analytics

AWS IoT Analytics Documentation

AWS IoT Analytics: AWS IoT Analytics Documentation

API Version 2017-11-27

Response Syntax .............................................................................................................. 23

API Version 2017-11-27

Response Elements ........................................................................................................... 39

API Version 2017-11-27

API Version 2017-11-27

See Also .......................................................................................................................... 74

API Version 2017-11-27

API Version 2017-11-27

Contents ........................................................................................................................ 120

API Version 2017-11-27

Contents ........................................................................................................................ 145

API Version 2017-11-27

Contents ........................................................................................................................ 167

API Version 2017-11-27

This document was last published on July 16, 2019.

API Version 2017-11-27

API Version 2017-11-27

URI Request Parameters

The name of the channel where the messages are sent.

Length Constraints: Minimum length of 1. Maximum length of 128.

API Version 2017-11-27

Type: Array of Message (p. 145) objects

The following data is returned in JSON format by the service.

Type: Array of BatchPutMessageErrorEntry (p. 96) objects

There was an internal failure.

HTTP Status Code: 500

The request was not valid.

HTTP Status Code: 400

A resource with the speciﬁed name could not be found.

HTTP Status Code: 404

The service is temporarily unavailable.

HTTP Status Code: 503

API Version 2017-11-27

The request was denied due to request throttling.

HTTP Status Code: 429

• AWS Command Line Interface

API Version 2017-11-27

URI Request Parameters

The name of pipeline for which data reprocessing is canceled.

Length Constraints: Minimum length of 1. Maximum length of 128.

The ID of the reprocessing task (returned by "StartPipelineReprocessing").

There was an internal failure.

HTTP Status Code: 500

The request was not valid.

HTTP Status Code: 400

A resource with the speciﬁed name could not be found.

API Version 2017-11-27

HTTP Status Code: 404

The service is temporarily unavailable.

HTTP Status Code: 503

The request was denied due to request throttling.

HTTP Status Code: 429

• AWS Command Line Interface

API Version 2017-11-27

URI Request Parameters

The name of the channel.

Length Constraints: Minimum length of 1. Maximum length of 128.

API Version 2017-11-27

Type: ChannelStorage (p. 101) object

Type: RetentionPeriod (p. 156) object

Metadata which can be used to manage the channel.

Type: Array of Tag (p. 166) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

The following data is returned in JSON format by the service.

The ARN of the channel.

The name of the channel.

Length Constraints: Minimum length of 1. Maximum length of 128.

How long, in days, message data is kept for the channel.

API Version 2017-11-27

Type: RetentionPeriod (p. 156) object

There was an internal failure.

HTTP Status Code: 500