# AWS IoT Events The following actions are supported by AWS IoT Events: + [CreateAlarmModel](API_CreateAlarmModel.md) + [CreateDetectorModel](API_CreateDetectorModel.md) + [CreateInput](API_CreateInput.md) + [DeleteAlarmModel](API_DeleteAlarmModel.md) + [DeleteDetectorModel](API_DeleteDetectorModel.md) + [DeleteInput](API_DeleteInput.md) + [DescribeAlarmModel](API_DescribeAlarmModel.md) + [DescribeDetectorModel](API_DescribeDetectorModel.md) + [DescribeDetectorModelAnalysis](API_DescribeDetectorModelAnalysis.md) + [DescribeInput](API_DescribeInput.md) + [DescribeLoggingOptions](API_DescribeLoggingOptions.md) + [GetDetectorModelAnalysisResults](API_GetDetectorModelAnalysisResults.md) + [ListAlarmModels](API_ListAlarmModels.md) + [ListAlarmModelVersions](API_ListAlarmModelVersions.md) + [ListDetectorModels](API_ListDetectorModels.md) + [ListDetectorModelVersions](API_ListDetectorModelVersions.md) + [ListInputRoutings](API_ListInputRoutings.md) + [ListInputs](API_ListInputs.md) + [ListTagsForResource](API_ListTagsForResource.md) + [PutLoggingOptions](API_PutLoggingOptions.md) + [StartDetectorModelAnalysis](API_StartDetectorModelAnalysis.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAlarmModel](API_UpdateAlarmModel.md) + [UpdateDetectorModel](API_UpdateDetectorModel.md) + [UpdateInput](API_UpdateInput.md) # CreateAlarmModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the * AWS IoT Events Developer Guide*. ## Request Syntax ``` POST /alarm-models HTTP/1.1 Content-type: application/json { "alarmCapabilities": { "acknowledgeFlow": { "enabled": boolean }, "initializationConfiguration": { "disabledOnInitialization": boolean } }, "alarmEventActions": { "alarmActions": [ { "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ] }, "alarmModelDescription": "string", "alarmModelName": "string", "alarmNotification": { "notificationActions": [ { "action": { "lambdaAction": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } } }, "emailConfigurations": [ { "content": { "additionalMessage": "string", "subject": "string" }, "from": "string", "recipients": { "to": [ { "ssoIdentity": { "identityStoreId": "string", "userId": "string" } } ] } } ], "smsConfigurations": [ { "additionalMessage": "string", "recipients": [ { "ssoIdentity": { "identityStoreId": "string", "userId": "string" } } ], "senderId": "string" } ] } ] }, "alarmRule": { "simpleRule": { "comparisonOperator": "string", "inputProperty": "string", "threshold": "string" } }, "key": "string", "roleArn": "string", "severity": number, "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [alarmCapabilities](#API_CreateAlarmModel_RequestSyntax) ** Contains the configuration information of alarm state changes. Type: [AlarmCapabilities](API_AlarmCapabilities.md) object Required: No ** [alarmEventActions](#API_CreateAlarmModel_RequestSyntax) ** Contains information about one or more alarm actions. Type: [AlarmEventActions](API_AlarmEventActions.md) object Required: No ** [alarmModelDescription](#API_CreateAlarmModel_RequestSyntax) ** A description that tells you what the alarm model detects. Type: String Length Constraints: Maximum length of 1024. Required: No ** [alarmModelName](#API_CreateAlarmModel_RequestSyntax) ** A unique name that helps you identify the alarm model. You can't change this name after you create the alarm model. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [alarmNotification](#API_CreateAlarmModel_RequestSyntax) ** Contains information about one or more notification actions. Type: [AlarmNotification](API_AlarmNotification.md) object Required: No ** [alarmRule](#API_CreateAlarmModel_RequestSyntax) ** Defines when your alarm is invoked. Type: [AlarmRule](API_AlarmRule.md) object Required: Yes ** [key](#API_CreateAlarmModel_RequestSyntax) ** An input attribute used as a key to create an alarm. AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$` Required: No ** [roleArn](#API_CreateAlarmModel_RequestSyntax) ** The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [severity](#API_CreateAlarmModel_RequestSyntax) ** A non-negative integer that reflects the severity level of the alarm. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: No ** [tags](#API_CreateAlarmModel_RequestSyntax) ** A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your AWS IoT Events resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the * AWS IoT Events Developer Guide*. You can create up to 50 tags for one alarm model. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "alarmModelArn": "string", "alarmModelVersion": "string", "creationTime": number, "lastUpdateTime": number, "status": "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. ** [alarmModelArn](#API_CreateAlarmModel_ResponseSyntax) ** The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String ** [alarmModelVersion](#API_CreateAlarmModel_ResponseSyntax) ** The version of the alarm model. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ** [creationTime](#API_CreateAlarmModel_ResponseSyntax) ** The time the alarm model was created, in the Unix epoch format. Type: Timestamp ** [lastUpdateTime](#API_CreateAlarmModel_ResponseSyntax) ** The time the alarm model was last updated, in the Unix epoch format. Type: Timestamp ** [status](#API_CreateAlarmModel_ResponseSyntax) ** The status of the alarm model. The status can be one of the following values: + `ACTIVE` - The alarm model is active and it's ready to evaluate data. + `ACTIVATING` - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. + `INACTIVE` - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. + `FAILED` - You couldn't create or update the alarm model. Check your alarm model information and try again. Type: String Valid Values: `ACTIVE | ACTIVATING | INACTIVE | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** LimitExceededException ** A limit was exceeded. ** message ** The message for the exception. HTTP Status Code: 410 ** ResourceAlreadyExistsException ** The resource already exists. ** message ** The message for the exception. ** resourceArn ** The ARN of the resource. ** resourceId ** The ID of the resource. HTTP Status Code: 409 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/CreateAlarmModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/CreateAlarmModel) # CreateDetectorModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Creates a detector model. ## Request Syntax ``` POST /detector-models HTTP/1.1 Content-type: application/json { "detectorModelDefinition": { "initialStateName": "string", "states": [ { "onEnter": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onExit": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onInput": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ], "transitionEvents": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string", "nextState": "string" } ] }, "stateName": "string" } ] }, "detectorModelDescription": "string", "detectorModelName": "string", "evaluationMethod": "string", "key": "string", "roleArn": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [detectorModelDefinition](#API_CreateDetectorModel_RequestSyntax) ** Information that defines how the detectors operate. Type: [DetectorModelDefinition](API_DetectorModelDefinition.md) object Required: Yes ** [detectorModelDescription](#API_CreateDetectorModel_RequestSyntax) ** A brief description of the detector model. Type: String Length Constraints: Maximum length of 1024. Required: No ** [detectorModelName](#API_CreateDetectorModel_RequestSyntax) ** The name of the detector model. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [evaluationMethod](#API_CreateDetectorModel_RequestSyntax) ** Information about the order in which events are evaluated and how actions are executed. Default: `BATCH` Type: String Valid Values: `BATCH | SERIAL` Required: No ** [key](#API_CreateDetectorModel_RequestSyntax) ** The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression in the message payload of each input to specify the attribute-value pair that is used to identify the device associated with the input. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$` Required: No ** [roleArn](#API_CreateDetectorModel_RequestSyntax) ** The ARN of the role that grants permission to AWS IoT Events to perform its operations. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [tags](#API_CreateDetectorModel_RequestSyntax) ** Metadata that can be used to manage the detector model. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "detectorModelConfiguration": { "creationTime": number, "detectorModelArn": "string", "detectorModelDescription": "string", "detectorModelName": "string", "detectorModelVersion": "string", "evaluationMethod": "string", "key": "string", "lastUpdateTime": number, "roleArn": "string", "status": "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. ** [detectorModelConfiguration](#API_CreateDetectorModel_ResponseSyntax) ** Information about how the detector model is configured. Type: [DetectorModelConfiguration](API_DetectorModelConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** LimitExceededException ** A limit was exceeded. ** message ** The message for the exception. HTTP Status Code: 410 ** ResourceAlreadyExistsException ** The resource already exists. ** message ** The message for the exception. ** resourceArn ** The ARN of the resource. ** resourceId ** The ID of the resource. HTTP Status Code: 409 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/CreateDetectorModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/CreateDetectorModel) # CreateInput **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Creates an input. ## Request Syntax ``` POST /inputs HTTP/1.1 Content-type: application/json { "inputDefinition": { "attributes": [ { "jsonPath": "string" } ] }, "inputDescription": "string", "inputName": "string", "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [inputDefinition](#API_CreateInput_RequestSyntax) ** The definition of the input. Type: [InputDefinition](API_InputDefinition.md) object Required: Yes ** [inputDescription](#API_CreateInput_RequestSyntax) ** A brief description of the input. Type: String Length Constraints: Maximum length of 1024. Required: No ** [inputName](#API_CreateInput_RequestSyntax) ** The name you want to give to the input. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$` Required: Yes ** [tags](#API_CreateInput_RequestSyntax) ** Metadata that can be used to manage the input. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` HTTP/1.1 201 Content-type: application/json { "inputConfiguration": { "creationTime": number, "inputArn": "string", "inputDescription": "string", "inputName": "string", "lastUpdateTime": number, "status": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ** [inputConfiguration](#API_CreateInput_ResponseSyntax) ** Information about the configuration of the input. Type: [InputConfiguration](API_InputConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The resource already exists. ** message ** The message for the exception. ** resourceArn ** The ARN of the resource. ** resourceId ** The ID of the resource. HTTP Status Code: 409 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/CreateInput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/CreateInput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/CreateInput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/CreateInput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/CreateInput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/CreateInput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/CreateInput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/CreateInput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/CreateInput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/CreateInput) # DeleteAlarmModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone. ## Request Syntax ``` DELETE /alarm-models/alarmModelName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [alarmModelName](#API_DeleteAlarmModel_RequestSyntax) ** The name of the alarm model. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DeleteAlarmModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DeleteAlarmModel) # DeleteDetectorModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Deletes a detector model. Any active instances of the detector model are also deleted. ## Request Syntax ``` DELETE /detector-models/detectorModelName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [detectorModelName](#API_DeleteDetectorModel_RequestSyntax) ** The name of the detector model to be deleted. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 204 ``` ## Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DeleteDetectorModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DeleteDetectorModel) # DeleteInput **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Deletes an input. ## Request Syntax ``` DELETE /inputs/inputName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [inputName](#API_DeleteInput_RequestSyntax) ** The name of the input to delete. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DeleteInput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DeleteInput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DeleteInput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DeleteInput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DeleteInput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DeleteInput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DeleteInput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DeleteInput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DeleteInput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DeleteInput) # DescribeAlarmModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Retrieves information about an alarm model. If you don't specify a value for the `alarmModelVersion` parameter, the latest version is returned. ## Request Syntax ``` GET /alarm-models/alarmModelName?version=alarmModelVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [alarmModelName](#API_DescribeAlarmModel_RequestSyntax) ** The name of the alarm model. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [alarmModelVersion](#API_DescribeAlarmModel_RequestSyntax) ** The version of the alarm model. Length Constraints: Minimum length of 1. Maximum length of 128. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "alarmCapabilities": { "acknowledgeFlow": { "enabled": boolean }, "initializationConfiguration": { "disabledOnInitialization": boolean } }, "alarmEventActions": { "alarmActions": [ { "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ] }, "alarmModelArn": "string", "alarmModelDescription": "string", "alarmModelName": "string", "alarmModelVersion": "string", "alarmNotification": { "notificationActions": [ { "action": { "lambdaAction": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } } }, "emailConfigurations": [ { "content": { "additionalMessage": "string", "subject": "string" }, "from": "string", "recipients": { "to": [ { "ssoIdentity": { "identityStoreId": "string", "userId": "string" } } ] } } ], "smsConfigurations": [ { "additionalMessage": "string", "recipients": [ { "ssoIdentity": { "identityStoreId": "string", "userId": "string" } } ], "senderId": "string" } ] } ] }, "alarmRule": { "simpleRule": { "comparisonOperator": "string", "inputProperty": "string", "threshold": "string" } }, "creationTime": number, "key": "string", "lastUpdateTime": number, "roleArn": "string", "severity": number, "status": "string", "statusMessage": "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. ** [alarmCapabilities](#API_DescribeAlarmModel_ResponseSyntax) ** Contains the configuration information of alarm state changes. Type: [AlarmCapabilities](API_AlarmCapabilities.md) object ** [alarmEventActions](#API_DescribeAlarmModel_ResponseSyntax) ** Contains information about one or more alarm actions. Type: [AlarmEventActions](API_AlarmEventActions.md) object ** [alarmModelArn](#API_DescribeAlarmModel_ResponseSyntax) ** The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String ** [alarmModelDescription](#API_DescribeAlarmModel_ResponseSyntax) ** The description of the alarm model. Type: String Length Constraints: Maximum length of 1024. ** [alarmModelName](#API_DescribeAlarmModel_ResponseSyntax) ** The name of the alarm model. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` ** [alarmModelVersion](#API_DescribeAlarmModel_ResponseSyntax) ** The version of the alarm model. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ** [alarmNotification](#API_DescribeAlarmModel_ResponseSyntax) ** Contains information about one or more notification actions. Type: [AlarmNotification](API_AlarmNotification.md) object ** [alarmRule](#API_DescribeAlarmModel_ResponseSyntax) ** Defines when your alarm is invoked. Type: [AlarmRule](API_AlarmRule.md) object ** [creationTime](#API_DescribeAlarmModel_ResponseSyntax) ** The time the alarm model was created, in the Unix epoch format. Type: Timestamp ** [key](#API_DescribeAlarmModel_ResponseSyntax) ** An input attribute used as a key to create an alarm. AWS IoT Events routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w- ]+`)|([\w\-]+)))*$` ** [lastUpdateTime](#API_DescribeAlarmModel_ResponseSyntax) ** The time the alarm model was last updated, in the Unix epoch format. Type: Timestamp ** [roleArn](#API_DescribeAlarmModel_ResponseSyntax) ** The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [severity](#API_DescribeAlarmModel_ResponseSyntax) ** A non-negative integer that reflects the severity level of the alarm. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. ** [status](#API_DescribeAlarmModel_ResponseSyntax) ** The status of the alarm model. The status can be one of the following values: + `ACTIVE` - The alarm model is active and it's ready to evaluate data. + `ACTIVATING` - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. + `INACTIVE` - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. + `FAILED` - You couldn't create or update the alarm model. Check your alarm model information and try again. Type: String Valid Values: `ACTIVE | ACTIVATING | INACTIVE | FAILED` ** [statusMessage](#API_DescribeAlarmModel_ResponseSyntax) ** Contains information about the status of the alarm model. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DescribeAlarmModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DescribeAlarmModel) # DescribeDetectorModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Describes a detector model. If the `version` parameter is not specified, information about the latest version is returned. ## Request Syntax ``` GET /detector-models/detectorModelName?version=detectorModelVersion HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [detectorModelName](#API_DescribeDetectorModel_RequestSyntax) ** The name of the detector model. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [detectorModelVersion](#API_DescribeDetectorModel_RequestSyntax) ** The version of the detector model. Length Constraints: Minimum length of 1. Maximum length of 128. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "detectorModel": { "detectorModelConfiguration": { "creationTime": number, "detectorModelArn": "string", "detectorModelDescription": "string", "detectorModelName": "string", "detectorModelVersion": "string", "evaluationMethod": "string", "key": "string", "lastUpdateTime": number, "roleArn": "string", "status": "string" }, "detectorModelDefinition": { "initialStateName": "string", "states": [ { "onEnter": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onExit": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onInput": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ], "transitionEvents": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string", "nextState": "string" } ] }, "stateName": "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. ** [detectorModel](#API_DescribeDetectorModel_ResponseSyntax) ** Information about the detector model. Type: [DetectorModel](API_DetectorModel.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DescribeDetectorModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DescribeDetectorModel) # DescribeDetectorModelAnalysis **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Retrieves runtime information about a detector model analysis. **Note** After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. ## Request Syntax ``` GET /analysis/detector-models/analysisId HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisId](#API_DescribeDetectorModelAnalysis_RequestSyntax) ** The ID of the analysis result that you want to retrieve. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "status": "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. ** [status](#API_DescribeDetectorModelAnalysis_ResponseSyntax) ** The status of the analysis activity. The status can be one of the following values: + `RUNNING` - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete. + `COMPLETE` - AWS IoT Events finished analyzing your detector model. + `FAILED` - AWS IoT Events couldn't analyze your detector model. Try again later. Type: String Valid Values: `RUNNING | COMPLETE | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DescribeDetectorModelAnalysis) # DescribeInput **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Describes an input. ## Request Syntax ``` GET /inputs/inputName HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [inputName](#API_DescribeInput_RequestSyntax) ** The name of the input. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$` Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "input": { "inputConfiguration": { "creationTime": number, "inputArn": "string", "inputDescription": "string", "inputName": "string", "lastUpdateTime": number, "status": "string" }, "inputDefinition": { "attributes": [ { "jsonPath": "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. ** [input](#API_DescribeInput_ResponseSyntax) ** Information about the input. Type: [Input](API_Input.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DescribeInput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DescribeInput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DescribeInput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DescribeInput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DescribeInput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DescribeInput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DescribeInput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DescribeInput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DescribeInput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DescribeInput) # DescribeLoggingOptions **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Retrieves the current settings of the AWS IoT Events logging options. ## Request Syntax ``` GET /logging HTTP/1.1 ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "loggingOptions": { "detectorDebugOptions": [ { "detectorModelName": "string", "keyValue": "string" } ], "enabled": boolean, "level": "string", "roleArn": "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. ** [loggingOptions](#API_DescribeLoggingOptions_ResponseSyntax) ** The current settings of the AWS IoT Events logging options. Type: [LoggingOptions](API_LoggingOptions.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ** UnsupportedOperationException ** The requested operation is not supported. ** message ** The message for the exception. HTTP Status Code: 501 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/DescribeLoggingOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/DescribeLoggingOptions) # GetDetectorModelAnalysisResults **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Retrieves one or more analysis results of the detector model. **Note** After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. ## Request Syntax ``` GET /analysis/detector-models/analysisId/results?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [analysisId](#API_GetDetectorModelAnalysisResults_RequestSyntax) ** The ID of the analysis result that you want to retrieve. Required: Yes ** [maxResults](#API_GetDetectorModelAnalysisResults_RequestSyntax) ** The maximum number of results to be returned per request. ** [nextToken](#API_GetDetectorModelAnalysisResults_RequestSyntax) ** The token that you can use to return the next set of results. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisResults": [ { "level": "string", "locations": [ { "path": "string" } ], "message": "string", "type": "string" } ], "nextToken": "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. ** [analysisResults](#API_GetDetectorModelAnalysisResults_ResponseSyntax) ** Contains information about one or more analysis results. Type: Array of [AnalysisResult](API_AnalysisResult.md) objects ** [nextToken](#API_GetDetectorModelAnalysisResults_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/GetDetectorModelAnalysisResults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/GetDetectorModelAnalysisResults) # ListAlarmModels **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model. ## Request Syntax ``` GET /alarm-models?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListAlarmModels_RequestSyntax) ** The maximum number of results to be returned per request. Valid Range: Minimum value of 1. Maximum value of 250. ** [nextToken](#API_ListAlarmModels_RequestSyntax) ** The token that you can use to return the next set of results. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "alarmModelSummaries": [ { "alarmModelDescription": "string", "alarmModelName": "string", "creationTime": number } ], "nextToken": "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. ** [alarmModelSummaries](#API_ListAlarmModels_ResponseSyntax) ** A list that summarizes each alarm model. Type: Array of [AlarmModelSummary](API_AlarmModelSummary.md) objects ** [nextToken](#API_ListAlarmModels_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListAlarmModels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListAlarmModels) # ListAlarmModelVersions **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version. ## Request Syntax ``` GET /alarm-models/alarmModelName/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [alarmModelName](#API_ListAlarmModelVersions_RequestSyntax) ** The name of the alarm model. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [maxResults](#API_ListAlarmModelVersions_RequestSyntax) ** The maximum number of results to be returned per request. Valid Range: Minimum value of 1. Maximum value of 250. ** [nextToken](#API_ListAlarmModelVersions_RequestSyntax) ** The token that you can use to return the next set of results. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "alarmModelVersionSummaries": [ { "alarmModelArn": "string", "alarmModelName": "string", "alarmModelVersion": "string", "creationTime": number, "lastUpdateTime": number, "roleArn": "string", "status": "string", "statusMessage": "string" } ], "nextToken": "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. ** [alarmModelVersionSummaries](#API_ListAlarmModelVersions_ResponseSyntax) ** A list that summarizes each alarm model version. Type: Array of [AlarmModelVersionSummary](API_AlarmModelVersionSummary.md) objects ** [nextToken](#API_ListAlarmModelVersions_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListAlarmModelVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListAlarmModelVersions) # ListDetectorModels **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists the detector models you have created. Only the metadata associated with each detector model is returned. ## Request Syntax ``` GET /detector-models?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListDetectorModels_RequestSyntax) ** The maximum number of results to be returned per request. Valid Range: Minimum value of 1. Maximum value of 250. ** [nextToken](#API_ListDetectorModels_RequestSyntax) ** The token that you can use to return the next set of results. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "detectorModelSummaries": [ { "creationTime": number, "detectorModelDescription": "string", "detectorModelName": "string" } ], "nextToken": "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. ** [detectorModelSummaries](#API_ListDetectorModels_ResponseSyntax) ** Summary information about the detector models. Type: Array of [DetectorModelSummary](API_DetectorModelSummary.md) objects ** [nextToken](#API_ListDetectorModels_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListDetectorModels) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListDetectorModels) # ListDetectorModelVersions **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. ## Request Syntax ``` GET /detector-models/detectorModelName/versions?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [detectorModelName](#API_ListDetectorModelVersions_RequestSyntax) ** The name of the detector model whose versions are returned. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ** [maxResults](#API_ListDetectorModelVersions_RequestSyntax) ** The maximum number of results to be returned per request. Valid Range: Minimum value of 1. Maximum value of 250. ** [nextToken](#API_ListDetectorModelVersions_RequestSyntax) ** The token that you can use to return the next set of results. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "detectorModelVersionSummaries": [ { "creationTime": number, "detectorModelArn": "string", "detectorModelName": "string", "detectorModelVersion": "string", "evaluationMethod": "string", "lastUpdateTime": number, "roleArn": "string", "status": "string" } ], "nextToken": "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. ** [detectorModelVersionSummaries](#API_ListDetectorModelVersions_ResponseSyntax) ** Summary information about the detector model versions. Type: Array of [DetectorModelVersionSummary](API_DetectorModelVersionSummary.md) objects ** [nextToken](#API_ListDetectorModelVersions_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListDetectorModelVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListDetectorModelVersions) # ListInputRoutings **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists one or more input routings. ## Request Syntax ``` POST /input-routings HTTP/1.1 Content-type: application/json { "inputIdentifier": { "iotEventsInputIdentifier": { "inputName": "string" }, "iotSiteWiseInputIdentifier": { "iotSiteWiseAssetModelPropertyIdentifier": { "assetModelId": "string", "propertyId": "string" } } }, "maxResults": number, "nextToken": "string" } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [inputIdentifier](#API_ListInputRoutings_RequestSyntax) ** The identifier of the routed input. Type: [InputIdentifier](API_InputIdentifier.md) object Required: Yes ** [maxResults](#API_ListInputRoutings_RequestSyntax) ** The maximum number of results to be returned per request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 250. Required: No ** [nextToken](#API_ListInputRoutings_RequestSyntax) ** The token that you can use to return the next set of results. Type: String Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "routedResources": [ { "arn": "string", "name": "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. ** [nextToken](#API_ListInputRoutings_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ** [routedResources](#API_ListInputRoutings_ResponseSyntax) ** Summary information about the routed resources. Type: Array of [RoutedResource](API_RoutedResource.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListInputRoutings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListInputRoutings) # ListInputs **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists the inputs you have created. ## Request Syntax ``` GET /inputs?maxResults=maxResults&nextToken=nextToken HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [maxResults](#API_ListInputs_RequestSyntax) ** The maximum number of results to be returned per request. Valid Range: Minimum value of 1. Maximum value of 250. ** [nextToken](#API_ListInputs_RequestSyntax) ** The token that you can use to return the next set of results. ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "inputSummaries": [ { "creationTime": number, "inputArn": "string", "inputDescription": "string", "inputName": "string", "lastUpdateTime": number, "status": "string" } ], "nextToken": "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. ** [inputSummaries](#API_ListInputs_ResponseSyntax) ** Summary information about the inputs. Type: Array of [InputSummary](API_InputSummary.md) objects ** [nextToken](#API_ListInputs_ResponseSyntax) ** The token that you can use to return the next set of results, or `null` if there are no more results. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListInputs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListInputs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListInputs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListInputs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListInputs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListInputs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListInputs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListInputs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListInputs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListInputs) # ListTagsForResource **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Lists the tags (metadata) you have assigned to the resource. ## Request Syntax ``` GET /tags?resourceArn=resourceArn HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_ListTagsForResource_RequestSyntax) ** The ARN of the resource. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "tags": [ { "key": "string", "value": "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. ** [tags](#API_ListTagsForResource_ResponseSyntax) ** The list of tags assigned to the resource. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/ListTagsForResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/ListTagsForResource) # PutLoggingOptions **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Sets or updates the AWS IoT Events logging options. If you update the value of any `loggingOptions` field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the `roleArn` field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect. ## Request Syntax ``` PUT /logging HTTP/1.1 Content-type: application/json { "loggingOptions": { "detectorDebugOptions": [ { "detectorModelName": "string", "keyValue": "string" } ], "enabled": boolean, "level": "string", "roleArn": "string" } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [loggingOptions](#API_PutLoggingOptions_RequestSyntax) ** The new values of the AWS IoT Events logging options. Type: [LoggingOptions](API_LoggingOptions.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ** UnsupportedOperationException ** The requested operation is not supported. ** message ** The message for the exception. HTTP Status Code: 501 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/PutLoggingOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/PutLoggingOptions) # StartDetectorModelAnalysis **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Analyzes your detector model. For more information, see [Troubleshooting a detector model](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html) in the * AWS IoT Events Developer Guide*. ## Request Syntax ``` POST /analysis/detector-models/ HTTP/1.1 Content-type: application/json { "detectorModelDefinition": { "initialStateName": "string", "states": [ { "onEnter": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onExit": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onInput": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ], "transitionEvents": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string", "nextState": "string" } ] }, "stateName": "string" } ] } } ``` ## URI Request Parameters The request does not use any URI parameters. ## Request Body The request accepts the following data in JSON format. ** [detectorModelDefinition](#API_StartDetectorModelAnalysis_RequestSyntax) ** Information that defines how a detector operates. Type: [DetectorModelDefinition](API_DetectorModelDefinition.md) object Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "analysisId": "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. ** [analysisId](#API_StartDetectorModelAnalysis_ResponseSyntax) ** The ID that you use to retrieve the analysis result. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** LimitExceededException ** A limit was exceeded. ** message ** The message for the exception. HTTP Status Code: 410 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/StartDetectorModelAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/StartDetectorModelAnalysis) # TagResource **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. ## Request Syntax ``` POST /tags?resourceArn=resourceArn HTTP/1.1 Content-type: application/json { "tags": [ { "key": "string", "value": "string" } ] } ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_TagResource_RequestSyntax) ** The ARN of the resource. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [tags](#API_TagResource_RequestSyntax) ** The new or modified tags for the resource. Type: Array of [Tag](API_Tag.md) objects Required: Yes ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** LimitExceededException ** A limit was exceeded. ** message ** The message for the exception. HTTP Status Code: 410 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/TagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/TagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/TagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/TagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/TagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/TagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/TagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/TagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/TagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/TagResource) # UntagResource **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Removes the given tags (metadata) from the resource. ## Request Syntax ``` DELETE /tags?resourceArn=resourceArn&tagKeys=tagKeys HTTP/1.1 ``` ## URI Request Parameters The request uses the following URI parameters. ** [resourceArn](#API_UntagResource_RequestSyntax) ** The ARN of the resource. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [tagKeys](#API_UntagResource_RequestSyntax) ** A list of the keys of the tags to be removed from the resource. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ## Request Body The request does not have a request body. ## Response Syntax ``` HTTP/1.1 200 ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/UntagResource) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/UntagResource) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/UntagResource) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/UntagResource) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/UntagResource) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/UntagResource) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/UntagResource) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/UntagResource) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/UntagResource) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/UntagResource) # UpdateAlarmModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives. ## Request Syntax ``` POST /alarm-models/alarmModelName HTTP/1.1 Content-type: application/json { "alarmCapabilities": { "acknowledgeFlow": { "enabled": boolean }, "initializationConfiguration": { "disabledOnInitialization": boolean } }, "alarmEventActions": { "alarmActions": [ { "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ] }, "alarmModelDescription": "string", "alarmNotification": { "notificationActions": [ { "action": { "lambdaAction": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } } }, "emailConfigurations": [ { "content": { "additionalMessage": "string", "subject": "string" }, "from": "string", "recipients": { "to": [ { "ssoIdentity": { "identityStoreId": "string", "userId": "string" } } ] } } ], "smsConfigurations": [ { "additionalMessage": "string", "recipients": [ { "ssoIdentity": { "identityStoreId": "string", "userId": "string" } } ], "senderId": "string" } ] } ] }, "alarmRule": { "simpleRule": { "comparisonOperator": "string", "inputProperty": "string", "threshold": "string" } }, "roleArn": "string", "severity": number } ``` ## URI Request Parameters The request uses the following URI parameters. ** [alarmModelName](#API_UpdateAlarmModel_RequestSyntax) ** The name of the alarm model. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [alarmCapabilities](#API_UpdateAlarmModel_RequestSyntax) ** Contains the configuration information of alarm state changes. Type: [AlarmCapabilities](API_AlarmCapabilities.md) object Required: No ** [alarmEventActions](#API_UpdateAlarmModel_RequestSyntax) ** Contains information about one or more alarm actions. Type: [AlarmEventActions](API_AlarmEventActions.md) object Required: No ** [alarmModelDescription](#API_UpdateAlarmModel_RequestSyntax) ** The description of the alarm model. Type: String Length Constraints: Maximum length of 1024. Required: No ** [alarmNotification](#API_UpdateAlarmModel_RequestSyntax) ** Contains information about one or more notification actions. Type: [AlarmNotification](API_AlarmNotification.md) object Required: No ** [alarmRule](#API_UpdateAlarmModel_RequestSyntax) ** Defines when your alarm is invoked. Type: [AlarmRule](API_AlarmRule.md) object Required: Yes ** [roleArn](#API_UpdateAlarmModel_RequestSyntax) ** The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ** [severity](#API_UpdateAlarmModel_RequestSyntax) ** A non-negative integer that reflects the severity level of the alarm. Type: Integer Valid Range: Minimum value of 0. Maximum value of 2147483647. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "alarmModelArn": "string", "alarmModelVersion": "string", "creationTime": number, "lastUpdateTime": number, "status": "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. ** [alarmModelArn](#API_UpdateAlarmModel_ResponseSyntax) ** The ARN of the alarm model. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the * AWS General Reference*. Type: String ** [alarmModelVersion](#API_UpdateAlarmModel_ResponseSyntax) ** The version of the alarm model. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ** [creationTime](#API_UpdateAlarmModel_ResponseSyntax) ** The time the alarm model was created, in the Unix epoch format. Type: Timestamp ** [lastUpdateTime](#API_UpdateAlarmModel_ResponseSyntax) ** The time the alarm model was last updated, in the Unix epoch format. Type: Timestamp ** [status](#API_UpdateAlarmModel_ResponseSyntax) ** The status of the alarm model. The status can be one of the following values: + `ACTIVE` - The alarm model is active and it's ready to evaluate data. + `ACTIVATING` - AWS IoT Events is activating your alarm model. Activating an alarm model can take up to a few minutes. + `INACTIVE` - The alarm model is inactive, so it isn't ready to evaluate data. Check your alarm model information and update the alarm model. + `FAILED` - You couldn't create or update the alarm model. Check your alarm model information and try again. Type: String Valid Values: `ACTIVE | ACTIVATING | INACTIVE | FAILED` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/UpdateAlarmModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/UpdateAlarmModel) # UpdateDetectorModel **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. ## Request Syntax ``` POST /detector-models/detectorModelName HTTP/1.1 Content-type: application/json { "detectorModelDefinition": { "initialStateName": "string", "states": [ { "onEnter": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onExit": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ] }, "onInput": { "events": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string" } ], "transitionEvents": [ { "actions": [ { "clearTimer": { "timerName": "string" }, "dynamoDB": { "hashKeyField": "string", "hashKeyType": "string", "hashKeyValue": "string", "operation": "string", "payload": { "contentExpression": "string", "type": "string" }, "payloadField": "string", "rangeKeyField": "string", "rangeKeyType": "string", "rangeKeyValue": "string", "tableName": "string" }, "dynamoDBv2": { "payload": { "contentExpression": "string", "type": "string" }, "tableName": "string" }, "firehose": { "deliveryStreamName": "string", "payload": { "contentExpression": "string", "type": "string" }, "separator": "string" }, "iotEvents": { "inputName": "string", "payload": { "contentExpression": "string", "type": "string" } }, "iotSiteWise": { "assetId": "string", "entryId": "string", "propertyAlias": "string", "propertyId": "string", "propertyValue": { "quality": "string", "timestamp": { "offsetInNanos": "string", "timeInSeconds": "string" }, "value": { "booleanValue": "string", "doubleValue": "string", "integerValue": "string", "stringValue": "string" } } }, "iotTopicPublish": { "mqttTopic": "string", "payload": { "contentExpression": "string", "type": "string" } }, "lambda": { "functionArn": "string", "payload": { "contentExpression": "string", "type": "string" } }, "resetTimer": { "timerName": "string" }, "setTimer": { "durationExpression": "string", "seconds": number, "timerName": "string" }, "setVariable": { "value": "string", "variableName": "string" }, "sns": { "payload": { "contentExpression": "string", "type": "string" }, "targetArn": "string" }, "sqs": { "payload": { "contentExpression": "string", "type": "string" }, "queueUrl": "string", "useBase64": boolean } } ], "condition": "string", "eventName": "string", "nextState": "string" } ] }, "stateName": "string" } ] }, "detectorModelDescription": "string", "evaluationMethod": "string", "roleArn": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [detectorModelName](#API_UpdateDetectorModel_RequestSyntax) ** The name of the detector model that is updated. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z0-9_-]+$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [detectorModelDefinition](#API_UpdateDetectorModel_RequestSyntax) ** Information that defines how a detector operates. Type: [DetectorModelDefinition](API_DetectorModelDefinition.md) object Required: Yes ** [detectorModelDescription](#API_UpdateDetectorModel_RequestSyntax) ** A brief description of the detector model. Type: String Length Constraints: Maximum length of 1024. Required: No ** [evaluationMethod](#API_UpdateDetectorModel_RequestSyntax) ** Information about the order in which events are evaluated and how actions are executed. Type: String Valid Values: `BATCH | SERIAL` Required: No ** [roleArn](#API_UpdateDetectorModel_RequestSyntax) ** The ARN of the role that grants permission to AWS IoT Events to perform its operations. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "detectorModelConfiguration": { "creationTime": number, "detectorModelArn": "string", "detectorModelDescription": "string", "detectorModelName": "string", "detectorModelVersion": "string", "evaluationMethod": "string", "key": "string", "lastUpdateTime": number, "roleArn": "string", "status": "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. ** [detectorModelConfiguration](#API_UpdateDetectorModel_ResponseSyntax) ** Information about how the detector model is configured. Type: [DetectorModelConfiguration](API_DetectorModelConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/UpdateDetectorModel) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/UpdateDetectorModel) # UpdateInput **Important** End of support notice: On May 20,2026, AWS will end support for AWS IoT Events. After May 20,2026, you will no longer be able to access the AWS IoT Events console or AWS IoT Events resources. For more information, see [AWS IoT Events end of support](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-end-of-support.html). Updates an input. ## Request Syntax ``` PUT /inputs/inputName HTTP/1.1 Content-type: application/json { "inputDefinition": { "attributes": [ { "jsonPath": "string" } ] }, "inputDescription": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [inputName](#API_UpdateInput_RequestSyntax) ** The name of the input you want to update. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: `^[a-zA-Z][a-zA-Z0-9_]*$` Required: Yes ## Request Body The request accepts the following data in JSON format. ** [inputDefinition](#API_UpdateInput_RequestSyntax) ** The definition of the input. Type: [InputDefinition](API_InputDefinition.md) object Required: Yes ** [inputDescription](#API_UpdateInput_RequestSyntax) ** A brief description of the input. Type: String Length Constraints: Maximum length of 1024. Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "inputConfiguration": { "creationTime": number, "inputArn": "string", "inputDescription": "string", "inputName": "string", "lastUpdateTime": number, "status": "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. ** [inputConfiguration](#API_UpdateInput_ResponseSyntax) ** Information about the configuration of the input. Type: [InputConfiguration](API_InputConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InternalFailureException ** An internal failure occurred. ** message ** The message for the exception. HTTP Status Code: 500 ** InvalidRequestException ** The request was invalid. ** message ** The message for the exception. HTTP Status Code: 400 ** ResourceInUseException ** The resource is in use. ** message ** The message for the exception. HTTP Status Code: 409 ** ResourceNotFoundException ** The resource was not found. ** message ** The message for the exception. HTTP Status Code: 404 ** ServiceUnavailableException ** The service is currently unavailable. ** message ** The message for the exception. HTTP Status Code: 503 ** ThrottlingException ** The request could not be completed due to throttling. ** message ** The message for the exception. HTTP Status Code: 429 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/iotevents-2018-07-27/UpdateInput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/iotevents-2018-07-27/UpdateInput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/iotevents-2018-07-27/UpdateInput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/iotevents-2018-07-27/UpdateInput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/iotevents-2018-07-27/UpdateInput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/iotevents-2018-07-27/UpdateInput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/iotevents-2018-07-27/UpdateInput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/iotevents-2018-07-27/UpdateInput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/iotevents-2018-07-27/UpdateInput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/iotevents-2018-07-27/UpdateInput)