@aws-sdk/client-iot-events-data 3.325.0 → 3.326.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.
@@ -39,6 +39,16 @@ export interface BatchAcknowledgeAlarmCommandOutput extends BatchAcknowledgeAlar
39
39
  * };
40
40
  * const command = new BatchAcknowledgeAlarmCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // BatchAcknowledgeAlarmResponse
43
+ * // errorEntries: [ // BatchAlarmActionErrorEntries
44
+ * // { // BatchAlarmActionErrorEntry
45
+ * // requestId: "STRING_VALUE",
46
+ * // errorCode: "STRING_VALUE",
47
+ * // errorMessage: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
42
52
  * ```
43
53
  *
44
54
  * @param BatchAcknowledgeAlarmCommandInput - {@link BatchAcknowledgeAlarmCommandInput}
@@ -59,6 +69,8 @@ export interface BatchAcknowledgeAlarmCommandOutput extends BatchAcknowledgeAlar
59
69
  * @throws {@link ThrottlingException} (client fault)
60
70
  * <p>The request could not be completed due to throttling.</p>
61
71
  *
72
+ * @throws {@link IoTEventsDataServiceException}
73
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
62
74
  *
63
75
  */
64
76
  export declare class BatchAcknowledgeAlarmCommand extends $Command<BatchAcknowledgeAlarmCommandInput, BatchAcknowledgeAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -37,6 +37,16 @@ export interface BatchDeleteDetectorCommandOutput extends BatchDeleteDetectorRes
37
37
  * };
38
38
  * const command = new BatchDeleteDetectorCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // BatchDeleteDetectorResponse
41
+ * // batchDeleteDetectorErrorEntries: [ // BatchDeleteDetectorErrorEntries
42
+ * // { // BatchDeleteDetectorErrorEntry
43
+ * // messageId: "STRING_VALUE",
44
+ * // errorCode: "STRING_VALUE",
45
+ * // errorMessage: "STRING_VALUE",
46
+ * // },
47
+ * // ],
48
+ * // };
49
+ *
40
50
  * ```
41
51
  *
42
52
  * @param BatchDeleteDetectorCommandInput - {@link BatchDeleteDetectorCommandInput}
@@ -57,6 +67,8 @@ export interface BatchDeleteDetectorCommandOutput extends BatchDeleteDetectorRes
57
67
  * @throws {@link ThrottlingException} (client fault)
58
68
  * <p>The request could not be completed due to throttling.</p>
59
69
  *
70
+ * @throws {@link IoTEventsDataServiceException}
71
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
60
72
  *
61
73
  */
62
74
  export declare class BatchDeleteDetectorCommand extends $Command<BatchDeleteDetectorCommandInput, BatchDeleteDetectorCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -39,6 +39,16 @@ export interface BatchDisableAlarmCommandOutput extends BatchDisableAlarmRespons
39
39
  * };
40
40
  * const command = new BatchDisableAlarmCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // BatchDisableAlarmResponse
43
+ * // errorEntries: [ // BatchAlarmActionErrorEntries
44
+ * // { // BatchAlarmActionErrorEntry
45
+ * // requestId: "STRING_VALUE",
46
+ * // errorCode: "STRING_VALUE",
47
+ * // errorMessage: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
42
52
  * ```
43
53
  *
44
54
  * @param BatchDisableAlarmCommandInput - {@link BatchDisableAlarmCommandInput}
@@ -59,6 +69,8 @@ export interface BatchDisableAlarmCommandOutput extends BatchDisableAlarmRespons
59
69
  * @throws {@link ThrottlingException} (client fault)
60
70
  * <p>The request could not be completed due to throttling.</p>
61
71
  *
72
+ * @throws {@link IoTEventsDataServiceException}
73
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
62
74
  *
63
75
  */
64
76
  export declare class BatchDisableAlarmCommand extends $Command<BatchDisableAlarmCommandInput, BatchDisableAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -39,6 +39,16 @@ export interface BatchEnableAlarmCommandOutput extends BatchEnableAlarmResponse,
39
39
  * };
40
40
  * const command = new BatchEnableAlarmCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // BatchEnableAlarmResponse
43
+ * // errorEntries: [ // BatchAlarmActionErrorEntries
44
+ * // { // BatchAlarmActionErrorEntry
45
+ * // requestId: "STRING_VALUE",
46
+ * // errorCode: "STRING_VALUE",
47
+ * // errorMessage: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
42
52
  * ```
43
53
  *
44
54
  * @param BatchEnableAlarmCommandInput - {@link BatchEnableAlarmCommandInput}
@@ -59,6 +69,8 @@ export interface BatchEnableAlarmCommandOutput extends BatchEnableAlarmResponse,
59
69
  * @throws {@link ThrottlingException} (client fault)
