@aws-sdk/client-iot-events 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 { IoTEventsServiceException as __BaseException } from "./IoTEventsServiceException";
 /**
+ * @public
  * <p>Specifies whether to get notified for alarm state changes.</p>
  */
 export interface AcknowledgeFlow {
@@ -14,6 +15,7 @@ export interface AcknowledgeFlow {
     enabled: boolean | undefined;
 }
 /**
+ * @public
  * <p>Information needed to clear the timer.</p>
  */
 export interface ClearTimerAction {
@@ -22,11 +24,15 @@ export interface ClearTimerAction {
      */
     timerName: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum PayloadType {
     JSON = "JSON",
     STRING = "STRING"
 }
 /**
+ * @public
  * <p>Information needed to configure the payload.</p>
  *          <p>By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload
  *       contains all attribute-value pairs that have the information about the detector model instance
@@ -38,7 +44,7 @@ export interface Payload {
      * <p>The content of the payload. You can use a string expression that includes quoted strings
      *         (<code>'<string>'</code>), variables (<code>$variable.<variable-name></code>),
      *       input values (<code>$input.<input-name>.<path-to-datum></code>), string
-     *       concatenations, and quoted strings that contain <code>${}</code> as the content. The
+     *       concatenations, and quoted strings that contain <code>$\{\}</code> as the content. The
      *       recommended maximum size of a content expression is 1 KB.</p>
      */
     contentExpression: string | undefined;
@@ -49,6 +55,7 @@ export interface Payload {
     type: PayloadType | string | undefined;
 }
 /**
+ * @public
  * <p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action
  *       payload contains all the information about the detector model instance and the event that
  *       triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. One column of the
@@ -69,13 +76,13 @@ export interface Payload {
  *             <code>$input.GreenhouseInput.name</code>.</p>
  *             </li>
  *             <li>
- *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+ *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
  *           in single quotes. A substitution template can also contain a combination of literals,
  *           operators, functions, references, and substitution templates.</p>
  *                <p>In the following example, the value for the <code>hashKeyValue</code> parameter uses a
  *           substitution template. </p>
  *                <p>
- *                   <code>'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'</code>
+ *                   <code>'$\{$input.GreenhouseInput.temperature * 6 / 5 + 32\} in Fahrenheit'</code>
  *                </p>
  *             </li>
  *             <li>
@@ -197,6 +204,7 @@ export interface DynamoDBAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>Defines an action to write to the Amazon DynamoDB table that you created. The default action
  *       payload contains all the information about the detector model instance and the event that
  *       triggered the action. You can customize the <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html">payload</a>. A separate column of
@@ -218,14 +226,14 @@ export interface DynamoDBAction {
  *           <code>$variable.ddbtableName</code>.</p>
  *             </li>
  *             <li>
- *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+ *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
  *           in single quotes. A substitution template can also contain a combination of literals,
  *           operators, functions, references, and substitution templates.</p>
  *                <p>In the following example, the value for the <code>contentExpression</code> parameter
  *           in <code>Payload</code> uses a substitution template. </p>
  *                <p>
- *                   <code>'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\":
- *             \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'</code>
+ *                   <code>'\{\"sensorID\": \"$\{$input.GreenhouseInput.sensor_id\}\", \"temperature\":
+ *             \"$\{$input.GreenhouseInput.temperature * 9 / 5 + 32\}\"\}'</code>
  *                </p>
  *             </li>
  *             <li>
@@ -260,6 +268,7 @@ export interface DynamoDBv2Action {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>Sends information about the detector model instance and the event that triggered the
  *       action to an Amazon Kinesis Data Firehose delivery stream.</p>
  */
@@ -281,6 +290,7 @@ export interface FirehoseAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>Sends an AWS IoT Events input, passing in information about the detector model instance and the
  *       event that triggered the action.</p>
  */
@@ -295,6 +305,7 @@ export interface IotEventsAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>A structure that contains timestamp information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
  *          <p>You must use expressions for all parameters in <code>AssetPropertyTimestamp</code>. The
  *       expressions accept literals, operators, functions, references, and substitution
@@ -313,13 +324,13 @@ export interface IotEventsAction {
  *           <code>$variable.time</code>.</p>
  *             </li>
  *             <li>
- *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+ *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
  *           in single quotes. A substitution template can also contain a combination of literals,
  *           operators, functions, references, and substitution templates.</p>
  *                <p>In the following example, the value for the <code>timeInSeconds</code> parameter uses
  *           a substitution template.</p>
  *                <p>
- *                   <code>'${$input.TemperatureInput.sensorData.timestamp / 1000}'</code>
+ *                   <code>'$\{$input.TemperatureInput.sensorData.timestamp / 1000\}'</code>
  *                </p>
  *             </li>
  *          </ul>
@@ -340,6 +351,7 @@ export interface AssetPropertyTimestamp {
     offsetInNanos?: string;
 }
 /**
+ * @public
  * <p>A structure that contains an asset property value. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html">Variant</a>
  *       in the <i>AWS IoT SiteWise API Reference</i>.</p>
  *          <p>You must use expressions for all parameters in <code>AssetPropertyVariant</code>. The
@@ -359,13 +371,13 @@ export interface AssetPropertyTimestamp {
  *           <code>$variable.offline</code>.</p>
  *             </li>
  *             <li>
- *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+ *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
  *           in single quotes. A substitution template can also contain a combination of literals,
  *           operators, functions, references, and substitution templates. </p>
  *                <p>In the following example, the value for the <code>doubleValue</code> parameter uses a
  *           substitution template. </p>
  *                <p>
- *                   <code>'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'</code>
+ *                   <code>'$\{$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32\}'</code>
  *                </p>
  *             </li>
  *          </ul>
@@ -400,6 +412,7 @@ export interface AssetPropertyVariant {
     booleanValue?: string;
 }
 /**
+ * @public
  * <p>A structure that contains value information. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>
  *          <p>You must use expressions for all parameters in <code>AssetPropertyValue</code>. The
  *       expressions accept literals, operators, functions, references, and substitution
@@ -439,6 +452,7 @@ export interface AssetPropertyValue {
     quality?: string;
 }
 /**
+ * @public
  * <p>Sends information about the detector model instance and the event that triggered the
  *       action to a specified asset property in AWS IoT SiteWise.</p>
  *          <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The
@@ -459,14 +473,14 @@ export interface AssetPropertyValue {
  *             <code>$input.TurbineInput.assetId1</code>.</p>
  *             </li>
  *             <li>
- *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+ *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
  *           in single quotes. A substitution template can also contain a combination of literals,
  *           operators, functions, references, and substitution templates.</p>
  *                <p>In the following example, the value for the <code>propertyAlias</code> parameter uses
  *           a substitution template. </p>
  *                <p>
- *                   <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/
- *             ${$input.TemperatureInput.sensorData.turbineID}/temperature'</code>
+ *                   <code>'company/windfarm/$\{$input.TemperatureInput.sensorData.windfarmID\}/turbine/
+ *             $\{$input.TemperatureInput.sensorData.turbineID\}/temperature'</code>
  *                </p>
  *             </li>
  *          </ul>
@@ -501,6 +515,7 @@ export interface IotSiteWiseAction {
     propertyValue?: AssetPropertyValue;
 }
 /**
+ * @public
  * <p>Information required to publish the MQTT message through the AWS IoT message broker.</p>
  */
 export interface IotTopicPublishAction {
@@ -517,6 +532,7 @@ export interface IotTopicPublishAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>Calls a Lambda function, passing in information about the detector model instance and the
  *       event that triggered the action.</p>
  */
@@ -531,6 +547,7 @@ export interface LambdaAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>Information required to reset the timer. The timer is reset to the previously evaluated
  *       result of the duration. The duration expression isn't reevaluated when you reset the
  *       timer.</p>
@@ -542,6 +559,7 @@ export interface ResetTimerAction {
     timerName: string | undefined;
 }
 /**
+ * @public
  * <p>Information needed to set the timer.</p>
  */
 export interface SetTimerAction {
@@ -566,6 +584,7 @@ export interface SetTimerAction {
     durationExpression?: string;
 }
 /**
+ * @public
  * <p>Information about the variable and its new value.</p>
  */
 export interface SetVariableAction {
@@ -579,6 +598,7 @@ export interface SetVariableAction {
     value: string | undefined;
 }
 /**
+ * @public
  * <p>Information required to publish the Amazon SNS message.</p>
  */
 export interface SNSTopicPublishAction {
@@ -593,6 +613,7 @@ export interface SNSTopicPublishAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>Sends information about the detector model instance and the event that triggered the
  *       action to an Amazon SQS queue.</p>
  */
@@ -613,6 +634,7 @@ export interface SqsAction {
     payload?: Payload;
 }
 /**
+ * @public
  * <p>An action to be performed when the <code>condition</code> is TRUE.</p>
  */
 export interface Action {
@@ -685,6 +707,7 @@ export interface Action {
     iotSiteWise?: IotSiteWiseAction;
 }
 /**
+ * @public
  * <p>Specifies one of the following actions to receive notifications when the alarm state
  *       changes.</p>
  */
@@ -738,13 +761,13 @@ export interface AlarmAction {
      *             <code>$input.GreenhouseInput.name</code>.</p>
      *             </li>
      *             <li>
-     *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+     *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
      *           in single quotes. A substitution template can also contain a combination of literals,
      *           operators, functions, references, and substitution templates.</p>
      *                <p>In the following example, the value for the <code>hashKeyValue</code> parameter uses a
      *           substitution template. </p>
      *                <p>
-     *                   <code>'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'</code>
+     *                   <code>'$\{$input.GreenhouseInput.temperature * 6 / 5 + 32\} in Fahrenheit'</code>
      *                </p>
      *             </li>
      *             <li>
@@ -789,14 +812,14 @@ export interface AlarmAction {
      *           <code>$variable.ddbtableName</code>.</p>
      *             </li>
      *             <li>
-     *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+     *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
      *           in single quotes. A substitution template can also contain a combination of literals,
      *           operators, functions, references, and substitution templates.</p>
      *                <p>In the following example, the value for the <code>contentExpression</code> parameter
      *           in <code>Payload</code> uses a substitution template. </p>
      *                <p>
-     *                   <code>'{\"sensorID\": \"${$input.GreenhouseInput.sensor_id}\", \"temperature\":
-     *             \"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\"}'</code>
+     *                   <code>'\{\"sensorID\": \"$\{$input.GreenhouseInput.sensor_id\}\", \"temperature\":
+     *             \"$\{$input.GreenhouseInput.temperature * 9 / 5 + 32\}\"\}'</code>
      *                </p>
      *             </li>
      *             <li>
@@ -838,14 +861,14 @@ export interface AlarmAction {
      *             <code>$input.TurbineInput.assetId1</code>.</p>
      *             </li>
      *             <li>
-     *                <p>For a substitution template, you must use <code>${}</code>, and the template must be
+     *                <p>For a substitution template, you must use <code>$\{\}</code>, and the template must be
      *           in single quotes. A substitution template can also contain a combination of literals,
      *           operators, functions, references, and substitution templates.</p>
      *                <p>In the following example, the value for the <code>propertyAlias</code> parameter uses
      *           a substitution template. </p>
      *                <p>
-     *                   <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/
-     *             ${$input.TemperatureInput.sensorData.turbineID}/temperature'</code>
+     *                   <code>'company/windfarm/$\{$input.TemperatureInput.sensorData.windfarmID\}/turbine/
+     *             $\{$input.TemperatureInput.sensorData.turbineID\}/temperature'</code>
      *                </p>
      *             </li>
      *          </ul>
@@ -858,6 +881,7 @@ export interface AlarmAction {
     iotSiteWise?: IotSiteWiseAction;
 }
 /**
+ * @public
  * <p>Specifies the default alarm state.
  * The configuration applies to all alarms that were created based on this alarm model.</p>
  */
@@ -870,6 +894,7 @@ export interface InitializationConfiguration {
     disabledOnInitialization: boolean | undefined;
 }
 /**
+ * @public
  * <p>Contains the configuration information of alarm state changes.</p>
  */
 export interface AlarmCapabilities {
@@ -884,6 +909,7 @@ export interface AlarmCapabilities {
     acknowledgeFlow?: AcknowledgeFlow;
 }
 /**
+ * @public
  * <p>Contains information about one or more alarm actions.</p>
  */
 export interface AlarmEventActions {
@@ -894,6 +920,7 @@ export interface AlarmEventActions {
     alarmActions?: AlarmAction[];
 }
 /**
+ * @public
  * <p>Contains a summary of an alarm model.</p>
  */
 export interface AlarmModelSummary {
@@ -910,6 +937,9 @@ export interface AlarmModelSummary {
      */
     alarmModelName?: string;
 }
+/**
+ * @public
+ */
 export declare enum AlarmModelVersionStatus {
     ACTIVATING = "ACTIVATING",
     ACTIVE = "ACTIVE",
@@ -917,6 +947,7 @@ export declare enum AlarmModelVersionStatus {
     INACTIVE = "INACTIVE"
 }
 /**
+ * @public
  * <p>Contains a summary of an alarm model version.</p>
  */
 export interface AlarmModelVersionSummary {
@@ -977,6 +1008,7 @@ export interface AlarmModelVersionSummary {
     statusMessage?: string;
 }
 /**
+ * @public
  * <p>Specifies an AWS Lambda function to manage alarm notifications.
  * You can create one or use the <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html">AWS Lambda function provided by AWS IoT Events</a>.</p>
  */
@@ -988,6 +1020,7 @@ export interface NotificationTargetActions {
     lambdaAction?: LambdaAction;
 }
 /**
+ * @public
  * <p>Contains the subject and message of an email.</p>
  */
 export interface EmailContent {
@@ -1001,6 +1034,7 @@ export interface EmailContent {
     additionalMessage?: string;
 }
 /**
+ * @public
  * <p>Contains information about your identity source in AWS Single Sign-On. For more information, see
  *       the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">AWS Single Sign-On
  *         User Guide</a>.</p>
@@ -1016,6 +1050,7 @@ export interface SSOIdentity {
     userId?: string;
 }
 /**
+ * @public
  * <p>The information that identifies the recipient.</p>
  */
 export interface RecipientDetail {
@@ -1025,6 +1060,7 @@ export interface RecipientDetail {
     ssoIdentity?: SSOIdentity;
 }
 /**
+ * @public
  * <p>Contains the information of one or more recipients who receive the emails.</p>
  *          <important>
  *             <p>You must <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/addusers.html">add the users that receive emails to your AWS SSO store</a>.</p>
@@ -1037,6 +1073,7 @@ export interface EmailRecipients {
     to?: RecipientDetail[];
 }
 /**
+ * @public
  * <p>Contains the configuration information of email notifications.</p>
  */
 export interface EmailConfiguration {
@@ -1061,6 +1098,7 @@ export interface EmailConfiguration {
     recipients: EmailRecipients | undefined;
 }
 /**
+ * @public
  * <p>Contains the configuration information of SMS notifications.</p>
  */
 export interface SMSConfiguration {
@@ -1081,6 +1119,7 @@ export interface SMSConfiguration {
     recipients: RecipientDetail[] | undefined;
 }
 /**
+ * @public
  * <p>Contains the notification settings of an alarm model.
  * The settings apply to all alarms that were created based on this alarm model.</p>
  */
@@ -1100,6 +1139,7 @@ export interface NotificationAction {
     emailConfigurations?: EmailConfiguration[];
 }
 /**
+ * @public
  * <p>Contains information about one or more notification actions.</p>
  */
 export interface AlarmNotification {
@@ -1109,6 +1149,9 @@ export interface AlarmNotification {
      */
     notificationActions?: NotificationAction[];
 }
+/**
+ * @public
+ */
 export declare enum ComparisonOperator {
     EQUAL = "EQUAL",
     GREATER = "GREATER",
@@ -1118,6 +1161,7 @@ export declare enum ComparisonOperator {
     NOT_EQUAL = "NOT_EQUAL"
 }
 /**
+ * @public
  * <p>A rule that compares an input property value to a threshold value with a comparison operator.</p>
  */
 export interface SimpleRule {
@@ -1137,6 +1181,7 @@ export interface SimpleRule {
     threshold: string | undefined;
 }
 /**
+ * @public
  * <p>Defines when your alarm is invoked.</p>
  */
 export interface AlarmRule {
@@ -1145,12 +1190,16 @@ export interface AlarmRule {
      */
     simpleRule?: SimpleRule;
 }
+/**
+ * @public
+ */
 export declare enum AnalysisResultLevel {
     ERROR = "ERROR",
     INFO = "INFO",
     WARNING = "WARNING"
 }
 /**
+ * @public
  * <p>Contains information that you can use to locate the field in your detector model that the
  *       analysis result references.</p>
  */
@@ -1162,6 +1211,7 @@ export interface AnalysisResultLocation {
     path?: string;
 }
 /**
+ * @public
  * <p>Contains the result of the analysis.</p>
  */
 export interface AnalysisResult {
@@ -1244,12 +1294,16 @@ export interface AnalysisResult {
      */
     locations?: AnalysisResultLocation[];
 }
+/**
+ * @public
+ */
 export declare enum AnalysisStatus {
     COMPLETE = "COMPLETE",
     FAILED = "FAILED",
     RUNNING = "RUNNING"
 }
 /**
+ * @public
  * <p>The attributes from the JSON payload that are made available by the input. Inputs are
  *       derived from messages sent to the AWS IoT Events system using <code>BatchPutMessage</code>. Each such
  *       message contains a JSON payload. Those attributes (and their paired values) specified here are
@@ -1268,6 +1322,7 @@ export interface Attribute {
     jsonPath: string | undefined;
 }
 /**
+ * @public
  * <p>Metadata that can be used to manage the resource.</p>
  */
 export interface Tag {
@@ -1280,6 +1335,9 @@ export interface Tag {
      */
     value: string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateAlarmModelRequest {
     /**
      * <p>A unique name that helps you identify the alarm model. You can't change this name after
@@ -1328,6 +1386,9 @@ export interface CreateAlarmModelRequest {
      */
     alarmCapabilities?: AlarmCapabilities;
 }
+/**
+ * @public
+ */
 export interface CreateAlarmModelResponse {
     /**
      * <p>The time the alarm model was created, in the Unix epoch format.</p>
@@ -1372,6 +1433,7 @@ export interface CreateAlarmModelResponse {
     status?: AlarmModelVersionStatus | string;
 }
 /**
+ * @public
  * <p>An internal failure occurred.</p>
  */
 export declare class InternalFailureException extends __BaseException {
@@ -1383,6 +1445,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 {
@@ -1394,6 +1457,7 @@ export declare class InvalidRequestException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
 }
 /**
+ * @public
  * <p>A limit was exceeded.</p>
  */
 export declare class LimitExceededException extends __BaseException {
@@ -1405,6 +1469,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>The resource already exists.</p>
  */
 export declare class ResourceAlreadyExistsException extends __BaseException {
@@ -1424,6 +1489,7 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceAlreadyExistsException, __BaseException>);
 }
 /**
+ * @public
  * <p>The resource is in use.</p>
  */
 export declare class ResourceInUseException extends __BaseException {
@@ -1435,6 +1501,7 @@ export declare class ResourceInUseException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
 }
 /**
+ * @public
  * <p>The service is currently unavailable.</p>
  */
 export declare class ServiceUnavailableException extends __BaseException {
@@ -1446,6 +1513,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 {
@@ -1457,6 +1525,7 @@ export declare class ThrottlingException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
 }
 /**
+ * @public
  * <p>Specifies the <code>actions</code> to be performed when the <code>condition</code>
  *       evaluates to TRUE.</p>
  */
@@ -1477,6 +1546,7 @@ export interface Event {
     actions?: Action[];
 }
 /**
+ * @public
  * <p>When entering this state, perform these <code>actions</code> if the <code>condition</code>
  *       is TRUE.</p>
  */
@@ -1488,6 +1558,7 @@ export interface OnEnterLifecycle {
     events?: Event[];
 }
 /**
+ * @public
  * <p>When exiting this state, perform these <code>actions</code> if the specified
  *         <code>condition</code> is <code>TRUE</code>.</p>
  */
@@ -1499,6 +1570,7 @@ export interface OnExitLifecycle {
     events?: Event[];
 }
 /**
+ * @public
  * <p>Specifies the actions performed and the next state entered when a <code>condition</code>
  *       evaluates to TRUE.</p>
  */
@@ -1522,6 +1594,7 @@ export interface TransitionEvent {
     nextState: string | undefined;
 }
 /**
+ * @public
  * <p>Specifies the actions performed when the <code>condition</code> evaluates to TRUE.</p>
  */
 export interface OnInputLifecycle {
@@ -1536,6 +1609,7 @@ export interface OnInputLifecycle {
     transitionEvents?: TransitionEvent[];
 }
 /**
+ * @public
  * <p>Information that defines a state of a detector.</p>
  */
 export interface State {
@@ -1560,6 +1634,7 @@ export interface State {
     onExit?: OnExitLifecycle;
 }
 /**
+ * @public
  * <p>Information that defines how a detector operates.</p>
  */
 export interface DetectorModelDefinition {
@@ -1572,10 +1647,16 @@ export interface DetectorModelDefinition {
      */
     initialStateName: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum EvaluationMethod {
     BATCH = "BATCH",
     SERIAL = "SERIAL"
 }
+/**
+ * @public
+ */
 export interface CreateDetectorModelRequest {
     /**
      * <p>The name of the detector model.</p>
@@ -1611,6 +1692,9 @@ export interface CreateDetectorModelRequest {
      */
     evaluationMethod?: EvaluationMethod | string;
 }
+/**
+ * @public
+ */
 export declare enum DetectorModelVersionStatus {
     ACTIVATING = "ACTIVATING",
     ACTIVE = "ACTIVE",
@@ -1621,6 +1705,7 @@ export declare enum DetectorModelVersionStatus {
     PAUSED = "PAUSED"
 }
 /**
+ * @public
  * <p>Information about how the detector model is configured.</p>
  */
 export interface DetectorModelConfiguration {
@@ -1672,6 +1757,9 @@ export interface DetectorModelConfiguration {
      */
     evaluationMethod?: EvaluationMethod | string;
 }
+/**
+ * @public
+ */
 export interface CreateDetectorModelResponse {
     /**
      * <p>Information about how the detector model is configured.</p>
@@ -1679,6 +1767,7 @@ export interface CreateDetectorModelResponse {
     detectorModelConfiguration?: DetectorModelConfiguration;
 }
 /**
+ * @public
  * <p>The definition of the input.</p>
  */
 export interface InputDefinition {
@@ -1691,6 +1780,9 @@ export interface InputDefinition {
      */
     attributes: Attribute[] | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateInputRequest {
     /**
      * <p>The name you want to give to the input.</p>
@@ -1709,6 +1801,9 @@ export interface CreateInputRequest {
      */
     tags?: Tag[];
 }
+/**
+ * @public
+ */
 export declare enum InputStatus {
     ACTIVE = "ACTIVE",
     CREATING = "CREATING",
@@ -1716,6 +1811,7 @@ export declare enum InputStatus {
     UPDATING = "UPDATING"
 }
 /**
+ * @public
  * <p>Information about the configuration of an input.</p>
  */
 export interface InputConfiguration {
@@ -1744,21 +1840,31 @@ export interface InputConfiguration {
      */
     status: InputStatus | string | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateInputResponse {
     /**
      * <p>Information about the configuration of the input.</p>
      */
     inputConfiguration?: InputConfiguration;
 }
+/**
+ * @public
+ */
 export interface DeleteAlarmModelRequest {
     /**
      * <p>The name of the alarm model.</p>
      */
     alarmModelName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteAlarmModelResponse {
 }
 /**
+ * @public
  * <p>The resource was not found.</p>
  */
 export declare class ResourceNotFoundException extends __BaseException {
@@ -1769,22 +1875,37 @@ export declare class ResourceNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteDetectorModelRequest {
     /**
      * <p>The name of the detector model to be deleted.</p>
      */
     detectorModelName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteDetectorModelResponse {
 }
+/**
+ * @public
+ */
 export interface DeleteInputRequest {
     /**
      * <p>The name of the input to delete.</p>
      */
     inputName: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteInputResponse {
 }
+/**
+ * @public
+ */
 export interface DescribeAlarmModelRequest {
     /**
      * <p>The name of the alarm model.</p>
@@ -1795,6 +1916,9 @@ export interface DescribeAlarmModelRequest {
      */
     alarmModelVersion?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeAlarmModelResponse {
     /**
      * <p>The time the alarm model was created, in the Unix epoch format.</p>
@@ -1882,6 +2006,9 @@ export interface DescribeAlarmModelResponse {
      */
     alarmCapabilities?: AlarmCapabilities;
 }
+/**
+ * @public
+ */
 export interface DescribeDetectorModelRequest {
     /**
      * <p>The name of the detector model.</p>
@@ -1893,6 +2020,7 @@ export interface DescribeDetectorModelRequest {
     detectorModelVersion?: string;
 }
 /**
+ * @public
  * <p>Information about the detector model.</p>
  */
 export interface DetectorModel {
@@ -1905,18 +2033,27 @@ export interface DetectorModel {
      */
     detectorModelConfiguration?: DetectorModelConfiguration;
 }
+/**
+ * @public
+ */
 export interface DescribeDetectorModelResponse {
     /**
      * <p>Information about the detector model.</p>
      */
     detectorModel?: DetectorModel;
 }
+/**
+ * @public
+ */
 export interface DescribeDetectorModelAnalysisRequest {
     /**
      * <p>The ID of the analysis result that you want to retrieve.</p>
      */
     analysisId: string | undefined;
 }
+/**
+ * @public
+ */
 export interface DescribeDetectorModelAnalysisResponse {
     /**
      * <p>The status of the analysis activity. The status can be one of the following values:</p>
@@ -1939,6 +2076,9 @@ export interface DescribeDetectorModelAnalysisResponse {
      */
     status?: AnalysisStatus | string;
 }
+/**
+ * @public
+ */
 export interface DescribeInputRequest {
     /**
      * <p>The name of the input.</p>
@@ -1946,6 +2086,7 @@ export interface DescribeInputRequest {
     inputName: string | undefined;
 }
 /**
+ * @public
  * <p>Information about the input.</p>
  */
 export interface Input {
@@ -1958,15 +2099,22 @@ export interface Input {
      */
     inputDefinition?: InputDefinition;
 }
+/**
+ * @public
+ */
 export interface DescribeInputResponse {
     /**
      * <p>Information about the input.</p>
      */
     input?: Input;
 }
+/**
+ * @public
+ */
 export interface DescribeLoggingOptionsRequest {
 }
 /**
+ * @public
  * <p>The detector model and the specific detectors (instances) for which the logging level is
  *       given.</p>
  */
@@ -1981,12 +2129,16 @@ export interface DetectorDebugOption {
      */
     keyValue?: string;
 }
+/**
+ * @public
+ */
 export declare enum LoggingLevel {
     DEBUG = "DEBUG",
     ERROR = "ERROR",
     INFO = "INFO"
 }
 /**
+ * @public
  * <p>The values of the AWS IoT Events logging options.</p>
  */
 export interface LoggingOptions {
@@ -2008,6 +2160,9 @@ export interface LoggingOptions {
      */
     detectorDebugOptions?: DetectorDebugOption[];
 }
+/**
+ * @public
+ */
 export interface DescribeLoggingOptionsResponse {
     /**
      * <p>The current settings of the AWS IoT Events logging options.</p>
@@ -2015,6 +2170,7 @@ export interface DescribeLoggingOptionsResponse {
     loggingOptions?: LoggingOptions;
 }
 /**
+ * @public
  * <p>The requested operation is not supported.</p>
  */
 export declare class UnsupportedOperationException extends __BaseException {
@@ -2026,6 +2182,7 @@ export declare class UnsupportedOperationException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedOperationException, __BaseException>);
 }
 /**
+ * @public
  * <p>Information about the detector model.</p>
  */
 export interface DetectorModelSummary {
@@ -2043,6 +2200,7 @@ export interface DetectorModelSummary {
     creationTime?: Date;
 }
 /**
+ * @public
  * <p>Information about the detector model version.</p>
  */
 export interface DetectorModelVersionSummary {
@@ -2080,6 +2238,9 @@ export interface DetectorModelVersionSummary {
      */
     evaluationMethod?: EvaluationMethod | string;
 }
+/**
+ * @public
+ */
 export interface GetDetectorModelAnalysisResultsRequest {
     /**
      * <p>The ID of the analysis result that you want to retrieve.</p>
@@ -2094,6 +2255,9 @@ export interface GetDetectorModelAnalysisResultsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface GetDetectorModelAnalysisResultsResponse {
     /**
      * <p>Contains information about one or more analysis results.</p>
@@ -2106,6 +2270,7 @@ export interface GetDetectorModelAnalysisResultsResponse {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>
  *       The identifier of the input routed to AWS IoT Events.
  *     </p>
@@ -2119,6 +2284,7 @@ export interface IotEventsInputIdentifier {
     inputName: string | undefined;
 }
 /**
+ * @public
  * <p>
  *       The asset model property identifer of the input routed from AWS IoT SiteWise.
  *     </p>
@@ -2138,6 +2304,7 @@ export interface IotSiteWiseAssetModelPropertyIdentifier {
     propertyId: string | undefined;
 }
 /**
+ * @public
  * <p>
  *       The identifer of the input routed from AWS IoT SiteWise.
  *     </p>
@@ -2151,6 +2318,7 @@ export interface IotSiteWiseInputIdentifier {
     iotSiteWiseAssetModelPropertyIdentifier?: IotSiteWiseAssetModelPropertyIdentifier;
 }
 /**
+ * @public
  * <p>
  *       The identifer of the input.
  *     </p>
@@ -2170,6 +2338,7 @@ export interface InputIdentifier {
     iotSiteWiseInputIdentifier?: IotSiteWiseInputIdentifier;
 }
 /**
+ * @public
  * <p>Information about the input.</p>
  */
 export interface InputSummary {
@@ -2198,6 +2367,9 @@ export interface InputSummary {
      */
     status?: InputStatus | string;
 }
+/**
+ * @public
+ */
 export interface ListAlarmModelsRequest {
     /**
      * <p>The token that you can use to return the next set of results.</p>
@@ -2208,6 +2380,9 @@ export interface ListAlarmModelsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAlarmModelsResponse {
     /**
      * <p>A list that summarizes each alarm model.</p>
@@ -2219,6 +2394,9 @@ export interface ListAlarmModelsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListAlarmModelVersionsRequest {
     /**
      * <p>The name of the alarm model.</p>
@@ -2233,6 +2411,9 @@ export interface ListAlarmModelVersionsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListAlarmModelVersionsResponse {
     /**
      * <p>A list that summarizes each alarm model version.</p>
@@ -2244,6 +2425,9 @@ export interface ListAlarmModelVersionsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListDetectorModelsRequest {
     /**
      * <p>The token that you can use to return the next set of results.</p>
@@ -2254,6 +2438,9 @@ export interface ListDetectorModelsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListDetectorModelsResponse {
     /**
      * <p>Summary information about the detector models.</p>
@@ -2265,6 +2452,9 @@ export interface ListDetectorModelsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListDetectorModelVersionsRequest {
     /**
      * <p>The name of the detector model whose versions are returned.</p>
@@ -2279,6 +2469,9 @@ export interface ListDetectorModelVersionsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListDetectorModelVersionsResponse {
     /**
      * <p>Summary information about the detector model versions.</p>
@@ -2290,6 +2483,9 @@ export interface ListDetectorModelVersionsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListInputRoutingsRequest {
     /**
      * <p>
@@ -2311,6 +2507,7 @@ export interface ListInputRoutingsRequest {
     nextToken?: string;
 }
 /**
+ * @public
  * <p>
  *       Contains information about the routed resource.
  *     </p>
@@ -2329,6 +2526,9 @@ export interface RoutedResource {
      */
     arn?: string;
 }
+/**
+ * @public
+ */
 export interface ListInputRoutingsResponse {
     /**
      * <p>
@@ -2344,6 +2544,9 @@ export interface ListInputRoutingsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListInputsRequest {
     /**
      * <p>The token that you can use to return the next set of results.</p>
@@ -2354,6 +2557,9 @@ export interface ListInputsRequest {
      */
     maxResults?: number;
 }
+/**
+ * @public
+ */
 export interface ListInputsResponse {
     /**
      * <p>Summary information about the inputs.</p>
@@ -2365,36 +2571,54 @@ export interface ListInputsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceRequest {
     /**
      * <p>The ARN of the resource.</p>
      */
     resourceArn: string | undefined;
 }
+/**
+ * @public
+ */
 export interface ListTagsForResourceResponse {
     /**
      * <p>The list of tags assigned to the resource.</p>
      */
     tags?: Tag[];
 }
+/**
+ * @public
+ */
 export interface PutLoggingOptionsRequest {
     /**
      * <p>The new values of the AWS IoT Events logging options.</p>
      */
     loggingOptions: LoggingOptions | undefined;
 }
+/**
+ * @public
+ */
 export interface StartDetectorModelAnalysisRequest {
     /**
      * <p>Information that defines how a detector operates.</p>
      */
     detectorModelDefinition: DetectorModelDefinition | undefined;
 }
+/**
+ * @public
+ */
 export interface StartDetectorModelAnalysisResponse {
     /**
      * <p>The ID that you can use to retrieve the analysis result.</p>
      */
     analysisId?: string;
 }
+/**
+ * @public
+ */
 export interface TagResourceRequest {
     /**
      * <p>The ARN of the resource.</p>
@@ -2405,8 +2629,14 @@ export interface TagResourceRequest {
      */
     tags: Tag[] | undefined;
 }
+/**
+ * @public
+ */
 export interface TagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UntagResourceRequest {
     /**
      * <p>The ARN of the resource.</p>
@@ -2417,8 +2647,14 @@ export interface UntagResourceRequest {
      */
     tagKeys: string[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UntagResourceResponse {
 }
+/**
+ * @public
+ */
 export interface UpdateAlarmModelRequest {
     /**
      * <p>The name of the alarm model.</p>
@@ -2453,6 +2689,9 @@ export interface UpdateAlarmModelRequest {
      */
     alarmCapabilities?: AlarmCapabilities;
 }
+/**
+ * @public
+ */
 export interface UpdateAlarmModelResponse {
     /**
      * <p>The time the alarm model was created, in the Unix epoch format.</p>
@@ -2496,6 +2735,9 @@ export interface UpdateAlarmModelResponse {
      */
     status?: AlarmModelVersionStatus | string;
 }
+/**
+ * @public
+ */
 export interface UpdateDetectorModelRequest {
     /**
      * <p>The name of the detector model that is updated.</p>
@@ -2519,12 +2761,18 @@ export interface UpdateDetectorModelRequest {
      */
     evaluationMethod?: EvaluationMethod | string;
 }
+/**
+ * @public
+ */
 export interface UpdateDetectorModelResponse {
     /**
      * <p>Information about how the detector model is configured.</p>
      */
     detectorModelConfiguration?: DetectorModelConfiguration;
 }
+/**
+ * @public
+ */
 export interface UpdateInputRequest {
     /**
      * <p>The name of the input you want to update.</p>
@@ -2539,6 +2787,9 @@ export interface UpdateInputRequest {
      */
     inputDefinition: InputDefinition | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateInputResponse {
     /**
      * <p>Information about the configuration of the input.</p>