@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AWS IoT Events Data
@version 2018-10-23
@auth AWS SigV4
@endpoints 12
@toc alarms(7), detectors(4), inputs(1)

@group alarms
@endpoint POST /alarms/acknowledge
@required {acknowledgeActionRequests: [AcknowledgeAlarmActionRequest]}
@returns(200) {errorEntries: [BatchAlarmActionErrorEntry]?}

@endgroup

@group detectors
@endpoint POST /detectors/delete
@required {detectors: [DeleteDetectorRequest]}
@returns(200) {batchDeleteDetectorErrorEntries: [BatchDeleteDetectorErrorEntry]?}

@endgroup

@group alarms
@endpoint POST /alarms/disable
@required {disableActionRequests: [DisableAlarmActionRequest]}
@returns(200) {errorEntries: [BatchAlarmActionErrorEntry]?}

@endpoint POST /alarms/enable
@required {enableActionRequests: [EnableAlarmActionRequest]}
@returns(200) {errorEntries: [BatchAlarmActionErrorEntry]?}

@endgroup

@group inputs
@endpoint POST /inputs/messages
@required {messages: [Message]}
@returns(200) {BatchPutMessageErrorEntries: [BatchPutMessageErrorEntry]?}

@endgroup

@group alarms
@endpoint POST /alarms/reset
@required {resetActionRequests: [ResetAlarmActionRequest]}
@returns(200) {errorEntries: [BatchAlarmActionErrorEntry]?}

@endpoint POST /alarms/snooze
@required {snoozeActionRequests: [SnoozeAlarmActionRequest]}
@returns(200) {errorEntries: [BatchAlarmActionErrorEntry]?}

@endgroup

@group detectors
@endpoint POST /detectors
@required {detectors: [UpdateDetectorRequest]}
@returns(200) {batchUpdateDetectorErrorEntries: [BatchUpdateDetectorErrorEntry]?}

@endgroup

@group alarms
@endpoint GET /alarms/{alarmModelName}/keyValues/
@required {alarmModelName: str}
@optional {keyValue: str}
@returns(200) {alarm: Alarm?{alarmModelName: str?, alarmModelVersion: str?, keyValue: str?, alarmState: AlarmState?{stateName: str?, ruleEvaluation: RuleEvaluation?{simpleRuleEvaluation: SimpleRuleEvaluation?}, customerAction: CustomerAction?{actionName: str?, snoozeActionConfiguration: SnoozeActionConfiguration?, enableActionConfiguration: EnableActionConfiguration?, disableActionConfiguration: DisableActionConfiguration?, acknowledgeActionConfiguration: AcknowledgeActionConfiguration?, resetActionConfiguration: ResetActionConfiguration?}, systemEvent: SystemEvent?{eventType: str?, stateChangeConfiguration: StateChangeConfiguration?}}, severity: int?, creationTime: str(timestamp)?, lastUpdateTime: str(timestamp)?}}

@endgroup

@group detectors
@endpoint GET /detectors/{detectorModelName}/keyValues/
@required {detectorModelName: str}
@optional {keyValue: str}
@returns(200) {detector: Detector?{detectorModelName: str?, keyValue: str?, detectorModelVersion: str?, state: DetectorState?{stateName: str, variables: [Variable], timers: [Timer]}, creationTime: str(timestamp)?, lastUpdateTime: str(timestamp)?}}

@endgroup

@group alarms
@endpoint GET /alarms/{alarmModelName}
@required {alarmModelName: str}
@optional {nextToken: str, maxResults: int}
@returns(200) {alarmSummaries: [AlarmSummary]?, nextToken: str?}

@endgroup

@group detectors
@endpoint GET /detectors/{detectorModelName}
@required {detectorModelName: str}
@optional {stateName: str, nextToken: str, maxResults: int}
@returns(200) {detectorSummaries: [DetectorSummary]?, nextToken: str?}

@endgroup

@end