60
70
  * <p>The request could not be completed due to throttling.</p>
61
71
  *
72
+ * @throws {@link IoTEventsDataServiceException}
73
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
62
74
  *
63
75
  */
64
76
  export declare class BatchEnableAlarmCommand extends $Command<BatchEnableAlarmCommandInput, BatchEnableAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -44,6 +44,16 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _
44
44
  * };
45
45
  * const command = new BatchPutMessageCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // BatchPutMessageResponse
48
+ * // BatchPutMessageErrorEntries: [ // BatchPutMessageErrorEntries
49
+ * // { // BatchPutMessageErrorEntry
50
+ * // messageId: "STRING_VALUE",
51
+ * // errorCode: "STRING_VALUE",
52
+ * // errorMessage: "STRING_VALUE",
53
+ * // },
54
+ * // ],
55
+ * // };
56
+ *
47
57
  * ```
48
58
  *
49
59
  * @param BatchPutMessageCommandInput - {@link BatchPutMessageCommandInput}
@@ -64,6 +74,8 @@ export interface BatchPutMessageCommandOutput extends BatchPutMessageResponse, _
64
74
  * @throws {@link ThrottlingException} (client fault)
65
75
  * <p>The request could not be completed due to throttling.</p>
66
76
  *
77
+ * @throws {@link IoTEventsDataServiceException}
78
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
67
79
  *
68
80
  */
69
81
  export declare class BatchPutMessageCommand extends $Command<BatchPutMessageCommandInput, BatchPutMessageCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -39,6 +39,16 @@ export interface BatchResetAlarmCommandOutput extends BatchResetAlarmResponse, _
39
39
  * };
40
40
  * const command = new BatchResetAlarmCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // BatchResetAlarmResponse
43
+ * // errorEntries: [ // BatchAlarmActionErrorEntries
44
+ * // { // BatchAlarmActionErrorEntry
45
+ * // requestId: "STRING_VALUE",
46
+ * // errorCode: "STRING_VALUE",
47
+ * // errorMessage: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // };
51
+ *
42
52
  * ```
43
53
  *
44
54
  * @param BatchResetAlarmCommandInput - {@link BatchResetAlarmCommandInput}
@@ -59,6 +69,8 @@ export interface BatchResetAlarmCommandOutput extends BatchResetAlarmResponse, _
59
69
  * @throws {@link ThrottlingException} (client fault)
60
70
  * <p>The request could not be completed due to throttling.</p>
61
71
  *
72
+ * @throws {@link IoTEventsDataServiceException}
73
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
62
74
  *
63
75
  */
64
76
  export declare class BatchResetAlarmCommand extends $Command<BatchResetAlarmCommandInput, BatchResetAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -40,6 +40,16 @@ export interface BatchSnoozeAlarmCommandOutput extends BatchSnoozeAlarmResponse,
40
40
  * };
41
41
  * const command = new BatchSnoozeAlarmCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // BatchSnoozeAlarmResponse
44
+ * // errorEntries: [ // BatchAlarmActionErrorEntries
45
+ * // { // BatchAlarmActionErrorEntry
46
+ * // requestId: "STRING_VALUE",
47
+ * // errorCode: "STRING_VALUE",
48
+ * // errorMessage: "STRING_VALUE",
49
+ * // },
50
+ * // ],
51
+ * // };
52
+ *
43
53
  * ```
44
54
  *
45
55
  * @param BatchSnoozeAlarmCommandInput - {@link BatchSnoozeAlarmCommandInput}
@@ -60,6 +70,8 @@ export interface BatchSnoozeAlarmCommandOutput extends BatchSnoozeAlarmResponse,
60
70
  * @throws {@link ThrottlingException} (client fault)
61
71
  * <p>The request could not be completed due to throttling.</p>
62
72
  *
73
+ * @throws {@link IoTEventsDataServiceException}
74
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
63
75
  *
64
76
  */
65
77
  export declare class BatchSnoozeAlarmCommand extends $Command<BatchSnoozeAlarmCommandInput, BatchSnoozeAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -53,6 +53,16 @@ export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorRes
53
53
  * };
54
54
  * const command = new BatchUpdateDetectorCommand(input);
55
55
  * const response = await client.send(command);
56
+ * // { // BatchUpdateDetectorResponse
57
+ * // batchUpdateDetectorErrorEntries: [ // BatchUpdateDetectorErrorEntries
58
+ * // { // BatchUpdateDetectorErrorEntry
59
+ * // messageId: "STRING_VALUE",
60
+ * // errorCode: "STRING_VALUE",
61
+ * // errorMessage: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // };
65
+ *
56
66
  * ```
57
67
  *
58
68
  * @param BatchUpdateDetectorCommandInput - {@link BatchUpdateDetectorCommandInput}
@@ -73,6 +83,8 @@ export interface BatchUpdateDetectorCommandOutput extends BatchUpdateDetectorRes
73
83
  * @throws {@link ThrottlingException} (client fault)
74
84
  * <p>The request could not be completed due to throttling.</p>
75
85
  *
86
+ * @throws {@link IoTEventsDataServiceException}
87
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
76
88
  *
77
89
  */
78
90
  export declare class BatchUpdateDetectorCommand extends $Command<BatchUpdateDetectorCommandInput, BatchUpdateDetectorCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -32,6 +32,52 @@ export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __Met
32
32
  * };
33
33
  * const command = new DescribeAlarmCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeAlarmResponse
36
+ * // alarm: { // Alarm
37
+ * // alarmModelName: "STRING_VALUE",
38
+ * // alarmModelVersion: "STRING_VALUE",
39
+ * // keyValue: "STRING_VALUE",
40
+ * // alarmState: { // AlarmState
41
+ * // stateName: "STRING_VALUE",
42
+ * // ruleEvaluation: { // RuleEvaluation
43
+ * // simpleRuleEvaluation: { // SimpleRuleEvaluation
44
+ * // inputPropertyValue: "STRING_VALUE",
45
+ * // operator: "STRING_VALUE",
46
+ * // thresholdValue: "STRING_VALUE",
47
+ * // },
48
+ * // },
49
+ * // customerAction: { // CustomerAction
50
+ * // actionName: "STRING_VALUE",
51
+ * // snoozeActionConfiguration: { // SnoozeActionConfiguration
52
+ * // snoozeDuration: Number("int"),
53
+ * // note: "STRING_VALUE",
54
+ * // },
55
+ * // enableActionConfiguration: { // EnableActionConfiguration
56
+ * // note: "STRING_VALUE",
57
+ * // },
58
+ * // disableActionConfiguration: { // DisableActionConfiguration
59
+ * // note: "STRING_VALUE",
60
+ * // },
61
+ * // acknowledgeActionConfiguration: { // AcknowledgeActionConfiguration
62
+ * // note: "STRING_VALUE",
63
+ * // },
64
+ * // resetActionConfiguration: { // ResetActionConfiguration
65
+ * // note: "STRING_VALUE",
66
+ * // },
67
+ * // },
68
+ * // systemEvent: { // SystemEvent
69
+ * // eventType: "STRING_VALUE",
70
+ * // stateChangeConfiguration: { // StateChangeConfiguration
71
+ * // triggerType: "STRING_VALUE",
72
+ * // },
73
+ * // },
74
+ * // },
75
+ * // severity: Number("int"),
76
+ * // creationTime: new Date("TIMESTAMP"),
77
+ * // lastUpdateTime: new Date("TIMESTAMP"),
78
+ * // },
79
+ * // };
80
+ *
35
81
  * ```
36
82
  *
37
83
  * @param DescribeAlarmCommandInput - {@link DescribeAlarmCommandInput}
@@ -55,6 +101,8 @@ export interface DescribeAlarmCommandOutput extends DescribeAlarmResponse, __Met
55
101
  * @throws {@link ThrottlingException} (client fault)
56
102
  * <p>The request could not be completed due to throttling.</p>
57
103
  *
104
+ * @throws {@link IoTEventsDataServiceException}
105
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
58
106
  *
59
107
  */
60
108
  export declare class DescribeAlarmCommand extends $Command<DescribeAlarmCommandInput, DescribeAlarmCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -32,6 +32,31 @@ export interface DescribeDetectorCommandOutput extends DescribeDetectorResponse,
32
32
  * };
33
33
  * const command = new DescribeDetectorCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // DescribeDetectorResponse
36
+ * // detector: { // Detector
37
+ * // detectorModelName: "STRING_VALUE",
38
+ * // keyValue: "STRING_VALUE",
39
+ * // detectorModelVersion: "STRING_VALUE",
40
+ * // state: { // DetectorState
41
+ * // stateName: "STRING_VALUE", // required
42
+ * // variables: [ // Variables // required
43
+ * // { // Variable
44
+ * // name: "STRING_VALUE", // required
45
+ * // value: "STRING_VALUE", // required
46
+ * // },
47
+ * // ],
48
+ * // timers: [ // Timers // required
49
+ * // { // Timer
50
+ * // name: "STRING_VALUE", // required
51
+ * // timestamp: new Date("TIMESTAMP"), // required
52
+ * // },
53
+ * // ],
54
+ * // },
55
+ * // creationTime: new Date("TIMESTAMP"),
56
+ * // lastUpdateTime: new Date("TIMESTAMP"),
57
+ * // },
58
+ * // };
59
+ *
35
60
  * ```
36
61
  *
37
62
  * @param DescribeDetectorCommandInput - {@link DescribeDetectorCommandInput}
@@ -55,6 +80,8 @@ export interface DescribeDetectorCommandOutput extends DescribeDetectorResponse,
55
80
  * @throws {@link ThrottlingException} (client fault)
56
81
  * <p>The request could not be completed due to throttling.</p>
57
82
  *
83
+ * @throws {@link IoTEventsDataServiceException}
84
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
58
85
  *
59
86
  */
60
87
  export declare class DescribeDetectorCommand extends $Command<DescribeDetectorCommandInput, DescribeDetectorCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -34,6 +34,20 @@ export interface ListAlarmsCommandOutput extends ListAlarmsResponse, __MetadataB
34
34
  * };
35
35
  * const command = new ListAlarmsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListAlarmsResponse
38
+ * // alarmSummaries: [ // AlarmSummaries
39
+ * // { // AlarmSummary
40
+ * // alarmModelName: "STRING_VALUE",
41
+ * // alarmModelVersion: "STRING_VALUE",
42
+ * // keyValue: "STRING_VALUE",
43
+ * // stateName: "STRING_VALUE",
44
+ * // creationTime: new Date("TIMESTAMP"),
45
+ * // lastUpdateTime: new Date("TIMESTAMP"),
46
+ * // },
47
+ * // ],
48
+ * // nextToken: "STRING_VALUE",
49
+ * // };
50
+ *
37
51
  * ```
38
52
  *
39
53
  * @param ListAlarmsCommandInput - {@link ListAlarmsCommandInput}
@@ -57,6 +71,8 @@ export interface ListAlarmsCommandOutput extends ListAlarmsResponse, __MetadataB
57
71
  * @throws {@link ThrottlingException} (client fault)
58
72
  * <p>The request could not be completed due to throttling.</p>
59
73
  *
74
+ * @throws {@link IoTEventsDataServiceException}
75
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
60
76
  *
61
77
  */
62
78
  export declare class ListAlarmsCommand extends $Command<ListAlarmsCommandInput, ListAlarmsCommandOutput, IoTEventsDataClientResolvedConfig> {
@@ -34,6 +34,22 @@ export interface ListDetectorsCommandOutput extends ListDetectorsResponse, __Met
34
34
  * };
35
35
  * const command = new ListDetectorsCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ListDetectorsResponse
38
+ * // detectorSummaries: [ // DetectorSummaries
39
+ * // { // DetectorSummary
40
+ * // detectorModelName: "STRING_VALUE",
41
+ * // keyValue: "STRING_VALUE",
42
+ * // detectorModelVersion: "STRING_VALUE",
43
+ * // state: { // DetectorStateSummary
44
+ * // stateName: "STRING_VALUE",
45
+ * // },
46
+ * // creationTime: new Date("TIMESTAMP"),
47
+ * // lastUpdateTime: new Date("TIMESTAMP"),
48
+ * // },
49
+ * // ],
50
+ * // nextToken: "STRING_VALUE",
51
+ * // };
52
+ *
37
53
  * ```
38
54
  *
39
55
  * @param ListDetectorsCommandInput - {@link ListDetectorsCommandInput}
@@ -57,6 +73,8 @@ export interface ListDetectorsCommandOutput extends ListDetectorsResponse, __Met
57
73
  * @throws {@link ThrottlingException} (client fault)
58
74
  * <p>The request could not be completed due to throttling.</p>
59
75
  *
76
+ * @throws {@link IoTEventsDataServiceException}
77
+ * <p>Base exception class for all service exceptions from IoTEventsData service.</p>
60
78
  *
61
79
  */
62
80
  export declare class ListDetectorsCommand extends $Command<ListDetectorsCommandInput, ListDetectorsCommandOutput, IoTEventsDataClientResolvedConfig> {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-iot-events-data",
3
3
  "description": "AWS SDK for JavaScript Iot Events Data Client for Node.js, Browser and React Native",
4
- "version": "3.325.0",
4
+ "version": "3.326.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.325.0",
24
+ "@aws-sdk/client-sts": "3.326.0",
25
25
  "@aws-sdk/config-resolver": "3.310.0",
26
- "@aws-sdk/credential-provider-node": "3.325.0",
26
+ "@aws-sdk/credential-provider-node": "3.326.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.310.0",
28
28
  "@aws-sdk/hash-node": "3.310.0",
29
29
  "@aws-sdk/invalid-dependency": "3.310.0",