@aws-sdk/client-iot

import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; import { IoTServiceException as __BaseException } from "./IoTServiceException"; /** * @public * @enum */ export declare const AbortAction: { readonly CANCEL: "CANCEL"; }; /** * @public */ export type AbortAction = (typeof AbortAction)[keyof typeof AbortAction]; /** * @public * @enum */ export declare const JobExecutionFailureType: { readonly ALL: "ALL"; readonly FAILED: "FAILED"; readonly REJECTED: "REJECTED"; readonly TIMED_OUT: "TIMED_OUT"; }; /** * @public */ export type JobExecutionFailureType = (typeof JobExecutionFailureType)[keyof typeof JobExecutionFailureType]; /** * The criteria that determine when and how a job abort takes place. * @public */ export interface AbortCriteria { /** * The type of job execution failures that can initiate a job abort. * @public */ failureType: JobExecutionFailureType | undefined; /** * The type of job action to take to initiate the job abort. * @public */ action: AbortAction | undefined; /** * The minimum percentage of job execution failures that must occur to initiate the job abort. * Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999). * @public */ thresholdPercentage: number | undefined; /** * The minimum number of things which must receive job execution notifications before the job * can be aborted. * @public */ minNumberOfExecutedThings: number | undefined; } /** * The criteria that determine when and how a job abort takes place. * @public */ export interface AbortConfig { /** * The list of criteria that determine when and how to abort the job. * @public */ criteriaList: AbortCriteria[] | undefined; } /** * The input for the AcceptCertificateTransfer operation. * @public */ export interface AcceptCertificateTransferRequest { /** * The ID of the certificate. (The last part of the certificate ARN contains the * certificate ID.) * @public */ certificateId: string | undefined; /** * Specifies whether the certificate is active. * @public */ setAsActive?: boolean; } /** * An unexpected error has occurred. * @public */ export declare class InternalFailureException extends __BaseException { readonly name: "InternalFailureException"; readonly $fault: "server"; /** * @internal */ constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>); } /** * The request is not valid. * @public */ export declare class InvalidRequestException extends __BaseException { readonly name: "InvalidRequestException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>); } /** * The specified resource does not exist. * @public */ export declare class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>); } /** * The service is temporarily unavailable. * @public */ export declare class ServiceUnavailableException extends __BaseException { readonly name: "ServiceUnavailableException"; readonly $fault: "server"; /** * @internal */ constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>); } /** * The rate exceeds the limit. * @public */ export declare class ThrottlingException extends __BaseException { readonly name: "ThrottlingException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>); } /** * You can't revert the certificate transfer because the transfer is already * complete. * @public */ export declare class TransferAlreadyCompletedException extends __BaseException { readonly name: "TransferAlreadyCompletedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<TransferAlreadyCompletedException, __BaseException>); } /** * You are not authorized to perform this operation. * @public */ export declare class UnauthorizedException extends __BaseException { readonly name: "UnauthorizedException"; readonly $fault: "client"; /** * @internal */ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>); } /** * Describes an action that updates a CloudWatch alarm. * @public */ export interface CloudwatchAlarmAction { /** * The IAM role that allows access to the CloudWatch alarm. * @public */ roleArn: string | undefined; /** * The CloudWatch alarm name. * @public */ alarmName: string | undefined; /** * The reason for the alarm change. * @public */ stateReason: string | undefined; /** * The value of the alarm state. Acceptable values are: OK, ALARM, * INSUFFICIENT_DATA. * @public */ stateValue: string | undefined; } /** * Describes an action that sends data to CloudWatch Logs. * @public */ export interface CloudwatchLogsAction { /** * The IAM role that allows access to the CloudWatch log. * @public */ roleArn: string | undefined; /** * The CloudWatch log group to which the action sends data. * @public */ logGroupName: string | undefined; /** * Indicates whether batches of log records will be extracted and uploaded into CloudWatch. Values include <code>true</code> or <code>false</code> * (default). * @public */ batchMode?: boolean; } /** * Describes an action that captures a CloudWatch metric. * @public */ export interface CloudwatchMetricAction { /** * The IAM role that allows access to the CloudWatch metric. * @public */ roleArn: string | undefined; /** * The CloudWatch metric namespace name. * @public */ metricNamespace: string | undefined; /** * The CloudWatch metric name. * @public */ metricName: string | undefined; /** * The CloudWatch metric value. * @public */ metricValue: string | undefined; /** * The <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit">metric * unit</a> supported by CloudWatch. * @public */ metricUnit: string | undefined; /** * An optional <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp">Unix timestamp</a>. * @public */ metricTimestamp?: string; } /** * @public * @enum */ export declare const DynamoKeyType: { readonly NUMBER: "NUMBER"; readonly STRING: "STRING"; }; /** * @public */ export type DynamoKeyType = (typeof DynamoKeyType)[keyof typeof DynamoKeyType]; /** * Describes an action to write to a DynamoDB table. * The <code>tableName</code>, <code>hashKeyField</code>, and <code>rangeKeyField</code> * values must match the values used when you created the table. * The <code>hashKeyValue</code> and <code>rangeKeyvalue</code> fields use a * substitution template syntax. These templates provide data at runtime. The syntax is as * follows: $\{sql-expression\}. * You can specify any valid expression in a WHERE or SELECT clause, including JSON * properties, comparisons, calculations, and functions. For example, the following field uses * the third level of the topic: * * <code>"hashKeyValue": "$\{topic(3)\}"</code> * * The following field uses the timestamp: * * <code>"rangeKeyValue": "$\{timestamp()\}"</code> * * @public */ export interface DynamoDBAction { /** * The name of the DynamoDB table. * @public */ tableName: string | undefined; /** * The ARN of the IAM role that grants access to the DynamoDB table. * @public */ roleArn: string | undefined; /** * The type of operation to be performed. This follows the substitution template, so it * can be <code>$\{operation\}</code>, but the substitution must result in one of the following: * <code>INSERT</code>, <code>UPDATE</code>, or <code>DELETE</code>. * @public */ operation?: string; /** * The hash key name. * @public */ hashKeyField: string | undefined; /** * The hash key value. * @public */ hashKeyValue: string | undefined; /** * The hash key type. Valid values are "STRING" or "NUMBER" * @public */ hashKeyType?: DynamoKeyType; /** * The range key name. * @public */ rangeKeyField?: string; /** * The range key value. * @public */ rangeKeyValue?: string; /** * The range key type. Valid values are "STRING" or "NUMBER" * @public */ rangeKeyType?: DynamoKeyType; /** * The action payload. This name can be customized. * @public */ payloadField?: string; } /** * The input for the DynamoActionVS action that specifies the DynamoDB table to which * the message data will be written. * @public */ export interface PutItemInput { /** * The table where the message data will be written. * @public */ tableName: string | undefined; } /** * Describes an action to write to a DynamoDB table. * This DynamoDB action writes each attribute in the message payload into it's own * column in the DynamoDB table. * @public */ export interface DynamoDBv2Action { /** * The ARN of the IAM role that grants access to the DynamoDB table. * @public */ roleArn: string | undefined; /** * Specifies the DynamoDB table to which the message data will be written. For * example: * * <code>\{ "dynamoDBv2": \{ "roleArn": "aws:iam:12341251:my-role" "putItem": \{ "tableName": * "my-table" \} \} \}</code> * * Each attribute in the message payload will be written to a separate column in the * DynamoDB database. * @public */ putItem: PutItemInput | undefined; } /** * Describes an action that writes data to an Amazon OpenSearch Service * domain. * <note> * The <code>Elasticsearch</code> action can only be used by existing rule actions. To create a * new rule action or to update an existing rule action, use the * <code>OpenSearch</code> rule action instead. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html">OpenSearchAction</a>. * </note> * @public */ export interface ElasticsearchAction { /** * The IAM role ARN that has access to OpenSearch. * @public */ roleArn: string | undefined; /** * The endpoint of your OpenSearch domain. * @public */ endpoint: string | undefined; /** * The index where you want to store your data. * @public */ index: string | undefined; /** * The type of document you are storing. * @public */ type: string | undefined; /** * The unique identifier for the document you are storing. * @public */ id: string | undefined; } /** * Describes an action that writes data to an Amazon Kinesis Firehose stream. * @public */ export interface FirehoseAction { /** * The IAM role that grants access to the Amazon Kinesis Firehose stream. * @public */ roleArn: string | undefined; /** * The delivery stream name. * @public */ deliveryStreamName: string | undefined; /** * A character separator that will be used to separate records written to the Firehose * stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' * (comma). * @public */ separator?: string; /** * Whether to deliver the Kinesis Data Firehose stream as a batch by using <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html"> * <code>PutRecordBatch</code> * </a>. The default value is * <code>false</code>. * When <code>batchMode</code> is <code>true</code> and the rule's SQL statement * evaluates to an Array, each Array element forms one record in the <a href="https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html"> * <code>PutRecordBatch</code> * </a> request. The resulting array can't have more * than 500 records. * @public */ batchMode?: boolean; } /** * For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4 signing process</a>. * @public */ export interface SigV4Authorization { /** * The signing region. * @public */ signingRegion: string | undefined; /** * The service name to use while signing with Sig V4. * @public */ serviceName: string | undefined; /** * The ARN of the signing role. * @public */ roleArn: string | undefined; } /** * The authorization method used to send messages. * @public */ export interface HttpAuthorization { /** * Use Sig V4 authorization. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature * Version 4 Signing Process</a>. * @public */ sigv4?: SigV4Authorization; } /** * The HTTP action header. * @public */ export interface HttpActionHeader { /** * The HTTP header key. * @public */ key: string | undefined; /** * The HTTP header value. Substitution templates are supported. * @public */ value: string | undefined; } /** * Send data to an HTTPS endpoint. * @public */ export interface HttpAction { /** * The endpoint URL. If substitution templates are used in the URL, you must also specify a * <code>confirmationUrl</code>. If this is a new destination, a new * <code>TopicRuleDestination</code> is created if possible. * @public */ url: string | undefined; /** * The URL to which IoT sends a confirmation message. The value of the confirmation URL * must be a prefix of the endpoint URL. If you do not specify a confirmation URL IoT uses * the endpoint URL as the confirmation URL. If you use substitution templates in the * confirmationUrl, you must create and enable topic rule destinations that match each * possible value of the substitution template before traffic is allowed to your endpoint * URL. * @public */ confirmationUrl?: string; /** * The HTTP headers to send with the message data. * @public */ headers?: HttpActionHeader[]; /** * The authentication method to use when sending data to an HTTPS endpoint. * @public */ auth?: HttpAuthorization; } /** * Sends message data to an IoT Analytics channel. * @public */ export interface IotAnalyticsAction { /** * (deprecated) The ARN of the IoT Analytics channel to which message data will be * sent. * @public */ channelArn?: string; /** * The name of the IoT Analytics channel to which message data will be sent. * @public */ channelName?: string; /** * Whether to process the action as a batch. The default value is * <code>false</code>. * When <code>batchMode</code> is <code>true</code> and the rule SQL statement evaluates * to an Array, each Array element is delivered as a separate message when passed by <a href="https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html"> * <code>BatchPutMessage</code> * </a> to the IoT Analytics channel. The resulting array can't have more * than 100 messages. * @public */ batchMode?: boolean; /** * The ARN of the role which has a policy that grants IoT Analytics permission to send * message data via IoT Analytics (iotanalytics:BatchPutMessage). * @public */ roleArn?: string; } /** * Sends an input to an IoT Events detector. * @public */ export interface IotEventsAction { /** * The name of the IoT Events input. * @public */ inputName: string | undefined; /** * The ID of the message. The default <code>messageId</code> is a new UUID value. * When <code>batchMode</code> is <code>true</code>, you can't specify a * <code>messageId</code>--a new UUID value will be assigned. * Assign a value to this property to ensure that only one input (message) with a given * <code>messageId</code> will be processed by an IoT Events detector. * @public */ messageId?: string; /** * Whether to process the event actions as a batch. The default value is * <code>false</code>. * When <code>batchMode</code> is <code>true</code>, you can't specify a * <code>messageId</code>. * When <code>batchMode</code> is <code>true</code> and the rule SQL statement evaluates * to an Array, each Array element is treated as a separate message when it's sent to IoT * Events by calling <a href="https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html"> * <code>BatchPutMessage</code> * </a>. The resulting array can't have more * than 10 messages. * @public */ batchMode?: boolean; /** * The ARN of the role that grants IoT permission to send an input to an IoT * Events detector. ("Action":"iotevents:BatchPutMessage"). * @public */ roleArn: string | undefined; } /** * An asset property timestamp entry containing the following information. * @public */ export interface AssetPropertyTimestamp { /** * A string that contains the time in seconds since epoch. Accepts substitution * templates. * @public */ timeInSeconds: string | undefined; /** * Optional. A string that contains the nanosecond time offset. Accepts substitution * templates. * @public */ offsetInNanos?: string; } /** * Contains an asset property value (of a single type). * @public */ export type AssetPropertyVariant = AssetPropertyVariant.BooleanValueMember | AssetPropertyVariant.DoubleValueMember | AssetPropertyVariant.IntegerValueMember | AssetPropertyVariant.StringValueMember | AssetPropertyVariant.$UnknownMember; /** * @public */ export declare namespace AssetPropertyVariant { /** * Optional. The string value of the value entry. Accepts substitution templates. * @public */ interface StringValueMember { stringValue: string; integerValue?: never; doubleValue?: never; booleanValue?: never; $unknown?: never; } /** * Optional. A string that contains the integer value of the value entry. Accepts * substitution templates. * @public */ interface IntegerValueMember { stringValue?: never; integerValue: string; doubleValue?: never; booleanValue?: never; $unknown?: never; } /** * Optional. A string that contains the double value of the value entry. Accepts substitution * templates. * @public */ interface DoubleValueMember { stringValue?: never; integerValue?: never; doubleValue: string; booleanValue?: never; $unknown?: never; } /** * Optional. A string that contains the boolean value (<code>true</code> or * <code>false</code>) of the value entry. Accepts substitution templates. * @public */ interface BooleanValueMember { stringValue?: never; integerValue?: never; doubleValue?: never; booleanValue: string; $unknown?: never; } /** * @public */ interface $UnknownMember { stringValue?: never; integerValue?: never; doubleValue?: never; booleanValue?: never; $unknown: [string, any]; } interface Visitor<T> { stringValue: (value: string) => T; integerValue: (value: string) => T; doubleValue: (value: string) => T; booleanValue: (value: string) => T; _: (name: string, value: any) => T; } const visit: <T>(value: AssetPropertyVariant, visitor: Visitor<T>) => T; } /** * An asset property value entry containing the following information. * @public */ export interface AssetPropertyValue { /** * The value of the asset property. * @public */ value: AssetPropertyVariant | undefined; /** * The asset property value timestamp. * @public */ timestamp: AssetPropertyTimestamp | undefined; /** * Optional. A string that describes the quality of the value. Accepts substitution * templates. Must be <code>GOOD</code>, <code>BAD</code>, or <code>UNCERTAIN</code>. * @public */ quality?: string; } /** * An asset property value entry containing the following information. * @public */ export interface PutAssetPropertyValueEntry { /** * Optional. A unique identifier for this entry that you can define to better track which * message caused an error in case of failure. Accepts substitution templates. Defaults to a new * UUID. * @public */ entryId?: string; /** * The ID of the IoT SiteWise asset. You must specify either a <code>propertyAlias</code> * or both an <code>aliasId</code> and a <code>propertyId</code>. Accepts substitution * templates. * @public */ assetId?: string; /** * The ID of the asset's property. You must specify either a <code>propertyAlias</code> or * both an <code>aliasId</code> and a <code>propertyId</code>. Accepts substitution * templates. * @public */ propertyId?: string; /** * The name of the property alias associated with your asset property. You must specify * either a <code>propertyAlias</code> or both an <code>aliasId</code> and a * <code>propertyId</code>. Accepts substitution templates. * @public */ propertyAlias?: string; /** * A list of property values to insert that each contain timestamp, quality, and value (TQV) * information. * @public */ propertyValues: AssetPropertyValue[] | undefined; } /** * Describes an action to send data from an MQTT message that triggered the rule to IoT * SiteWise asset properties. * @public */ export interface IotSiteWiseAction { /** * A list of asset property value entries. * @public */ putAssetPropertyValueEntries: PutAssetPropertyValueEntry[] | undefined; /** * The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. (<code>"Action": "iotsitewise:BatchPutAssetPropertyValue"</code>). The trust * policy can restrict access to specific asset hierarchy paths. * @public */ roleArn: string | undefined; } /** * Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action. * You can use these headers to route data from IoT clients to downstream Kafka clusters * without modifying your message payload. * For more information about Rule's Kafka action, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/apache-kafka-rule-action.html">Apache Kafka</a>. * * @public */ export interface KafkaActionHeader { /** * The key of the Kafka header. * @public */ key: string | undefined; /** * The value of the Kafka header. * @public */ value: string | undefined; } /** * Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster. * @public */ export interface KafkaAction { /** * The ARN of Kafka action's VPC <code>TopicRuleDestination</code>. * @public */ destinationArn: string | undefined; /** * The Kafka topic for messages to be sent to the Kafka broker. * @public */ topic: string | undefined; /** * The Kafka message key. * @public */ key?: string; /** * The Kafka message partition. * @public */ partition?: string; /** * Properties of the Apache Kafka producer client. * @public */ clientProperties: Record<string, string> | undefined; /** * The list of Kafka headers that you specify. * @public */ headers?: KafkaActionHeader[]; } /** * Describes an action to write data to an Amazon Kinesis stream. * @public */ export interface KinesisAction { /** * The ARN of the IAM role that grants access to the Amazon Kinesis stream. * @public */ roleArn: string | undefined; /** * The name of the Amazon Kinesis stream. * @public */ streamName: string | undefined; /** * The partition key. * @public */ partitionKey?: string; } /** * Describes an action to invoke a Lambda function. * @public */ export interface LambdaAction { /** * The ARN of the Lambda function. * @public */ functionArn: string | undefined; } /** * Describes how to interpret an application-defined timestamp value from an MQTT message * payload and the precision of that value. * @public */ export interface LocationTimestamp { /** * An expression that returns a long epoch time value. * @public */ value: string | undefined; /** * The precision of the timestamp value that results from the expression * described in <code>value</code>. * Valid values: <code>SECONDS</code> | <code>MILLISECONDS</code> | * <code>MICROSECONDS</code> | <code>NANOSECONDS</code>. The default is * <code>MILLISECONDS</code>. * @public */ unit?: string; } /** * The Amazon Location rule action sends device location updates from * an MQTT message to an Amazon Location tracker resource. * @public */ export interface LocationAction { /** * The IAM role that grants permission to write to the Amazon Location resource. * @public */ roleArn: string | undefined; /** * The name of the tracker resource in Amazon Location in which the location is updated. * @public */ trackerName: string | undefined; /** * The unique ID of the device providing the location data. * @public */ deviceId: string | undefined; /** * The time that the location data was sampled. The default value is * the time the MQTT message was processed. * @public */ timestamp?: LocationTimestamp; /** * A string that evaluates to a double value that represents the * latitude of the device's location. * @public */ latitude: string | undefined; /** * A string that evaluates to a double value that represents the * longitude of the device's location. * @public */ longitude: string | undefined; } /** * Describes an action that writes data to an Amazon OpenSearch Service * domain. * @public */ export interface OpenSearchAction { /** * The IAM role ARN that has access to OpenSearch. * @public */ roleArn: string | undefined; /** * The endpoint of your OpenSearch domain. * @public */ endpoint: string | undefined; /** * The OpenSearch index where you want to store your data. * @public */ index: string | undefined; /** * The type of document you are storing. * @public */ type: string | undefined; /** * The unique identifier for the document you are storing. * @public */ id: string | undefined; } /** * A key-value pair that you define in the header. Both the key and the value are either * literal strings or valid <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html">substitution * templates</a>. * @public */ export interface UserProperty { /** * A key to be specified in <code>UserProperty</code>. * @public */ key: string | undefined; /** * A value to be specified in <code>UserProperty</code>. * @public */ value: string | undefined; } /** * Specifies MQTT Version 5.0 headers information. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html"> MQTT</a> from * Amazon Web Services IoT Core Developer Guide. * @public */ export interface MqttHeaders { /** * An <code>Enum</code> string value that indicates whether the payload is formatted as * UTF-8. * Valid values are <code>UNSPECIFIED_BYTES</code> and <code>UTF8_DATA</code>. * For more information, see <a href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111"> * Payload Format Indicator</a> from the MQTT Version 5.0 specification. * Supports <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html">substitution * templates</a>. * @public */ payloadFormatIndicator?: string; /** * A UTF-8 encoded string that describes the content of the publishing message. * For more information, see <a href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118"> * Content Type</a> from the MQTT Version 5.0 specification. * Supports <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html">substitution * templates</a>. * @public */ contentType?: string; /** * A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe * the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard * characters. * For more information, see <a href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114"> * Response Topic</a> from the MQTT Version 5.0 specification. * Supports <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html">substitution * templates</a>. * @public */ responseTopic?: string; /** * The base64-encoded binary data used by the sender of the request message to identify which request the response message is * for when it's received. * For more information, see <a href="https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115"> * Correlation Data</a> from the MQTT Version 5.0 specification. * <note> * * This binary data must be based64-encoded. * * </note> * Supports <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html">substitution * templates</a>. * @public */ correlationData?: string; /** * A user-defined integer value that will persist a message at the message broker for a * specified amount of time to ensure that the message will expire if it's no longer relevant to * the subscriber. The value of <code>messageExpiry</code> represents the number of seconds * before it expires. For more information about the limits of <code>messageExpiry</code>, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html">Amazon Web Services IoT Core message broker and protocol * limits and quotas </a> from the Amazon Web Services Reference Guide. * Supports <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-substitution-templates.html">substitution * templates</a>. * @public */ messageExpiry?: string; /** * An array of key-value pairs that you define in the MQTT5 header. * @public */ userProperties?: UserProperty[]; } /** * Describes an action to republish to another topic. * @public */ export interface RepublishAction { /** * The ARN of the IAM role that grants access. * @public */ roleArn: string | undefined; /** * The name of the MQTT topic. * @public */ topic: string | undefined; /** * The Quality of Service (QoS) level to use when republishing messages. The default value * is 0. * @public */ qos?: number; /** * MQTT Version 5.0 headers information. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html"> * MQTT</a> from the Amazon Web Services IoT Core Developer Guide. * @public */ headers?: MqttHeaders; } /** * @public * @enum */ export declare const CannedAccessControlList: { readonly AuthenticatedRead: "authenticated-read"; readonly AwsExecRead: "aws-exec-read"; readonly BucketOwnerFullControl: "bucket-owner-full-control"; readonly BucketOwnerRead: "bucket-owner-read"; readonly LogDeliveryWrite: "log-delivery-write"; readonly Private: "private"; readonly PublicRead: "public-read"; readonly PublicReadWrite: "public-read-write"; }; /** * @public */ export type CannedAccessControlList = (typeof CannedAccessControlList)[keyof typeof CannedAccessControlList]; /** * Describes an action to write data to an Amazon S3 bucket. * @public */ export interface S3Action { /** * The ARN of the IAM role that grants access. * @public */ roleArn: string | undefined; /** * The Amazon S3 bucket. * @public */ bucketName: string | undefined; /** * The object key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html">Actions, resources, and condition keys for Amazon S3</a>. * @public */ key: string | undefined; /** * The Amazon S3 canned ACL that controls access to the object identified by the object * key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl">S3 canned ACLs</a>. * @public */ cannedAcl?: CannedAccessControlList; } /** * Describes an action to write a message to a Salesforce IoT Cloud Input * Stream. * @public */ export interface SalesforceAction { /** * The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The * token is available from the Salesforce IoT Cloud platform after creation of the Input * Stream. * @public */ token: string | undefined; /** * The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from * the Salesforce IoT Cloud platform after creation of the Input Stream. * @public */ url: string | undefined; } /** * @public * @enum */ export declare const MessageFormat: { readonly JSON: "JSON"; readonly RAW: "RAW"; }; /** * @public */ export type MessageFormat = (typeof MessageFormat)[keyof typeof MessageFormat]; /** * Describes an action to publish to an Amazon SNS topic. * @public */ export interface SnsAction { /** * The ARN of the SNS topic. * @public */ targetArn: string | undefined; /** * The ARN of the IAM role that grants access. * @public */ roleArn: string | undefined; /** * (Optional) The message format of the message to publish. Accepted values are "JSON" * and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine * if the payload should be parsed and relevant platform-specific bits of the payload should * be extracted. To read more about SNS message formats, see <a href="https://docs.aws.amazon.com/sns/latest/dg/json-formats.html">https://docs.aws.amazon.com/sns/latest/dg/json-formats.html</a> refer to their official documentation. * @public */ messageFormat?: MessageFormat; } /** * Describes an action to publish data to an Amazon SQS queue. * @public */ export interface SqsAction { /** * The ARN of the IAM role that grants access. * @public */ roleArn: string | undefined; /** * The URL of the Amazon SQS queue. * @public */ queueUrl: string | undefined; /** * Specifies whether to use Base64 encoding. * @public */ useBase64?: boolean; } /** * Starts execution of a Step Functions state machine. * @public */ export interface StepFunctionsAction { /** * (Optional) A name will be given to the state machine execution consisting of this * prefix followed by a UUID. Step Functions automatically creates a unique name for each state * machine execution if one is not provided. * @public */ executionNamePrefix?: string; /** * The name of the Step Functions state machine whose execution will be started. * @public */ stateMachineName: string | undefined; /** * The ARN of the role that grants IoT permission to start execution of a state machine * ("Action":"states:StartExecution"). * @public */ roleArn: string | undefined; } /** * Metadata attributes of the time series that are written in each measure record. * @public */ export interface TimestreamDimension { /** * The metadata dimension name. This is the name of the column in the * Amazon Timestream database table record. * Dimensions cannot be named: <code>measure_name</code>, * <code>measure_value</code>, or <code>time</code>. * These names are reserved. Dimension names cannot start * with <code>ts_</code> or <code>measure_value</code> and * they cannot contain the colon (<code>:</code>) * character. * @public */ name: string | undefined; /** * The value to write in this column of the database record. * @public */ value: string | undefined; } /** * Describes how to interpret an application-defined timestamp value from an MQTT message * payload and the precision of that value. * @public */ export interface TimestreamTimestamp { /** * An expression that returns a long epoch time value. * @public */ value: string | undefined; /** * The precision of the timestamp value that results from the expression * described in <code>value</code>. * Valid values: <code>SECONDS</code> | <code>MILLISECONDS</code> | * <code>MICROSECONDS</code> | <code>NANOSECONDS</code>. The default is * <code>MILLISECONDS</code>. * @public */ unit: string | undefined; } /** * The Timestream rule action writes attributes (measures) from an MQTT message * into an Amazon Timestream table. For more information, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html">Timestream</a> * topic rule action documentation. * @public */ export interface TimestreamAction { /** * The ARN of the role that grants permission to write to the * Amazon Timestream database table. * @public */ roleArn: string | undefined; /** * The name of an Amazon Timestream database. * @public */ databaseName: string | undefined; /** * The name of the database table into which to write the measure records. * @public */ tableName: string | undefined; /** * Metadata attributes of the time series that are written in each measure record. * @public */ dimensions: TimestreamDimension[] | undefined; /** * Specifies an application-defined value to replace the default value assigned to the * Timestream record's timestamp in the <code>time</code> column. * You can use this property to specify the value and the precision of the Timestream * record's timestamp. You can specify a value from the message payload or a value computed by * a substitution template. * If omitted, the topic rule action assigns the timestamp, in milliseconds, at the time it * processed the rule. * @public */ timestamp?: TimestreamTimestamp; } /** * Describes the actions associated with a rule. * @public */ export interface Action { /** * Write to a DynamoDB table. * @public */ dynamoDB?: DynamoDBAction; /** * Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows * you to write each attribute in an MQTT message payload into a separate DynamoDB * column. * @public */ dynamoDBv2?: DynamoDBv2Action; /** * Invoke a Lambda function. * @public */ lambda?: LambdaAction; /** * Publish to an Amazon SNS topic. * @public */ sns?: SnsAction; /** * Publish to an Amazon SQS queue. * @public */ sqs?: SqsAction; /** * Write data to an Amazon Kinesis stream. * @public */ kinesis?: KinesisAction; /** * Publish to another MQTT topic. * @public */ republish?: RepublishAction; /** * Write to an Amazon S3 bucket. * @public */ s3?: S3Action; /** * Write to an Amazon Kinesis Firehose stream. * @public */ firehose?: FirehoseAction; /** * Capture a CloudWatch metric. * @public */ cloudwatchMetric?: CloudwatchMetricAction; /** * Change the state of a CloudWatch alarm. * @public */ cloudwatchAlarm?: CloudwatchAlarmAction; /** * Send data to CloudWatch Logs. * @public */ cloudwatchLogs?: CloudwatchLogsAction; /** * Write data to an Amazon OpenSearch Service domain. * <note> * The <code>Elasticsearch</code> action can only be used by existing rule actions. * To create a new rule action or to update an existing rule action, use the * <code>OpenSearch</code> rule action instead. For more information, see * <a href="https://docs.aws.amazon.com/iot/latest/apireference/API_OpenSearchAction.html">OpenSearchAction</a>. * </note> * @public */ elasticsearch?: ElasticsearchAction; /** * Send a message to a Salesforce IoT Cloud Input Stream. * @public */ salesforce?: SalesforceAction; /** * Sends message data to an IoT Analytics channel. * @public */ iotAnalytics?: IotAnalyticsAction; /** * Sends an input to an IoT Events detector. * @public */ iotEvents?: IotEventsAction; /** * Sends data from the MQTT message that triggered the rule to IoT SiteWise asset * properties. * @public */ iotSiteWise?: IotSiteWiseAction; /** * Starts execution of a Step Functions state machine. * @public */ stepFunctions?: StepFunctionsAction; /** * The Timestream rule action writes attributes (measures) from an MQTT message * into an Amazon Timestream table. For more information, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/timestream-rule-action.html">Timestream</a> * topic rule action documentation. * @public */ timestream?: TimestreamAction; /** * Send data to an HTTPS endpoint. * @public */ http?: HttpAction; /** * Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster. * @public */ kafka?: KafkaAction; /** * Write data to an Amazon OpenSearch Service domain. * @public */ openSearch?: OpenSearchAction; /** * The Amazon Location Service rule action sends device location updates from * an MQTT message to an Amazon Location tracker resource. * @public */ location?: LocationAction; } /** * @public * @enum */ export declare const ActionType: { readonly CONNECT: "CONNECT"; readonly PUBLISH: "PUBLISH"; readonly RECEIVE: "RECEIVE"; readonly SUBSCRIBE: "SUBSCRIBE"; }; /** * @public */ export type ActionType = (typeof ActionType)[keyof typeof ActionType]; /** * @public * @enum */ export declare const ComparisonOperator: { readonly GREATER_THAN: "greater-than"; readonly GREATER_THAN_EQUALS: "greater-than-equals"; readonly IN_CIDR_SET: "in-cidr-set"; readonly IN_PORT_SET: "in-port-set"; readonly IN_SET: "in-set"; readonly LESS_THAN: "less-than"; readonly LESS_THAN_EQUALS: "less-than-equals"; readonly NOT_IN_CIDR_SET: "not-in-cidr-set"; readonly NOT_IN_PORT_SET: "not-in-port-set"; readonly NOT_IN_SET: "not-in-set"; }; /** * @public */ export type ComparisonOperator = (typeof ComparisonOperator)[keyof typeof ComparisonOperator]; /** * @public * @enum */ export declare const ConfidenceLevel: { readonly HIGH: "HIGH"; readonly LOW: "LOW"; readonly MEDIUM: "MEDIUM"; }; /** * @public */ export type ConfidenceLevel = (typeof ConfidenceLevel)[keyof typeof ConfidenceLevel]; /** * * The configuration of an ML Detect Security Profile. * * @public */ export interface MachineLearningDetectionConfig { /** * * The sensitivity of anomalous behavior evaluation. Can be <code>Low</code>, <code>Medium</code>, or <code>High</code>. * * @public */ confidenceLevel: ConfidenceLevel | undefined; } /** * A statistical ranking (percentile) that * indicates a threshold value by which a behavior is determined to be in compliance or in * violation of the behavior. * @public */ export interface StatisticalThreshold { /** * The percentile that * resolves to a threshold value by which compliance with a behavior is determined. Metrics are * collected over the specified period (<code>durationSeconds</code>) from all reporting devices * in your account and statistical ranks are calculated. Then, the measurements from a device are * collected over the same period. If the accumulated measurements from the device fall above or * below (<code>comparisonOperator</code>) the value associated with the percentile specified, * then the device is considered to be in compliance with the behavior, otherwise