Menu
AWS IoT
API Reference

GetTopicRule

Gets information about the rule.

Request Syntax

GET /rules/ruleName HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

ruleName

The name of the rule.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9_]+$

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "rule": { 
      "actions": [ 
         { 
            "cloudwatchAlarm": { 
               "alarmName": "string",
               "roleArn": "string",
               "stateReason": "string",
               "stateValue": "string"
            },
            "cloudwatchMetric": { 
               "metricName": "string",
               "metricNamespace": "string",
               "metricTimestamp": "string",
               "metricUnit": "string",
               "metricValue": "string",
               "roleArn": "string"
            },
            "dynamoDB": { 
               "hashKeyField": "string",
               "hashKeyType": "string",
               "hashKeyValue": "string",
               "operation": "string",
               "payloadField": "string",
               "rangeKeyField": "string",
               "rangeKeyType": "string",
               "rangeKeyValue": "string",
               "roleArn": "string",
               "tableName": "string"
            },
            "dynamoDBv2": { 
               "putItem": { 
                  "tableName": "string"
               },
               "roleArn": "string"
            },
            "elasticsearch": { 
               "endpoint": "string",
               "id": "string",
               "index": "string",
               "roleArn": "string",
               "type": "string"
            },
            "firehose": { 
               "deliveryStreamName": "string",
               "roleArn": "string",
               "separator": "string"
            },
            "kinesis": { 
               "partitionKey": "string",
               "roleArn": "string",
               "streamName": "string"
            },
            "lambda": { 
               "functionArn": "string"
            },
            "republish": { 
               "roleArn": "string",
               "topic": "string"
            },
            "s3": { 
               "bucketName": "string",
               "cannedAcl": "string",
               "key": "string",
               "roleArn": "string"
            },
            "salesforce": { 
               "token": "string",
               "url": "string"
            },
            "sns": { 
               "messageFormat": "string",
               "roleArn": "string",
               "targetArn": "string"
            },
            "sqs": { 
               "queueUrl": "string",
               "roleArn": "string",
               "useBase64": boolean
            }
         }
      ],
      "awsIotSqlVersion": "string",
      "createdAt": number,
      "description": "string",
      "errorAction": { 
         "cloudwatchAlarm": { 
            "alarmName": "string",
            "roleArn": "string",
            "stateReason": "string",
            "stateValue": "string"
         },
         "cloudwatchMetric": { 
            "metricName": "string",
            "metricNamespace": "string",
            "metricTimestamp": "string",
            "metricUnit": "string",
            "metricValue": "string",
            "roleArn": "string"
         },
         "dynamoDB": { 
            "hashKeyField": "string",
            "hashKeyType": "string",
            "hashKeyValue": "string",
            "operation": "string",
            "payloadField": "string",
            "rangeKeyField": "string",
            "rangeKeyType": "string",
            "rangeKeyValue": "string",
            "roleArn": "string",
            "tableName": "string"
         },
         "dynamoDBv2": { 
            "putItem": { 
               "tableName": "string"
            },
            "roleArn": "string"
         },
         "elasticsearch": { 
            "endpoint": "string",
            "id": "string",
            "index": "string",
            "roleArn": "string",
            "type": "string"
         },
         "firehose": { 
            "deliveryStreamName": "string",
            "roleArn": "string",
            "separator": "string"
         },
         "kinesis": { 
            "partitionKey": "string",
            "roleArn": "string",
            "streamName": "string"
         },
         "lambda": { 
            "functionArn": "string"
         },
         "republish": { 
            "roleArn": "string",
            "topic": "string"
         },
         "s3": { 
            "bucketName": "string",
            "cannedAcl": "string",
            "key": "string",
            "roleArn": "string"
         },
         "salesforce": { 
            "token": "string",
            "url": "string"
         },
         "sns": { 
            "messageFormat": "string",
            "roleArn": "string",
            "targetArn": "string"
         },
         "sqs": { 
            "queueUrl": "string",
            "roleArn": "string",
            "useBase64": boolean
         }
      },
      "ruleDisabled": boolean,
      "ruleName": "string",
      "sql": "string"
   },
   "ruleArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

rule

The rule.

Type: TopicRule object

ruleArn

The rule ARN.

Type: String

Errors

InternalException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: