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.
- package/CHANGELOG.md +26 -1
- package/README.md +1 -1
- package/apis/autoscaling-2011-01-01.min.json +63 -60
- package/apis/datasync-2018-11-09.min.json +16 -15
- package/apis/devicefarm-2015-06-23.min.json +144 -92
- package/apis/docdb-2014-10-31.min.json +233 -65
- package/apis/docdb-2014-10-31.paginators.json +6 -0
- package/apis/ec2-2016-11-15.min.json +6 -0
- package/apis/fsx-2018-03-01.min.json +27 -24
- package/apis/iotevents-2018-07-27.min.json +715 -188
- package/apis/iotevents-data-2018-10-23.min.json +380 -1
- package/apis/iotsitewise-2019-12-02.min.json +65 -43
- package/apis/iotwireless-2020-11-22.min.json +210 -6
- package/apis/kendra-2019-02-03.min.json +351 -77
- package/apis/location-2020-11-19.min.json +677 -84
- package/apis/location-2020-11-19.paginators.json +12 -0
- package/apis/sns-2010-03-31.min.json +150 -13
- package/apis/sns-2010-03-31.paginators.json +12 -0
- package/clients/autoscaling.d.ts +55 -50
- package/clients/braket.d.ts +2 -2
- package/clients/datasync.d.ts +39 -34
- package/clients/devicefarm.d.ts +41 -10
- package/clients/docdb.d.ts +217 -4
- package/clients/ec2.d.ts +8 -0
- package/clients/ecs.d.ts +4 -4
- package/clients/fsx.d.ts +15 -2
- package/clients/iam.d.ts +1 -1
- package/clients/iotevents.d.ts +595 -11
- package/clients/ioteventsdata.d.ts +474 -9
- package/clients/iotsitewise.d.ts +34 -0
- package/clients/iotwireless.d.ts +126 -0
- package/clients/kendra.d.ts +410 -6
- package/clients/lightsail.d.ts +3 -3
- package/clients/location.d.ts +651 -77
- package/clients/polly.d.ts +1 -1
- package/clients/resourcegroups.d.ts +4 -4
- package/clients/servicediscovery.d.ts +41 -41
- package/clients/sns.d.ts +181 -4
- package/clients/sqs.d.ts +5 -5
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +17 -17
- package/dist/aws-sdk.js +378 -168
- package/dist/aws-sdk.min.js +68 -68
- package/lib/core.js +1 -1
- package/package.json +1 -1
|
@@ -11,6 +11,30 @@ declare class IoTEventsData extends Service {
|
|
|
11
11
|
*/
|
|
12
12
|
constructor(options?: IoTEventsData.Types.ClientConfiguration)
|
|
13
13
|
config: Config & IoTEventsData.Types.ClientConfiguration;
|
|
14
|
+
/**
|
|
15
|
+
* Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.
|
|
16
|
+
*/
|
|
17
|
+
batchAcknowledgeAlarm(params: IoTEventsData.Types.BatchAcknowledgeAlarmRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchAcknowledgeAlarmResponse) => void): Request<IoTEventsData.Types.BatchAcknowledgeAlarmResponse, AWSError>;
|
|
18
|
+
/**
|
|
19
|
+
* Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.
|
|
20
|
+
*/
|
|
21
|
+
batchAcknowledgeAlarm(callback?: (err: AWSError, data: IoTEventsData.Types.BatchAcknowledgeAlarmResponse) => void): Request<IoTEventsData.Types.BatchAcknowledgeAlarmResponse, AWSError>;
|
|
22
|
+
/**
|
|
23
|
+
* Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
|
|
24
|
+
*/
|
|
25
|
+
batchDisableAlarm(params: IoTEventsData.Types.BatchDisableAlarmRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchDisableAlarmResponse) => void): Request<IoTEventsData.Types.BatchDisableAlarmResponse, AWSError>;
|
|
26
|
+
/**
|
|
27
|
+
* Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
|
|
28
|
+
*/
|
|
29
|
+
batchDisableAlarm(callback?: (err: AWSError, data: IoTEventsData.Types.BatchDisableAlarmResponse) => void): Request<IoTEventsData.Types.BatchDisableAlarmResponse, AWSError>;
|
|
30
|
+
/**
|
|
31
|
+
* Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
|
|
32
|
+
*/
|
|
33
|
+
batchEnableAlarm(params: IoTEventsData.Types.BatchEnableAlarmRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchEnableAlarmResponse) => void): Request<IoTEventsData.Types.BatchEnableAlarmResponse, AWSError>;
|
|
34
|
+
/**
|
|
35
|
+
* Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
|
|
36
|
+
*/
|
|
37
|
+
batchEnableAlarm(callback?: (err: AWSError, data: IoTEventsData.Types.BatchEnableAlarmResponse) => void): Request<IoTEventsData.Types.BatchEnableAlarmResponse, AWSError>;
|
|
14
38
|
/**
|
|
15
39
|
* Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
|
|
16
40
|
*/
|
|
@@ -19,6 +43,22 @@ declare class IoTEventsData extends Service {
|
|
|
19
43
|
* Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
|
|
20
44
|
*/
|
|
21
45
|
batchPutMessage(callback?: (err: AWSError, data: IoTEventsData.Types.BatchPutMessageResponse) => void): Request<IoTEventsData.Types.BatchPutMessageResponse, AWSError>;
|
|
46
|
+
/**
|
|
47
|
+
* Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
|
|
48
|
+
*/
|
|
49
|
+
batchResetAlarm(params: IoTEventsData.Types.BatchResetAlarmRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchResetAlarmResponse) => void): Request<IoTEventsData.Types.BatchResetAlarmResponse, AWSError>;
|
|
50
|
+
/**
|
|
51
|
+
* Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
|
|
52
|
+
*/
|
|
53
|
+
batchResetAlarm(callback?: (err: AWSError, data: IoTEventsData.Types.BatchResetAlarmResponse) => void): Request<IoTEventsData.Types.BatchResetAlarmResponse, AWSError>;
|
|
54
|
+
/**
|
|
55
|
+
* Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.
|
|
56
|
+
*/
|
|
57
|
+
batchSnoozeAlarm(params: IoTEventsData.Types.BatchSnoozeAlarmRequest, callback?: (err: AWSError, data: IoTEventsData.Types.BatchSnoozeAlarmResponse) => void): Request<IoTEventsData.Types.BatchSnoozeAlarmResponse, AWSError>;
|
|
58
|
+
/**
|
|
59
|
+
* Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.
|
|
60
|
+
*/
|
|
61
|
+
batchSnoozeAlarm(callback?: (err: AWSError, data: IoTEventsData.Types.BatchSnoozeAlarmResponse) => void): Request<IoTEventsData.Types.BatchSnoozeAlarmResponse, AWSError>;
|
|
22
62
|
/**
|
|
23
63
|
* Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
|
|
24
64
|
*/
|
|
@@ -27,6 +67,14 @@ declare class IoTEventsData extends Service {
|
|
|
27
67
|
* Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
|
|
28
68
|
*/
|
|
29
69
|
batchUpdateDetector(callback?: (err: AWSError, data: IoTEventsData.Types.BatchUpdateDetectorResponse) => void): Request<IoTEventsData.Types.BatchUpdateDetectorResponse, AWSError>;
|
|
70
|
+
/**
|
|
71
|
+
* Retrieves information about an alarm.
|
|
72
|
+
*/
|
|
73
|
+
describeAlarm(params: IoTEventsData.Types.DescribeAlarmRequest, callback?: (err: AWSError, data: IoTEventsData.Types.DescribeAlarmResponse) => void): Request<IoTEventsData.Types.DescribeAlarmResponse, AWSError>;
|
|
74
|
+
/**
|
|
75
|
+
* Retrieves information about an alarm.
|
|
76
|
+
*/
|
|
77
|
+
describeAlarm(callback?: (err: AWSError, data: IoTEventsData.Types.DescribeAlarmResponse) => void): Request<IoTEventsData.Types.DescribeAlarmResponse, AWSError>;
|
|
30
78
|
/**
|
|
31
79
|
* Returns information about the specified detector (instance).
|
|
32
80
|
*/
|
|
@@ -35,6 +83,14 @@ declare class IoTEventsData extends Service {
|
|
|
35
83
|
* Returns information about the specified detector (instance).
|
|
36
84
|
*/
|
|
37
85
|
describeDetector(callback?: (err: AWSError, data: IoTEventsData.Types.DescribeDetectorResponse) => void): Request<IoTEventsData.Types.DescribeDetectorResponse, AWSError>;
|
|
86
|
+
/**
|
|
87
|
+
* Lists one or more alarms. The operation returns only the metadata associated with each alarm.
|
|
88
|
+
*/
|
|
89
|
+
listAlarms(params: IoTEventsData.Types.ListAlarmsRequest, callback?: (err: AWSError, data: IoTEventsData.Types.ListAlarmsResponse) => void): Request<IoTEventsData.Types.ListAlarmsResponse, AWSError>;
|
|
90
|
+
/**
|
|
91
|
+
* Lists one or more alarms. The operation returns only the metadata associated with each alarm.
|
|
92
|
+
*/
|
|
93
|
+
listAlarms(callback?: (err: AWSError, data: IoTEventsData.Types.ListAlarmsResponse) => void): Request<IoTEventsData.Types.ListAlarmsResponse, AWSError>;
|
|
38
94
|
/**
|
|
39
95
|
* Lists detectors (the instances of a detector model).
|
|
40
96
|
*/
|
|
@@ -45,6 +101,160 @@ declare class IoTEventsData extends Service {
|
|
|
45
101
|
listDetectors(callback?: (err: AWSError, data: IoTEventsData.Types.ListDetectorsResponse) => void): Request<IoTEventsData.Types.ListDetectorsResponse, AWSError>;
|
|
46
102
|
}
|
|
47
103
|
declare namespace IoTEventsData {
|
|
104
|
+
export interface AcknowledgeActionConfiguration {
|
|
105
|
+
/**
|
|
106
|
+
* The note that you can leave when you acknowledge the alarm.
|
|
107
|
+
*/
|
|
108
|
+
note?: Note;
|
|
109
|
+
}
|
|
110
|
+
export interface AcknowledgeAlarmActionRequest {
|
|
111
|
+
/**
|
|
112
|
+
* The request ID. Each ID must be unique within each batch.
|
|
113
|
+
*/
|
|
114
|
+
requestId: RequestId;
|
|
115
|
+
/**
|
|
116
|
+
* The name of the alarm model.
|
|
117
|
+
*/
|
|
118
|
+
alarmModelName: AlarmModelName;
|
|
119
|
+
/**
|
|
120
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
121
|
+
*/
|
|
122
|
+
keyValue?: KeyValue;
|
|
123
|
+
/**
|
|
124
|
+
* The note that you can leave when you acknowledge the alarm.
|
|
125
|
+
*/
|
|
126
|
+
note?: Note;
|
|
127
|
+
}
|
|
128
|
+
export type AcknowledgeAlarmActionRequests = AcknowledgeAlarmActionRequest[];
|
|
129
|
+
export interface Alarm {
|
|
130
|
+
/**
|
|
131
|
+
* The name of the alarm model.
|
|
132
|
+
*/
|
|
133
|
+
alarmModelName?: AlarmModelName;
|
|
134
|
+
/**
|
|
135
|
+
* The version of the alarm model.
|
|
136
|
+
*/
|
|
137
|
+
alarmModelVersion?: AlarmModelVersion;
|
|
138
|
+
/**
|
|
139
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
140
|
+
*/
|
|
141
|
+
keyValue?: KeyValue;
|
|
142
|
+
/**
|
|
143
|
+
* Contains information about the current state of the alarm.
|
|
144
|
+
*/
|
|
145
|
+
alarmState?: AlarmState;
|
|
146
|
+
/**
|
|
147
|
+
* A non-negative integer that reflects the severity level of the alarm.
|
|
148
|
+
*/
|
|
149
|
+
severity?: Severity;
|
|
150
|
+
/**
|
|
151
|
+
* The time the alarm was created, in the Unix epoch format.
|
|
152
|
+
*/
|
|
153
|
+
creationTime?: Timestamp;
|
|
154
|
+
/**
|
|
155
|
+
* The time the alarm was last updated, in the Unix epoch format.
|
|
156
|
+
*/
|
|
157
|
+
lastUpdateTime?: Timestamp;
|
|
158
|
+
}
|
|
159
|
+
export type AlarmModelName = string;
|
|
160
|
+
export type AlarmModelVersion = string;
|
|
161
|
+
export interface AlarmState {
|
|
162
|
+
/**
|
|
163
|
+
* The name of the alarm state. The state name can be one of the following values: DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state. NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data. ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm. SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state. LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
|
|
164
|
+
*/
|
|
165
|
+
stateName?: AlarmStateName;
|
|
166
|
+
/**
|
|
167
|
+
* Information needed to evaluate data.
|
|
168
|
+
*/
|
|
169
|
+
ruleEvaluation?: RuleEvaluation;
|
|
170
|
+
/**
|
|
171
|
+
* Contains information about the action that you can take to respond to the alarm.
|
|
172
|
+
*/
|
|
173
|
+
customerAction?: CustomerAction;
|
|
174
|
+
/**
|
|
175
|
+
* Contains information about alarm state changes.
|
|
176
|
+
*/
|
|
177
|
+
systemEvent?: SystemEvent;
|
|
178
|
+
}
|
|
179
|
+
export type AlarmStateName = "DISABLED"|"NORMAL"|"ACTIVE"|"ACKNOWLEDGED"|"SNOOZE_DISABLED"|"LATCHED"|string;
|
|
180
|
+
export type AlarmSummaries = AlarmSummary[];
|
|
181
|
+
export interface AlarmSummary {
|
|
182
|
+
/**
|
|
183
|
+
* The name of the alarm model.
|
|
184
|
+
*/
|
|
185
|
+
alarmModelName?: AlarmModelName;
|
|
186
|
+
/**
|
|
187
|
+
* The version of the alarm model.
|
|
188
|
+
*/
|
|
189
|
+
alarmModelVersion?: AlarmModelVersion;
|
|
190
|
+
/**
|
|
191
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
192
|
+
*/
|
|
193
|
+
keyValue?: KeyValue;
|
|
194
|
+
/**
|
|
195
|
+
* The name of the alarm state. The state name can be one of the following values: DISABLED - When the alarm is in the DISABLED state, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to the NORMAL state. NORMAL - When the alarm is in the NORMAL state, it's ready to evaluate data. ACTIVE - If the alarm is in the ACTIVE state, the alarm is invoked. ACKNOWLEDGED - When the alarm is in the ACKNOWLEDGED state, the alarm was invoked and you acknowledged the alarm. SNOOZE_DISABLED - When the alarm is in the SNOOZE_DISABLED state, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to the NORMAL state. LATCHED - When the alarm is in the LATCHED state, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to the NORMAL state, you must acknowledge the alarm.
|
|
196
|
+
*/
|
|
197
|
+
stateName?: AlarmStateName;
|
|
198
|
+
/**
|
|
199
|
+
* The time the alarm was created, in the Unix epoch format.
|
|
200
|
+
*/
|
|
201
|
+
creationTime?: Timestamp;
|
|
202
|
+
/**
|
|
203
|
+
* The time the alarm was last updated, in the Unix epoch format.
|
|
204
|
+
*/
|
|
205
|
+
lastUpdateTime?: Timestamp;
|
|
206
|
+
}
|
|
207
|
+
export interface BatchAcknowledgeAlarmRequest {
|
|
208
|
+
/**
|
|
209
|
+
* The list of acknowledge action requests. You can specify up to 10 requests per operation.
|
|
210
|
+
*/
|
|
211
|
+
acknowledgeActionRequests: AcknowledgeAlarmActionRequests;
|
|
212
|
+
}
|
|
213
|
+
export interface BatchAcknowledgeAlarmResponse {
|
|
214
|
+
/**
|
|
215
|
+
* A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
|
|
216
|
+
*/
|
|
217
|
+
errorEntries?: BatchAlarmActionErrorEntries;
|
|
218
|
+
}
|
|
219
|
+
export type BatchAlarmActionErrorEntries = BatchAlarmActionErrorEntry[];
|
|
220
|
+
export interface BatchAlarmActionErrorEntry {
|
|
221
|
+
/**
|
|
222
|
+
* The request ID. Each ID must be unique within each batch.
|
|
223
|
+
*/
|
|
224
|
+
requestId?: RequestId;
|
|
225
|
+
/**
|
|
226
|
+
* The error code.
|
|
227
|
+
*/
|
|
228
|
+
errorCode?: ErrorCode;
|
|
229
|
+
/**
|
|
230
|
+
* A message that describes the error.
|
|
231
|
+
*/
|
|
232
|
+
errorMessage?: ErrorMessage;
|
|
233
|
+
}
|
|
234
|
+
export interface BatchDisableAlarmRequest {
|
|
235
|
+
/**
|
|
236
|
+
* The list of disable action requests. You can specify up to 10 requests per operation.
|
|
237
|
+
*/
|
|
238
|
+
disableActionRequests: DisableAlarmActionRequests;
|
|
239
|
+
}
|
|
240
|
+
export interface BatchDisableAlarmResponse {
|
|
241
|
+
/**
|
|
242
|
+
* A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
|
|
243
|
+
*/
|
|
244
|
+
errorEntries?: BatchAlarmActionErrorEntries;
|
|
245
|
+
}
|
|
246
|
+
export interface BatchEnableAlarmRequest {
|
|
247
|
+
/**
|
|
248
|
+
* The list of enable action requests. You can specify up to 10 requests per operation.
|
|
249
|
+
*/
|
|
250
|
+
enableActionRequests: EnableAlarmActionRequests;
|
|
251
|
+
}
|
|
252
|
+
export interface BatchEnableAlarmResponse {
|
|
253
|
+
/**
|
|
254
|
+
* A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
|
|
255
|
+
*/
|
|
256
|
+
errorEntries?: BatchAlarmActionErrorEntries;
|
|
257
|
+
}
|
|
48
258
|
export type BatchPutMessageErrorEntries = BatchPutMessageErrorEntry[];
|
|
49
259
|
export interface BatchPutMessageErrorEntry {
|
|
50
260
|
/**
|
|
@@ -52,11 +262,11 @@ declare namespace IoTEventsData {
|
|
|
52
262
|
*/
|
|
53
263
|
messageId?: MessageId;
|
|
54
264
|
/**
|
|
55
|
-
* The code
|
|
265
|
+
* The error code.
|
|
56
266
|
*/
|
|
57
267
|
errorCode?: ErrorCode;
|
|
58
268
|
/**
|
|
59
|
-
*
|
|
269
|
+
* A message that describes the error.
|
|
60
270
|
*/
|
|
61
271
|
errorMessage?: ErrorMessage;
|
|
62
272
|
}
|
|
@@ -72,6 +282,30 @@ declare namespace IoTEventsData {
|
|
|
72
282
|
*/
|
|
73
283
|
BatchPutMessageErrorEntries?: BatchPutMessageErrorEntries;
|
|
74
284
|
}
|
|
285
|
+
export interface BatchResetAlarmRequest {
|
|
286
|
+
/**
|
|
287
|
+
* The list of reset action requests. You can specify up to 10 requests per operation.
|
|
288
|
+
*/
|
|
289
|
+
resetActionRequests: ResetAlarmActionRequests;
|
|
290
|
+
}
|
|
291
|
+
export interface BatchResetAlarmResponse {
|
|
292
|
+
/**
|
|
293
|
+
* A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
|
|
294
|
+
*/
|
|
295
|
+
errorEntries?: BatchAlarmActionErrorEntries;
|
|
296
|
+
}
|
|
297
|
+
export interface BatchSnoozeAlarmRequest {
|
|
298
|
+
/**
|
|
299
|
+
* The list of snooze action requests. You can specify up to 10 requests per operation.
|
|
300
|
+
*/
|
|
301
|
+
snoozeActionRequests: SnoozeAlarmActionRequests;
|
|
302
|
+
}
|
|
303
|
+
export interface BatchSnoozeAlarmResponse {
|
|
304
|
+
/**
|
|
305
|
+
* A list of errors associated with the request, or null if there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
|
|
306
|
+
*/
|
|
307
|
+
errorEntries?: BatchAlarmActionErrorEntries;
|
|
308
|
+
}
|
|
75
309
|
export type BatchUpdateDetectorErrorEntries = BatchUpdateDetectorErrorEntry[];
|
|
76
310
|
export interface BatchUpdateDetectorErrorEntry {
|
|
77
311
|
/**
|
|
@@ -79,11 +313,11 @@ declare namespace IoTEventsData {
|
|
|
79
313
|
*/
|
|
80
314
|
messageId?: MessageId;
|
|
81
315
|
/**
|
|
82
|
-
* The code
|
|
316
|
+
* The error code.
|
|
83
317
|
*/
|
|
84
318
|
errorCode?: ErrorCode;
|
|
85
319
|
/**
|
|
86
|
-
* A message
|
|
320
|
+
* A message that describes the error.
|
|
87
321
|
*/
|
|
88
322
|
errorMessage?: ErrorMessage;
|
|
89
323
|
}
|
|
@@ -99,6 +333,50 @@ declare namespace IoTEventsData {
|
|
|
99
333
|
*/
|
|
100
334
|
batchUpdateDetectorErrorEntries?: BatchUpdateDetectorErrorEntries;
|
|
101
335
|
}
|
|
336
|
+
export type ComparisonOperator = "GREATER"|"GREATER_OR_EQUAL"|"LESS"|"LESS_OR_EQUAL"|"EQUAL"|"NOT_EQUAL"|string;
|
|
337
|
+
export interface CustomerAction {
|
|
338
|
+
/**
|
|
339
|
+
* The name of the action. The action name can be one of the following values: SNOOZE - When you snooze the alarm, the alarm state changes to SNOOZE_DISABLED. ENABLE - When you enable the alarm, the alarm state changes to NORMAL. DISABLE - When you disable the alarm, the alarm state changes to DISABLED. ACKNOWLEDGE - When you acknowledge the alarm, the alarm state changes to ACKNOWLEDGED. RESET - When you reset the alarm, the alarm state changes to NORMAL. For more information, see the AlarmState API.
|
|
340
|
+
*/
|
|
341
|
+
actionName?: CustomerActionName;
|
|
342
|
+
/**
|
|
343
|
+
* Contains the configuration information of a snooze action.
|
|
344
|
+
*/
|
|
345
|
+
snoozeActionConfiguration?: SnoozeActionConfiguration;
|
|
346
|
+
/**
|
|
347
|
+
* Contains the configuration information of an enable action.
|
|
348
|
+
*/
|
|
349
|
+
enableActionConfiguration?: EnableActionConfiguration;
|
|
350
|
+
/**
|
|
351
|
+
* Contains the configuration information of a disable action.
|
|
352
|
+
*/
|
|
353
|
+
disableActionConfiguration?: DisableActionConfiguration;
|
|
354
|
+
/**
|
|
355
|
+
* Contains the configuration information of an acknowledge action.
|
|
356
|
+
*/
|
|
357
|
+
acknowledgeActionConfiguration?: AcknowledgeActionConfiguration;
|
|
358
|
+
/**
|
|
359
|
+
* Contains the configuration information of a reset action.
|
|
360
|
+
*/
|
|
361
|
+
resetActionConfiguration?: ResetActionConfiguration;
|
|
362
|
+
}
|
|
363
|
+
export type CustomerActionName = "SNOOZE"|"ENABLE"|"DISABLE"|"ACKNOWLEDGE"|"RESET"|string;
|
|
364
|
+
export interface DescribeAlarmRequest {
|
|
365
|
+
/**
|
|
366
|
+
* The name of the alarm model.
|
|
367
|
+
*/
|
|
368
|
+
alarmModelName: AlarmModelName;
|
|
369
|
+
/**
|
|
370
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
371
|
+
*/
|
|
372
|
+
keyValue?: KeyValue;
|
|
373
|
+
}
|
|
374
|
+
export interface DescribeAlarmResponse {
|
|
375
|
+
/**
|
|
376
|
+
* Contains information about an alarm.
|
|
377
|
+
*/
|
|
378
|
+
alarm?: Alarm;
|
|
379
|
+
}
|
|
102
380
|
export interface DescribeDetectorRequest {
|
|
103
381
|
/**
|
|
104
382
|
* The name of the detector model whose detectors (instances) you want information about.
|
|
@@ -204,10 +482,87 @@ declare namespace IoTEventsData {
|
|
|
204
482
|
*/
|
|
205
483
|
lastUpdateTime?: Timestamp;
|
|
206
484
|
}
|
|
485
|
+
export interface DisableActionConfiguration {
|
|
486
|
+
/**
|
|
487
|
+
* The note that you can leave when you disable the alarm.
|
|
488
|
+
*/
|
|
489
|
+
note?: Note;
|
|
490
|
+
}
|
|
491
|
+
export interface DisableAlarmActionRequest {
|
|
492
|
+
/**
|
|
493
|
+
* The request ID. Each ID must be unique within each batch.
|
|
494
|
+
*/
|
|
495
|
+
requestId: RequestId;
|
|
496
|
+
/**
|
|
497
|
+
* The name of the alarm model.
|
|
498
|
+
*/
|
|
499
|
+
alarmModelName: AlarmModelName;
|
|
500
|
+
/**
|
|
501
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
502
|
+
*/
|
|
503
|
+
keyValue?: KeyValue;
|
|
504
|
+
/**
|
|
505
|
+
* The note that you can leave when you disable the alarm.
|
|
506
|
+
*/
|
|
507
|
+
note?: Note;
|
|
508
|
+
}
|
|
509
|
+
export type DisableAlarmActionRequests = DisableAlarmActionRequest[];
|
|
510
|
+
export interface EnableActionConfiguration {
|
|
511
|
+
/**
|
|
512
|
+
* The note that you can leave when you enable the alarm.
|
|
513
|
+
*/
|
|
514
|
+
note?: Note;
|
|
515
|
+
}
|
|
516
|
+
export interface EnableAlarmActionRequest {
|
|
517
|
+
/**
|
|
518
|
+
* The request ID. Each ID must be unique within each batch.
|
|
519
|
+
*/
|
|
520
|
+
requestId: RequestId;
|
|
521
|
+
/**
|
|
522
|
+
* The name of the alarm model.
|
|
523
|
+
*/
|
|
524
|
+
alarmModelName: AlarmModelName;
|
|
525
|
+
/**
|
|
526
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
527
|
+
*/
|
|
528
|
+
keyValue?: KeyValue;
|
|
529
|
+
/**
|
|
530
|
+
* The note that you can leave when you enable the alarm.
|
|
531
|
+
*/
|
|
532
|
+
note?: Note;
|
|
533
|
+
}
|
|
534
|
+
export type EnableAlarmActionRequests = EnableAlarmActionRequest[];
|
|
535
|
+
export type EphemeralInputName = string;
|
|
536
|
+
export type EpochMilliTimestamp = number;
|
|
207
537
|
export type ErrorCode = "ResourceNotFoundException"|"InvalidRequestException"|"InternalFailureException"|"ServiceUnavailableException"|"ThrottlingException"|string;
|
|
208
538
|
export type ErrorMessage = string;
|
|
209
|
-
export type
|
|
539
|
+
export type EventType = "STATE_CHANGE"|string;
|
|
540
|
+
export type InputPropertyValue = string;
|
|
210
541
|
export type KeyValue = string;
|
|
542
|
+
export interface ListAlarmsRequest {
|
|
543
|
+
/**
|
|
544
|
+
* The name of the alarm model.
|
|
545
|
+
*/
|
|
546
|
+
alarmModelName: AlarmModelName;
|
|
547
|
+
/**
|
|
548
|
+
* The token that you can use to return the next set of results.
|
|
549
|
+
*/
|
|
550
|
+
nextToken?: NextToken;
|
|
551
|
+
/**
|
|
552
|
+
* The maximum number of results to be returned per request.
|
|
553
|
+
*/
|
|
554
|
+
maxResults?: MaxResults;
|
|
555
|
+
}
|
|
556
|
+
export interface ListAlarmsResponse {
|
|
557
|
+
/**
|
|
558
|
+
* A list that summarizes each alarm.
|
|
559
|
+
*/
|
|
560
|
+
alarmSummaries?: AlarmSummaries;
|
|
561
|
+
/**
|
|
562
|
+
* The token that you can use to return the next set of results, or null if there are no more results.
|
|
563
|
+
*/
|
|
564
|
+
nextToken?: NextToken;
|
|
565
|
+
}
|
|
211
566
|
export interface ListDetectorsRequest {
|
|
212
567
|
/**
|
|
213
568
|
* The name of the detector model whose detectors (instances) are listed.
|
|
@@ -218,11 +573,11 @@ declare namespace IoTEventsData {
|
|
|
218
573
|
*/
|
|
219
574
|
stateName?: StateName;
|
|
220
575
|
/**
|
|
221
|
-
* The token
|
|
576
|
+
* The token that you can use to return the next set of results.
|
|
222
577
|
*/
|
|
223
578
|
nextToken?: NextToken;
|
|
224
579
|
/**
|
|
225
|
-
* The maximum number of results to
|
|
580
|
+
* The maximum number of results to be returned per request.
|
|
226
581
|
*/
|
|
227
582
|
maxResults?: MaxResults;
|
|
228
583
|
}
|
|
@@ -232,7 +587,7 @@ declare namespace IoTEventsData {
|
|
|
232
587
|
*/
|
|
233
588
|
detectorSummaries?: DetectorSummaries;
|
|
234
589
|
/**
|
|
235
|
-
*
|
|
590
|
+
* The token that you can use to return the next set of results, or null if there are no more results.
|
|
236
591
|
*/
|
|
237
592
|
nextToken?: NextToken;
|
|
238
593
|
}
|
|
@@ -245,18 +600,121 @@ declare namespace IoTEventsData {
|
|
|
245
600
|
/**
|
|
246
601
|
* The name of the input into which the message payload is transformed.
|
|
247
602
|
*/
|
|
248
|
-
inputName:
|
|
603
|
+
inputName: EphemeralInputName;
|
|
249
604
|
/**
|
|
250
605
|
* The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
|
|
251
606
|
*/
|
|
252
607
|
payload: Payload;
|
|
608
|
+
/**
|
|
609
|
+
* The timestamp associated with the message.
|
|
610
|
+
*/
|
|
611
|
+
timestamp?: TimestampValue;
|
|
253
612
|
}
|
|
254
613
|
export type MessageId = string;
|
|
255
614
|
export type Messages = Message[];
|
|
256
615
|
export type NextToken = string;
|
|
616
|
+
export type Note = string;
|
|
257
617
|
export type Payload = Buffer|Uint8Array|Blob|string;
|
|
618
|
+
export type RequestId = string;
|
|
619
|
+
export interface ResetActionConfiguration {
|
|
620
|
+
/**
|
|
621
|
+
* The note that you can leave when you reset the alarm.
|
|
622
|
+
*/
|
|
623
|
+
note?: Note;
|
|
624
|
+
}
|
|
625
|
+
export interface ResetAlarmActionRequest {
|
|
626
|
+
/**
|
|
627
|
+
* The request ID. Each ID must be unique within each batch.
|
|
628
|
+
*/
|
|
629
|
+
requestId: RequestId;
|
|
630
|
+
/**
|
|
631
|
+
* The name of the alarm model.
|
|
632
|
+
*/
|
|
633
|
+
alarmModelName: AlarmModelName;
|
|
634
|
+
/**
|
|
635
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
636
|
+
*/
|
|
637
|
+
keyValue?: KeyValue;
|
|
638
|
+
/**
|
|
639
|
+
* The note that you can leave when you reset the alarm.
|
|
640
|
+
*/
|
|
641
|
+
note?: Note;
|
|
642
|
+
}
|
|
643
|
+
export type ResetAlarmActionRequests = ResetAlarmActionRequest[];
|
|
644
|
+
export interface RuleEvaluation {
|
|
645
|
+
/**
|
|
646
|
+
* Information needed to compare two values with a comparison operator.
|
|
647
|
+
*/
|
|
648
|
+
simpleRuleEvaluation?: SimpleRuleEvaluation;
|
|
649
|
+
}
|
|
258
650
|
export type Seconds = number;
|
|
651
|
+
export type Severity = number;
|
|
652
|
+
export interface SimpleRuleEvaluation {
|
|
653
|
+
/**
|
|
654
|
+
* The value of the input property, on the left side of the comparison operator.
|
|
655
|
+
*/
|
|
656
|
+
inputPropertyValue?: InputPropertyValue;
|
|
657
|
+
/**
|
|
658
|
+
* The comparison operator.
|
|
659
|
+
*/
|
|
660
|
+
operator?: ComparisonOperator;
|
|
661
|
+
/**
|
|
662
|
+
* The threshold value, on the right side of the comparison operator.
|
|
663
|
+
*/
|
|
664
|
+
thresholdValue?: ThresholdValue;
|
|
665
|
+
}
|
|
666
|
+
export interface SnoozeActionConfiguration {
|
|
667
|
+
/**
|
|
668
|
+
* The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.
|
|
669
|
+
*/
|
|
670
|
+
snoozeDuration?: SnoozeDuration;
|
|
671
|
+
/**
|
|
672
|
+
* The note that you can leave when you snooze the alarm.
|
|
673
|
+
*/
|
|
674
|
+
note?: Note;
|
|
675
|
+
}
|
|
676
|
+
export interface SnoozeAlarmActionRequest {
|
|
677
|
+
/**
|
|
678
|
+
* The request ID. Each ID must be unique within each batch.
|
|
679
|
+
*/
|
|
680
|
+
requestId: RequestId;
|
|
681
|
+
/**
|
|
682
|
+
* The name of the alarm model.
|
|
683
|
+
*/
|
|
684
|
+
alarmModelName: AlarmModelName;
|
|
685
|
+
/**
|
|
686
|
+
* The value of the key used as a filter to select only the alarms associated with the key.
|
|
687
|
+
*/
|
|
688
|
+
keyValue?: KeyValue;
|
|
689
|
+
/**
|
|
690
|
+
* The note that you can leave when you snooze the alarm.
|
|
691
|
+
*/
|
|
692
|
+
note?: Note;
|
|
693
|
+
/**
|
|
694
|
+
* The snooze time in seconds. The alarm automatically changes to the NORMAL state after this duration.
|
|
695
|
+
*/
|
|
696
|
+
snoozeDuration: SnoozeDuration;
|
|
697
|
+
}
|
|
698
|
+
export type SnoozeAlarmActionRequests = SnoozeAlarmActionRequest[];
|
|
699
|
+
export type SnoozeDuration = number;
|
|
700
|
+
export interface StateChangeConfiguration {
|
|
701
|
+
/**
|
|
702
|
+
* The trigger type. If the value is SNOOZE_TIMEOUT, the snooze duration ends and the alarm automatically changes to the NORMAL state.
|
|
703
|
+
*/
|
|
704
|
+
triggerType?: TriggerType;
|
|
705
|
+
}
|
|
259
706
|
export type StateName = string;
|
|
707
|
+
export interface SystemEvent {
|
|
708
|
+
/**
|
|
709
|
+
* The event type. If the value is STATE_CHANGE, the event contains information about alarm state changes.
|
|
710
|
+
*/
|
|
711
|
+
eventType?: EventType;
|
|
712
|
+
/**
|
|
713
|
+
* Contains the configuration information of alarm state changes.
|
|
714
|
+
*/
|
|
715
|
+
stateChangeConfiguration?: StateChangeConfiguration;
|
|
716
|
+
}
|
|
717
|
+
export type ThresholdValue = string;
|
|
260
718
|
export interface Timer {
|
|
261
719
|
/**
|
|
262
720
|
* The name of the timer.
|
|
@@ -281,6 +739,13 @@ declare namespace IoTEventsData {
|
|
|
281
739
|
export type TimerName = string;
|
|
282
740
|
export type Timers = Timer[];
|
|
283
741
|
export type Timestamp = Date;
|
|
742
|
+
export interface TimestampValue {
|
|
743
|
+
/**
|
|
744
|
+
* The value of the timestamp, in the Unix epoch format.
|
|
745
|
+
*/
|
|
746
|
+
timeInMillis?: EpochMilliTimestamp;
|
|
747
|
+
}
|
|
748
|
+
export type TriggerType = "SNOOZE_TIMEOUT"|string;
|
|
284
749
|
export interface UpdateDetectorRequest {
|
|
285
750
|
/**
|
|
286
751
|
* The ID to assign to the detector update "message". Each "messageId" must be unique within each batch sent.
|
package/clients/iotsitewise.d.ts
CHANGED
|
@@ -598,6 +598,16 @@ declare namespace IoTSiteWise {
|
|
|
598
598
|
*/
|
|
599
599
|
standardDeviation?: AggregatedDoubleValue;
|
|
600
600
|
}
|
|
601
|
+
export interface Alarms {
|
|
602
|
+
/**
|
|
603
|
+
* The ARN of the IAM role that allows the alarm to perform actions and access AWS resources, including AWS IoT Events.
|
|
604
|
+
*/
|
|
605
|
+
alarmRoleArn: ARN;
|
|
606
|
+
/**
|
|
607
|
+
* The ARN of the AWS Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the AWS IoT Events Developer Guide.
|
|
608
|
+
*/
|
|
609
|
+
notificationLambdaArn?: ARN;
|
|
610
|
+
}
|
|
601
611
|
export type AmazonResourceName = string;
|
|
602
612
|
export interface AssetCompositeModel {
|
|
603
613
|
/**
|
|
@@ -1296,6 +1306,14 @@ declare namespace IoTSiteWise {
|
|
|
1296
1306
|
* The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions. IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions. You can't change this value after you create a portal. Default: SSO
|
|
1297
1307
|
*/
|
|
1298
1308
|
portalAuthMode?: AuthMode;
|
|
1309
|
+
/**
|
|
1310
|
+
* The email address that sends alarm notifications. If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.
|
|
1311
|
+
*/
|
|
1312
|
+
notificationSenderEmail?: Email;
|
|
1313
|
+
/**
|
|
1314
|
+
* Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see .
|
|
1315
|
+
*/
|
|
1316
|
+
alarms?: Alarms;
|
|
1299
1317
|
}
|
|
1300
1318
|
export interface CreatePortalResponse {
|
|
1301
1319
|
/**
|
|
@@ -1817,6 +1835,14 @@ declare namespace IoTSiteWise {
|
|
|
1817
1835
|
* The service to use to authenticate users to the portal.
|
|
1818
1836
|
*/
|
|
1819
1837
|
portalAuthMode?: AuthMode;
|
|
1838
|
+
/**
|
|
1839
|
+
* The email address that sends alarm notifications.
|
|
1840
|
+
*/
|
|
1841
|
+
notificationSenderEmail?: Email;
|
|
1842
|
+
/**
|
|
1843
|
+
* Contains the configuration information of an alarm created in a AWS IoT SiteWise Monitor portal.
|
|
1844
|
+
*/
|
|
1845
|
+
alarms?: Alarms;
|
|
1820
1846
|
}
|
|
1821
1847
|
export interface DescribeProjectRequest {
|
|
1822
1848
|
/**
|
|
@@ -2991,6 +3017,14 @@ declare namespace IoTSiteWise {
|
|
|
2991
3017
|
* A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
|
|
2992
3018
|
*/
|
|
2993
3019
|
clientToken?: ClientToken;
|
|
3020
|
+
/**
|
|
3021
|
+
* The email address that sends alarm notifications.
|
|
3022
|
+
*/
|
|
3023
|
+
notificationSenderEmail?: Email;
|
|
3024
|
+
/**
|
|
3025
|
+
* Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see .
|
|
3026
|
+
*/
|
|
3027
|
+
alarms?: Alarms;
|
|
2994
3028
|
}
|
|
2995
3029
|
export interface UpdatePortalResponse {
|
|
2996
3030
|
/**
|