aws iot analytics - aws iot analytics documentation · aws iot analytics automates the steps...

AWS IoT AnalyticsAWS IoT Analytics Documentation

API Version 2017-11-27

AWS IoT Analytics AWS IoT Analytics Documentation

AWS IoT Analytics: AWS IoT Analytics DocumentationCopyright © 2018 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored byAmazon.


Table of ContentsWelcome .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Actions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

BatchPutMessage .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

CancelPipelineReprocessing .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

CreateChannel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

CreateDataset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

CreateDatasetContent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

CreateDatastore .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

CreatePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

API Version 2017-11-27iii


Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

DeleteChannel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

DeleteDataset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

DeleteDatasetContent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

DeleteDatastore .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

DeletePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

DescribeChannel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

DescribeDataset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

API Version 2017-11-27iv


Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

DescribeDatastore .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

DescribeLoggingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

DescribePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

GetDatasetContent .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

ListChannels ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

ListDatasets ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

ListDatastores .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

API Version 2017-11-27v


Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

ListPipelines .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

ListTagsForResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

PutLoggingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

RunPipelineActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

SampleChannelData .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

StartPipelineReprocessing .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

TagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

API Version 2017-11-27vi


See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69UntagResource .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

UpdateChannel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

UpdateDataset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

UpdateDatastore .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

UpdatePipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79Request Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79URI Request Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Request Body .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Syntax .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Response Elements .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Data Types .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82AddAttributesActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

BatchPutMessageErrorEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Channel ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

ChannelActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

ChannelSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

API Version 2017-11-27vii


Dataset ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

DatasetAction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

DatasetContentStatus .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

DatasetEntry .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

DatasetSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

DatasetTrigger .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Datastore .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

DatastoreActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

DatastoreSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

DeviceRegistryEnrichActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

DeviceShadowEnrichActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

FilterActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

LambdaActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

LoggingOptions .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

MathActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Message .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Pipeline .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

PipelineActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

PipelineSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114

API Version 2017-11-27viii


RemoveAttributesActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115

ReprocessingSummary .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

RetentionPeriod .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Schedule .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

SelectAttributesActivity ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

SqlQueryDatasetAction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Tag .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121Contents .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121See Also .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Common Parameters ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122Common Errors ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124

API Version 2017-11-27ix


WelcomeAWS 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 advanceddata exploration through integration with Jupyter Notebooks and data visualization through integrationwith Amazon QuickSight.

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

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

This document was last published on July 27, 2018.



ActionsThe following actions are supported:

• BatchPutMessage (p. 3)• CancelPipelineReprocessing (p. 6)• CreateChannel (p. 8)• CreateDataset (p. 11)• CreateDatasetContent (p. 14)• CreateDatastore (p. 16)• CreatePipeline (p. 19)• DeleteChannel (p. 23)• DeleteDataset (p. 25)• DeleteDatasetContent (p. 27)• DeleteDatastore (p. 29)• DeletePipeline (p. 31)• DescribeChannel (p. 33)• DescribeDataset (p. 35)• DescribeDatastore (p. 38)• DescribeLoggingOptions (p. 40)• DescribePipeline (p. 42)• GetDatasetContent (p. 45)• ListChannels (p. 48)• ListDatasets (p. 50)• ListDatastores (p. 52)• ListPipelines (p. 54)• ListTagsForResource (p. 56)• PutLoggingOptions (p. 58)• RunPipelineActivity (p. 60)• SampleChannelData (p. 63)• StartPipelineReprocessing (p. 65)• TagResource (p. 68)• UntagResource (p. 70)• UpdateChannel (p. 72)• UpdateDataset (p. 74)• UpdateDatastore (p. 77)• UpdatePipeline (p. 79)


AWS IoT Analytics AWS IoT Analytics DocumentationBatchPutMessage

BatchPutMessageSends messages to a channel.

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

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

URI Request ParametersThe request does not use any URI parameters.

Request BodyThe 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: Yesmessages (p. 3)

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

Type: Array of Message (p. 109) objects

Required: Yes

Response SyntaxHTTP/1.1 200Content-type: application/json

{ "batchPutMessageErrorEntries": [ {


AWS IoT Analytics AWS IoT Analytics DocumentationResponse Elements

"errorCode": "string", "errorMessage": "string", "messageId": "string" } ]}

Response ElementsIf 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. 3)

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

Type: Array of BatchPutMessageErrorEntry (p. 84) objects

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

InternalFailureException

There was an internal failure.

HTTP Status Code: 500InvalidRequestException

The request was not valid.

HTTP Status Code: 400ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following:

• AWS Command Line Interface• AWS SDK for .NET


https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/BatchPutMessage

AWS IoT Analytics AWS IoT Analytics DocumentationSee Also

• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V2


https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/BatchPutMessage

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/BatchPutMessage

AWS IoT Analytics AWS IoT Analytics DocumentationCancelPipelineReprocessing

CancelPipelineReprocessingCancels the reprocessing of data through the pipeline.

Request SyntaxDELETE /pipelines/pipelineName/reprocessing/reprocessingId HTTP/1.1

URI Request ParametersThe request requires the following URI parameters.

pipelineName (p. 6)

The name of pipeline for which data reprocessing is canceled.


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

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

Request BodyThe request does not have a request body.

Response SyntaxHTTP/1.1 200

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
















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python• AWS SDK for Ruby V2


https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/CancelPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/CancelPipelineReprocessing

AWS IoT Analytics AWS IoT Analytics DocumentationCreateChannel

CreateChannelCreates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessedmessages before publishing the data to a pipeline.

Request SyntaxPOST /channels HTTP/1.1Content-type: application/json

{ "channelName": "string", "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }, "tags": [ { "key": "string", "value": "string" } ]}



channelName (p. 8)

The name of the channel.

Type: String



Required: YesretentionPeriod (p. 8)

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

Type: RetentionPeriod (p. 117) object

Required: Notags (p. 8)

Metadata which can be used to manage the channel.

Type: Array of Tag (p. 121) objects

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


AWS IoT Analytics AWS IoT Analytics DocumentationResponse Syntax

Required: No


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



channelArn (p. 9)

The ARN of the channel.

Type: StringchannelName (p. 9)


Type: String


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











LimitExceededException

The command caused an internal limit to be exceeded.

HTTP Status Code: 410ResourceAlreadyExistsException

A resource with the same name already exists.









https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/CreateChannel

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/CreateChannel

AWS IoT Analytics AWS IoT Analytics DocumentationCreateDataset

CreateDatasetCreates a data set. A data set stores data retrieved from a data store by applying an SQL action.

NoteThis operation creates the skeleton of a data set. To populate the data set, call"CreateDatasetContent".

Request SyntaxPOST /datasets HTTP/1.1Content-type: application/json

{ "actions": [ { "actionName": "string", "queryAction": { "sqlQuery": "string" } } ], "datasetName": "string", "tags": [ { "key": "string", "value": "string" } ], "triggers": [ { "schedule": { "expression": "string" } } ]}



actions (p. 11)

A list of actions that create the data set. Only one action is supported at this time.

Type: Array of DatasetAction (p. 91) objects

Array Members: Fixed number of 1 item.

Required: YesdatasetName (p. 11)

The name of the data set.



Type: String



Required: Yestags (p. 11)

Metadata which can be used to manage the data set.



Required: Notriggers (p. 11)

A list of triggers. A trigger causes data set content to be populated at a specified time or timeinterval. The list of triggers can be empty or contain up to five DataSetTrigger objects.

Type: Array of DatasetTrigger (p. 95) objects

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

Required: No


{ "datasetArn": "string", "datasetName": "string"}



datasetArn (p. 12)

The ARN of the data set.

Type: StringdatasetName (p. 12)


Type: String




AWS IoT Analytics AWS IoT Analytics DocumentationErrors






HTTP Status Code: 400LimitExceededException












https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/CreateDataset

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/CreateDataset

AWS IoT Analytics AWS IoT Analytics DocumentationCreateDatasetContent

CreateDatasetContentCreates the content of a data set by applying an SQL action.

Request SyntaxPOST /datasets/datasetName/content HTTP/1.1


datasetName (p. 14)

















ServiceUnavailableException








https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/CreateDatasetContent

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/CreateDatasetContent

AWS IoT Analytics AWS IoT Analytics DocumentationCreateDatastore

CreateDatastoreCreates a data store, which is a repository for messages.

Request SyntaxPOST /datastores HTTP/1.1Content-type: application/json

{ "datastoreName": "string", "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }, "tags": [ { "key": "string", "value": "string" } ]}



datastoreName (p. 16)

The name of the data store.

Type: String



Required: YesretentionPeriod (p. 16)

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


Required: Notags (p. 16)

Metadata which can be used to manage the data store.





Required: No


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



datastoreArn (p. 17)

The ARN of the data store.

Type: StringdatastoreName (p. 17)


Type: String


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























https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/CreateDatastore

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/CreateDatastore

AWS IoT Analytics AWS IoT Analytics DocumentationCreatePipeline

CreatePipelineCreates a pipeline. A pipeline consumes messages from one or more channels and allows you to processthe messages before storing them in a data store.

Request Syntax

POST /pipelines HTTP/1.1Content-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": { "attributes": [ "string" ],


AWS IoT Analytics AWS IoT Analytics DocumentationURI Request Parameters

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



pipelineActivities (p. 19)

A list of pipeline activities.

The list can be 1-25 PipelineActivity objects. Activities perform transformations on your messages,such as removing, renaming, or adding message attributes; filtering messages based on attributevalues; invoking your Lambda functions on messages for advanced processing; or performingmathematical transformations to normalize device data.

Type: Array of PipelineActivity (p. 112) objects


Required: YespipelineName (p. 19)

The name of the pipeline.

Type: String



Required: Yestags (p. 19)

Metadata which can be used to manage the pipeline.





Required: No


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



pipelineArn (p. 21)

The ARN of the pipeline.

Type: StringpipelineName (p. 21)


Type: String






















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/CreatePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/CreatePipeline

AWS IoT Analytics AWS IoT Analytics DocumentationDeleteChannel

DeleteChannelDeletes the specified channel.

Request SyntaxDELETE /channels/channelName HTTP/1.1


channelName (p. 23)

The name of the channel to delete.
























https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DeleteChannel

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeleteChannel

AWS IoT Analytics AWS IoT Analytics DocumentationDeleteDataset

DeleteDatasetDeletes the specified data set.

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

Request SyntaxDELETE /datasets/datasetName HTTP/1.1


datasetName (p. 25)

The name of the data set to delete.























https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DeleteDataset

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeleteDataset

AWS IoT Analytics AWS IoT Analytics DocumentationDeleteDatasetContent

DeleteDatasetContentDeletes the content of the specified data set.

Request SyntaxDELETE /datasets/datasetName/content?versionId=versionId HTTP/1.1


datasetName (p. 27)

The name of the data set whose content is deleted.


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

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 notspecified, "$LATEST_SUCCEEDED" is the default.












ResourceNotFoundException










https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DeleteDatasetContent

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeleteDatasetContent

AWS IoT Analytics AWS IoT Analytics DocumentationDeleteDatastore

DeleteDatastoreDeletes the specified data store.

Request SyntaxDELETE /datastores/datastoreName HTTP/1.1



The name of the data store to delete.
























https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DeleteDatastore

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeleteDatastore

AWS IoT Analytics AWS IoT Analytics DocumentationDeletePipeline

DeletePipelineDeletes the specified pipeline.

Request SyntaxDELETE /pipelines/pipelineName HTTP/1.1


pipelineName (p. 31)

The name of the pipeline to delete.
























https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DeletePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeletePipeline

AWS IoT Analytics AWS IoT Analytics DocumentationDescribeChannel

DescribeChannelRetrieves information about a channel.

Request SyntaxGET /channels/channelName HTTP/1.1


channelName (p. 33)

The name of the channel whose information is retrieved.





{ "channel": { "arn": "string", "creationTime": number, "lastUpdateTime": number, "name": "string", "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }, "status": "string" }}



channel (p. 33)

An object that contains information about the channel.

Type: Channel (p. 85) object


















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DescribeChannel

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DescribeChannel

AWS IoT Analytics AWS IoT Analytics DocumentationDescribeDataset

DescribeDatasetRetrieves information about a data set.

Request Syntax

GET /datasets/datasetName HTTP/1.1


datasetName (p. 35)

The name of the data set whose information is retrieved.




Response Syntax

HTTP/1.1 200Content-type: application/json

{ "dataset": { "actions": [ { "actionName": "string", "queryAction": { "sqlQuery": "string" } } ], "arn": "string", "creationTime": number, "lastUpdateTime": number, "name": "string", "status": "string", "triggers": [ { "schedule": { "expression": "string" } } ] }}





dataset (p. 35)

An object that contains information about the data set.

Type: Dataset (p. 89) object














• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for JavaScript• AWS SDK for PHP V3• AWS SDK for Python


https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DescribeDataset

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DescribeDataset


• AWS SDK for Ruby V2


https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DescribeDataset

AWS IoT Analytics AWS IoT Analytics DocumentationDescribeDatastore

DescribeDatastoreRetrieves information about a data store.

Request SyntaxGET /datastores/datastoreName HTTP/1.1



The name of the data store





{ "datastore": { "arn": "string", "creationTime": number, "lastUpdateTime": number, "name": "string", "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }, "status": "string" }}



datastore (p. 38)

Information about the data store.

Type: Datastore (p. 96) object


















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DescribeDatastore

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DescribeDatastore

AWS IoT Analytics AWS IoT Analytics DocumentationDescribeLoggingOptions

DescribeLoggingOptionsRetrieves the current settings of the AWS IoT Analytics logging options.

Request SyntaxGET /logging HTTP/1.1




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



loggingOptions (p. 40)

The current settings of the AWS IoT Analytics logging options.

Type: LoggingOptions (p. 107) object


















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DescribeLoggingOptions

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DescribeLoggingOptions

AWS IoT Analytics AWS IoT Analytics DocumentationDescribePipeline

DescribePipelineRetrieves information about a pipeline.

Request SyntaxGET /pipelines/pipelineName HTTP/1.1



The name of the pipeline whose information is retrieved.





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



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



pipeline (p. 42)

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

Type: Pipeline (p. 110) object


















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/DescribePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DescribePipeline

AWS IoT Analytics AWS IoT Analytics DocumentationGetDatasetContent

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

Request SyntaxGET /datasets/datasetName/content?versionId=versionId HTTP/1.1


datasetName (p. 45)

The name of the data set whose contents are retrieved.


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

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 dataset. If not specified, "$LATEST_SUCCEEDED" is the default.



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





entries (p. 45)

A list of "DatasetEntry" objects.

Type: Array of DatasetEntry (p. 93) objectsstatus (p. 45)

The status of the data set content.

Type: DatasetContentStatus (p. 92) objecttimestamp (p. 45)

The time when the request was made.

Type: Timestamp














• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/GetDatasetContent


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


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/GetDatasetContent

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/GetDatasetContent

AWS IoT Analytics AWS IoT Analytics DocumentationListChannels

ListChannelsRetrieves a list of channels.

Request SyntaxGET /channels?maxResults=maxResults&nextToken=nextToken HTTP/1.1


maxResults (p. 48)

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. 48)

The token for the next set of results.



{ "channelSummaries": [ { "channelName": "string", "creationTime": number, "lastUpdateTime": number, "status": "string" } ], "nextToken": "string"}



channelSummaries (p. 48)

A list of "ChannelSummary" objects.



Type: Array of ChannelSummary (p. 88) objectsnextToken (p. 48)

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

Type: String














https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/ListChannels

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ListChannels

AWS IoT Analytics AWS IoT Analytics DocumentationListDatasets

ListDatasetsRetrieves information about data sets.

Request SyntaxGET /datasets?maxResults=maxResults&nextToken=nextToken HTTP/1.1


maxResults (p. 50)







{ "datasetSummaries": [ { "creationTime": number, "datasetName": "string", "lastUpdateTime": number, "status": "string" } ], "nextToken": "string"}



datasetSummaries (p. 50)

A list of "DatasetSummary" objects.



Type: Array of DatasetSummary (p. 94) objectsnextToken (p. 50)


Type: String














https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/ListDatasets

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ListDatasets

AWS IoT Analytics AWS IoT Analytics DocumentationListDatastores

ListDatastoresRetrieves a list of data stores.

Request SyntaxGET /datastores?maxResults=maxResults&nextToken=nextToken HTTP/1.1


maxResults (p. 52)







{ "datastoreSummaries": [ { "creationTime": number, "datastoreName": "string", "lastUpdateTime": number, "status": "string" } ], "nextToken": "string"}



datastoreSummaries (p. 52)

A list of "DatastoreSummary" objects.



Type: Array of DatastoreSummary (p. 99) objectsnextToken (p. 52)


Type: String














https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/ListDatastores

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ListDatastores

AWS IoT Analytics AWS IoT Analytics DocumentationListPipelines

ListPipelinesRetrieves a list of pipelines.

Request SyntaxGET /pipelines?maxResults=maxResults&nextToken=nextToken HTTP/1.1


maxResults (p. 54)







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





nextToken (p. 54)


Type: StringpipelineSummaries (p. 54)

A list of "PipelineSummary" objects.

Type: Array of PipelineSummary (p. 114) objects














https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/ListPipelines

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ListPipelines

AWS IoT Analytics AWS IoT Analytics DocumentationListTagsForResource

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

Request SyntaxGET /tags?resourceArn=resourceArn HTTP/1.1


resourceArn (p. 56)

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




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



tags (p. 56)

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






















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/ListTagsForResource

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ListTagsForResource

AWS IoT Analytics AWS IoT Analytics DocumentationPutLoggingOptions

PutLoggingOptionsSets 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 thechange 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 SyntaxPUT /logging HTTP/1.1Content-type: application/json

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



loggingOptions (p. 58)

The new values of the AWS IoT Analytics logging options.

Type: LoggingOptions (p. 107) object

Required: Yes


















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/PutLoggingOptions

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/PutLoggingOptions

AWS IoT Analytics AWS IoT Analytics DocumentationRunPipelineActivity

RunPipelineActivitySimulates the results of running a pipeline activity on a message payload.

Request SyntaxPOST /pipelineactivities/run HTTP/1.1Content-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"



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



payloads (p. 60)

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

Type: Array of Base64-encoded binary data objects


Required: YespipelineActivity (p. 60)

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

Type: PipelineActivity (p. 112) object

Required: Yes


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



logResult (p. 61)

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



Type: Stringpayloads (p. 61)

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
















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/RunPipelineActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/RunPipelineActivity

AWS IoT Analytics AWS IoT Analytics DocumentationSampleChannelData

SampleChannelDataRetrieves a sample of messages from the specified channel ingested during the specified timeframe. Upto 10 messages can be retrieved.

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


channelName (p. 63)

The name of the channel whose message samples are retrieved.


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

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

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. 63)

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



{ "payloads": [ blob ]}





payloads (p. 63)

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


















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/SampleChannelData

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/SampleChannelData

AWS IoT Analytics AWS IoT Analytics DocumentationStartPipelineReprocessing

StartPipelineReprocessingStarts the reprocessing of raw message data through the pipeline.

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

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



The name of the pipeline on which to start reprocessing.




endTime (p. 65)

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

Type: Timestamp

Required: NostartTime (p. 65)

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

Type: Timestamp

Required: No


{ "reprocessingId": "string"}





reprocessingId (p. 65)

The ID of the pipeline reprocessing activity that was started.

Type: String
















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go


https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/StartPipelineReprocessing


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


https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/StartPipelineReprocessing

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/StartPipelineReprocessing

AWS IoT Analytics AWS IoT Analytics DocumentationTagResource

TagResourceAdds to or modifies the tags of the given resource. Tags are metadata which can be used to manage aresource.

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

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


resourceArn (p. 68)

The ARN of the resource whose tags will be modified.



tags (p. 68)

The new or modified tags for the resource.



Required: Yes






















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/TagResource

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/TagResource

AWS IoT Analytics AWS IoT Analytics DocumentationUntagResource

UntagResourceRemoves the given tags (metadata) from the resource.

Request SyntaxDELETE /tags?resourceArn=resourceArn&tagKeys=tagKeys HTTP/1.1


resourceArn (p. 70)

The ARN of the resource whose tags will be removed.

Length Constraints: Minimum length of 20. Maximum length of 2048.tagKeys (p. 70)

The keys of those tags which will be removed.


























https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/UntagResource

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/UntagResource

AWS IoT Analytics AWS IoT Analytics DocumentationUpdateChannel

UpdateChannelUpdates the settings of a channel.

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

{ "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }}


channelName (p. 72)

The name of the channel to be updated.




retentionPeriod (p. 72)



Required: No




















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/UpdateChannel

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/UpdateChannel

AWS IoT Analytics AWS IoT Analytics DocumentationUpdateDataset

UpdateDatasetUpdates the settings of a data set.

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

{ "actions": [ { "actionName": "string", "queryAction": { "sqlQuery": "string" } } ], "triggers": [ { "schedule": { "expression": "string" } } ]}


datasetName (p. 74)

The name of the data set to update.




actions (p. 74)

A list of "DatasetAction" objects. Only one action is supported at this time.



Required: Yestriggers (p. 74)

A list of "DatasetTrigger" objects. The list can be empty or can contain up to five DataSetTriggerobjects.





Required: No
















• AWS Command Line Interface• AWS SDK for .NET• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java


https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/UpdateDataset


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


https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/UpdateDataset

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/UpdateDataset

AWS IoT Analytics AWS IoT Analytics DocumentationUpdateDatastore

UpdateDatastoreUpdates the settings of a data store.

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

{ "retentionPeriod": { "numberOfDays": number, "unlimited": boolean }}



The name of the data store to be updated.




retentionPeriod (p. 77)



Required: No




















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/UpdateDatastore

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/UpdateDatastore

AWS IoT Analytics AWS IoT Analytics DocumentationUpdatePipeline

UpdatePipelineUpdates the settings of a pipeline.

Request SyntaxPUT /pipelines/pipelineName HTTP/1.1Content-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": { "attributes": [ "string" ], "name": "string", "next": "string"



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



The name of the pipeline to update.




pipelineActivities (p. 79)

A list of "PipelineActivity" objects.

The list can be 1-25 PipelineActivity objects. Activities perform transformations on your messages,such as removing, renaming or adding message attributes; filtering messages based on attributevalues; invoking your Lambda functions on messages for advanced processing; or performingmathematical transformations to normalize device data.



Required: Yes






















https://docs.aws.amazon.com/goto/aws-cli/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/DotNetSDKV3/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/SdkForPHPV3/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/boto3/iotanalytics-2017-11-27/UpdatePipeline

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/UpdatePipeline


Data TypesThe AWS IoT Analytics API contains several data types that various actions use. This section describeseach data type in detail.

NoteThe order of each element in a data type structure is not guaranteed. Applications should notassume a particular order.

The following data types are supported:

• AddAttributesActivity (p. 83)• BatchPutMessageErrorEntry (p. 84)• Channel (p. 85)• ChannelActivity (p. 87)• ChannelSummary (p. 88)• Dataset (p. 89)• DatasetAction (p. 91)• DatasetContentStatus (p. 92)• DatasetEntry (p. 93)• DatasetSummary (p. 94)• DatasetTrigger (p. 95)• Datastore (p. 96)• DatastoreActivity (p. 98)• DatastoreSummary (p. 99)• DeviceRegistryEnrichActivity (p. 100)• DeviceShadowEnrichActivity (p. 102)• FilterActivity (p. 104)• LambdaActivity (p. 105)• LoggingOptions (p. 107)• MathActivity (p. 108)• Message (p. 109)• Pipeline (p. 110)• PipelineActivity (p. 112)• PipelineSummary (p. 114)• RemoveAttributesActivity (p. 115)• ReprocessingSummary (p. 116)• RetentionPeriod (p. 117)• Schedule (p. 118)• SelectAttributesActivity (p. 119)• SqlQueryDatasetAction (p. 120)• Tag (p. 121)


AWS IoT Analytics AWS IoT Analytics DocumentationAddAttributesActivity

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

Contentsattributes

A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.

NoteThe 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: Yesname

The name of the 'addAttributes' activity.

Type: String


Required: Yesnext

The next activity in the pipeline.

Type: String


Required: No


• AWS SDK for C++• AWS SDK for Go• AWS SDK for Java• AWS SDK for Ruby V2


https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/AddAttributesActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/AddAttributesActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/AddAttributesActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/AddAttributesActivity

AWS IoT Analytics AWS IoT Analytics DocumentationBatchPutMessageErrorEntry

BatchPutMessageErrorEntryContains informations about errors.

ContentserrorCode

The code associated with the error.

Type: String

Required: NoerrorMessage

The message associated with the error.

Type: String

Required: NomessageId

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

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/BatchPutMessageErrorEntry

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/BatchPutMessageErrorEntry

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/BatchPutMessageErrorEntry

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/BatchPutMessageErrorEntry

AWS IoT Analytics AWS IoT Analytics DocumentationChannel

ChannelA collection of data from an MQTT topic. Channels archive the raw, unprocessed messages beforepublishing the data to a pipeline.

Contentsarn

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


Type: String



Required: No

retentionPeriod



Required: No

status

The status of the channel.

Type: String

Valid Values: CREATING | ACTIVE | DELETING

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Channel

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Channel

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Channel

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Channel

AWS IoT Analytics AWS IoT Analytics DocumentationChannelActivity

ChannelActivityThe activity that determines the source of the messages to be processed.

ContentschannelName

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

Type: String



Required: Yesname

The name of the 'channel' activity.

Type: String


Required: Yesnext


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ChannelActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ChannelActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ChannelActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ChannelActivity

AWS IoT Analytics AWS IoT Analytics DocumentationChannelSummary

ChannelSummaryA summary of information about a channel.

ContentschannelName


Type: String



Required: NocreationTime

When the channel was created.

Type: Timestamp

Required: NolastUpdateTime

The last time the channel was updated.

Type: Timestamp

Required: Nostatus

The status of the channel.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ChannelSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ChannelSummary

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ChannelSummary

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ChannelSummary

AWS IoT Analytics AWS IoT Analytics DocumentationDataset

DatasetInformation about a data set.

Contentsactions

The "DatasetAction" objects that create the data set.



Required: Noarn

The ARN of the data set.

Type: String


When the data set was created.

Type: Timestamp


The last time the data set was updated.

Type: Timestamp

Required: Noname


Type: String



Required: Nostatus

The status of the data set.

Type: String


Required: Notriggers

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





Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Dataset

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Dataset

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Dataset

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Dataset

AWS IoT Analytics AWS IoT Analytics DocumentationDatasetAction

DatasetActionA "DatasetAction" object specifying the query that creates the data set content.

ContentsactionName

The name of the data set action.

Type: String



Required: NoqueryAction

An "SqlQueryDatasetAction" object that contains the SQL query to modify the message.

Type: SqlQueryDatasetAction (p. 120) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatasetAction

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatasetAction

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatasetAction

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatasetAction

AWS IoT Analytics AWS IoT Analytics DocumentationDatasetContentStatus

DatasetContentStatusThe state of the data set and the reason it is in this state.

Contentsreason

The reason the data set is in this state.

Type: String

Required: Nostate

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

Type: String

Valid Values: CREATING | SUCCEEDED | FAILED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatasetContentStatus

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatasetContentStatus

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatasetContentStatus

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatasetContentStatus

AWS IoT Analytics AWS IoT Analytics DocumentationDatasetEntry

DatasetEntryThe reference to a data set entry.

ContentsdataURI

The pre-signed URI of the data set item.

Type: String

Required: NoentryName

The name of the data set item.

Type: String

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatasetEntry

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatasetEntry

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatasetEntry

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatasetEntry

AWS IoT Analytics AWS IoT Analytics DocumentationDatasetSummary

DatasetSummaryA summary of information about a data set.

ContentscreationTime

The time the data set was created.

Type: Timestamp

Required: NodatasetName


Type: String




The last time the data set was updated.

Type: Timestamp

Required: Nostatus

The status of the data set.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatasetSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatasetSummary

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatasetSummary

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatasetSummary

AWS IoT Analytics AWS IoT Analytics DocumentationDatasetTrigger

DatasetTriggerThe "DatasetTrigger" that specifies when the data set is automatically updated.

Contentsschedule

The "Schedule" when the trigger is initiated.

Type: Schedule (p. 118) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatasetTrigger

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatasetTrigger

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatasetTrigger

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatasetTrigger

AWS IoT Analytics AWS IoT Analytics DocumentationDatastore

DatastoreInformation about a data store.

Contentsarn

The ARN of the data store.

Type: String


When the data store was created.

Type: Timestamp


The last time the data store was updated.

Type: Timestamp

Required: Noname


Type: String



Required: NoretentionPeriod



Required: Nostatus

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.



Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Datastore

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Datastore

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Datastore

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Datastore

AWS IoT Analytics AWS IoT Analytics DocumentationDatastoreActivity

DatastoreActivityThe 'datastore' activity that specifies where to store the processed data.

ContentsdatastoreName

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

Type: String



Required: Yesname

The name of the 'datastore' activity.

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatastoreActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatastoreActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatastoreActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatastoreActivity

AWS IoT Analytics AWS IoT Analytics DocumentationDatastoreSummary

DatastoreSummaryA summary of information about a data store.


When the data store was created.

Type: Timestamp

Required: NodatastoreName


Type: String




The last time the data store was updated.

Type: Timestamp

Required: Nostatus

The status of the data store.

Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DatastoreSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DatastoreSummary

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DatastoreSummary

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DatastoreSummary

AWS IoT Analytics AWS IoT Analytics DocumentationDeviceRegistryEnrichActivity

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

Contentsattribute

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

Type: String


Required: Yesname

The name of the 'deviceRegistryEnrich' activity.

Type: String


Required: Yesnext


Type: String


Required: NoroleArn

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

Type: String


Required: YesthingName

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

Type: String


Required: Yes


• AWS SDK for C++


https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeviceRegistryEnrichActivity


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


https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeviceRegistryEnrichActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeviceRegistryEnrichActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeviceRegistryEnrichActivity

AWS IoT Analytics AWS IoT Analytics DocumentationDeviceShadowEnrichActivity

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

Contentsattribute

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

Type: String


Required: Yesname

The name of the 'deviceShadowEnrich' activity.

Type: String


Required: Yesnext


Type: String


Required: NoroleArn

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

Type: String


Required: YesthingName

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

Type: String


Required: Yes


• AWS SDK for C++


https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/DeviceShadowEnrichActivity


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


https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/DeviceShadowEnrichActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/DeviceShadowEnrichActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/DeviceShadowEnrichActivity

AWS IoT Analytics AWS IoT Analytics DocumentationFilterActivity

FilterActivityAn activity that filters a message based on its attributes.

Contentsfilter

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

Type: String


Required: Yesname

The name of the 'filter' activity.

Type: String


Required: Yesnext


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/FilterActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/FilterActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/FilterActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/FilterActivity

AWS IoT Analytics AWS IoT Analytics DocumentationLambdaActivity

LambdaActivityAn activity that runs a Lambda function to modify the message.

ContentsbatchSize

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 five minutes, whichis the maximum timeout duration for Lambda functions.

Type: Integer

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

Required: YeslambdaName

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

Type: String


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

Required: Yesname

The name of the 'lambda' activity.

Type: String


Required: Yesnext


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/LambdaActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/LambdaActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/LambdaActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/LambdaActivity

AWS IoT Analytics AWS IoT Analytics DocumentationLoggingOptions

LoggingOptionsInformation about logging options.

Contentsenabled

If true, logging is enabled for AWS IoT Analytics.

Type: Boolean

Required: Yeslevel

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

Type: String

Valid Values: ERROR

Required: YesroleArn

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

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/LoggingOptions

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/LoggingOptions

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/LoggingOptions

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/LoggingOptions

AWS IoT Analytics AWS IoT Analytics DocumentationMathActivity

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

Contentsattribute

The name of the attribute that will contain the result of the math operation.

Type: String


Required: Yesmath

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

Type: String


Required: Yesname

The name of the 'math' activity.

Type: String


Required: Yesnext


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/MathActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/MathActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/MathActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/MathActivity

AWS IoT Analytics AWS IoT Analytics DocumentationMessage

MessageInformation about a message.

ContentsmessageId

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

Type: String


Required: Yespayload

The payload of the message.

Type: Base64-encoded binary data object

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Message

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Message

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Message

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Message

AWS IoT Analytics AWS IoT Analytics DocumentationPipeline

PipelineContains information about a pipeline.

Contentsactivities

The activities that perform transformations on the messages.



Required: Noarn

The ARN of the pipeline.

Type: String


When the pipeline was created.

Type: Timestamp


The last time the pipeline was updated.

Type: Timestamp

Required: Noname


Type: String



Required: NoreprocessingSummaries

A summary of information about the pipeline reprocessing.

Type: Array of ReprocessingSummary (p. 116) objects

Required: No






https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Pipeline

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Pipeline

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Pipeline

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Pipeline

AWS IoT Analytics AWS IoT Analytics DocumentationPipelineActivity

PipelineActivityAn activity that performs a transformation on a message.

ContentsaddAttributes

Adds other attributes based on existing attributes in the message.

Type: AddAttributesActivity (p. 83) object

Required: Nochannel

Determines the source of the messages to be processed.

Type: ChannelActivity (p. 87) object

Required: Nodatastore

Specifies where to store the processed message data.

Type: DatastoreActivity (p. 98) object

Required: NodeviceRegistryEnrich

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

Type: DeviceRegistryEnrichActivity (p. 100) object

Required: NodeviceShadowEnrich

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

Type: DeviceShadowEnrichActivity (p. 102) object

Required: Nofilter

Filters a message based on its attributes.

Type: FilterActivity (p. 104) object

Required: Nolambda

Runs a Lambda function to modify the message.

Type: LambdaActivity (p. 105) object

Required: Nomath

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



Type: MathActivity (p. 108) object

Required: NoremoveAttributes

Removes attributes from a message.

Type: RemoveAttributesActivity (p. 115) object

Required: NoselectAttributes

Creates a new message using only the specified attributes from the original message.

Type: SelectAttributesActivity (p. 119) object

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/PipelineActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/PipelineActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/PipelineActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/PipelineActivity

AWS IoT Analytics AWS IoT Analytics DocumentationPipelineSummary

PipelineSummaryA summary of information about a pipeline.


When the pipeline was created.

Type: Timestamp


When the pipeline was last updated.

Type: Timestamp

Required: NopipelineName


Type: String



Required: NoreprocessingSummaries

A summary of information about the pipeline reprocessing.

Type: Array of ReprocessingSummary (p. 116) objects

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/PipelineSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/PipelineSummary

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/PipelineSummary

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/PipelineSummary

AWS IoT Analytics AWS IoT Analytics DocumentationRemoveAttributesActivity

RemoveAttributesActivityAn activity that removes attributes from a message.

Contentsattributes

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

Type: Array of strings



Required: Yesname

The name of the 'removeAttributes' activity.

Type: String


Required: Yesnext


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/RemoveAttributesActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/RemoveAttributesActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/RemoveAttributesActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/RemoveAttributesActivity

AWS IoT Analytics AWS IoT Analytics DocumentationReprocessingSummary

ReprocessingSummaryInformation about pipeline reprocessing.


The time the pipeline reprocessing was created.

Type: Timestamp

Required: Noid

The 'reprocessingId' returned by "StartPipelineReprocessing".

Type: String

Required: Nostatus

The status of the pipeline reprocessing.

Type: String

Valid Values: RUNNING | SUCCEEDED | CANCELLED | FAILED

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/ReprocessingSummary

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/ReprocessingSummary

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/ReprocessingSummary

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/ReprocessingSummary

AWS IoT Analytics AWS IoT Analytics DocumentationRetentionPeriod

RetentionPeriodHow long, in days, message data is kept.

ContentsnumberOfDays

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

Type: Integer

Valid Range: Minimum value of 1.

Required: Nounlimited

If true, message data is kept indefinitely.

Type: Boolean

Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/RetentionPeriod

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/RetentionPeriod

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/RetentionPeriod

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/RetentionPeriod

AWS IoT Analytics AWS IoT Analytics DocumentationSchedule

ScheduleThe schedule for when to trigger an update.

Contentsexpression

The expression that defines when to trigger an update. For more information, see ScheduleExpressions for Rules in the Amazon CloudWatch documentation.

Type: String

Required: No




https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html

https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Schedule

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Schedule

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Schedule

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Schedule

AWS IoT Analytics AWS IoT Analytics DocumentationSelectAttributesActivity

SelectAttributesActivityCreates a new message using only the specified attributes from the original message.

Contentsattributes

A list of the attributes to select from the message.

Type: Array of strings



Required: Yesname

The name of the 'selectAttributes' activity.

Type: String


Required: Yesnext


Type: String


Required: No




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/SelectAttributesActivity

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/SelectAttributesActivity

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/SelectAttributesActivity

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/SelectAttributesActivity

AWS IoT Analytics AWS IoT Analytics DocumentationSqlQueryDatasetAction

SqlQueryDatasetActionThe SQL query to modify the message.

ContentssqlQuery

An SQL query string.

Type: String

Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/SqlQueryDatasetAction

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/SqlQueryDatasetAction

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/SqlQueryDatasetAction

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/SqlQueryDatasetAction

AWS IoT Analytics AWS IoT Analytics DocumentationTag

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

Contentskey

The tag's key.

Type: String


Required: Yesvalue

The tag's value.

Type: String


Required: Yes




https://docs.aws.amazon.com/goto/SdkForCpp/iotanalytics-2017-11-27/Tag

https://docs.aws.amazon.com/goto/SdkForGoV1/iotanalytics-2017-11-27/Tag

https://docs.aws.amazon.com/goto/SdkForJava/iotanalytics-2017-11-27/Tag

https://docs.aws.amazon.com/goto/SdkForRubyV2/iotanalytics-2017-11-27/Tag


Common ParametersThe following list contains the parameters that all actions use for signing Signature Version 4 requestswith a query string. Any action-specific parameters are listed in the topic for that action. For moreinformation about Signature Version 4, see Signature Version 4 Signing Process in the Amazon WebServices General Reference.

Action

The action to be performed.

Type: string

Required: YesVersion

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: YesX-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 stringinstead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: ConditionalX-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region youare targeting, the service you are requesting, and a termination string ("aws4_request"). The value isexpressed 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 WebServices General Reference.


Type: string

Required: ConditionalX-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 forsigning requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is


http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-string-to-sign.html


not required. When X-Amz-Date is used, it always overrides the value of the Date header. Formore information, see Handling Dates in Signature Version 4 in the Amazon Web Services GeneralReference.

Type: string

Required: ConditionalX-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service (AWSSTS). For a list of services that support temporary security credentials from AWS Security TokenService, 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, youmust include the security token.

Type: string

Required: ConditionalX-Amz-Signature

Specifies the hex-encoded signature that was calculated from the string to sign and the derivedsigning key.


Type: string

Required: ConditionalX-Amz-SignedHeaders

Specifies all the HTTP headers that were included as part of the canonical request. For moreinformation about specifying signed headers, see Task 1: Create a Canonical Request For SignatureVersion 4 in the Amazon Web Services General Reference.


Type: string

Required: Conditional


http://docs.aws.amazon.com/general/latest/gr/sigv4-date-handling.html

http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html

http://docs.aws.amazon.com/general/latest/gr/sigv4-create-canonical-request.html


Common ErrorsThis section lists the errors common to the API actions of all AWS services. For errors specific to an APIaction for this service, see the topic for that API action.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400InvalidClientTokenId

The X.509 certificate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403InvalidParameterCombination

Parameters that must not be used together were used together.

HTTP Status Code: 400InvalidParameterValue

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400InvalidQueryParameter

The AWS query string is malformed or does not adhere to AWS standards.

HTTP Status Code: 400MalformedQueryString

The query string contains a syntax error.

HTTP Status Code: 404MissingAction

The request is missing an action or a required parameter.




MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 403MissingParameter

A required parameter for the specified action is not supplied.

HTTP Status Code: 400OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or morethan 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stampon the request is more than 15 minutes in the future.

HTTP Status Code: 400ServiceUnavailable

The request has failed due to a temporary failure of the server.



HTTP Status Code: 400ValidationError

The input fails to satisfy the constraints specified by an AWS service.



aws iot analytics - aws iot analytics documentation · aws iot analytics automates the steps...

Documents