Amazon IoT Device Defender Rules API is one of 69 APIs that Amazon IoT Device Defender publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Rules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
7 operations
across 4 paths,
and defines 132 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://iot.{region}.amazonaws.com, https://iot.{region}.amazonaws.com, http://iot.{region}.amazonaws.com.cn, https://iot.{region}.amazonaws.com.cn.
7 operations4 paths132 schemas1 DELETE2 GET1 PATCH3 POST
Metadata
The identity and technical contract details declared by the specification.
Amazon IoT Device Defender Rules API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 132 schemas that model the data the API accepts and returns. The most detailed are Action (23 properties), DynamoDBAction (10 properties), TopicRule (8 properties), CloudwatchMetricAction (6 properties). Each schema is shown below with its type and property counts.
String
string
PutAssetPropertyValueEntryList
array
ContentType
string
ChannelName
string
TopicRuleList
array
UnauthorizedException
ListTopicRulesResponse
object
The output from the ListTopicRules operation.
2 properties
CloudwatchMetricAction
object
Describes an action that captures a CloudWatch metric.
6 properties5 required
CorrelationData
string
Description
string
AssetPropertyQuality
string
AssetPropertyId
string
MessageFormat
string
AssetPropertyValue
object
An asset property value entry containing the following information.
3 properties2 required
HttpAction
object
Send data to an HTTPS endpoint.
4 properties1 required
AssetPropertyTimestamp
object
An asset property timestamp entry containing the following information.
2 properties1 required
Action
object
Describes the actions associated with a rule.
23 properties
DynamoOperation
string
IotEventsAction
object
Sends an input to an IoT Events detector.
4 properties2 required
ServiceName
string
HttpAuthorization
object
The authorization method used to send messages.
1 property
AssetPropertyDoubleValue
string
UserProperties
array
StateValue
string
LocationTimestamp
object
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
2 properties1 required
ElasticsearchIndex
string
InputName
string
SigV4Authorization
object
For more information, see Signature Version 4 signing process .
3 properties3 required
TopicRule
object
Describes a rule.
8 properties
InvalidRequestException
ActionList
array
DynamoDBAction
object
Describes an action to write to a DynamoDB table. The tableName , hashKeyField , and rangeKeyField values must match the values used when you created the table…
10 properties4 required
Url
string
BatchMode
boolean
ServiceUnavailableException
OpenSearchAction
object
Describes an action that writes data to an Amazon OpenSearch Service domain.
5 properties5 required
AssetPropertyAlias
string
TimestreamTimestampUnit
string
ElasticsearchEndpoint
string
CreatedAtDate
string
PayloadFormatIndicator
string
StepFunctionsAction
object
Starts execution of a Step Functions state machine.
3 properties2 required
CloudwatchAlarmAction
object
Describes an action that updates a CloudWatch alarm.
4 properties4 required
RuleArn
string
ResourceAlreadyExistsException
PutAssetPropertyValueEntry
object
An asset property value entry containing the following information.
5 properties1 required
StateReason
string
BucketName
string
Key
string
ElasticsearchType
string
CloudwatchLogsAction
object
Describes an action that sends data to CloudWatch Logs.
3 properties2 required
DeliveryStreamName
string
UserProperty
object
A key-value pair that you define in the header. Both the key and the value are either literal strings or valid substitution templates .
2 properties2 required
ExecutionNamePrefix
string
MqttHeaders
object
Specifies MQTT Version 5.0 headers information. For more information, see MQTT from Amazon Web Services IoT Core Developer Guide.
6 properties
HashKeyField
string
AssetPropertyOffsetInNanos
string
S3Action
object
Describes an action to write data to an Amazon S3 bucket.
4 properties3 required
AssetPropertyIntegerValue
string
InternalException
RepublishAction
object
Describes an action to republish to another topic.
4 properties2 required
ClientProperties
object
UserPropertyKey
string
StateMachineName
string
FirehoseAction
object
Describes an action that writes data to an Amazon Kinesis Firehose stream.
4 properties2 required
AssetId
string
QueueUrl
string
TimestreamDimensionName
string
DynamoKeyType
string
TopicRuleListItem
object
Describes a rule.
5 properties
ElasticsearchAction
object
Describes an action that writes data to an Amazon OpenSearch Service domain. The Elasticsearch action can only be used by existing rule actions. To create a ne…
5 properties5 required
TableName
string
AlarmName
string
GetTopicRuleResponse
object
The output from the GetTopicRule operation.
2 properties
PayloadField
string
AssetPropertyEntryId
string
SnsAction
object
Describes an action to publish to an Amazon SNS topic.
3 properties2 required
TimestreamDimension
object
Metadata attributes of the time series that are written in each measure record.
2 properties2 required
AwsArn
string
RangeKeyValue
string
RangeKeyField
string
TimestreamTimestampValue
string
ConflictingResourceUpdateException
HashKeyValue
string
TopicPattern
string
ResponseTopic
string
KafkaAction
object
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
5 properties3 required
SalesforceEndpoint
string
UseBase64
boolean
HeaderList
array
AwsIotSqlVersion
string
TimestreamTimestamp
object
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
2 properties2 required
TimestreamDatabaseName
string
DynamoDBv2Action
object
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.
2 properties2 required
StreamName
string
MessageExpiry
string
SalesforceAction
object
Describes an action to write a message to a Salesforce IoT Cloud Input Stream.
2 properties2 required
SigningRegion
string
FunctionArn
string
NextToken
string
AssetPropertyBooleanValue
string
AssetPropertyValueList
array
LambdaAction
object
Describes an action to invoke a Lambda function.
1 property1 required
ElasticsearchId
string
TimestreamDimensionList
array
KinesisAction
object
Describes an action to write data to an Amazon Kinesis stream.
3 properties2 required
PartitionKey
string
HttpActionHeader
object
The HTTP action header.
2 properties2 required
SqlParseException
LocationAction
object
The Amazon Location rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.
6 properties5 required
CannedAccessControlList
string
AssetPropertyStringValue
string
TimestreamAction
object
The Timestream rule action writes attributes (measures) from an MQTT message into an Amazon Timestream table. For more information, see the Timestream topic ru…
5 properties4 required
RuleName
string
AssetPropertyTimeInSeconds
string
FirehoseSeparator
string
MessageId
string
SqsAction
object
Describes an action to publish data to an Amazon SQS queue.
3 properties2 required
PutItemInput
object
The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
1 property1 required
LogGroupName
string
IotAnalyticsAction
object
Sends message data to an IoT Analytics channel.
4 properties
SQL
string
Qos
integer
TimestreamDimensionValue
string
SalesforceToken
string
IotSiteWiseAction
object
Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.
2 properties2 required
UserPropertyValue
string
HeaderKey
string
HeaderValue
string
TimestreamTableName
string
IsDisabled
boolean
AssetPropertyVariant
object
Contains an asset property value (of a single type).
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Amazon IoT Device Defender Rules API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
