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.

inputConﬁguration (p. 23)

Information about the conﬁguration of the input.

Type: InputConﬁguration (p. 181) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400

CreateInput

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

DELETE /alarm-models/alarmModelName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

alarmModelName (p. 25)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

DeleteAlarmModel

HTTP Status Code: 409 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

DELETE /detector-models/detectorModelName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

detectorModelName (p. 27)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400

DeleteDetectorModel

ResourceNotFoundException The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

DELETE /inputs/inputName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

inputName (p. 29)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400

DeleteInput

ResourceNotFoundException The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

GET /alarm-models/alarmModelName?version=alarmModelVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

alarmModelName (p. 31)

The name of the alarm model.

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

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

Required: Yes

alarmModelVersion (p. 31)

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",

DescribeAlarmModel

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 (p. 31)

Contains the conﬁguration information of alarm state changes.

Type: AlarmCapabilities (p. 145) object alarmEventActions (p. 31)

Contains information about one or more alarm actions.

Type: AlarmEventActions (p. 146) object alarmModelArn (p. 31)

The ARN of the alarm model. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

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

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

alarmModelVersion (p. 31)

The version of the alarm model.

Type: String

DescribeAlarmModel

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

alarmNotiﬁcation (p. 31)

Contains information about one or more notiﬁcation actions.

Type: AlarmNotiﬁcation (p. 150) object alarmRule (p. 31)

Deﬁnes when your alarm is invoked.

Type: AlarmRule (p. 151) object creationTime (p. 31)

The time the alarm model was created, in the Unix epoch format.

Type: Timestamp key (p. 31)

An input attribute used as a key to create an alarm. AWS IoT Events routes inputs 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 (p. 31)

The time the alarm model was last updated, in the Unix epoch format.

Type: Timestamp roleArn (p. 31)

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) in the AWS General Reference.

Type: String

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

severity (p. 31)

A non-negative integer that reﬂects the severity level of the alarm.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

status (p. 31)

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.

DescribeAlarmModel

Valid Values: ACTIVE | ACTIVATING | INACTIVE | FAILED statusMessage (p. 31)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

GET /detector-models/detectorModelName?version=detectorModelVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

detectorModelName (p. 37)

The name of the detector model.

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

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

Required: Yes

detectorModelVersion (p. 37)

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",

DescribeDetectorModel

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

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

DescribeDetectorModel

detectorModel (p. 37)

Information about the detector model.

Type: DetectorModel (p. 162) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

GET /analysis/detector-models/analysisId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

analysisId (p. 46)

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 (p. 46)

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 ﬁnished analyzing your detector model.

• FAILED - AWS IoT Events couldn't analyze your detector model. Try again later.

Type: String

Valid Values: RUNNING | COMPLETE | FAILED

DescribeDetectorModelAnalysis

Errors

For information about the errors that are common to all actions, see Common Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

GET /inputs/inputName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

inputName (p. 48)

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.

DescribeInput

input (p. 48)

Information about the input.

Type: Input (p. 180) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

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 (p. 50)

The current settings of the AWS IoT Events logging options.

Type: LoggingOptions (p. 195) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 263).

InternalFailureException An internal failure occurred.

DescribeLoggingOptions

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429 UnsupportedOperationException

The requested operation is not supported.

HTTP Status Code: 501

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 (p. 52)

The ID of the analysis result that you want to retrieve.

Required: Yes maxResults (p. 52)

The maximum number of results to be returned per request.

nextToken (p. 52)

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"

}

GetDetectorModelAnalysisResults

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 (p. 52)

Contains information about one or more analysis results.

Type: Array of AnalysisResult (p. 152) objects nextToken (p. 52)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Request Syntax

GET /alarm-models?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults (p. 55)

The maximum number of results to be returned per request.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 55)

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.

ListAlarmModels

nextToken (p. 55)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

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 (p. 57)

The name of the alarm model.

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

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

Required: Yes maxResults (p. 57)

The maximum number of results to be returned per request.

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken (p. 57)

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",

ListAlarmModelVersions

}

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 (p. 57)

A list that summarizes each alarm model version.

Type: Array of AlarmModelVersionSummary (p. 148) objects nextToken (p. 57)

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 Errors (p. 263).

InternalFailureException An internal failure occurred.

HTTP Status Code: 500 InvalidRequestException

The request was invalid.

HTTP Status Code: 400 ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404 ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503 ThrottlingException

The request could not be completed due to throttling.

HTTP Status Code: 429

Response Elements

Response Elements

Errors

See Also

DeleteAlarmModel

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteDetectorModel

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteInput

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DescribeAlarmModel

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Errors

See Also

DescribeDetectorModel

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Errors

See Also

DescribeDetectorModelAnalysis

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DescribeInput

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DescribeLoggingOptions

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

GetDetectorModelAnalysisResults

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

ListAlarmModels

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements