aws-sdk 2.916.0 → 2.920.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. package/CHANGELOG.md +26 -1
  2. package/README.md +1 -1
  3. package/apis/autoscaling-2011-01-01.min.json +63 -60
  4. package/apis/datasync-2018-11-09.min.json +16 -15
  5. package/apis/devicefarm-2015-06-23.min.json +144 -92
  6. package/apis/docdb-2014-10-31.min.json +233 -65
  7. package/apis/docdb-2014-10-31.paginators.json +6 -0
  8. package/apis/ec2-2016-11-15.min.json +6 -0
  9. package/apis/fsx-2018-03-01.min.json +27 -24
  10. package/apis/iotevents-2018-07-27.min.json +715 -188
  11. package/apis/iotevents-data-2018-10-23.min.json +380 -1
  12. package/apis/iotsitewise-2019-12-02.min.json +65 -43
  13. package/apis/iotwireless-2020-11-22.min.json +210 -6
  14. package/apis/kendra-2019-02-03.min.json +351 -77
  15. package/apis/location-2020-11-19.min.json +677 -84
  16. package/apis/location-2020-11-19.paginators.json +12 -0
  17. package/apis/sns-2010-03-31.min.json +150 -13
  18. package/apis/sns-2010-03-31.paginators.json +12 -0
  19. package/clients/autoscaling.d.ts +55 -50
  20. package/clients/braket.d.ts +2 -2
  21. package/clients/datasync.d.ts +39 -34
  22. package/clients/devicefarm.d.ts +41 -10
  23. package/clients/docdb.d.ts +217 -4
  24. package/clients/ec2.d.ts +8 -0
  25. package/clients/ecs.d.ts +4 -4
  26. package/clients/fsx.d.ts +15 -2
  27. package/clients/iam.d.ts +1 -1
  28. package/clients/iotevents.d.ts +595 -11
  29. package/clients/ioteventsdata.d.ts +474 -9
  30. package/clients/iotsitewise.d.ts +34 -0
  31. package/clients/iotwireless.d.ts +126 -0
  32. package/clients/kendra.d.ts +410 -6
  33. package/clients/lightsail.d.ts +3 -3
  34. package/clients/location.d.ts +651 -77
  35. package/clients/polly.d.ts +1 -1
  36. package/clients/resourcegroups.d.ts +4 -4
  37. package/clients/servicediscovery.d.ts +41 -41
  38. package/clients/sns.d.ts +181 -4
  39. package/clients/sqs.d.ts +5 -5
  40. package/dist/aws-sdk-core-react-native.js +1 -1
  41. package/dist/aws-sdk-react-native.js +17 -17
  42. package/dist/aws-sdk.js +378 -168
  43. package/dist/aws-sdk.min.js +68 -68
  44. package/lib/core.js +1 -1
  45. package/package.json +1 -1
