@aws-sdk/client-iot-events-data 3.296.0 → 3.297.0

package/dist-types/models/models_0.d.ts

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { IoTEventsDataServiceException as __BaseException } from "./IoTEventsDataServiceException";
 /**
+ * @public
  * <p>Contains the configuration information of an acknowledge action.</p>
  */
 export interface AcknowledgeActionConfiguration {
@@ -10,6 +11,7 @@ export interface AcknowledgeActionConfiguration {
     note?: string;
 }
 /**
+ * @public
  * <p>Information needed to acknowledge the alarm.</p>
  */
 export interface AcknowledgeAlarmActionRequest {
@@ -31,6 +33,9 @@ export interface AcknowledgeAlarmActionRequest {
      */
     note?: string;
 }
+/**
+ * @public
+ */
 export declare enum CustomerActionName {
     ACKNOWLEDGE = "ACKNOWLEDGE",
     DISABLE = "DISABLE",
@@ -39,6 +44,7 @@ export declare enum CustomerActionName {
     SNOOZE = "SNOOZE"
 }
 /**
+ * @public
  * <p>Contains the configuration information of a disable action.</p>
  */
 export interface DisableActionConfiguration {
@@ -48,6 +54,7 @@ export interface DisableActionConfiguration {
     note?: string;
 }
 /**
+ * @public
  * <p>Contains the configuration information of an enable action.</p>
  */
 export interface EnableActionConfiguration {
@@ -57,6 +64,7 @@ export interface EnableActionConfiguration {
     note?: string;
 }
 /**
+ * @public
  * <p>Contains the configuration information of a reset action.</p>
  */
 export interface ResetActionConfiguration {
@@ -66,6 +74,7 @@ export interface ResetActionConfiguration {
     note?: string;
 }
 /**
+ * @public
  * <p>Contains the configuration information of a snooze action.</p>
  */
 export interface SnoozeActionConfiguration {
@@ -79,6 +88,7 @@ export interface SnoozeActionConfiguration {
     note?: string;
 }
 /**
+ * @public
  * <p>Contains information about the action that you can take to respond to the alarm.</p>
  */
 export interface CustomerAction {
@@ -130,6 +140,9 @@ export interface CustomerAction {
      */
     resetActionConfiguration?: ResetActionConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum ComparisonOperator {
     EQUAL = "EQUAL",
     GREATER = "GREATER",
@@ -139,6 +152,7 @@ export declare enum ComparisonOperator {
     NOT_EQUAL = "NOT_EQUAL"
 }
 /**
+ * @public
  * <p>Information needed to compare two values with a comparison operator.</p>
  */
 export interface SimpleRuleEvaluation {
@@ -156,6 +170,7 @@ export interface SimpleRuleEvaluation {
     thresholdValue?: string;
 }
 /**
+ * @public
  * <p>Information needed to evaluate data.</p>
  */
 export interface RuleEvaluation {
@@ -164,6 +179,9 @@ export interface RuleEvaluation {
      */
     simpleRuleEvaluation?: SimpleRuleEvaluation;
 }
+/**
+ * @public
+ */
 export declare enum AlarmStateName {
     ACKNOWLEDGED = "ACKNOWLEDGED",
     ACTIVE = "ACTIVE",
@@ -172,13 +190,20 @@ export declare enum AlarmStateName {
     NORMAL = "NORMAL",
     SNOOZE_DISABLED = "SNOOZE_DISABLED"
 }
+/**
+ * @public
+ */
 export declare enum EventType {
     STATE_CHANGE = "STATE_CHANGE"
 }
+/**
+ * @public
+ */
 export declare enum TriggerType {
     SNOOZE_TIMEOUT = "SNOOZE_TIMEOUT"
 }
 /**
+ * @public
  * <p>Contains the configuration information of alarm state changes.</p>
  */
 export interface StateChangeConfiguration {
@@ -189,6 +214,7 @@ export interface StateChangeConfiguration {
     triggerType?: TriggerType | string;
 }
 /**
+ * @public
  * <p>Contains information about alarm state changes.</p>
  */
 export interface SystemEvent {
@@ -203,6 +229,7 @@ export interface SystemEvent {
     stateChangeConfiguration?: StateChangeConfiguration;
 }
 /**
+ * @public
  * <p>Contains information about the current state of the alarm.</p>
  */
 export interface AlarmState {
@@ -259,6 +286,7 @@ export interface AlarmState {
     systemEvent?: SystemEvent;
 }
 /**
+ * @public
  * <p>Contains information about an alarm.</p>
  */
 export interface Alarm {
@@ -293,6 +321,7 @@ export interface Alarm {
     lastUpdateTime?: Date;
 }
 /**
+ * @public
  * <p>Contains a summary of an alarm.</p>
  */
 export interface AlarmSummary {
@@ -357,12 +386,18 @@ export interface AlarmSummary {
      */
     lastUpdateTime?: Date;
 }
+/**
+ * @public
+ */
 export interface BatchAcknowledgeAlarmRequest {
     /**
      * <p>The list of acknowledge action requests. You can specify up to 10 requests per operation.</p>
      */
     acknowledgeActionRequests: AcknowledgeAlarmActionRequest[] | undefined;
 }
+/**
+ * @public
+ */
 export declare enum ErrorCode {
     InternalFailureException = "InternalFailureException",
     InvalidRequestException = "InvalidRequestException",
@@ -371,6 +406,7 @@ export declare enum ErrorCode {
     ThrottlingException = "ThrottlingException"
 }
 /**
+ * @public
  * <p>Contains error messages associated with one of the following requests:</p>
  *          <ul>
  *             <li>
@@ -414,6 +450,9 @@ export interface BatchAlarmActionErrorEntry {
      */
     errorMessage?: string;
 }
+/**
+ * @public
+ */
 export interface BatchAcknowledgeAlarmResponse {
     /**
      * <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
@@ -422,6 +461,7 @@ export interface BatchAcknowledgeAlarmResponse {
     errorEntries?: BatchAlarmActionErrorEntry[];
 }
 /**
+ * @public
  * <p>An internal failure occurred.</p>
  */
 export declare class InternalFailureException extends __BaseException {
@@ -433,6 +473,7 @@ export declare class InternalFailureException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request was invalid.</p>
  */
 export declare class InvalidRequestException extends __BaseException {
@@ -444,6 +485,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is currently unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -455,6 +497,7 @@ export declare class ServiceUnavailableException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
 }
 /**
+ * @public
  * <p>The request could not be completed due to throttling.</p>
  */
 export declare class ThrottlingException extends __BaseException {
@@ -466,6 +509,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>Information used to delete the detector model.</p>
  */
 export interface DeleteDetectorRequest {
@@ -482,6 +526,9 @@ export interface DeleteDetectorRequest {
      */
     keyValue?: string;
 }
+/**
+ * @public
+ */
 export interface BatchDeleteDetectorRequest {
     /**
      * <p>The list of one or more detectors to be deleted.</p>
@@ -489,6 +536,7 @@ export interface BatchDeleteDetectorRequest {
     detectors: DeleteDetectorRequest[] | undefined;
 }
 /**
+ * @public
  * <p>Contains error messages associated with the deletion request.</p>
  */
 export interface BatchDeleteDetectorErrorEntry {
@@ -505,6 +553,9 @@ export interface BatchDeleteDetectorErrorEntry {
      */
     errorMessage?: string;
 }
+/**
+ * @public
+ */
 export interface BatchDeleteDetectorResponse {
     /**
      * <p>A list of errors associated with the request, or an empty array (<code>[]</code>) if there are no errors. Each error entry contains a <code>messageId</code> that helps you identify the entry that failed.</p>
@@ -512,6 +563,7 @@ export interface BatchDeleteDetectorResponse {
     batchDeleteDetectorErrorEntries?: BatchDeleteDetectorErrorEntry[];
 }
 /**
+ * @public
  * <p>Information used to disable the alarm.</p>
  */
 export interface DisableAlarmActionRequest {
@@ -533,12 +585,18 @@ export interface DisableAlarmActionRequest {
      */
     note?: string;
 }
+/**
+ * @public
+ */
 export interface BatchDisableAlarmRequest {
     /**
      * <p>The list of disable action requests. You can specify up to 10 requests per operation.</p>
      */
     disableActionRequests: DisableAlarmActionRequest[] | undefined;
 }
+/**
+ * @public
+ */
 export interface BatchDisableAlarmResponse {
     /**
      * <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
@@ -547,6 +605,7 @@ export interface BatchDisableAlarmResponse {
     errorEntries?: BatchAlarmActionErrorEntry[];
 }
 /**
+ * @public
  * <p>Information needed to enable the alarm.</p>
  */
 export interface EnableAlarmActionRequest {
@@ -568,12 +627,18 @@ export interface EnableAlarmActionRequest {
      */
     note?: string;
 }
+/**
+ * @public
+ */
 export interface BatchEnableAlarmRequest {
     /**
      * <p>The list of enable action requests. You can specify up to 10 requests per operation.</p>
      */
     enableActionRequests: EnableAlarmActionRequest[] | undefined;
 }
+/**
+ * @public
+ */
 export interface BatchEnableAlarmResponse {
     /**
      * <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
@@ -582,6 +647,7 @@ export interface BatchEnableAlarmResponse {
     errorEntries?: BatchAlarmActionErrorEntry[];
 }
 /**
+ * @public
  * <p>Contains information about a timestamp.</p>
  */
 export interface TimestampValue {
@@ -591,6 +657,7 @@ export interface TimestampValue {
     timeInMillis?: number;
 }
 /**
+ * @public
  * <p>Information about a message.</p>
  */
 export interface Message {
@@ -613,15 +680,19 @@ export interface Message {
      */
     timestamp?: TimestampValue;
 }
+/**
+ * @public
+ */
 export interface BatchPutMessageRequest {
     /**
-     * <p>The list of messages to send. Each message has the following format: <code>'{ "messageId":
-     *         "string", "inputName": "string", "payload": "string"}'</code>
+     * <p>The list of messages to send. Each message has the following format: <code>'\{ "messageId":
+     *         "string", "inputName": "string", "payload": "string"\}'</code>
      *          </p>
      */
     messages: Message[] | undefined;
 }
 /**
+ * @public
  * <p>Contains information about the errors encountered.</p>
  */
 export interface BatchPutMessageErrorEntry {
@@ -639,6 +710,9 @@ export interface BatchPutMessageErrorEntry {
      */
     errorMessage?: string;
 }
+/**
+ * @public
+ */
 export interface BatchPutMessageResponse {
     /**
      * <p>A list of any errors encountered when sending the messages.</p>
@@ -646,6 +720,7 @@ export interface BatchPutMessageResponse {
     BatchPutMessageErrorEntries?: BatchPutMessageErrorEntry[];
 }
 /**
+ * @public
  * <p>Information needed to reset the alarm.</p>
  */
 export interface ResetAlarmActionRequest {
@@ -667,12 +742,18 @@ export interface ResetAlarmActionRequest {
      */
     note?: string;
 }
+/**
+ * @public
+ */
 export interface BatchResetAlarmRequest {
     /**
      * <p>The list of reset action requests. You can specify up to 10 requests per operation.</p>
      */
     resetActionRequests: ResetAlarmActionRequest[] | undefined;
 }
+/**
+ * @public
+ */
 export interface BatchResetAlarmResponse {
     /**
      * <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
@@ -681,6 +762,7 @@ export interface BatchResetAlarmResponse {
     errorEntries?: BatchAlarmActionErrorEntry[];
 }
 /**
+ * @public
  * <p>Information needed to snooze the alarm.</p>
  */
 export interface SnoozeAlarmActionRequest {
@@ -706,12 +788,18 @@ export interface SnoozeAlarmActionRequest {
      */
     snoozeDuration: number | undefined;
 }
+/**
+ * @public
+ */
 export interface BatchSnoozeAlarmRequest {
     /**
      * <p>The list of snooze action requests. You can specify up to 10 requests per operation.</p>
      */
     snoozeActionRequests: SnoozeAlarmActionRequest[] | undefined;
 }
+/**
+ * @public
+ */
 export interface BatchSnoozeAlarmResponse {
     /**
      * <p>A list of errors associated with the request, or <code>null</code> if there are no errors.
@@ -720,6 +808,7 @@ export interface BatchSnoozeAlarmResponse {
     errorEntries?: BatchAlarmActionErrorEntry[];
 }
 /**
+ * @public
  * <p>The new setting of a timer.</p>
  */
 export interface TimerDefinition {
@@ -733,6 +822,7 @@ export interface TimerDefinition {
     seconds: number | undefined;
 }
 /**
+ * @public
  * <p>The new value of the variable.</p>
  */
 export interface VariableDefinition {
@@ -746,6 +836,7 @@ export interface VariableDefinition {
     value: string | undefined;
 }
 /**
+ * @public
  * <p>The new state, variable values, and timer settings of the detector (instance).</p>
  */
 export interface DetectorStateDefinition {
@@ -765,6 +856,7 @@ export interface DetectorStateDefinition {
     timers: TimerDefinition[] | undefined;
 }
 /**
+ * @public
  * <p>Information used to update the detector (instance).</p>
  */
 export interface UpdateDetectorRequest {
@@ -787,6 +879,9 @@ export interface UpdateDetectorRequest {
      */
     state: DetectorStateDefinition | undefined;
 }
+/**
+ * @public
+ */
 export interface BatchUpdateDetectorRequest {
     /**
      * <p>The list of detectors (instances) to update, along with the values to update.</p>
@@ -794,6 +889,7 @@ export interface BatchUpdateDetectorRequest {
     detectors: UpdateDetectorRequest[] | undefined;
 }
 /**
+ * @public
  * <p>Information about the error that occurred when attempting to update a detector.</p>
  */
 export interface BatchUpdateDetectorErrorEntry {
@@ -811,6 +907,9 @@ export interface BatchUpdateDetectorErrorEntry {
      */
     errorMessage?: string;
 }
+/**
+ * @public
+ */
 export interface BatchUpdateDetectorResponse {
     /**
      * <p>A list of those detector updates that resulted in errors. (If an error is listed here, the
@@ -818,6 +917,9 @@ export interface BatchUpdateDetectorResponse {
      */
     batchUpdateDetectorErrorEntries?: BatchUpdateDetectorErrorEntry[];
 }
+/**
+ * @public
+ */
 export interface DescribeAlarmRequest {
     /**
      * <p>The name of the alarm model.</p>
@@ -829,6 +931,9 @@ export interface DescribeAlarmRequest {
      */
     keyValue?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeAlarmResponse {
     /**
      * <p>Contains information about an alarm.</p>
@@ -836,6 +941,7 @@ export interface DescribeAlarmResponse {
     alarm?: Alarm;
 }
 /**
+ * @public
  * <p>The resource was not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -846,6 +952,9 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeDetectorRequest {
     /**
      * <p>The name of the detector model whose detectors (instances) you want information
@@ -859,6 +968,7 @@ export interface DescribeDetectorRequest {
     keyValue?: string;
 }
 /**
+ * @public
  * <p>The current state of a timer.</p>
  */
 export interface Timer {
@@ -872,6 +982,7 @@ export interface Timer {
     timestamp: Date | undefined;
 }
 /**
+ * @public
  * <p>The current state of the variable.</p>
  */
 export interface Variable {
@@ -885,6 +996,7 @@ export interface Variable {
     value: string | undefined;
 }
 /**
+ * @public
  * <p>Information about the current state of the detector instance.</p>
  */
 export interface DetectorState {
@@ -902,6 +1014,7 @@ export interface DetectorState {
     timers: Timer[] | undefined;
 }
 /**
+ * @public
  * <p>Information about the detector (instance).</p>
  */
 export interface Detector {
@@ -931,6 +1044,9 @@ export interface Detector {
      */
     lastUpdateTime?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeDetectorResponse {
     /**
      * <p>Information about the detector (instance).</p>
@@ -938,6 +1054,7 @@ export interface DescribeDetectorResponse {
     detector?: Detector;
 }
 /**
+ * @public
  * <p>Information about the detector state.</p>
  */
 export interface DetectorStateSummary {
@@ -947,6 +1064,7 @@ export interface DetectorStateSummary {
     stateName?: string;
 }
 /**
+ * @public
  * <p>Information about the detector (instance).</p>
  */
 export interface DetectorSummary {
@@ -976,6 +1094,9 @@ export interface DetectorSummary {
      */
     lastUpdateTime?: Date;
 }
+/**
+ * @public
+ */
 export interface ListAlarmsRequest {
     /**
      * <p>The name of the alarm model.</p>
@@ -990,6 +1111,9 @@ export interface ListAlarmsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAlarmsResponse {
     /**
      * <p>A list that summarizes each alarm.</p>
@@ -1001,6 +1125,9 @@ export interface ListAlarmsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListDetectorsRequest {
     /**
      * <p>The name of the detector model whose detectors (instances) are listed.</p>
@@ -1019,6 +1146,9 @@ export interface ListDetectorsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListDetectorsResponse {
     /**
      * <p>A list of summary information about the detectors (instances).</p>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-iot-events-data",
   "description": "AWS SDK for JavaScript Iot Events Data Client for Node.js, Browser and React Native",
-  "version": "3.296.0",
+  "version": "3.297.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.297.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.297.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",