How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon IoT Device Management Rules API

The Rules API from Amazon IoT Device Management — 4 operation(s) for rules.

Amazon IoT Device Management Rules API is one of 69 APIs that Amazon IoT Device Management 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 operations 4 paths 132 schemas 1 DELETE2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://iot.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT Device Management 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.

Rules 7
POST
/rules/{ruleName}
Amazon IoT Device Management Create Topic Rule
CreateTopicRule 9 params body → 200480481482483484485
DELETE
/rules/{ruleName}
Amazon IoT Device Management Delete Topic Rule
DeleteTopicRule 8 params → 200480481482483484
GET
/rules/{ruleName}
Amazon IoT Device Management Get Topic Rule
GetTopicRule 8 params → 200480481482483
PATCH
/rules/{ruleName}
Amazon IoT Device Management Replace Topic Rule
ReplaceTopicRule 8 params body → 200480481482483484485
POST
/rules/{ruleName}/disable
Amazon IoT Device Management Disable Topic Rule
DisableTopicRule 8 params → 200480481482483484
POST
/rules/{ruleName}/enable
Amazon IoT Device Management Enable Topic Rule
EnableTopicRule 8 params → 200480481482483484
GET
/rules
Amazon IoT Device Management List Topic Rules
ListTopicRules 11 params → 200480481482

Schemas 132

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.

SalesforceToken
string
CloudwatchLogsAction
object
Describes an action that sends data to CloudWatch Logs.
3 properties 2 required
ExecutionNamePrefix
string
TopicRuleListItem
object
Describes a rule.
5 properties
BucketName
string
UserProperties
array
SnsAction
object
Describes an action to publish to an Amazon SNS topic.
3 properties 2 required
LogGroupName
string
ActionList
array
HttpAction
object
Send data to an HTTPS endpoint.
4 properties 1 required
ResponseTopic
string
CreatedAtDate
string
FunctionArn
string
BatchMode
boolean
Key
string
SalesforceEndpoint
string
RuleName
string
HeaderValue
string
ServiceUnavailableException
SqlParseException
Url
string
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 properties 4 required
ElasticsearchType
string
AssetPropertyDoubleValue
string
PayloadFormatIndicator
string
NextToken
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
ContentType
string
AwsIotSqlVersion
string
AssetPropertyOffsetInNanos
string
AlarmName
string
Qos
integer
ElasticsearchIndex
string
PutItemInput
object
The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
1 property 1 required
ClientProperties
object
UserPropertyKey
string
AssetPropertyTimeInSeconds
string
PutAssetPropertyValueEntryList
array
Action
object
Describes the actions associated with a rule.
23 properties
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 properties 4 required
TimestreamTimestampValue
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 properties 2 required
S3Action
object
Describes an action to write data to an Amazon S3 bucket.
4 properties 3 required
AssetPropertyStringValue
string
ResourceAlreadyExistsException
AssetPropertyQuality
string
StateReason
string
KinesisAction
object
Describes an action to write data to an Amazon Kinesis stream.
3 properties 2 required
ChannelName
string
RepublishAction
object
Describes an action to republish to another topic.
4 properties 2 required
InvalidRequestException
PayloadField
string
AssetId
string
UnauthorizedException
String
string
InputName
string
QueueUrl
string
IsDisabled
boolean
IotEventsAction
object
Sends an input to an IoT Events detector.
4 properties 2 required
StateMachineName
string
HttpAuthorization
object
The authorization method used to send messages.
1 property
FirehoseAction
object
Describes an action that writes data to an Amazon Kinesis Firehose stream.
4 properties 2 required
LocationTimestamp
object
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
2 properties 1 required
TimestreamTimestampUnit
string
HeaderKey
string
RuleArn
string
ServiceName
string
AssetPropertyId
string
MessageId
string
ElasticsearchId
string
CloudwatchAlarmAction
object
Describes an action that updates a CloudWatch alarm.
4 properties 4 required
SqsAction
object
Describes an action to publish data to an Amazon SQS queue.
3 properties 2 required
TimestreamTableName
string
CannedAccessControlList
string
AwsArn
string
AssetPropertyValueList
array
AssetPropertyBooleanValue
string
TableName
string
PartitionKey
string
TopicRule
object
Describes a rule.
8 properties
AssetPropertyVariant
object
Contains an asset property value (of a single type).
4 properties
HashKeyField
string
SigV4Authorization
object
For more information, see Signature Version 4 signing process .
3 properties 3 required
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 properties 2 required
DynamoOperation
string
HttpActionHeader
object
The HTTP action header.
2 properties 2 required
TimestreamTimestamp
object
Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
2 properties 2 required
IotSiteWiseAction
object
Describes an action to send data from an MQTT message that triggered the rule to IoT SiteWise asset properties.
2 properties 2 required
StateValue
string
UseBase64
boolean
TimestreamDimensionValue
string
InternalException
TopicRuleList
array
PutAssetPropertyValueEntry
object
An asset property value entry containing the following information.
5 properties 1 required
FirehoseSeparator
string
CorrelationData
string
TimestreamDimensionList
array
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 properties 5 required
LocationAction
object
The Amazon Location rule action sends device location updates from an MQTT message to an Amazon Location tracker resource.
6 properties 5 required
KafkaAction
object
Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
5 properties 3 required
IotAnalyticsAction
object
Sends message data to an IoT Analytics channel.
4 properties
SigningRegion
string
SalesforceAction
object
Describes an action to write a message to a Salesforce IoT Cloud Input Stream.
2 properties 2 required
StreamName
string
SQL
string
Description
string
RangeKeyField
string
UserPropertyValue
string
AssetPropertyEntryId
string
TimestreamDatabaseName
string
ListTopicRulesResponse
object
The output from the ListTopicRules operation.
2 properties
CloudwatchMetricAction
object
Describes an action that captures a CloudWatch metric.
6 properties 5 required
AssetPropertyTimestamp
object
An asset property timestamp entry containing the following information.
2 properties 1 required
RangeKeyValue
string
TopicPattern
string
MessageExpiry
string
ConflictingResourceUpdateException
AssetPropertyIntegerValue
string
TimestreamDimensionName
string
OpenSearchAction
object
Describes an action that writes data to an Amazon OpenSearch Service domain.
5 properties 5 required
DeliveryStreamName
string
TimestreamDimension
object
Metadata attributes of the time series that are written in each measure record.
2 properties 2 required
AssetPropertyAlias
string
AssetPropertyValue
object
An asset property value entry containing the following information.
3 properties 2 required
StepFunctionsAction
object
Starts execution of a Step Functions state machine.
3 properties 2 required
HeaderList
array
ElasticsearchEndpoint
string
MessageFormat
string
HashKeyValue
string
GetTopicRuleResponse
object
The output from the GetTopicRule operation.
2 properties
DynamoKeyType
string
LambdaAction
object
Describes an action to invoke a Lambda function.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-management-rules-api-openapi.yml Raw ↑

Other APIs Amazon IoT Device Management publishes across the network.

Amazon IoT Device Management Accept Certificate Transfer API
Amazon IoT Device Management Active Violations API
Amazon IoT Device Management Attached Policies API
Amazon IoT Device Management Audit API
Amazon IoT Device Management Authorizer API
Amazon IoT Device Management Authorizers API
Amazon IoT Device Management Behavior Model Training API
Amazon IoT Device Management Billing Groups API
Amazon IoT Device Management Cacertificate API
Amazon IoT Device Management Cacertificates API
Amazon IoT Device Management Cancel Certificate Transfer API
Amazon IoT Device Management Certificate API
Where this information came from

This is an independent, third-party profile of Amazon IoT Device Management 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.