@@ -11,6 +11,14 @@ declare class IoTEvents extends Service {
11
11
  */
12
12
  constructor(options?: IoTEvents.Types.ClientConfiguration)
13
13
  config: Config & IoTEvents.Types.ClientConfiguration;
14
+ /**
15
+ * Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.
16
+ */
17
+ createAlarmModel(params: IoTEvents.Types.CreateAlarmModelRequest, callback?: (err: AWSError, data: IoTEvents.Types.CreateAlarmModelResponse) => void): Request<IoTEvents.Types.CreateAlarmModelResponse, AWSError>;
18
+ /**
19
+ * Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.
20
+ */
21
+ createAlarmModel(callback?: (err: AWSError, data: IoTEvents.Types.CreateAlarmModelResponse) => void): Request<IoTEvents.Types.CreateAlarmModelResponse, AWSError>;
14
22
  /**
15
23
  * Creates a detector model.
16
24
  */
@@ -27,6 +35,14 @@ declare class IoTEvents extends Service {
27
35
  * Creates an input.
28
36
  */
29
37
  createInput(callback?: (err: AWSError, data: IoTEvents.Types.CreateInputResponse) => void): Request<IoTEvents.Types.CreateInputResponse, AWSError>;
38
+ /**
39
+ * Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
40
+ */
41
+ deleteAlarmModel(params: IoTEvents.Types.DeleteAlarmModelRequest, callback?: (err: AWSError, data: IoTEvents.Types.DeleteAlarmModelResponse) => void): Request<IoTEvents.Types.DeleteAlarmModelResponse, AWSError>;
42
+ /**
43
+ * Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
44
+ */
45
+ deleteAlarmModel(callback?: (err: AWSError, data: IoTEvents.Types.DeleteAlarmModelResponse) => void): Request<IoTEvents.Types.DeleteAlarmModelResponse, AWSError>;
30
46
  /**
31
47
  * Deletes a detector model. Any active instances of the detector model are also deleted.
32
48
  */
@@ -43,6 +59,14 @@ declare class IoTEvents extends Service {
43
59
  * Deletes an input.
44
60
  */
45
61
  deleteInput(callback?: (err: AWSError, data: IoTEvents.Types.DeleteInputResponse) => void): Request<IoTEvents.Types.DeleteInputResponse, AWSError>;
62
+ /**
63
+ * Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.
64
+ */
65
+ describeAlarmModel(params: IoTEvents.Types.DescribeAlarmModelRequest, callback?: (err: AWSError, data: IoTEvents.Types.DescribeAlarmModelResponse) => void): Request<IoTEvents.Types.DescribeAlarmModelResponse, AWSError>;
66
+ /**
67
+ * Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.
68
+ */
69
+ describeAlarmModel(callback?: (err: AWSError, data: IoTEvents.Types.DescribeAlarmModelResponse) => void): Request<IoTEvents.Types.DescribeAlarmModelResponse, AWSError>;
46
70
  /**
47
71
  * Describes a detector model. If the version parameter is not specified, information about the latest version is returned.
48
72
  */
@@ -52,11 +76,11 @@ declare class IoTEvents extends Service {
52
76
  */
53
77
  describeDetectorModel(callback?: (err: AWSError, data: IoTEvents.Types.DescribeDetectorModelResponse) => void): Request<IoTEvents.Types.DescribeDetectorModelResponse, AWSError>;
54
78
  /**
55
- * Retrieves execution information about a detector model analysis
79
+ * Retrieves runtime information about a detector model analysis. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
56
80
  */
57
81
  describeDetectorModelAnalysis(params: IoTEvents.Types.DescribeDetectorModelAnalysisRequest, callback?: (err: AWSError, data: IoTEvents.Types.DescribeDetectorModelAnalysisResponse) => void): Request<IoTEvents.Types.DescribeDetectorModelAnalysisResponse, AWSError>;
58
82
  /**
59
- * Retrieves execution information about a detector model analysis
83
+ * Retrieves runtime information about a detector model analysis. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
60
84
  */
61
85
  describeDetectorModelAnalysis(callback?: (err: AWSError, data: IoTEvents.Types.DescribeDetectorModelAnalysisResponse) => void): Request<IoTEvents.Types.DescribeDetectorModelAnalysisResponse, AWSError>;
62
86
  /**
@@ -76,13 +100,29 @@ declare class IoTEvents extends Service {
76
100
  */
77
101
  describeLoggingOptions(callback?: (err: AWSError, data: IoTEvents.Types.DescribeLoggingOptionsResponse) => void): Request<IoTEvents.Types.DescribeLoggingOptionsResponse, AWSError>;
78
102
  /**
79
- * Retrieves one or more analysis results of the detector model.
103
+ * Retrieves one or more analysis results of the detector model. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
80
104
  */
81
105
  getDetectorModelAnalysisResults(params: IoTEvents.Types.GetDetectorModelAnalysisResultsRequest, callback?: (err: AWSError, data: IoTEvents.Types.GetDetectorModelAnalysisResultsResponse) => void): Request<IoTEvents.Types.GetDetectorModelAnalysisResultsResponse, AWSError>;
82
106
  /**
83
- * Retrieves one or more analysis results of the detector model.
107
+ * Retrieves one or more analysis results of the detector model. After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.
84
108
  */
85
109
  getDetectorModelAnalysisResults(callback?: (err: AWSError, data: IoTEvents.Types.GetDetectorModelAnalysisResultsResponse) => void): Request<IoTEvents.Types.GetDetectorModelAnalysisResultsResponse, AWSError>;
110
+ /**
111
+ * Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
112
+ */
113
+ listAlarmModelVersions(params: IoTEvents.Types.ListAlarmModelVersionsRequest, callback?: (err: AWSError, data: IoTEvents.Types.ListAlarmModelVersionsResponse) => void): Request<IoTEvents.Types.ListAlarmModelVersionsResponse, AWSError>;
114
+ /**
115
+ * Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
116
+ */
117
+ listAlarmModelVersions(callback?: (err: AWSError, data: IoTEvents.Types.ListAlarmModelVersionsResponse) => void): Request<IoTEvents.Types.ListAlarmModelVersionsResponse, AWSError>;
118
+ /**
119
+ * Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
120
+ */
121
+ listAlarmModels(params: IoTEvents.Types.ListAlarmModelsRequest, callback?: (err: AWSError, data: IoTEvents.Types.ListAlarmModelsResponse) => void): Request<IoTEvents.Types.ListAlarmModelsResponse, AWSError>;
122
+ /**
123
+ * Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
124
+ */
125
+ listAlarmModels(callback?: (err: AWSError, data: IoTEvents.Types.ListAlarmModelsResponse) => void): Request<IoTEvents.Types.ListAlarmModelsResponse, AWSError>;
86
126
  /**
87
127
  * Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
88
128
  */
@@ -99,6 +139,14 @@ declare class IoTEvents extends Service {
99
139
  * Lists the detector models you have created. Only the metadata associated with each detector model is returned.
100
140
  */
101
141
  listDetectorModels(callback?: (err: AWSError, data: IoTEvents.Types.ListDetectorModelsResponse) => void): Request<IoTEvents.Types.ListDetectorModelsResponse, AWSError>;
142
+ /**
143
+ * Lists one or more input routings.
144
+ */
145
+ listInputRoutings(params: IoTEvents.Types.ListInputRoutingsRequest, callback?: (err: AWSError, data: IoTEvents.Types.ListInputRoutingsResponse) => void): Request<IoTEvents.Types.ListInputRoutingsResponse, AWSError>;
146
+ /**
147
+ * Lists one or more input routings.
148
+ */
149
+ listInputRoutings(callback?: (err: AWSError, data: IoTEvents.Types.ListInputRoutingsResponse) => void): Request<IoTEvents.Types.ListInputRoutingsResponse, AWSError>;
102
150
  /**
103
151
  * Lists the inputs you have created.
104
152
  */
@@ -124,11 +172,11 @@ declare class IoTEvents extends Service {
124
172
  */
125
173
  putLoggingOptions(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
126
174
  /**
127
- * Performs an analysis of your detector model. For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
175
+ * Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
128
176
  */
129
177
  startDetectorModelAnalysis(params: IoTEvents.Types.StartDetectorModelAnalysisRequest, callback?: (err: AWSError, data: IoTEvents.Types.StartDetectorModelAnalysisResponse) => void): Request<IoTEvents.Types.StartDetectorModelAnalysisResponse, AWSError>;
130
178
  /**
131
- * Performs an analysis of your detector model. For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
179
+ * Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
132
180
  */
133
181
  startDetectorModelAnalysis(callback?: (err: AWSError, data: IoTEvents.Types.StartDetectorModelAnalysisResponse) => void): Request<IoTEvents.Types.StartDetectorModelAnalysisResponse, AWSError>;
134
182
  /**
@@ -147,6 +195,14 @@ declare class IoTEvents extends Service {
147
195
  * Removes the given tags (metadata) from the resource.
148
196
  */
149
197
  untagResource(callback?: (err: AWSError, data: IoTEvents.Types.UntagResourceResponse) => void): Request<IoTEvents.Types.UntagResourceResponse, AWSError>;
198
+ /**
199
+ * Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
200
+ */
201
+ updateAlarmModel(params: IoTEvents.Types.UpdateAlarmModelRequest, callback?: (err: AWSError, data: IoTEvents.Types.UpdateAlarmModelResponse) => void): Request<IoTEvents.Types.UpdateAlarmModelResponse, AWSError>;
202
+ /**
203
+ * Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
204
+ */
205
+ updateAlarmModel(callback?: (err: AWSError, data: IoTEvents.Types.UpdateAlarmModelResponse) => void): Request<IoTEvents.Types.UpdateAlarmModelResponse, AWSError>;
150
206
  /**
151
207
  * Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
152
208
  */
@@ -165,6 +221,13 @@ declare class IoTEvents extends Service {
165
221
  updateInput(callback?: (err: AWSError, data: IoTEvents.Types.UpdateInputResponse) => void): Request<IoTEvents.Types.UpdateInputResponse, AWSError>;
166
222
  }
167
223
  declare namespace IoTEvents {
224
+ export interface AcknowledgeFlow {
225
+ /**
226
+ * The value must be TRUE or FALSE. If TRUE, you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to NORMAL. If FALSE, you won't receive notifications. The alarm automatically changes to the NORMAL state when the input property value returns to the specified range.
227
+ */
228
+ enabled: AcknowledgeFlowEnabled;
229
+ }
230
+ export type AcknowledgeFlowEnabled = boolean;
168
231
  export interface Action {
169
232
  /**
170
233
  * Sets a variable to a specified value.
@@ -220,16 +283,111 @@ declare namespace IoTEvents {
220
283
  iotSiteWise?: IotSiteWiseAction;
221
284
  }
222
285
  export type Actions = Action[];
286
+ export interface AlarmAction {
287
+ sns?: SNSTopicPublishAction;
288
+ iotTopicPublish?: IotTopicPublishAction;
289
+ lambda?: LambdaAction;
290
+ iotEvents?: IotEventsAction;
291
+ sqs?: SqsAction;
292
+ firehose?: FirehoseAction;
293
+ dynamoDB?: DynamoDBAction;
294
+ dynamoDBv2?: DynamoDBv2Action;
295
+ iotSiteWise?: IotSiteWiseAction;
296
+ }
297
+ export type AlarmActions = AlarmAction[];
298
+ export interface AlarmCapabilities {
299
+ /**
300
+ * Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
301
+ */
302
+ initializationConfiguration?: InitializationConfiguration;
303
+ /**
304
+ * Specifies whether to get notified for alarm state changes.
305
+ */
306
+ acknowledgeFlow?: AcknowledgeFlow;
307
+ }
308
+ export interface AlarmEventActions {
309
+ /**
310
+ * Specifies one or more supported actions to receive notifications when the alarm state changes.
311
+ */
312
+ alarmActions?: AlarmActions;
313
+ }
314
+ export type AlarmModelArn = string;
315
+ export type AlarmModelDescription = string;
316
+ export type AlarmModelName = string;
317
+ export type AlarmModelSummaries = AlarmModelSummary[];
318
+ export interface AlarmModelSummary {
319
+ /**
320
+ * The time the alarm model was created, in the Unix epoch format.
321
+ */
322
+ creationTime?: Timestamp;
323
+ /**
324
+ * The description of the alarm model.
325
+ */
326
+ alarmModelDescription?: AlarmModelDescription;
327
+ /**
328
+ * The name of the alarm model.
329
+ */
330
+ alarmModelName?: AlarmModelName;
331
+ }
332
+ export type AlarmModelVersion = string;
333
+ export type AlarmModelVersionStatus = "ACTIVE"|"ACTIVATING"|"INACTIVE"|"FAILED"|string;
334
+ export type AlarmModelVersionSummaries = AlarmModelVersionSummary[];
335
+ export interface AlarmModelVersionSummary {
336
+ /**
337
+ * The name of the alarm model.
338
+ */
339
+ alarmModelName?: AlarmModelName;
340
+ /**
341
+ * The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
342
+ */
343
+ alarmModelArn?: AlarmModelArn;
344
+ /**
345
+ * The version of the alarm model.
346
+ */
347
+ alarmModelVersion?: AlarmModelVersion;
348
+ /**
349
+ * The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
350
+ */
351
+ roleArn?: AmazonResourceName;
352
+ /**
353
+ * The time the alarm model was created, in the Unix epoch format.
354
+ */
355
+ creationTime?: Timestamp;
356
+ /**
357
+ * The time the alarm model was last updated, in the Unix epoch format.
358
+ */
359
+ lastUpdateTime?: Timestamp;
360
+ /**
361
+ * The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
362
+ */
363
+ status?: AlarmModelVersionStatus;
364
+ /**
365
+ * Contains information about the status of the alarm model version.
366
+ */
367
+ statusMessage?: StatusMessage;
368
+ }
369
+ export interface AlarmNotification {
370
+ /**
371
+ * Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
372
+ */
373
+ notificationActions?: NotificationActions;
374
+ }
375
+ export interface AlarmRule {
376
+ /**
377
+ * A rule that compares an input property value to a threshold value with a comparison operator.
378
+ */
379
+ simpleRule?: SimpleRule;
380
+ }
223
381
  export type AmazonResourceName = string;
224
382
  export type AnalysisId = string;
225
383
  export type AnalysisMessage = string;
226
384
  export interface AnalysisResult {
227
385
  /**
228
- * The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result: supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region. service-limits - Resources or operations can't exceed service limits. Update your detector model or request a limit adjust. structure - The detector model must follow a structure that AWS IoT Events supports. expression-syntax - Your expression must follow the required syntax. data-type - Data types referenced in the detector model must be compatible. referenced-data - You must define the data referenced in your detector model before you can use the data. referenced-resource - Resources that the detector model uses must be available. For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
386
+ * The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result: supported-actions - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region. service-limits - Resources or API operations can't exceed service quotas (also known as limits). Update your detector model or request a quota increase. structure - The detector model must follow a structure that AWS IoT Events supports. expression-syntax - Your expression must follow the required syntax. data-type - Data types referenced in the detector model must be compatible. referenced-data - You must define the data referenced in your detector model before you can use the data. referenced-resource - Resources that the detector model uses must be available. For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
229
387
  */
230
388
  type?: AnalysisType;
231
389
  /**
232
- * The severity level of the analysis result. Analysis results fall into three general categories based on the severity level: INFO - An information result informs you about a significant field in your detector model. This type of result usually doesn't require immediate action. WARNING - A warning result draws special attention to fields that are potentially damaging to your detector model. We recommend that you review warnings and take necessary actions before you use your detetor model in production environments. Otherwise, the detector model may not fully function as expected. ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
390
+ * The severity level of the analysis result. Based on the severity level, analysis results fall into three general categories: INFO - An information result tells you about a significant field in your detector model. This type of result usually doesn't require immediate action. WARNING - A warning result draws special attention to fields that might cause issues for your detector model. We recommend that you review warnings and take necessary actions before you use your detector model in production environments. Otherwise, the detector model might not work as expected. ERROR - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.
233
391
  */
234
392
  level?: AnalysisResultLevel;
235
393
  /**
@@ -254,6 +412,7 @@ declare namespace IoTEvents {
254
412
  export type AnalysisStatus = "RUNNING"|"COMPLETE"|"FAILED"|string;
255
413
  export type AnalysisType = string;
256
414
  export type AssetId = string;
415
+ export type AssetModelId = string;
257
416
  export type AssetPropertyAlias = string;
258
417
  export type AssetPropertyBooleanValue = string;
259
418
  export type AssetPropertyDoubleValue = string;
@@ -278,7 +437,7 @@ declare namespace IoTEvents {
278
437
  /**
279
438
  * The value to send to an asset property.
280
439
  */
281
- value: AssetPropertyVariant;
440
+ value?: AssetPropertyVariant;
282
441
  /**
283
442
  * The timestamp associated with the asset property value. The default is the current event time.
284
443
  */
@@ -320,8 +479,73 @@ declare namespace IoTEvents {
320
479
  */
321
480
  timerName: TimerName;
322
481
  }
482
+ export type ComparisonOperator = "GREATER"|"GREATER_OR_EQUAL"|"LESS"|"LESS_OR_EQUAL"|"EQUAL"|"NOT_EQUAL"|string;
323
483
  export type Condition = string;
324
484
  export type ContentExpression = string;
485
+ export interface CreateAlarmModelRequest {
486
+ /**
487
+ * A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model.
488
+ */
489
+ alarmModelName: AlarmModelName;
490
+ /**
491
+ * A description that tells you what the alarm model detects.
492
+ */
493
+ alarmModelDescription?: AlarmModelDescription;
494
+ /**
495
+ * The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
496
+ */
497
+ roleArn: AmazonResourceName;
498
+ /**
499
+ * A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see Tagging your AWS IoT Events resources in the AWS IoT Events Developer Guide. You can create up to 50 tags for one alarm model.
500
+ */
501
+ tags?: Tags;
502
+ /**
503
+ * An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
504
+ */
505
+ key?: AttributeJsonPath;
506
+ /**
507
+ * A non-negative integer that reflects the severity level of the alarm.
508
+ */
509
+ severity?: Severity;
510
+ /**
511
+ * Defines when your alarm is invoked.
512
+ */
513
+ alarmRule: AlarmRule;
514
+ /**
515
+ * Contains information about one or more notification actions.
516
+ */
517
+ alarmNotification?: AlarmNotification;
518
+ /**
519
+ * Contains information about one or more alarm actions.
520
+ */
521
+ alarmEventActions?: AlarmEventActions;
522
+ /**
523
+ * Contains the configuration information of alarm state changes.
524
+ */
525
+ alarmCapabilities?: AlarmCapabilities;
526
+ }
527
+ export interface CreateAlarmModelResponse {
528
+ /**
529
+ * The time the alarm model was created, in the Unix epoch format.
530
+ */
531
+ creationTime?: Timestamp;
532
+ /**
533
+ * The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
534
+ */
535
+ alarmModelArn?: AlarmModelArn;
536
+ /**
537
+ * The version of the alarm model.
538
+ */
539
+ alarmModelVersion?: AlarmModelVersion;
540
+ /**
541
+ * The time the alarm model was last updated, in the Unix epoch format.
542
+ */
543
+ lastUpdateTime?: Timestamp;
544
+ /**
545
+ * The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
546
+ */
547
+ status?: AlarmModelVersionStatus;
548
+ }
325
549
  export interface CreateDetectorModelRequest {
326
550
  /**
327
551
  * The name of the detector model.
@@ -382,6 +606,14 @@ declare namespace IoTEvents {
382
606
  */
383
607
  inputConfiguration?: InputConfiguration;
384
608
  }
609
+ export interface DeleteAlarmModelRequest {
610
+ /**
611
+ * The name of the alarm model.
612
+ */
613
+ alarmModelName: AlarmModelName;
614
+ }
615
+ export interface DeleteAlarmModelResponse {
616
+ }
385
617
  export interface DeleteDetectorModelRequest {
386
618
  /**
387
619
  * The name of the detector model to be deleted.
@@ -399,6 +631,78 @@ declare namespace IoTEvents {
399
631
  export interface DeleteInputResponse {
400
632
  }
401
633
  export type DeliveryStreamName = string;
634
+ export interface DescribeAlarmModelRequest {
635
+ /**
636
+ * The name of the alarm model.
637
+ */
638
+ alarmModelName: AlarmModelName;
639
+ /**
640
+ * The version of the alarm model.
641
+ */
642
+ alarmModelVersion?: AlarmModelVersion;
643
+ }
644
+ export interface DescribeAlarmModelResponse {
645
+ /**
646
+ * The time the alarm model was created, in the Unix epoch format.
647
+ */
648
+ creationTime?: Timestamp;
649
+ /**
650
+ * The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
651
+ */
652
+ alarmModelArn?: AlarmModelArn;
653
+ /**
654
+ * The version of the alarm model.
655
+ */
656
+ alarmModelVersion?: AlarmModelVersion;
657
+ /**
658
+ * The time the alarm model was last updated, in the Unix epoch format.
659
+ */
660
+ lastUpdateTime?: Timestamp;
661
+ /**
662
+ * The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
663
+ */
664
+ status?: AlarmModelVersionStatus;
665
+ /**
666
+ * Contains information about the status of the alarm model.
667
+ */
668
+ statusMessage?: StatusMessage;
669
+ /**
670
+ * The name of the alarm model.
671
+ */
672
+ alarmModelName?: AlarmModelName;
673
+ /**
674
+ * The description of the alarm model.
675
+ */
676
+ alarmModelDescription?: AlarmModelDescription;
677
+ /**
678
+ * The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
679
+ */
680
+ roleArn?: AmazonResourceName;
681
+ /**
682
+ * An input attribute used as a key to create an alarm. AWS IoT Events routes inputs associated with this key to the alarm.
683
+ */
684
+ key?: AttributeJsonPath;
685
+ /**
686
+ * A non-negative integer that reflects the severity level of the alarm.
687
+ */
688
+ severity?: Severity;
689
+ /**
690
+ * Defines when your alarm is invoked.
691
+ */
692
+ alarmRule?: AlarmRule;
693
+ /**
694
+ * Contains information about one or more notification actions.
695
+ */
696
+ alarmNotification?: AlarmNotification;
697
+ /**
698
+ * Contains information about one or more alarm actions.
699
+ */
700
+ alarmEventActions?: AlarmEventActions;
701
+ /**
702
+ * Contains the configuration information of alarm state changes.
703
+ */
704
+ alarmCapabilities?: AlarmCapabilities;
705
+ }
402
706
  export interface DescribeDetectorModelAnalysisRequest {
403
707
  /**
404
708
  * The ID of the analysis result that you want to retrieve.
@@ -407,7 +711,7 @@ declare namespace IoTEvents {
407
711
  }
408
712
  export interface DescribeDetectorModelAnalysisResponse {
409
713
  /**
410
- * The status of the analysis activity. The status can be one of the following values: RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete. COMPLETE - AWS IoT Events finished analyzing your detector model . FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.
714
+ * The status of the analysis activity. The status can be one of the following values: RUNNING - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete. COMPLETE - AWS IoT Events finished analyzing your detector model. FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.
411
715
  */
412
716
  status?: AnalysisStatus;
413
717
  }
@@ -575,6 +879,7 @@ declare namespace IoTEvents {
575
879
  */
576
880
  evaluationMethod?: EvaluationMethod;
577
881
  }
882
+ export type DisabledOnInitialization = boolean;
578
883
  export interface DynamoDBAction {
579
884
  /**
580
885
  * The data type for the hash key (also called the partition key). You can specify the following values: 'STRING' - The hash key is a string. 'NUMBER' - The hash key is a number. If you don't specify hashKeyType, the default value is 'STRING'.
@@ -626,6 +931,38 @@ declare namespace IoTEvents {
626
931
  export type DynamoKeyValue = string;
627
932
  export type DynamoOperation = string;
628
933
  export type DynamoTableName = string;
934
+ export interface EmailConfiguration {
935
+ /**
936
+ * The email address that sends emails. If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the email address that sends emails in Amazon SES.
937
+ */
938
+ from: FromEmail;
939
+ /**
940
+ * Contains the subject and message of an email.
941
+ */
942
+ content?: EmailContent;
943
+ /**
944
+ * Contains the information of one or more recipients who receive the emails. You must add the users that receive emails to your AWS SSO store.
945
+ */
946
+ recipients: EmailRecipients;
947
+ }
948
+ export type EmailConfigurations = EmailConfiguration[];
949
+ export interface EmailContent {
950
+ /**
951
+ * The subject of the email.
952
+ */
953
+ subject?: EmailSubject;
954
+ /**
955
+ * The message that you want to send. The message can be up to 200 characters.
956
+ */
957
+ additionalMessage?: NotificationAdditionalMessage;
958
+ }
959
+ export interface EmailRecipients {
960
+ /**
961
+ * Specifies one or more recipients who receive the email.
962
+ */
963
+ to?: RecipientDetails;
964
+ }
965
+ export type EmailSubject = string;
629
966
  export type EvaluationMethod = "BATCH"|"SERIAL"|string;
630
967
  export interface Event {
631
968
  /**
@@ -658,6 +995,7 @@ declare namespace IoTEvents {
658
995
  payload?: Payload;
659
996
  }
660
997
  export type FirehoseSeparator = string;
998
+ export type FromEmail = string;
661
999
  export interface GetDetectorModelAnalysisResultsRequest {
662
1000
  /**
663
1001
  * The ID of the analysis result that you want to retrieve.
@@ -682,6 +1020,13 @@ declare namespace IoTEvents {
682
1020
  */
683
1021
  nextToken?: NextToken;
684
1022
  }
1023
+ export type IdentityStoreId = string;
1024
+ export interface InitializationConfiguration {
1025
+ /**
1026
+ * The value must be TRUE or FALSE. If FALSE, all alarm instances created based on the alarm model are activated. The default value is TRUE.
1027
+ */
1028
+ disabledOnInitialization: DisabledOnInitialization;
1029
+ }
685
1030
  export interface Input {
686
1031
  /**
687
1032
  * Information about the configuration of an input.
@@ -726,7 +1071,18 @@ declare namespace IoTEvents {
726
1071
  attributes: Attributes;
727
1072
  }
728
1073
  export type InputDescription = string;
1074
+ export interface InputIdentifier {
1075
+ /**
1076
+ * The identifier of the input routed to AWS IoT Events.
1077
+ */
1078
+ iotEventsInputIdentifier?: IotEventsInputIdentifier;
1079
+ /**
1080
+ * The identifer of the input routed from AWS IoT SiteWise.
1081
+ */
1082
+ iotSiteWiseInputIdentifier?: IotSiteWiseInputIdentifier;
1083
+ }
729
1084
  export type InputName = string;
1085
+ export type InputProperty = string;
730
1086
  export type InputStatus = "CREATING"|"UPDATING"|"ACTIVE"|"DELETING"|string;
731
1087
  export type InputSummaries = InputSummary[];
732
1088
  export interface InputSummary {
@@ -765,6 +1121,12 @@ declare namespace IoTEvents {
765
1121
  */
766
1122
  payload?: Payload;
767
1123
  }
1124
+ export interface IotEventsInputIdentifier {
1125
+ /**
1126
+ * The name of the input routed to AWS IoT Events.
1127
+ */
1128
+ inputName: InputName;
1129
+ }
768
1130
  export interface IotSiteWiseAction {
769
1131
  /**
770
1132
  * A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
@@ -785,7 +1147,23 @@ declare namespace IoTEvents {
785
1147
  /**
786
1148
  * The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
787
1149
  */
788
- propertyValue: AssetPropertyValue;
1150
+ propertyValue?: AssetPropertyValue;
1151
+ }
1152
+ export interface IotSiteWiseAssetModelPropertyIdentifier {
1153
+ /**
1154
+ * The ID of the AWS IoT SiteWise asset model.
1155
+ */
1156
+ assetModelId: AssetModelId;
1157
+ /**
1158
+ * The ID of the AWS IoT SiteWise asset property.
1159
+ */
1160
+ propertyId: AssetPropertyId;
1161
+ }
1162
+ export interface IotSiteWiseInputIdentifier {
1163
+ /**
1164
+ * The identifier of the AWS IoT SiteWise asset model property.
1165
+ */
1166
+ iotSiteWiseAssetModelPropertyIdentifier?: IotSiteWiseAssetModelPropertyIdentifier;
789
1167
  }
790
1168
  export interface IotTopicPublishAction {
791
1169
  /**
@@ -808,6 +1186,50 @@ declare namespace IoTEvents {
808
1186
  */
809
1187
  payload?: Payload;
810
1188
  }
1189
+ export interface ListAlarmModelVersionsRequest {
1190
+ /**
1191
+ * The name of the alarm model.
1192
+ */
1193
+ alarmModelName: AlarmModelName;
1194
+ /**
1195
+ * The token that you can use to return the next set of results.
1196
+ */
1197
+ nextToken?: NextToken;
1198
+ /**
1199
+ * The maximum number of results to be returned per request.
1200
+ */
1201
+ maxResults?: MaxResults;
1202
+ }
1203
+ export interface ListAlarmModelVersionsResponse {
1204
+ /**
1205
+ * A list that summarizes each alarm model version.
1206
+ */
1207
+ alarmModelVersionSummaries?: AlarmModelVersionSummaries;
1208
+ /**
1209
+ * The token that you can use to return the next set of results, or null if there are no more results.
1210
+ */
1211
+ nextToken?: NextToken;
1212
+ }
1213
+ export interface ListAlarmModelsRequest {
1214
+ /**
1215
+ * The token that you can use to return the next set of results.
1216
+ */
1217
+ nextToken?: NextToken;
1218
+ /**
1219
+ * The maximum number of results to be returned per request.
1220
+ */
1221
+ maxResults?: MaxResults;
1222
+ }
1223
+ export interface ListAlarmModelsResponse {
1224
+ /**
1225
+ * A list that summarizes each alarm model.
1226
+ */
1227
+ alarmModelSummaries?: AlarmModelSummaries;
1228
+ /**
1229
+ * The token that you can use to return the next set of results, or null if there are no more results.
1230
+ */
1231
+ nextToken?: NextToken;
1232
+ }
811
1233
  export interface ListDetectorModelVersionsRequest {
812
1234
  /**
813
1235
  * The name of the detector model whose versions are returned.
@@ -852,6 +1274,30 @@ declare namespace IoTEvents {
852
1274
  */
853
1275
  nextToken?: NextToken;
854
1276
  }
1277
+ export interface ListInputRoutingsRequest {
1278
+ /**
1279
+ * The identifer of the routed input.
1280
+ */
1281
+ inputIdentifier: InputIdentifier;
1282
+ /**
1283
+ * The maximum number of results to be returned per request.
1284
+ */
1285
+ maxResults?: MaxResults;
1286
+ /**
1287
+ * The token that you can use to return the next set of results.
1288
+ */
1289
+ nextToken?: NextToken;
1290
+ }
1291
+ export interface ListInputRoutingsResponse {
1292
+ /**
1293
+ * Summary information about the routed resources.
1294
+ */
1295
+ routedResources?: RoutedResources;
1296
+ /**
1297
+ * The token that you can use to return the next set of results, or null if there are no more results.
1298
+ */
1299
+ nextToken?: NextToken;
1300
+ }
855
1301
  export interface ListInputsRequest {
856
1302
  /**
857
1303
  * The token that you can use to return the next set of results.
@@ -908,6 +1354,25 @@ declare namespace IoTEvents {
908
1354
  export type MaxAnalysisResults = number;
909
1355
  export type MaxResults = number;
910
1356
  export type NextToken = string;
1357
+ export interface NotificationAction {
1358
+ /**
1359
+ * Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events.
1360
+ */
1361
+ action: NotificationTargetActions;
1362
+ /**
1363
+ * Contains the configuration information of SMS notifications.
1364
+ */
1365
+ smsConfigurations?: SMSConfigurations;
1366
+ /**
1367
+ * Contains the configuration information of email notifications.
1368
+ */
1369
+ emailConfigurations?: EmailConfigurations;
1370
+ }
1371
+ export type NotificationActions = NotificationAction[];
1372
+ export type NotificationAdditionalMessage = string;
1373
+ export interface NotificationTargetActions {
1374
+ lambdaAction?: LambdaAction;
1375
+ }
911
1376
  export interface OnEnterLifecycle {
912
1377
  /**
913
1378
  * Specifies the actions that are performed when the state is entered and the condition is TRUE.
@@ -948,12 +1413,47 @@ declare namespace IoTEvents {
948
1413
  loggingOptions: LoggingOptions;
949
1414
  }
950
1415
  export type QueueUrl = string;
1416
+ export interface RecipientDetail {
1417
+ /**
1418
+ * The AWS Single Sign-On (AWS SSO) authentication information.
1419
+ */
1420
+ ssoIdentity?: SSOIdentity;
1421
+ }
1422
+ export type RecipientDetails = RecipientDetail[];
951
1423
  export interface ResetTimerAction {
952
1424
  /**
953
1425
  * The name of the timer to reset.
954
1426
  */
955
1427
  timerName: TimerName;
956
1428
  }
1429
+ export type ResourceName = string;
1430
+ export interface RoutedResource {
1431
+ /**
1432
+ * The name of the routed resource.
1433
+ */
1434
+ name?: ResourceName;
1435
+ /**
1436
+ * The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
1437
+ */
1438
+ arn?: AmazonResourceName;
1439
+ }
1440
+ export type RoutedResources = RoutedResource[];
1441
+ export interface SMSConfiguration {
1442
+ /**
1443
+ * The sender ID.
1444
+ */
1445
+ senderId?: SMSSenderId;
1446
+ /**
1447
+ * The message that you want to send. The message can be up to 200 characters.
1448
+ */
1449
+ additionalMessage?: NotificationAdditionalMessage;
1450
+ /**
1451
+ * Specifies one or more recipients who receive the message. You must add the users that receive SMS messages to your AWS SSO store.
1452
+ */
1453
+ recipients: RecipientDetails;
1454
+ }
1455
+ export type SMSConfigurations = SMSConfiguration[];
1456
+ export type SMSSenderId = string;
957
1457
  export interface SNSTopicPublishAction {
958
1458
  /**
959
1459
  * The ARN of the Amazon SNS target where the message is sent.
@@ -964,6 +1464,17 @@ declare namespace IoTEvents {
964
1464
  */
965
1465
  payload?: Payload;
966
1466
  }
1467
+ export interface SSOIdentity {
1468
+ /**
1469
+ * The ID of the AWS SSO identity store.
1470
+ */
1471
+ identityStoreId: IdentityStoreId;
1472
+ /**
1473
+ * The user ID.
1474
+ */
1475
+ userId?: SSOReferenceId;
1476
+ }
1477
+ export type SSOReferenceId = string;
967
1478
  export type Seconds = number;
968
1479
  export interface SetTimerAction {
969
1480
  /**
@@ -989,6 +1500,21 @@ declare namespace IoTEvents {
989
1500
  */
990
1501
  value: VariableValue;
991
1502
  }
1503
+ export type Severity = number;
1504
+ export interface SimpleRule {
1505
+ /**
1506
+ * The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
1507
+ */
1508
+ inputProperty: InputProperty;
1509
+ /**
1510
+ * The comparison operator.
1511
+ */
1512
+ comparisonOperator: ComparisonOperator;
1513
+ /**
1514
+ * The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
1515
+ */
1516
+ threshold: Threshold;
1517
+ }
992
1518
  export interface SqsAction {
993
1519
  /**
994
1520
  * The URL of the SQS queue where the data is written.
@@ -1032,6 +1558,7 @@ declare namespace IoTEvents {
1032
1558
  }
1033
1559
  export type StateName = string;
1034
1560
  export type States = State[];
1561
+ export type StatusMessage = string;
1035
1562
  export interface Tag {
1036
1563
  /**
1037
1564
  * The tag's key.
@@ -1058,6 +1585,7 @@ declare namespace IoTEvents {
1058
1585
  }
1059
1586
  export type TagValue = string;
1060
1587
  export type Tags = Tag[];
1588
+ export type Threshold = string;
1061
1589
  export type TimerName = string;
1062
1590
  export type Timestamp = Date;
1063
1591
  export interface TransitionEvent {
@@ -1091,6 +1619,62 @@ declare namespace IoTEvents {
1091
1619
  }
1092
1620
  export interface UntagResourceResponse {
1093
1621
  }
1622
+ export interface UpdateAlarmModelRequest {
1623
+ /**
1624
+ * The name of the alarm model.
1625
+ */
1626
+ alarmModelName: AlarmModelName;
1627
+ /**
1628
+ * The description of the alarm model.
1629
+ */
1630
+ alarmModelDescription?: AlarmModelDescription;
1631
+ /**
1632
+ * The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
1633
+ */
1634
+ roleArn: AmazonResourceName;
1635
+ /**
1636
+ * A non-negative integer that reflects the severity level of the alarm.
1637
+ */
1638
+ severity?: Severity;
1639
+ /**
1640
+ * Defines when your alarm is invoked.
1641
+ */
1642
+ alarmRule: AlarmRule;
1643
+ /**
1644
+ * Contains information about one or more notification actions.
1645
+ */
1646
+ alarmNotification?: AlarmNotification;
1647
+ /**
1648
+ * Contains information about one or more alarm actions.
1649
+ */
1650
+ alarmEventActions?: AlarmEventActions;
1651
+ /**
1652
+ * Contains the configuration information of alarm state changes.
1653
+ */
1654
+ alarmCapabilities?: AlarmCapabilities;
1655
+ }
1656
+ export interface UpdateAlarmModelResponse {
1657
+ /**
1658
+ * The time the alarm model was created, in the Unix epoch format.
1659
+ */
1660
+ creationTime?: Timestamp;
1661
+ /**
1662
+ * The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
1663
+ */
1664
+ alarmModelArn?: AlarmModelArn;
1665
+ /**
1666
+ * The version of the alarm model.
1667
+ */
1668
+ alarmModelVersion?: AlarmModelVersion;
1669
+ /**
1670
+ * The time the alarm model was last updated, in the Unix epoch format.
1671
+ */
1672
+ lastUpdateTime?: Timestamp;
1673
+ /**
1674
+ * The status of the alarm model. The status can be one of the following values: ACTIVE - The alarm model is active and it's ready to evaluate data. ACTIVATING - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. INACTIVE - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. FAILED - You couldn't create or update the alarm model. Check your alarm model information and try again.
1675
+ */
1676
+ status?: AlarmModelVersionStatus;
1677
+ }
1094
1678
  export interface UpdateDetectorModelRequest {
1095
1679
  /**
1096
1680
  * The name of the detector model that is updated.