Amazon IoT Device Defender Rules API
The Rules API from Amazon IoT Device Defender — 4 operation(s) for rules.
OpenAPI Specification
openapi: 3.0.0
info:
version: 2015-05-28
x-release: v4
title: AWS IoT Accept Certificate Transfer Rules API
description: '<fullname>IoT</fullname> <p>IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the Amazon Web Services cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.</p> <p>The service endpoints that expose this API are listed in <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html">Amazon Web Services IoT Core Endpoints and Quotas</a>. You must use the endpoint for the region that has the resources you want to access.</p> <p>The service name used by <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon Web Services Signature Version 4</a> to sign the request is: <i>execute-api</i>.</p> <p>For more information about how IoT works, see the <a href="https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html">Developer Guide</a>.</p> <p>For information about how to use the credentials provider for IoT, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html">Authorizing Direct Calls to Amazon Web Services Services</a>.</p>'
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: iot
x-aws-signingName: iot
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iot-2015-05-28.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: https://iot.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The AWS IoT multi-region endpoint
- url: http://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
- url: https://iot.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The AWS IoT endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Rules
paths:
/rules/{ruleName}:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateTopicRule
description: <p>Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">CreateTopicRule</a> action.</p>
responses:
'200':
description: Success
'480':
description: SqlParseException
content:
application/json:
schema:
$ref: '#/components/schemas/SqlParseException'
'481':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'484':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'485':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: ruleName
in: path
required: true
description: The name of the rule.
schema:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
- name: x-amz-tagging
in: header
required: false
description: '<p>Metadata which can be used to manage the topic rule.</p> <note> <p>For URI Request parameters use format: ...key1=value1&key2=value2...</p> <p>For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."</p> <p>For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."</p> </note>'
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- topicRulePayload
properties:
topicRulePayload:
description: Describes a rule.
type: object
properties:
sql:
allOf:
- $ref: '#/components/schemas/SQL'
- description: The SQL statement used to query the topic. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html">IoT SQL Reference</a> in the <i>IoT Developer Guide</i>.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the rule.
actions:
allOf:
- $ref: '#/components/schemas/ActionList'
- description: The actions associated with the rule.
ruleDisabled:
allOf:
- $ref: '#/components/schemas/IsDisabled'
- description: Specifies whether the rule is disabled.
awsIotSqlVersion:
allOf:
- $ref: '#/components/schemas/AwsIotSqlVersion'
- description: The version of the SQL rules engine to use when evaluating the rule.
errorAction:
allOf:
- $ref: '#/components/schemas/Action'
- description: The action to take when an error occurs.
summary: Amazon IoT Device Defender Create Topic Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
delete:
operationId: DeleteTopicRule
description: <p>Deletes the rule.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteTopicRule</a> action.</p>
responses:
'200':
description: Success
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: ruleName
in: path
required: true
description: The name of the rule.
schema:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
summary: Amazon IoT Device Defender Delete Topic Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
get:
operationId: GetTopicRule
description: <p>Gets information about the rule.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetTopicRule</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetTopicRuleResponse'
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
parameters:
- name: ruleName
in: path
required: true
description: The name of the rule.
schema:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
summary: Amazon IoT Device Defender Get Topic Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
patch:
operationId: ReplaceTopicRule
description: <p>Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ReplaceTopicRule</a> action.</p>
responses:
'200':
description: Success
'480':
description: SqlParseException
content:
application/json:
schema:
$ref: '#/components/schemas/SqlParseException'
'481':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'484':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'485':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: ruleName
in: path
required: true
description: The name of the rule.
schema:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- topicRulePayload
properties:
topicRulePayload:
description: Describes a rule.
type: object
properties:
sql:
allOf:
- $ref: '#/components/schemas/SQL'
- description: The SQL statement used to query the topic. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html">IoT SQL Reference</a> in the <i>IoT Developer Guide</i>.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the rule.
actions:
allOf:
- $ref: '#/components/schemas/ActionList'
- description: The actions associated with the rule.
ruleDisabled:
allOf:
- $ref: '#/components/schemas/IsDisabled'
- description: Specifies whether the rule is disabled.
awsIotSqlVersion:
allOf:
- $ref: '#/components/schemas/AwsIotSqlVersion'
- description: The version of the SQL rules engine to use when evaluating the rule.
errorAction:
allOf:
- $ref: '#/components/schemas/Action'
- description: The action to take when an error occurs.
summary: Amazon IoT Device Defender Replace Topic Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
/rules/{ruleName}/disable:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisableTopicRule
description: <p>Disables the rule.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DisableTopicRule</a> action.</p>
responses:
'200':
description: Success
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: ruleName
in: path
required: true
description: The name of the rule to disable.
schema:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
summary: Amazon IoT Device Defender Disable Topic Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
/rules/{ruleName}/enable:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: EnableTopicRule
description: <p>Enables the rule.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">EnableTopicRule</a> action.</p>
responses:
'200':
description: Success
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
'483':
description: UnauthorizedException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedException'
'484':
description: ConflictingResourceUpdateException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictingResourceUpdateException'
parameters:
- name: ruleName
in: path
required: true
description: The name of the topic rule to enable.
schema:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
summary: Amazon IoT Device Defender Enable Topic Rule
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
/rules:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: ListTopicRules
description: <p>Lists the rules for the specific topic.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListTopicRules</a> action.</p>
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTopicRulesResponse'
'480':
description: InternalException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceUnavailableException'
parameters:
- name: topic
in: query
required: false
description: The topic.
schema:
type: string
- name: maxResults
in: query
required: false
description: The maximum number of results to return.
schema:
type: integer
minimum: 1
maximum: 10000
- name: nextToken
in: query
required: false
description: To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.
schema:
type: string
- name: ruleDisabled
in: query
required: false
description: Specifies whether the rule is disabled.
schema:
type: boolean
summary: Amazon IoT Device Defender List Topic Rules
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Rules
components:
schemas:
CreatedAtDate:
type: string
format: date-time
TopicRuleList:
type: array
items:
$ref: '#/components/schemas/TopicRuleListItem'
RuleName:
type: string
pattern: ^[a-zA-Z0-9_]+$
minLength: 1
maxLength: 128
AssetPropertyQuality:
type: string
SQL:
type: string
InternalException: {}
NextToken:
type: string
ServiceUnavailableException: {}
UserProperties:
type: array
items:
$ref: '#/components/schemas/UserProperty'
minItems: 1
maxItems: 100
CloudwatchMetricAction:
type: object
required:
- roleArn
- metricNamespace
- metricName
- metricValue
- metricUnit
properties:
roleArn:
allOf:
- $ref: '#/components/schemas/AwsArn'
- description: The IAM role that allows access to the CloudWatch metric.
metricNamespace:
allOf:
- $ref: '#/components/schemas/String'
- description: The CloudWatch metric namespace name.
metricName:
allOf:
- $ref: '#/components/schemas/String'
- description: The CloudWatch metric name.
metricValue:
allOf:
- $ref: '#/components/schemas/String'
- description: The CloudWatch metric value.
metricUnit:
allOf:
- $ref: '#/components/schemas/String'
- description: The <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit">metric unit</a> supported by CloudWatch.
metricTimestamp:
allOf:
- $ref: '#/components/schemas/String'
- description: An optional <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp">Unix timestamp</a>.
description: Describes an action that captures a CloudWatch metric.
QueueUrl:
type: string
IotSiteWiseAction:
type: object
required:
- putAssetPropertyValueEntries
- roleArn
properties:
putAssetPropertyValueEntries:
allOf:
- $ref: '#/components/schemas/PutAssetPropertyValueEntryList'
- description: A list of asset property value entries.
roleArn:
allOf:
- $ref: '#/components/schemas/AwsArn'
- description: '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.'
description: Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.
Qos:
type: integer
minimum: 0
maximum: 1
TimestreamTimestampValue:
type: string
AssetId:
type: string
AssetPropertyTimeInSeconds:
type: string
AssetPropertyDoubleValue:
type: string
InvalidRequestException: {}
ChannelName:
type: string
ServiceName:
type: string
TimestreamTimestampUnit:
type: string
TimestreamTableName:
type: string
BucketName:
type: string
IotAnalyticsAction:
type: object
properties:
channelArn:
allOf:
- $ref: '#/components/schemas/AwsArn'
- description: (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
channelName:
allOf:
- $ref: '#/components/schemas/ChannelName'
- description: The name of the IoT Analytics channel to which message data will be sent.
batchMode:
allOf:
- $ref: '#/components/schemas/BatchMode'
- description: <p>Whether to process the action as a batch. The default value is <code>false</code>.</p> <p>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.</p>
roleArn:
allOf:
- $ref: '#/components/schemas/AwsArn'
- description: The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
description: Sends message data to an IoT Analytics channel.
TimestreamTimestamp:
type: object
required:
- value
- unit
properties:
value:
allOf:
- $ref: '#/components/schemas/TimestreamTimestampValue'
- description: An expression that returns a long epoch time value.
unit:
allOf:
- $ref: '#/components/schemas/TimestreamTimestampUnit'
- description: '<p>The precision of the timestamp value that results from the expression described in <code>value</code>.</p> <p>Valid values: <code>SECONDS</code> | <code>MILLISECONDS</code> | <code>MICROSECONDS</code> | <code>NANOSECONDS</code>. The default is <code>MILLISECONDS</code>.</p>'
description: Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
IsDisabled:
type: boolean
TopicRule:
type: object
properties:
ruleName:
allOf:
- $ref: '#/components/schemas/RuleName'
- description: The name of the rule.
sql:
allOf:
- $ref: '#/components/schemas/SQL'
- description: The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the rule.
createdAt:
allOf:
- $ref: '#/components/schemas/CreatedAtDate'
- description: The date and time the rule was created.
actions:
allOf:
- $ref: '#/components/schemas/ActionList'
- description: The actions associated with the rule.
ruleDisabled:
allOf:
- $ref: '#/components/schemas/IsDisabled'
- description: Specifies whether the rule is disabled.
awsIotSqlVersion:
allOf:
- $ref: '#/components/schemas/AwsIotSqlVersion'
- description: The version of the SQL rules engine to use when evaluating the rule.
errorAction:
allOf:
- $ref: '#/components/schemas/Action'
- description: The action to perform when an error occurs.
description: Describes a rule.
PutAssetPropertyValueEntry:
type: object
required:
- propertyValues
properties:
entryId:
allOf:
- $ref: '#/components/schemas/AssetPropertyEntryId'
- description: 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.
assetId:
allOf:
- $ref: '#/components/schemas/AssetId'
- description: 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.
propertyId:
allOf:
- $ref: '#/components/schemas/AssetPropertyId'
- description: 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.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: 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.
propertyValues:
allOf:
- $ref: '#/components/schemas/AssetPropertyValueList'
- description: A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
description: An asset property value entry containing the following information.
RangeKeyValue:
type: string
HashKeyField:
type: string
TimestreamDimensionName:
type: string
ContentType:
type: string
minLength: 0
maxLength: 1024
IotEventsAction:
type: object
required:
- inputName
- roleArn
properties:
inputName:
allOf:
- $ref: '#/components/schemas/InputName'
- description: The name of the IoT Events input.
messageId:
allOf:
- $ref: '#/components/schemas/MessageId'
- description: <p>The ID of the message. The default <code>messageId</code> is a new UUID value.</p> <p>When <code>batchMode</code> is <code>true</code>, you can't specify a <code>messageId</code>--a new UUID value will
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-defender/refs/heads/main/openapi/amazon-iot-device-defender-rules-api-openapi.yml