UNPKG

64.5 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class IoTAnalytics extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: IoTAnalytics.Types.ClientConfiguration)
13 config: Config & IoTAnalytics.Types.ClientConfiguration;
14 /**
15 * Sends messages to a channel.
16 */
17 batchPutMessage(params: IoTAnalytics.Types.BatchPutMessageRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.BatchPutMessageResponse) => void): Request<IoTAnalytics.Types.BatchPutMessageResponse, AWSError>;
18 /**
19 * Sends messages to a channel.
20 */
21 batchPutMessage(callback?: (err: AWSError, data: IoTAnalytics.Types.BatchPutMessageResponse) => void): Request<IoTAnalytics.Types.BatchPutMessageResponse, AWSError>;
22 /**
23 * Cancels the reprocessing of data through the pipeline.
24 */
25 cancelPipelineReprocessing(params: IoTAnalytics.Types.CancelPipelineReprocessingRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CancelPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.CancelPipelineReprocessingResponse, AWSError>;
26 /**
27 * Cancels the reprocessing of data through the pipeline.
28 */
29 cancelPipelineReprocessing(callback?: (err: AWSError, data: IoTAnalytics.Types.CancelPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.CancelPipelineReprocessingResponse, AWSError>;
30 /**
31 * Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
32 */
33 createChannel(params: IoTAnalytics.Types.CreateChannelRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateChannelResponse) => void): Request<IoTAnalytics.Types.CreateChannelResponse, AWSError>;
34 /**
35 * Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.
36 */
37 createChannel(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateChannelResponse) => void): Request<IoTAnalytics.Types.CreateChannelResponse, AWSError>;
38 /**
39 * Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify.
40 */
41 createDataset(params: IoTAnalytics.Types.CreateDatasetRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetResponse) => void): Request<IoTAnalytics.Types.CreateDatasetResponse, AWSError>;
42 /**
43 * Creates a data set. A data set stores data retrieved from a data store by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling "CreateDatasetContent" or automatically according to a "trigger" you specify.
44 */
45 createDataset(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetResponse) => void): Request<IoTAnalytics.Types.CreateDatasetResponse, AWSError>;
46 /**
47 * Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).
48 */
49 createDatasetContent(params: IoTAnalytics.Types.CreateDatasetContentRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request<IoTAnalytics.Types.CreateDatasetContentResponse, AWSError>;
50 /**
51 * Creates the content of a data set by applying a "queryAction" (a SQL query) or a "containerAction" (executing a containerized application).
52 */
53 createDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatasetContentResponse) => void): Request<IoTAnalytics.Types.CreateDatasetContentResponse, AWSError>;
54 /**
55 * Creates a data store, which is a repository for messages.
56 */
57 createDatastore(params: IoTAnalytics.Types.CreateDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request<IoTAnalytics.Types.CreateDatastoreResponse, AWSError>;
58 /**
59 * Creates a data store, which is a repository for messages.
60 */
61 createDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.CreateDatastoreResponse) => void): Request<IoTAnalytics.Types.CreateDatastoreResponse, AWSError>;
62 /**
63 * Creates a pipeline. A pipeline consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
64 */
65 createPipeline(params: IoTAnalytics.Types.CreatePipelineRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.CreatePipelineResponse) => void): Request<IoTAnalytics.Types.CreatePipelineResponse, AWSError>;
66 /**
67 * Creates a pipeline. A pipeline consumes messages from one or more channels and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
68 */
69 createPipeline(callback?: (err: AWSError, data: IoTAnalytics.Types.CreatePipelineResponse) => void): Request<IoTAnalytics.Types.CreatePipelineResponse, AWSError>;
70 /**
71 * Deletes the specified channel.
72 */
73 deleteChannel(params: IoTAnalytics.Types.DeleteChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74 /**
75 * Deletes the specified channel.
76 */
77 deleteChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * Deletes the specified data set. You do not have to delete the content of the data set before you perform this operation.
80 */
81 deleteDataset(params: IoTAnalytics.Types.DeleteDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * Deletes the specified data set. You do not have to delete the content of the data set before you perform this operation.
84 */
85 deleteDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86 /**
87 * Deletes the content of the specified data set.
88 */
89 deleteDatasetContent(params: IoTAnalytics.Types.DeleteDatasetContentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90 /**
91 * Deletes the content of the specified data set.
92 */
93 deleteDatasetContent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
94 /**
95 * Deletes the specified data store.
96 */
97 deleteDatastore(params: IoTAnalytics.Types.DeleteDatastoreRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
98 /**
99 * Deletes the specified data store.
100 */
101 deleteDatastore(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
102 /**
103 * Deletes the specified pipeline.
104 */
105 deletePipeline(params: IoTAnalytics.Types.DeletePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
106 /**
107 * Deletes the specified pipeline.
108 */
109 deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
110 /**
111 * Retrieves information about a channel.
112 */
113 describeChannel(params: IoTAnalytics.Types.DescribeChannelRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeChannelResponse) => void): Request<IoTAnalytics.Types.DescribeChannelResponse, AWSError>;
114 /**
115 * Retrieves information about a channel.
116 */
117 describeChannel(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeChannelResponse) => void): Request<IoTAnalytics.Types.DescribeChannelResponse, AWSError>;
118 /**
119 * Retrieves information about a data set.
120 */
121 describeDataset(params: IoTAnalytics.Types.DescribeDatasetRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatasetResponse) => void): Request<IoTAnalytics.Types.DescribeDatasetResponse, AWSError>;
122 /**
123 * Retrieves information about a data set.
124 */
125 describeDataset(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatasetResponse) => void): Request<IoTAnalytics.Types.DescribeDatasetResponse, AWSError>;
126 /**
127 * Retrieves information about a data store.
128 */
129 describeDatastore(params: IoTAnalytics.Types.DescribeDatastoreRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatastoreResponse) => void): Request<IoTAnalytics.Types.DescribeDatastoreResponse, AWSError>;
130 /**
131 * Retrieves information about a data store.
132 */
133 describeDatastore(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeDatastoreResponse) => void): Request<IoTAnalytics.Types.DescribeDatastoreResponse, AWSError>;
134 /**
135 * Retrieves the current settings of the AWS IoT Analytics logging options.
136 */
137 describeLoggingOptions(params: IoTAnalytics.Types.DescribeLoggingOptionsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeLoggingOptionsResponse) => void): Request<IoTAnalytics.Types.DescribeLoggingOptionsResponse, AWSError>;
138 /**
139 * Retrieves the current settings of the AWS IoT Analytics logging options.
140 */
141 describeLoggingOptions(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribeLoggingOptionsResponse) => void): Request<IoTAnalytics.Types.DescribeLoggingOptionsResponse, AWSError>;
142 /**
143 * Retrieves information about a pipeline.
144 */
145 describePipeline(params: IoTAnalytics.Types.DescribePipelineRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.DescribePipelineResponse) => void): Request<IoTAnalytics.Types.DescribePipelineResponse, AWSError>;
146 /**
147 * Retrieves information about a pipeline.
148 */
149 describePipeline(callback?: (err: AWSError, data: IoTAnalytics.Types.DescribePipelineResponse) => void): Request<IoTAnalytics.Types.DescribePipelineResponse, AWSError>;
150 /**
151 * Retrieves the contents of a data set as pre-signed URIs.
152 */
153 getDatasetContent(params: IoTAnalytics.Types.GetDatasetContentRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.GetDatasetContentResponse) => void): Request<IoTAnalytics.Types.GetDatasetContentResponse, AWSError>;
154 /**
155 * Retrieves the contents of a data set as pre-signed URIs.
156 */
157 getDatasetContent(callback?: (err: AWSError, data: IoTAnalytics.Types.GetDatasetContentResponse) => void): Request<IoTAnalytics.Types.GetDatasetContentResponse, AWSError>;
158 /**
159 * Retrieves a list of channels.
160 */
161 listChannels(params: IoTAnalytics.Types.ListChannelsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListChannelsResponse) => void): Request<IoTAnalytics.Types.ListChannelsResponse, AWSError>;
162 /**
163 * Retrieves a list of channels.
164 */
165 listChannels(callback?: (err: AWSError, data: IoTAnalytics.Types.ListChannelsResponse) => void): Request<IoTAnalytics.Types.ListChannelsResponse, AWSError>;
166 /**
167 * Lists information about data set contents that have been created.
168 */
169 listDatasetContents(params: IoTAnalytics.Types.ListDatasetContentsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetContentsResponse) => void): Request<IoTAnalytics.Types.ListDatasetContentsResponse, AWSError>;
170 /**
171 * Lists information about data set contents that have been created.
172 */
173 listDatasetContents(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetContentsResponse) => void): Request<IoTAnalytics.Types.ListDatasetContentsResponse, AWSError>;
174 /**
175 * Retrieves information about data sets.
176 */
177 listDatasets(params: IoTAnalytics.Types.ListDatasetsRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetsResponse) => void): Request<IoTAnalytics.Types.ListDatasetsResponse, AWSError>;
178 /**
179 * Retrieves information about data sets.
180 */
181 listDatasets(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatasetsResponse) => void): Request<IoTAnalytics.Types.ListDatasetsResponse, AWSError>;
182 /**
183 * Retrieves a list of data stores.
184 */
185 listDatastores(params: IoTAnalytics.Types.ListDatastoresRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatastoresResponse) => void): Request<IoTAnalytics.Types.ListDatastoresResponse, AWSError>;
186 /**
187 * Retrieves a list of data stores.
188 */
189 listDatastores(callback?: (err: AWSError, data: IoTAnalytics.Types.ListDatastoresResponse) => void): Request<IoTAnalytics.Types.ListDatastoresResponse, AWSError>;
190 /**
191 * Retrieves a list of pipelines.
192 */
193 listPipelines(params: IoTAnalytics.Types.ListPipelinesRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListPipelinesResponse) => void): Request<IoTAnalytics.Types.ListPipelinesResponse, AWSError>;
194 /**
195 * Retrieves a list of pipelines.
196 */
197 listPipelines(callback?: (err: AWSError, data: IoTAnalytics.Types.ListPipelinesResponse) => void): Request<IoTAnalytics.Types.ListPipelinesResponse, AWSError>;
198 /**
199 * Lists the tags (metadata) which you have assigned to the resource.
200 */
201 listTagsForResource(params: IoTAnalytics.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.ListTagsForResourceResponse) => void): Request<IoTAnalytics.Types.ListTagsForResourceResponse, AWSError>;
202 /**
203 * Lists the tags (metadata) which you have assigned to the resource.
204 */
205 listTagsForResource(callback?: (err: AWSError, data: IoTAnalytics.Types.ListTagsForResourceResponse) => void): Request<IoTAnalytics.Types.ListTagsForResourceResponse, AWSError>;
206 /**
207 * Sets or updates the AWS IoT Analytics logging options. Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.
208 */
209 putLoggingOptions(params: IoTAnalytics.Types.PutLoggingOptionsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
210 /**
211 * Sets or updates the AWS IoT Analytics logging options. Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.
212 */
213 putLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
214 /**
215 * Simulates the results of running a pipeline activity on a message payload.
216 */
217 runPipelineActivity(params: IoTAnalytics.Types.RunPipelineActivityRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.RunPipelineActivityResponse) => void): Request<IoTAnalytics.Types.RunPipelineActivityResponse, AWSError>;
218 /**
219 * Simulates the results of running a pipeline activity on a message payload.
220 */
221 runPipelineActivity(callback?: (err: AWSError, data: IoTAnalytics.Types.RunPipelineActivityResponse) => void): Request<IoTAnalytics.Types.RunPipelineActivityResponse, AWSError>;
222 /**
223 * Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
224 */
225 sampleChannelData(params: IoTAnalytics.Types.SampleChannelDataRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.SampleChannelDataResponse) => void): Request<IoTAnalytics.Types.SampleChannelDataResponse, AWSError>;
226 /**
227 * Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.
228 */
229 sampleChannelData(callback?: (err: AWSError, data: IoTAnalytics.Types.SampleChannelDataResponse) => void): Request<IoTAnalytics.Types.SampleChannelDataResponse, AWSError>;
230 /**
231 * Starts the reprocessing of raw message data through the pipeline.
232 */
233 startPipelineReprocessing(params: IoTAnalytics.Types.StartPipelineReprocessingRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.StartPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.StartPipelineReprocessingResponse, AWSError>;
234 /**
235 * Starts the reprocessing of raw message data through the pipeline.
236 */
237 startPipelineReprocessing(callback?: (err: AWSError, data: IoTAnalytics.Types.StartPipelineReprocessingResponse) => void): Request<IoTAnalytics.Types.StartPipelineReprocessingResponse, AWSError>;
238 /**
239 * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
240 */
241 tagResource(params: IoTAnalytics.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.TagResourceResponse) => void): Request<IoTAnalytics.Types.TagResourceResponse, AWSError>;
242 /**
243 * Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.
244 */
245 tagResource(callback?: (err: AWSError, data: IoTAnalytics.Types.TagResourceResponse) => void): Request<IoTAnalytics.Types.TagResourceResponse, AWSError>;
246 /**
247 * Removes the given tags (metadata) from the resource.
248 */
249 untagResource(params: IoTAnalytics.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTAnalytics.Types.UntagResourceResponse) => void): Request<IoTAnalytics.Types.UntagResourceResponse, AWSError>;
250 /**
251 * Removes the given tags (metadata) from the resource.
252 */
253 untagResource(callback?: (err: AWSError, data: IoTAnalytics.Types.UntagResourceResponse) => void): Request<IoTAnalytics.Types.UntagResourceResponse, AWSError>;
254 /**
255 * Updates the settings of a channel.
256 */
257 updateChannel(params: IoTAnalytics.Types.UpdateChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
258 /**
259 * Updates the settings of a channel.
260 */
261 updateChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
262 /**
263 * Updates the settings of a data set.
264 */
265 updateDataset(params: IoTAnalytics.Types.UpdateDatasetRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
266 /**
267 * Updates the settings of a data set.
268 */
269 updateDataset(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
270 /**
271 * Updates the settings of a data store.
272 */
273 updateDatastore(params: IoTAnalytics.Types.UpdateDatastoreRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
274 /**
275 * Updates the settings of a data store.
276 */
277 updateDatastore(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
278 /**
279 * Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
280 */
281 updatePipeline(params: IoTAnalytics.Types.UpdatePipelineRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
282 /**
283 * Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.
284 */
285 updatePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
286}
287declare namespace IoTAnalytics {
288 export type ActivityBatchSize = number;
289 export type ActivityName = string;
290 export interface AddAttributesActivity {
291 /**
292 * The name of the 'addAttributes' activity.
293 */
294 name: ActivityName;
295 /**
296 * A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute. The existing attributes remain in the message, so if you want to remove the originals, use "RemoveAttributeActivity".
297 */
298 attributes: AttributeNameMapping;
299 /**
300 * The next activity in the pipeline.
301 */
302 next?: ActivityName;
303 }
304 export type AttributeName = string;
305 export type AttributeNameMapping = {[key: string]: AttributeName};
306 export type AttributeNames = AttributeName[];
307 export type BatchPutMessageErrorEntries = BatchPutMessageErrorEntry[];
308 export interface BatchPutMessageErrorEntry {
309 /**
310 * The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message object.)
311 */
312 messageId?: MessageId;
313 /**
314 * The code associated with the error.
315 */
316 errorCode?: ErrorCode;
317 /**
318 * The message associated with the error.
319 */
320 errorMessage?: ErrorMessage;
321 }
322 export interface BatchPutMessageRequest {
323 /**
324 * The name of the channel where the messages are sent.
325 */
326 channelName: ChannelName;
327 /**
328 * The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'. Note that the field names of message payloads (data) that you send to AWS IoT Analytics: Must contain only alphanumeric characters and undescores (_); no other special characters are allowed. Must begin with an alphabetic character or single underscore (_). Cannot contain hyphens (-). In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$". Cannot be greater than 255 characters. Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.) For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.
329 */
330 messages: Messages;
331 }
332 export interface BatchPutMessageResponse {
333 /**
334 * A list of any errors encountered when sending the messages to the channel.
335 */
336 batchPutMessageErrorEntries?: BatchPutMessageErrorEntries;
337 }
338 export interface CancelPipelineReprocessingRequest {
339 /**
340 * The name of pipeline for which data reprocessing is canceled.
341 */
342 pipelineName: PipelineName;
343 /**
344 * The ID of the reprocessing task (returned by "StartPipelineReprocessing").
345 */
346 reprocessingId: ReprocessingId;
347 }
348 export interface CancelPipelineReprocessingResponse {
349 }
350 export interface Channel {
351 /**
352 * The name of the channel.
353 */
354 name?: ChannelName;
355 /**
356 * The ARN of the channel.
357 */
358 arn?: ChannelArn;
359 /**
360 * The status of the channel.
361 */
362 status?: ChannelStatus;
363 /**
364 * How long, in days, message data is kept for the channel.
365 */
366 retentionPeriod?: RetentionPeriod;
367 /**
368 * When the channel was created.
369 */
370 creationTime?: Timestamp;
371 /**
372 * When the channel was last updated.
373 */
374 lastUpdateTime?: Timestamp;
375 }
376 export interface ChannelActivity {
377 /**
378 * The name of the 'channel' activity.
379 */
380 name: ActivityName;
381 /**
382 * The name of the channel from which the messages are processed.
383 */
384 channelName: ChannelName;
385 /**
386 * The next activity in the pipeline.
387 */
388 next?: ActivityName;
389 }
390 export type ChannelArn = string;
391 export type ChannelName = string;
392 export interface ChannelStatistics {
393 /**
394 * The estimated size of the channel.
395 */
396 size?: EstimatedResourceSize;
397 }
398 export type ChannelStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
399 export type ChannelSummaries = ChannelSummary[];
400 export interface ChannelSummary {
401 /**
402 * The name of the channel.
403 */
404 channelName?: ChannelName;
405 /**
406 * The status of the channel.
407 */
408 status?: ChannelStatus;
409 /**
410 * When the channel was created.
411 */
412 creationTime?: Timestamp;
413 /**
414 * The last time the channel was updated.
415 */
416 lastUpdateTime?: Timestamp;
417 }
418 export type ComputeType = "ACU_1"|"ACU_2"|string;
419 export interface ContainerDatasetAction {
420 /**
421 * The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.
422 */
423 image: Image;
424 /**
425 * The ARN of the role which gives permission to the system to access needed resources in order to run the "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.
426 */
427 executionRoleArn: RoleArn;
428 /**
429 * Configuration of the resource which executes the "containerAction".
430 */
431 resourceConfiguration: ResourceConfiguration;
432 /**
433 * The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of "stringValue", "datasetContentVersionValue", or "outputFileUriValue".
434 */
435 variables?: Variables;
436 }
437 export interface CreateChannelRequest {
438 /**
439 * The name of the channel.
440 */
441 channelName: ChannelName;
442 /**
443 * How long, in days, message data is kept for the channel.
444 */
445 retentionPeriod?: RetentionPeriod;
446 /**
447 * Metadata which can be used to manage the channel.
448 */
449 tags?: TagList;
450 }
451 export interface CreateChannelResponse {
452 /**
453 * The name of the channel.
454 */
455 channelName?: ChannelName;
456 /**
457 * The ARN of the channel.
458 */
459 channelArn?: ChannelArn;
460 /**
461 * How long, in days, message data is kept for the channel.
462 */
463 retentionPeriod?: RetentionPeriod;
464 }
465 export interface CreateDatasetContentRequest {
466 /**
467 * The name of the data set.
468 */
469 datasetName: DatasetName;
470 }
471 export interface CreateDatasetContentResponse {
472 /**
473 * The version ID of the data set contents which are being created.
474 */
475 versionId?: DatasetContentVersion;
476 }
477 export interface CreateDatasetRequest {
478 /**
479 * The name of the data set.
480 */
481 datasetName: DatasetName;
482 /**
483 * A list of actions that create the data set contents.
484 */
485 actions: DatasetActions;
486 /**
487 * A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.
488 */
489 triggers?: DatasetTriggers;
490 /**
491 * When data set contents are created they are delivered to destinations specified here.
492 */
493 contentDeliveryRules?: DatasetContentDeliveryRules;
494 /**
495 * [Optional] How long, in days, versions of data set contents are kept for the data set. If not specified or set to null, versions of data set contents are retained for at most 90 days. The number of versions of data set contents retained is determined by the versioningConfiguration parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
496 */
497 retentionPeriod?: RetentionPeriod;
498 /**
499 * [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
500 */
501 versioningConfiguration?: VersioningConfiguration;
502 /**
503 * Metadata which can be used to manage the data set.
504 */
505 tags?: TagList;
506 }
507 export interface CreateDatasetResponse {
508 /**
509 * The name of the data set.
510 */
511 datasetName?: DatasetName;
512 /**
513 * The ARN of the data set.
514 */
515 datasetArn?: DatasetArn;
516 /**
517 * How long, in days, data set contents are kept for the data set.
518 */
519 retentionPeriod?: RetentionPeriod;
520 }
521 export interface CreateDatastoreRequest {
522 /**
523 * The name of the data store.
524 */
525 datastoreName: DatastoreName;
526 /**
527 * How long, in days, message data is kept for the data store.
528 */
529 retentionPeriod?: RetentionPeriod;
530 /**
531 * Metadata which can be used to manage the data store.
532 */
533 tags?: TagList;
534 }
535 export interface CreateDatastoreResponse {
536 /**
537 * The name of the data store.
538 */
539 datastoreName?: DatastoreName;
540 /**
541 * The ARN of the data store.
542 */
543 datastoreArn?: DatastoreArn;
544 /**
545 * How long, in days, message data is kept for the data store.
546 */
547 retentionPeriod?: RetentionPeriod;
548 }
549 export interface CreatePipelineRequest {
550 /**
551 * The name of the pipeline.
552 */
553 pipelineName: PipelineName;
554 /**
555 * A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example: pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
556 */
557 pipelineActivities: PipelineActivities;
558 /**
559 * Metadata which can be used to manage the pipeline.
560 */
561 tags?: TagList;
562 }
563 export interface CreatePipelineResponse {
564 /**
565 * The name of the pipeline.
566 */
567 pipelineName?: PipelineName;
568 /**
569 * The ARN of the pipeline.
570 */
571 pipelineArn?: PipelineArn;
572 }
573 export interface Dataset {
574 /**
575 * The name of the data set.
576 */
577 name?: DatasetName;
578 /**
579 * The ARN of the data set.
580 */
581 arn?: DatasetArn;
582 /**
583 * The "DatasetAction" objects that automatically create the data set contents.
584 */
585 actions?: DatasetActions;
586 /**
587 * The "DatasetTrigger" objects that specify when the data set is automatically updated.
588 */
589 triggers?: DatasetTriggers;
590 /**
591 * When data set contents are created they are delivered to destinations specified here.
592 */
593 contentDeliveryRules?: DatasetContentDeliveryRules;
594 /**
595 * The status of the data set.
596 */
597 status?: DatasetStatus;
598 /**
599 * When the data set was created.
600 */
601 creationTime?: Timestamp;
602 /**
603 * The last time the data set was updated.
604 */
605 lastUpdateTime?: Timestamp;
606 /**
607 * [Optional] How long, in days, message data is kept for the data set.
608 */
609 retentionPeriod?: RetentionPeriod;
610 /**
611 * [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
612 */
613 versioningConfiguration?: VersioningConfiguration;
614 }
615 export interface DatasetAction {
616 /**
617 * The name of the data set action by which data set contents are automatically created.
618 */
619 actionName?: DatasetActionName;
620 /**
621 * An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
622 */
623 queryAction?: SqlQueryDatasetAction;
624 /**
625 * Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.
626 */
627 containerAction?: ContainerDatasetAction;
628 }
629 export type DatasetActionName = string;
630 export type DatasetActionSummaries = DatasetActionSummary[];
631 export interface DatasetActionSummary {
632 /**
633 * The name of the action which automatically creates the data set's contents.
634 */
635 actionName?: DatasetActionName;
636 /**
637 * The type of action by which the data set's contents are automatically created.
638 */
639 actionType?: DatasetActionType;
640 }
641 export type DatasetActionType = "QUERY"|"CONTAINER"|string;
642 export type DatasetActions = DatasetAction[];
643 export type DatasetArn = string;
644 export interface DatasetContentDeliveryDestination {
645 /**
646 * Configuration information for delivery of data set contents to AWS IoT Events.
647 */
648 iotEventsDestinationConfiguration?: IotEventsDestinationConfiguration;
649 }
650 export interface DatasetContentDeliveryRule {
651 /**
652 * The name of the data set content delivery rules entry.
653 */
654 entryName?: EntryName;
655 /**
656 * The destination to which data set contents are delivered.
657 */
658 destination: DatasetContentDeliveryDestination;
659 }
660 export type DatasetContentDeliveryRules = DatasetContentDeliveryRule[];
661 export type DatasetContentState = "CREATING"|"SUCCEEDED"|"FAILED"|string;
662 export interface DatasetContentStatus {
663 /**
664 * The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".
665 */
666 state?: DatasetContentState;
667 /**
668 * The reason the data set contents are in this state.
669 */
670 reason?: Reason;
671 }
672 export type DatasetContentSummaries = DatasetContentSummary[];
673 export interface DatasetContentSummary {
674 /**
675 * The version of the data set contents.
676 */
677 version?: DatasetContentVersion;
678 /**
679 * The status of the data set contents.
680 */
681 status?: DatasetContentStatus;
682 /**
683 * The actual time the creation of the data set contents was started.
684 */
685 creationTime?: Timestamp;
686 /**
687 * The time the creation of the data set contents was scheduled to start.
688 */
689 scheduleTime?: Timestamp;
690 }
691 export type DatasetContentVersion = string;
692 export interface DatasetContentVersionValue {
693 /**
694 * The name of the data set whose latest contents are used as input to the notebook or application.
695 */
696 datasetName: DatasetName;
697 }
698 export type DatasetEntries = DatasetEntry[];
699 export interface DatasetEntry {
700 /**
701 * The name of the data set item.
702 */
703 entryName?: EntryName;
704 /**
705 * The pre-signed URI of the data set item.
706 */
707 dataURI?: PresignedURI;
708 }
709 export type DatasetName = string;
710 export type DatasetStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
711 export type DatasetSummaries = DatasetSummary[];
712 export interface DatasetSummary {
713 /**
714 * The name of the data set.
715 */
716 datasetName?: DatasetName;
717 /**
718 * The status of the data set.
719 */
720 status?: DatasetStatus;
721 /**
722 * The time the data set was created.
723 */
724 creationTime?: Timestamp;
725 /**
726 * The last time the data set was updated.
727 */
728 lastUpdateTime?: Timestamp;
729 /**
730 * A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
731 */
732 triggers?: DatasetTriggers;
733 /**
734 * A list of "DataActionSummary" objects.
735 */
736 actions?: DatasetActionSummaries;
737 }
738 export interface DatasetTrigger {
739 /**
740 * The "Schedule" when the trigger is initiated.
741 */
742 schedule?: Schedule;
743 /**
744 * The data set whose content creation triggers the creation of this data set's contents.
745 */
746 dataset?: TriggeringDataset;
747 }
748 export type DatasetTriggers = DatasetTrigger[];
749 export interface Datastore {
750 /**
751 * The name of the data store.
752 */
753 name?: DatastoreName;
754 /**
755 * The ARN of the data store.
756 */
757 arn?: DatastoreArn;
758 /**
759 * 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.
760 */
761 status?: DatastoreStatus;
762 /**
763 * How long, in days, message data is kept for the data store.
764 */
765 retentionPeriod?: RetentionPeriod;
766 /**
767 * When the data store was created.
768 */
769 creationTime?: Timestamp;
770 /**
771 * The last time the data store was updated.
772 */
773 lastUpdateTime?: Timestamp;
774 }
775 export interface DatastoreActivity {
776 /**
777 * The name of the 'datastore' activity.
778 */
779 name: ActivityName;
780 /**
781 * The name of the data store where processed messages are stored.
782 */
783 datastoreName: DatastoreName;
784 }
785 export type DatastoreArn = string;
786 export type DatastoreName = string;
787 export interface DatastoreStatistics {
788 /**
789 * The estimated size of the data store.
790 */
791 size?: EstimatedResourceSize;
792 }
793 export type DatastoreStatus = "CREATING"|"ACTIVE"|"DELETING"|string;
794 export type DatastoreSummaries = DatastoreSummary[];
795 export interface DatastoreSummary {
796 /**
797 * The name of the data store.
798 */
799 datastoreName?: DatastoreName;
800 /**
801 * The status of the data store.
802 */
803 status?: DatastoreStatus;
804 /**
805 * When the data store was created.
806 */
807 creationTime?: Timestamp;
808 /**
809 * The last time the data store was updated.
810 */
811 lastUpdateTime?: Timestamp;
812 }
813 export interface DeleteChannelRequest {
814 /**
815 * The name of the channel to delete.
816 */
817 channelName: ChannelName;
818 }
819 export interface DeleteDatasetContentRequest {
820 /**
821 * The name of the data set whose content is deleted.
822 */
823 datasetName: DatasetName;
824 /**
825 * The version of the data set whose content is deleted. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default.
826 */
827 versionId?: DatasetContentVersion;
828 }
829 export interface DeleteDatasetRequest {
830 /**
831 * The name of the data set to delete.
832 */
833 datasetName: DatasetName;
834 }
835 export interface DeleteDatastoreRequest {
836 /**
837 * The name of the data store to delete.
838 */
839 datastoreName: DatastoreName;
840 }
841 export interface DeletePipelineRequest {
842 /**
843 * The name of the pipeline to delete.
844 */
845 pipelineName: PipelineName;
846 }
847 export interface DeltaTime {
848 /**
849 * The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be "in flight" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the "in flight" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.
850 */
851 offsetSeconds: OffsetSeconds;
852 /**
853 * An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.
854 */
855 timeExpression: TimeExpression;
856 }
857 export interface DescribeChannelRequest {
858 /**
859 * The name of the channel whose information is retrieved.
860 */
861 channelName: ChannelName;
862 /**
863 * If true, additional statistical information about the channel is included in the response.
864 */
865 includeStatistics?: IncludeStatisticsFlag;
866 }
867 export interface DescribeChannelResponse {
868 /**
869 * An object that contains information about the channel.
870 */
871 channel?: Channel;
872 /**
873 * Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.
874 */
875 statistics?: ChannelStatistics;
876 }
877 export interface DescribeDatasetRequest {
878 /**
879 * The name of the data set whose information is retrieved.
880 */
881 datasetName: DatasetName;
882 }
883 export interface DescribeDatasetResponse {
884 /**
885 * An object that contains information about the data set.
886 */
887 dataset?: Dataset;
888 }
889 export interface DescribeDatastoreRequest {
890 /**
891 * The name of the data store
892 */
893 datastoreName: DatastoreName;
894 /**
895 * If true, additional statistical information about the datastore is included in the response.
896 */
897 includeStatistics?: IncludeStatisticsFlag;
898 }
899 export interface DescribeDatastoreResponse {
900 /**
901 * Information about the data store.
902 */
903 datastore?: Datastore;
904 /**
905 * Additional statistical information about the data store. Included if the 'includeStatistics' parameter is set to true in the request.
906 */
907 statistics?: DatastoreStatistics;
908 }
909 export interface DescribeLoggingOptionsRequest {
910 }
911 export interface DescribeLoggingOptionsResponse {
912 /**
913 * The current settings of the AWS IoT Analytics logging options.
914 */
915 loggingOptions?: LoggingOptions;
916 }
917 export interface DescribePipelineRequest {
918 /**
919 * The name of the pipeline whose information is retrieved.
920 */
921 pipelineName: PipelineName;
922 }
923 export interface DescribePipelineResponse {
924 /**
925 * A "Pipeline" object that contains information about the pipeline.
926 */
927 pipeline?: Pipeline;
928 }
929 export interface DeviceRegistryEnrichActivity {
930 /**
931 * The name of the 'deviceRegistryEnrich' activity.
932 */
933 name: ActivityName;
934 /**
935 * The name of the attribute that is added to the message.
936 */
937 attribute: AttributeName;
938 /**
939 * The name of the IoT device whose registry information is added to the message.
940 */
941 thingName: AttributeName;
942 /**
943 * The ARN of the role that allows access to the device's registry information.
944 */
945 roleArn: RoleArn;
946 /**
947 * The next activity in the pipeline.
948 */
949 next?: ActivityName;
950 }
951 export interface DeviceShadowEnrichActivity {
952 /**
953 * The name of the 'deviceShadowEnrich' activity.
954 */
955 name: ActivityName;
956 /**
957 * The name of the attribute that is added to the message.
958 */
959 attribute: AttributeName;
960 /**
961 * The name of the IoT device whose shadow information is added to the message.
962 */
963 thingName: AttributeName;
964 /**
965 * The ARN of the role that allows access to the device's shadow.
966 */
967 roleArn: RoleArn;
968 /**
969 * The next activity in the pipeline.
970 */
971 next?: ActivityName;
972 }
973 export type DoubleValue = number;
974 export type EndTime = Date;
975 export type EntryName = string;
976 export type ErrorCode = string;
977 export type ErrorMessage = string;
978 export interface EstimatedResourceSize {
979 /**
980 * The estimated size of the resource in bytes.
981 */
982 estimatedSizeInBytes?: SizeInBytes;
983 /**
984 * The time when the estimate of the size of the resource was made.
985 */
986 estimatedOn?: Timestamp;
987 }
988 export interface FilterActivity {
989 /**
990 * The name of the 'filter' activity.
991 */
992 name: ActivityName;
993 /**
994 * An expression that looks like a SQL WHERE clause that must return a Boolean value.
995 */
996 filter: FilterExpression;
997 /**
998 * The next activity in the pipeline.
999 */
1000 next?: ActivityName;
1001 }
1002 export type FilterExpression = string;
1003 export interface GetDatasetContentRequest {
1004 /**
1005 * The name of the data set whose contents are retrieved.
1006 */
1007 datasetName: DatasetName;
1008 /**
1009 * The version of the data set whose contents are retrieved. You can also use the strings "$LATEST" or "$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed data set. If not specified, "$LATEST_SUCCEEDED" is the default.
1010 */
1011 versionId?: DatasetContentVersion;
1012 }
1013 export interface GetDatasetContentResponse {
1014 /**
1015 * A list of "DatasetEntry" objects.
1016 */
1017 entries?: DatasetEntries;
1018 /**
1019 * The time when the request was made.
1020 */
1021 timestamp?: Timestamp;
1022 /**
1023 * The status of the data set content.
1024 */
1025 status?: DatasetContentStatus;
1026 }
1027 export type Image = string;
1028 export type IncludeStatisticsFlag = boolean;
1029 export interface IotEventsDestinationConfiguration {
1030 /**
1031 * The name of the AWS IoT Events input to which data set contents are delivered.
1032 */
1033 inputName: IotEventsInputName;
1034 /**
1035 * The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.
1036 */
1037 roleArn: RoleArn;
1038 }
1039 export type IotEventsInputName = string;
1040 export interface LambdaActivity {
1041 /**
1042 * The name of the 'lambda' activity.
1043 */
1044 name: ActivityName;
1045 /**
1046 * The name of the Lambda function that is run on the message.
1047 */
1048 lambdaName: LambdaName;
1049 /**
1050 * 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, which is the maximum timeout duration for Lambda functions.
1051 */
1052 batchSize: ActivityBatchSize;
1053 /**
1054 * The next activity in the pipeline.
1055 */
1056 next?: ActivityName;
1057 }
1058 export type LambdaName = string;
1059 export interface ListChannelsRequest {
1060 /**
1061 * The token for the next set of results.
1062 */
1063 nextToken?: NextToken;
1064 /**
1065 * The maximum number of results to return in this request. The default value is 100.
1066 */
1067 maxResults?: MaxResults;
1068 }
1069 export interface ListChannelsResponse {
1070 /**
1071 * A list of "ChannelSummary" objects.
1072 */
1073 channelSummaries?: ChannelSummaries;
1074 /**
1075 * The token to retrieve the next set of results, or null if there are no more results.
1076 */
1077 nextToken?: NextToken;
1078 }
1079 export interface ListDatasetContentsRequest {
1080 /**
1081 * The name of the data set whose contents information you want to list.
1082 */
1083 datasetName: DatasetName;
1084 /**
1085 * The token for the next set of results.
1086 */
1087 nextToken?: NextToken;
1088 /**
1089 * The maximum number of results to return in this request.
1090 */
1091 maxResults?: MaxResults;
1092 /**
1093 * A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
1094 */
1095 scheduledOnOrAfter?: Timestamp;
1096 /**
1097 * A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
1098 */
1099 scheduledBefore?: Timestamp;
1100 }
1101 export interface ListDatasetContentsResponse {
1102 /**
1103 * Summary information about data set contents that have been created.
1104 */
1105 datasetContentSummaries?: DatasetContentSummaries;
1106 /**
1107 * The token to retrieve the next set of results, or null if there are no more results.
1108 */
1109 nextToken?: NextToken;
1110 }
1111 export interface ListDatasetsRequest {
1112 /**
1113 * The token for the next set of results.
1114 */
1115 nextToken?: NextToken;
1116 /**
1117 * The maximum number of results to return in this request. The default value is 100.
1118 */
1119 maxResults?: MaxResults;
1120 }
1121 export interface ListDatasetsResponse {
1122 /**
1123 * A list of "DatasetSummary" objects.
1124 */
1125 datasetSummaries?: DatasetSummaries;
1126 /**
1127 * The token to retrieve the next set of results, or null if there are no more results.
1128 */
1129 nextToken?: NextToken;
1130 }
1131 export interface ListDatastoresRequest {
1132 /**
1133 * The token for the next set of results.
1134 */
1135 nextToken?: NextToken;
1136 /**
1137 * The maximum number of results to return in this request. The default value is 100.
1138 */
1139 maxResults?: MaxResults;
1140 }
1141 export interface ListDatastoresResponse {
1142 /**
1143 * A list of "DatastoreSummary" objects.
1144 */
1145 datastoreSummaries?: DatastoreSummaries;
1146 /**
1147 * The token to retrieve the next set of results, or null if there are no more results.
1148 */
1149 nextToken?: NextToken;
1150 }
1151 export interface ListPipelinesRequest {
1152 /**
1153 * The token for the next set of results.
1154 */
1155 nextToken?: NextToken;
1156 /**
1157 * The maximum number of results to return in this request. The default value is 100.
1158 */
1159 maxResults?: MaxResults;
1160 }
1161 export interface ListPipelinesResponse {
1162 /**
1163 * A list of "PipelineSummary" objects.
1164 */
1165 pipelineSummaries?: PipelineSummaries;
1166 /**
1167 * The token to retrieve the next set of results, or null if there are no more results.
1168 */
1169 nextToken?: NextToken;
1170 }
1171 export interface ListTagsForResourceRequest {
1172 /**
1173 * The ARN of the resource whose tags you want to list.
1174 */
1175 resourceArn: ResourceArn;
1176 }
1177 export interface ListTagsForResourceResponse {
1178 /**
1179 * The tags (metadata) which you have assigned to the resource.
1180 */
1181 tags?: TagList;
1182 }
1183 export type LogResult = string;
1184 export type LoggingEnabled = boolean;
1185 export type LoggingLevel = "ERROR"|string;
1186 export interface LoggingOptions {
1187 /**
1188 * The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
1189 */
1190 roleArn: RoleArn;
1191 /**
1192 * The logging level. Currently, only "ERROR" is supported.
1193 */
1194 level: LoggingLevel;
1195 /**
1196 * If true, logging is enabled for AWS IoT Analytics.
1197 */
1198 enabled: LoggingEnabled;
1199 }
1200 export interface MathActivity {
1201 /**
1202 * The name of the 'math' activity.
1203 */
1204 name: ActivityName;
1205 /**
1206 * The name of the attribute that contains the result of the math operation.
1207 */
1208 attribute: AttributeName;
1209 /**
1210 * An expression that uses one or more existing attributes and must return an integer value.
1211 */
1212 math: MathExpression;
1213 /**
1214 * The next activity in the pipeline.
1215 */
1216 next?: ActivityName;
1217 }
1218 export type MathExpression = string;
1219 export type MaxMessages = number;
1220 export type MaxResults = number;
1221 export type MaxVersions = number;
1222 export interface Message {
1223 /**
1224 * The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.
1225 */
1226 messageId: MessageId;
1227 /**
1228 * The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).
1229 */
1230 payload: MessagePayload;
1231 }
1232 export type MessageId = string;
1233 export type MessagePayload = Buffer|Uint8Array|Blob|string;
1234 export type MessagePayloads = MessagePayload[];
1235 export type Messages = Message[];
1236 export type NextToken = string;
1237 export type OffsetSeconds = number;
1238 export type OutputFileName = string;
1239 export interface OutputFileUriValue {
1240 /**
1241 * The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.
1242 */
1243 fileName: OutputFileName;
1244 }
1245 export interface Pipeline {
1246 /**
1247 * The name of the pipeline.
1248 */
1249 name?: PipelineName;
1250 /**
1251 * The ARN of the pipeline.
1252 */
1253 arn?: PipelineArn;
1254 /**
1255 * The activities that perform transformations on the messages.
1256 */
1257 activities?: PipelineActivities;
1258 /**
1259 * A summary of information about the pipeline reprocessing.
1260 */
1261 reprocessingSummaries?: ReprocessingSummaries;
1262 /**
1263 * When the pipeline was created.
1264 */
1265 creationTime?: Timestamp;
1266 /**
1267 * The last time the pipeline was updated.
1268 */
1269 lastUpdateTime?: Timestamp;
1270 }
1271 export type PipelineActivities = PipelineActivity[];
1272 export interface PipelineActivity {
1273 /**
1274 * Determines the source of the messages to be processed.
1275 */
1276 channel?: ChannelActivity;
1277 /**
1278 * Runs a Lambda function to modify the message.
1279 */
1280 lambda?: LambdaActivity;
1281 /**
1282 * Specifies where to store the processed message data.
1283 */
1284 datastore?: DatastoreActivity;
1285 /**
1286 * Adds other attributes based on existing attributes in the message.
1287 */
1288 addAttributes?: AddAttributesActivity;
1289 /**
1290 * Removes attributes from a message.
1291 */
1292 removeAttributes?: RemoveAttributesActivity;
1293 /**
1294 * Creates a new message using only the specified attributes from the original message.
1295 */
1296 selectAttributes?: SelectAttributesActivity;
1297 /**
1298 * Filters a message based on its attributes.
1299 */
1300 filter?: FilterActivity;
1301 /**
1302 * Computes an arithmetic expression using the message's attributes and adds it to the message.
1303 */
1304 math?: MathActivity;
1305 /**
1306 * Adds data from the AWS IoT device registry to your message.
1307 */
1308 deviceRegistryEnrich?: DeviceRegistryEnrichActivity;
1309 /**
1310 * Adds information from the AWS IoT Device Shadows service to a message.
1311 */
1312 deviceShadowEnrich?: DeviceShadowEnrichActivity;
1313 }
1314 export type PipelineArn = string;
1315 export type PipelineName = string;
1316 export type PipelineSummaries = PipelineSummary[];
1317 export interface PipelineSummary {
1318 /**
1319 * The name of the pipeline.
1320 */
1321 pipelineName?: PipelineName;
1322 /**
1323 * A summary of information about the pipeline reprocessing.
1324 */
1325 reprocessingSummaries?: ReprocessingSummaries;
1326 /**
1327 * When the pipeline was created.
1328 */
1329 creationTime?: Timestamp;
1330 /**
1331 * When the pipeline was last updated.
1332 */
1333 lastUpdateTime?: Timestamp;
1334 }
1335 export type PresignedURI = string;
1336 export interface PutLoggingOptionsRequest {
1337 /**
1338 * The new values of the AWS IoT Analytics logging options.
1339 */
1340 loggingOptions: LoggingOptions;
1341 }
1342 export interface QueryFilter {
1343 /**
1344 * Used to limit data to that which has arrived since the last execution of the action.
1345 */
1346 deltaTime?: DeltaTime;
1347 }
1348 export type QueryFilters = QueryFilter[];
1349 export type Reason = string;
1350 export interface RemoveAttributesActivity {
1351 /**
1352 * The name of the 'removeAttributes' activity.
1353 */
1354 name: ActivityName;
1355 /**
1356 * A list of 1-50 attributes to remove from the message.
1357 */
1358 attributes: AttributeNames;
1359 /**
1360 * The next activity in the pipeline.
1361 */
1362 next?: ActivityName;
1363 }
1364 export type ReprocessingId = string;
1365 export type ReprocessingStatus = "RUNNING"|"SUCCEEDED"|"CANCELLED"|"FAILED"|string;
1366 export type ReprocessingSummaries = ReprocessingSummary[];
1367 export interface ReprocessingSummary {
1368 /**
1369 * The 'reprocessingId' returned by "StartPipelineReprocessing".
1370 */
1371 id?: ReprocessingId;
1372 /**
1373 * The status of the pipeline reprocessing.
1374 */
1375 status?: ReprocessingStatus;
1376 /**
1377 * The time the pipeline reprocessing was created.
1378 */
1379 creationTime?: Timestamp;
1380 }
1381 export type ResourceArn = string;
1382 export interface ResourceConfiguration {
1383 /**
1384 * The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).
1385 */
1386 computeType: ComputeType;
1387 /**
1388 * The size (in GB) of the persistent storage available to the resource instance used to execute the "containerAction" (min: 1, max: 50).
1389 */
1390 volumeSizeInGB: VolumeSizeInGB;
1391 }
1392 export interface RetentionPeriod {
1393 /**
1394 * If true, message data is kept indefinitely.
1395 */
1396 unlimited?: UnlimitedRetentionPeriod;
1397 /**
1398 * The number of days that message data is kept. The "unlimited" parameter must be false.
1399 */
1400 numberOfDays?: RetentionPeriodInDays;
1401 }
1402 export type RetentionPeriodInDays = number;
1403 export type RoleArn = string;
1404 export interface RunPipelineActivityRequest {
1405 /**
1406 * The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a 'lambda' activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.
1407 */
1408 pipelineActivity: PipelineActivity;
1409 /**
1410 * The sample message payloads on which the pipeline activity is run.
1411 */
1412 payloads: MessagePayloads;
1413 }
1414 export interface RunPipelineActivityResponse {
1415 /**
1416 * The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the pipeline activity on each input sample message payload, encoded in base64.)
1417 */
1418 payloads?: MessagePayloads;
1419 /**
1420 * In case the pipeline activity fails, the log message that is generated.
1421 */
1422 logResult?: LogResult;
1423 }
1424 export interface SampleChannelDataRequest {
1425 /**
1426 * The name of the channel whose message samples are retrieved.
1427 */
1428 channelName: ChannelName;
1429 /**
1430 * The number of sample messages to be retrieved. The limit is 10, the default is also 10.
1431 */
1432 maxMessages?: MaxMessages;
1433 /**
1434 * The start of the time window from which sample messages are retrieved.
1435 */
1436 startTime?: StartTime;
1437 /**
1438 * The end of the time window from which sample messages are retrieved.
1439 */
1440 endTime?: EndTime;
1441 }
1442 export interface SampleChannelDataResponse {
1443 /**
1444 * The list of message samples. Each sample message is returned as a base64-encoded string.
1445 */
1446 payloads?: MessagePayloads;
1447 }
1448 export interface Schedule {
1449 /**
1450 * The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.
1451 */
1452 expression?: ScheduleExpression;
1453 }
1454 export type ScheduleExpression = string;
1455 export interface SelectAttributesActivity {
1456 /**
1457 * The name of the 'selectAttributes' activity.
1458 */
1459 name: ActivityName;
1460 /**
1461 * A list of the attributes to select from the message.
1462 */
1463 attributes: AttributeNames;
1464 /**
1465 * The next activity in the pipeline.
1466 */
1467 next?: ActivityName;
1468 }
1469 export type SizeInBytes = number;
1470 export type SqlQuery = string;
1471 export interface SqlQueryDatasetAction {
1472 /**
1473 * A SQL query string.
1474 */
1475 sqlQuery: SqlQuery;
1476 /**
1477 * Pre-filters applied to message data.
1478 */
1479 filters?: QueryFilters;
1480 }
1481 export interface StartPipelineReprocessingRequest {
1482 /**
1483 * The name of the pipeline on which to start reprocessing.
1484 */
1485 pipelineName: PipelineName;
1486 /**
1487 * The start time (inclusive) of raw message data that is reprocessed.
1488 */
1489 startTime?: StartTime;
1490 /**
1491 * The end time (exclusive) of raw message data that is reprocessed.
1492 */
1493 endTime?: EndTime;
1494 }
1495 export interface StartPipelineReprocessingResponse {
1496 /**
1497 * The ID of the pipeline reprocessing activity that was started.
1498 */
1499 reprocessingId?: ReprocessingId;
1500 }
1501 export type StartTime = Date;
1502 export type StringValue = string;
1503 export interface Tag {
1504 /**
1505 * The tag's key.
1506 */
1507 key: TagKey;
1508 /**
1509 * The tag's value.
1510 */
1511 value: TagValue;
1512 }
1513 export type TagKey = string;
1514 export type TagKeyList = TagKey[];
1515 export type TagList = Tag[];
1516 export interface TagResourceRequest {
1517 /**
1518 * The ARN of the resource whose tags you want to modify.
1519 */
1520 resourceArn: ResourceArn;
1521 /**
1522 * The new or modified tags for the resource.
1523 */
1524 tags: TagList;
1525 }
1526 export interface TagResourceResponse {
1527 }
1528 export type TagValue = string;
1529 export type TimeExpression = string;
1530 export type Timestamp = Date;
1531 export interface TriggeringDataset {
1532 /**
1533 * The name of the data set whose content generation triggers the new data set content generation.
1534 */
1535 name: DatasetName;
1536 }
1537 export type UnlimitedRetentionPeriod = boolean;
1538 export type UnlimitedVersioning = boolean;
1539 export interface UntagResourceRequest {
1540 /**
1541 * The ARN of the resource whose tags you want to remove.
1542 */
1543 resourceArn: ResourceArn;
1544 /**
1545 * The keys of those tags which you want to remove.
1546 */
1547 tagKeys: TagKeyList;
1548 }
1549 export interface UntagResourceResponse {
1550 }
1551 export interface UpdateChannelRequest {
1552 /**
1553 * The name of the channel to be updated.
1554 */
1555 channelName: ChannelName;
1556 /**
1557 * How long, in days, message data is kept for the channel.
1558 */
1559 retentionPeriod?: RetentionPeriod;
1560 }
1561 export interface UpdateDatasetRequest {
1562 /**
1563 * The name of the data set to update.
1564 */
1565 datasetName: DatasetName;
1566 /**
1567 * A list of "DatasetAction" objects.
1568 */
1569 actions: DatasetActions;
1570 /**
1571 * A list of "DatasetTrigger" objects. The list can be empty or can contain up to five DataSetTrigger objects.
1572 */
1573 triggers?: DatasetTriggers;
1574 /**
1575 * When data set contents are created they are delivered to destinations specified here.
1576 */
1577 contentDeliveryRules?: DatasetContentDeliveryRules;
1578 /**
1579 * How long, in days, data set contents are kept for the data set.
1580 */
1581 retentionPeriod?: RetentionPeriod;
1582 /**
1583 * [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the "retentionPeriod" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
1584 */
1585 versioningConfiguration?: VersioningConfiguration;
1586 }
1587 export interface UpdateDatastoreRequest {
1588 /**
1589 * The name of the data store to be updated.
1590 */
1591 datastoreName: DatastoreName;
1592 /**
1593 * How long, in days, message data is kept for the data store.
1594 */
1595 retentionPeriod?: RetentionPeriod;
1596 }
1597 export interface UpdatePipelineRequest {
1598 /**
1599 * The name of the pipeline to update.
1600 */
1601 pipelineName: PipelineName;
1602 /**
1603 * A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data. The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example: pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
1604 */
1605 pipelineActivities: PipelineActivities;
1606 }
1607 export interface Variable {
1608 /**
1609 * The name of the variable.
1610 */
1611 name: VariableName;
1612 /**
1613 * The value of the variable as a string.
1614 */
1615 stringValue?: StringValue;
1616 /**
1617 * The value of the variable as a double (numeric).
1618 */
1619 doubleValue?: DoubleValue;
1620 /**
1621 * The value of the variable as a structure that specifies a data set content version.
1622 */
1623 datasetContentVersionValue?: DatasetContentVersionValue;
1624 /**
1625 * The value of the variable as a structure that specifies an output file URI.
1626 */
1627 outputFileUriValue?: OutputFileUriValue;
1628 }
1629 export type VariableName = string;
1630 export type Variables = Variable[];
1631 export interface VersioningConfiguration {
1632 /**
1633 * If true, unlimited versions of data set contents will be kept.
1634 */
1635 unlimited?: UnlimitedVersioning;
1636 /**
1637 * How many versions of data set contents will be kept. The "unlimited" parameter must be false.
1638 */
1639 maxVersions?: MaxVersions;
1640 }
1641 export type VolumeSizeInGB = number;
1642 /**
1643 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1644 */
1645 export type apiVersion = "2017-11-27"|"latest"|string;
1646 export interface ClientApiVersions {
1647 /**
1648 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1649 */
1650 apiVersion?: apiVersion;
1651 }
1652 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1653 /**
1654 * Contains interfaces for use with the IoTAnalytics client.
1655 */
1656 export import Types = IoTAnalytics;
1657}
1658export = IoTAnalytics;