AWS IoT Events Data 2018-10-23
- Client: Aws\IoTEventsData\IoTEventsDataClient
- Service ID: iotevents-data
- Version: 2018-10-23
This page describes the parameters and results for the operations of the AWS IoT Events Data (2018-10-23), and shows how to use the Aws\IoTEventsData\IoTEventsDataClient object to call the described operations. This documentation is specific to the 2018-10-23 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- BatchAcknowledgeAlarm ( array $params = [] )
Acknowledges one or more alarms.
- BatchDisableAlarm ( array $params = [] )
Disables one or more alarms.
- BatchEnableAlarm ( array $params = [] )
Enables one or more alarms.
- BatchPutMessage ( array $params = [] )
Sends a set of messages to the AWS IoT Events system.
- BatchResetAlarm ( array $params = [] )
Resets one or more alarms.
- BatchSnoozeAlarm ( array $params = [] )
Changes one or more alarms to the snooze mode.
- BatchUpdateDetector ( array $params = [] )
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
- DescribeAlarm ( array $params = [] )
Retrieves information about an alarm.
- DescribeDetector ( array $params = [] )
Returns information about the specified detector (instance).
- ListAlarms ( array $params = [] )
Lists one or more alarms.
- ListDetectors ( array $params = [] )
Lists detectors (the instances of a detector model).
Operations
BatchAcknowledgeAlarm
$result = $client->batchAcknowledgeAlarm([/* ... */]); $promise = $client->batchAcknowledgeAlarmAsync([/* ... */]);
Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.
Parameter Syntax
$result = $client->batchAcknowledgeAlarm([
'acknowledgeActionRequests' => [ // REQUIRED
[
'alarmModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
'note' => '<string>',
'requestId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- acknowledgeActionRequests
-
- Required: Yes
- Type: Array of AcknowledgeAlarmActionRequest structures
The list of acknowledge action requests. You can specify up to 10 requests per operation.
Result Syntax
[
'errorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'requestId' => '<string>',
],
// ...
],
]
Result Details
Members
- errorEntries
-
- Type: Array of BatchAlarmActionErrorEntry structures
A list of errors associated with the request, or
nullif there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
BatchDisableAlarm
$result = $client->batchDisableAlarm([/* ... */]); $promise = $client->batchDisableAlarmAsync([/* ... */]);
Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
Parameter Syntax
$result = $client->batchDisableAlarm([
'disableActionRequests' => [ // REQUIRED
[
'alarmModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
'note' => '<string>',
'requestId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- disableActionRequests
-
- Required: Yes
- Type: Array of DisableAlarmActionRequest structures
The list of disable action requests. You can specify up to 10 requests per operation.
Result Syntax
[
'errorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'requestId' => '<string>',
],
// ...
],
]
Result Details
Members
- errorEntries
-
- Type: Array of BatchAlarmActionErrorEntry structures
A list of errors associated with the request, or
nullif there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
BatchEnableAlarm
$result = $client->batchEnableAlarm([/* ... */]); $promise = $client->batchEnableAlarmAsync([/* ... */]);
Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
Parameter Syntax
$result = $client->batchEnableAlarm([
'enableActionRequests' => [ // REQUIRED
[
'alarmModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
'note' => '<string>',
'requestId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- enableActionRequests
-
- Required: Yes
- Type: Array of EnableAlarmActionRequest structures
The list of enable action requests. You can specify up to 10 requests per operation.
Result Syntax
[
'errorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'requestId' => '<string>',
],
// ...
],
]
Result Details
Members
- errorEntries
-
- Type: Array of BatchAlarmActionErrorEntry structures
A list of errors associated with the request, or
nullif there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
BatchPutMessage
$result = $client->batchPutMessage([/* ... */]); $promise = $client->batchPutMessageAsync([/* ... */]);
Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.
Parameter Syntax
$result = $client->batchPutMessage([
'messages' => [ // REQUIRED
[
'inputName' => '<string>', // REQUIRED
'messageId' => '<string>', // REQUIRED
'payload' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED
'timestamp' => [
'timeInMillis' => <integer>,
],
],
// ...
],
]);
Parameter Details
Members
- messages
-
- Required: Yes
- Type: Array of Message structures
The list of messages to send. Each message has the following format:
'{ "messageId": "string", "inputName": "string", "payload": "string"}'
Result Syntax
[
'BatchPutMessageErrorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'messageId' => '<string>',
],
// ...
],
]
Result Details
Members
- BatchPutMessageErrorEntries
-
- Type: Array of BatchPutMessageErrorEntry structures
A list of any errors encountered when sending the messages.
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
BatchResetAlarm
$result = $client->batchResetAlarm([/* ... */]); $promise = $client->batchResetAlarmAsync([/* ... */]);
Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
Parameter Syntax
$result = $client->batchResetAlarm([
'resetActionRequests' => [ // REQUIRED
[
'alarmModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
'note' => '<string>',
'requestId' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- resetActionRequests
-
- Required: Yes
- Type: Array of ResetAlarmActionRequest structures
The list of reset action requests. You can specify up to 10 requests per operation.
Result Syntax
[
'errorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'requestId' => '<string>',
],
// ...
],
]
Result Details
Members
- errorEntries
-
- Type: Array of BatchAlarmActionErrorEntry structures
A list of errors associated with the request, or
nullif there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
BatchSnoozeAlarm
$result = $client->batchSnoozeAlarm([/* ... */]); $promise = $client->batchSnoozeAlarmAsync([/* ... */]);
Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.
Parameter Syntax
$result = $client->batchSnoozeAlarm([
'snoozeActionRequests' => [ // REQUIRED
[
'alarmModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
'note' => '<string>',
'requestId' => '<string>', // REQUIRED
'snoozeDuration' => <integer>, // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- snoozeActionRequests
-
- Required: Yes
- Type: Array of SnoozeAlarmActionRequest structures
The list of snooze action requests. You can specify up to 10 requests per operation.
Result Syntax
[
'errorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'requestId' => '<string>',
],
// ...
],
]
Result Details
Members
- errorEntries
-
- Type: Array of BatchAlarmActionErrorEntry structures
A list of errors associated with the request, or
nullif there are no errors. Each error entry contains an entry ID that helps you identify the entry that failed.
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
BatchUpdateDetector
$result = $client->batchUpdateDetector([/* ... */]); $promise = $client->batchUpdateDetectorAsync([/* ... */]);
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
Parameter Syntax
$result = $client->batchUpdateDetector([
'detectors' => [ // REQUIRED
[
'detectorModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
'messageId' => '<string>', // REQUIRED
'state' => [ // REQUIRED
'stateName' => '<string>', // REQUIRED
'timers' => [ // REQUIRED
[
'name' => '<string>', // REQUIRED
'seconds' => <integer>, // REQUIRED
],
// ...
],
'variables' => [ // REQUIRED
[
'name' => '<string>', // REQUIRED
'value' => '<string>', // REQUIRED
],
// ...
],
],
],
// ...
],
]);
Parameter Details
Members
- detectors
-
- Required: Yes
- Type: Array of UpdateDetectorRequest structures
The list of detectors (instances) to update, along with the values to update.
Result Syntax
[
'batchUpdateDetectorErrorEntries' => [
[
'errorCode' => 'ResourceNotFoundException|InvalidRequestException|InternalFailureException|ServiceUnavailableException|ThrottlingException',
'errorMessage' => '<string>',
'messageId' => '<string>',
],
// ...
],
]
Result Details
Members
- batchUpdateDetectorErrorEntries
-
- Type: Array of BatchUpdateDetectorErrorEntry structures
A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)
Errors
-
The request was invalid.
-
An internal failure occurred.
-
The service is currently unavailable.
-
The request could not be completed due to throttling.
DescribeAlarm
$result = $client->describeAlarm([/* ... */]); $promise = $client->describeAlarmAsync([/* ... */]);
Retrieves information about an alarm.
Parameter Syntax
$result = $client->describeAlarm([
'alarmModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
]);
Parameter Details
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
Result Syntax
[
'alarm' => [
'alarmModelName' => '<string>',
'alarmModelVersion' => '<string>',
'alarmState' => [
'customerAction' => [
'acknowledgeActionConfiguration' => [
'note' => '<string>',
],
'actionName' => 'SNOOZE|ENABLE|DISABLE|ACKNOWLEDGE|RESET',
'disableActionConfiguration' => [
'note' => '<string>',
],
'enableActionConfiguration' => [
'note' => '<string>',
],
'resetActionConfiguration' => [
'note' => '<string>',
],
'snoozeActionConfiguration' => [
'note' => '<string>',
'snoozeDuration' => <integer>,
],
],
'ruleEvaluation' => [
'simpleRuleEvaluation' => [
'inputPropertyValue' => '<string>',
'operator' => 'GREATER|GREATER_OR_EQUAL|LESS|LESS_OR_EQUAL|EQUAL|NOT_EQUAL',
'thresholdValue' => '<string>',
],
],
'stateName' => 'DISABLED|NORMAL|ACTIVE|ACKNOWLEDGED|SNOOZE_DISABLED|LATCHED',
'systemEvent' => [
'eventType' => 'STATE_CHANGE',
'stateChangeConfiguration' => [
'triggerType' => 'SNOOZE_TIMEOUT',
],
],
],
'creationTime' => <DateTime>,
'keyValue' => '<string>',
'lastUpdateTime' => <DateTime>,
'severity' => <integer>,
],
]
Result Details
Members
- alarm
-
- Type: Alarm structure
Contains information about an alarm.
Errors
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
DescribeDetector
$result = $client->describeDetector([/* ... */]); $promise = $client->describeDetectorAsync([/* ... */]);
Returns information about the specified detector (instance).
Parameter Syntax
$result = $client->describeDetector([
'detectorModelName' => '<string>', // REQUIRED
'keyValue' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'detector' => [
'creationTime' => <DateTime>,
'detectorModelName' => '<string>',
'detectorModelVersion' => '<string>',
'keyValue' => '<string>',
'lastUpdateTime' => <DateTime>,
'state' => [
'stateName' => '<string>',
'timers' => [
[
'name' => '<string>',
'timestamp' => <DateTime>,
],
// ...
],
'variables' => [
[
'name' => '<string>',
'value' => '<string>',
],
// ...
],
],
],
]
Result Details
Members
- detector
-
- Type: Detector structure
Information about the detector (instance).
Errors
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
ListAlarms
$result = $client->listAlarms([/* ... */]); $promise = $client->listAlarmsAsync([/* ... */]);
Lists one or more alarms. The operation returns only the metadata associated with each alarm.
Parameter Syntax
$result = $client->listAlarms([
'alarmModelName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'alarmSummaries' => [
[
'alarmModelName' => '<string>',
'alarmModelVersion' => '<string>',
'creationTime' => <DateTime>,
'keyValue' => '<string>',
'lastUpdateTime' => <DateTime>,
'stateName' => 'DISABLED|NORMAL|ACTIVE|ACKNOWLEDGED|SNOOZE_DISABLED|LATCHED',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- alarmSummaries
-
- Type: Array of AlarmSummary structures
A list that summarizes each alarm.
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
ListDetectors
$result = $client->listDetectors([/* ... */]); $promise = $client->listDetectorsAsync([/* ... */]);
Lists detectors (the instances of a detector model).
Parameter Syntax
$result = $client->listDetectors([
'detectorModelName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'stateName' => '<string>',
]);
Parameter Details
Members
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model whose detectors (instances) are listed.
- maxResults
-
- Type: int
The maximum number of results to be returned per request.
- nextToken
-
- Type: string
The token that you can use to return the next set of results.
- stateName
-
- Type: string
A filter that limits results to those detectors (instances) in the given state.
Result Syntax
[
'detectorSummaries' => [
[
'creationTime' => <DateTime>,
'detectorModelName' => '<string>',
'detectorModelVersion' => '<string>',
'keyValue' => '<string>',
'lastUpdateTime' => <DateTime>,
'state' => [
'stateName' => '<string>',
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- detectorSummaries
-
- Type: Array of DetectorSummary structures
A list of summary information about the detectors (instances).
- nextToken
-
- Type: string
The token that you can use to return the next set of results, or
nullif there are no more results.
Errors
-
The request was invalid.
-
The resource was not found.
-
The request could not be completed due to throttling.
-
An internal failure occurred.
-
The service is currently unavailable.
Shapes
AcknowledgeActionConfiguration
Description
Contains the configuration information of an acknowledge action.
Members
AcknowledgeAlarmActionRequest
Description
Information needed to acknowledge the alarm.
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- note
-
- Type: string
The note that you can leave when you acknowledge the alarm.
- requestId
-
- Required: Yes
- Type: string
The request ID. Each ID must be unique within each batch.
Alarm
Description
Contains information about an alarm.
Members
- alarmModelName
-
- Type: string
The name of the alarm model.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
- alarmState
-
- Type: AlarmState structure
Contains information about the current state of the alarm.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm was created, in the Unix epoch format.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm was last updated, in the Unix epoch format.
- severity
-
- Type: int
A non-negative integer that reflects the severity level of the alarm.
AlarmState
Description
Contains information about the current state of the alarm.
Members
- customerAction
-
- Type: CustomerAction structure
Contains information about the action that you can take to respond to the alarm.
- ruleEvaluation
-
- Type: RuleEvaluation structure
Information needed to evaluate data.
- stateName
-
- Type: string
The name of the alarm state. The state name can be one of the following values:
-
DISABLED- When the alarm is in theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate. -
NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data. -
ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked. -
ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate. -
LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
- systemEvent
-
- Type: SystemEvent structure
Contains information about alarm state changes.
AlarmSummary
Description
Contains a summary of an alarm.
Members
- alarmModelName
-
- Type: string
The name of the alarm model.
- alarmModelVersion
-
- Type: string
The version of the alarm model.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm was created, in the Unix epoch format.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the alarm was last updated, in the Unix epoch format.
- stateName
-
- Type: string
The name of the alarm state. The state name can be one of the following values:
-
DISABLED- When the alarm is in theDISABLEDstate, it isn't ready to evaluate data. To enable the alarm, you must change the alarm to theNORMALstate. -
NORMAL- When the alarm is in theNORMALstate, it's ready to evaluate data. -
ACTIVE- If the alarm is in theACTIVEstate, the alarm is invoked. -
ACKNOWLEDGED- When the alarm is in theACKNOWLEDGEDstate, the alarm was invoked and you acknowledged the alarm. -
SNOOZE_DISABLED- When the alarm is in theSNOOZE_DISABLEDstate, the alarm is disabled for a specified period of time. After the snooze time, the alarm automatically changes to theNORMALstate. -
LATCHED- When the alarm is in theLATCHEDstate, the alarm was invoked. However, the data that the alarm is currently evaluating is within the specified range. To change the alarm to theNORMALstate, you must acknowledge the alarm.
BatchAlarmActionErrorEntry
Description
Contains error messages associated with one of the following requests:
Members
BatchPutMessageErrorEntry
Description
Contains information about the errors encountered.
Members
BatchUpdateDetectorErrorEntry
Description
Information about the error that occurred when attempting to update a detector.
Members
CustomerAction
Description
Contains information about the action that you can take to respond to the alarm.
Members
- acknowledgeActionConfiguration
-
- Type: AcknowledgeActionConfiguration structure
Contains the configuration information of an acknowledge action.
- actionName
-
- Type: string
The name of the action. The action name can be one of the following values:
-
SNOOZE- When you snooze the alarm, the alarm state changes toSNOOZE_DISABLED. -
ENABLE- When you enable the alarm, the alarm state changes toNORMAL. -
DISABLE- When you disable the alarm, the alarm state changes toDISABLED. -
ACKNOWLEDGE- When you acknowledge the alarm, the alarm state changes toACKNOWLEDGED. -
RESET- When you reset the alarm, the alarm state changes toNORMAL.
For more information, see the AlarmState API.
- disableActionConfiguration
-
- Type: DisableActionConfiguration structure
Contains the configuration information of a disable action.
- enableActionConfiguration
-
- Type: EnableActionConfiguration structure
Contains the configuration information of an enable action.
- resetActionConfiguration
-
- Type: ResetActionConfiguration structure
Contains the configuration information of a reset action.
- snoozeActionConfiguration
-
- Type: SnoozeActionConfiguration structure
Contains the configuration information of a snooze action.
Detector
Description
Information about the detector (instance).
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector (instance) was created.
- detectorModelName
-
- Type: string
The name of the detector model that created this detector (instance).
- detectorModelVersion
-
- Type: string
The version of the detector model that created this detector (instance).
- keyValue
-
- Type: string
The value of the key (identifying the device or system) that caused the creation of this detector (instance).
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector (instance) was last updated.
- state
-
- Type: DetectorState structure
The current state of the detector (instance).
DetectorState
Description
Information about the current state of the detector instance.
Members
DetectorStateDefinition
Description
The new state, variable values, and timer settings of the detector (instance).
Members
- stateName
-
- Required: Yes
- Type: string
The name of the new state of the detector (instance).
- timers
-
- Required: Yes
- Type: Array of TimerDefinition structures
The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur.
- variables
-
- Required: Yes
- Type: Array of VariableDefinition structures
The new values of the detector's variables. Any variable whose value isn't specified is cleared.
DetectorStateSummary
Description
Information about the detector state.
Members
DetectorSummary
Description
Information about the detector (instance).
Members
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector (instance) was created.
- detectorModelName
-
- Type: string
The name of the detector model that created this detector (instance).
- detectorModelVersion
-
- Type: string
The version of the detector model that created this detector (instance).
- keyValue
-
- Type: string
The value of the key (identifying the device or system) that caused the creation of this detector (instance).
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the detector (instance) was last updated.
- state
-
- Type: DetectorStateSummary structure
The current state of the detector (instance).
DisableActionConfiguration
Description
Contains the configuration information of a disable action.
Members
DisableAlarmActionRequest
Description
Information used to disable the alarm.
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- note
-
- Type: string
The note that you can leave when you disable the alarm.
- requestId
-
- Required: Yes
- Type: string
The request ID. Each ID must be unique within each batch.
EnableActionConfiguration
Description
Contains the configuration information of an enable action.
Members
EnableAlarmActionRequest
Description
Information needed to enable the alarm.
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- note
-
- Type: string
The note that you can leave when you enable the alarm.
- requestId
-
- Required: Yes
- Type: string
The request ID. Each ID must be unique within each batch.
InternalFailureException
Description
An internal failure occurred.
Members
InvalidRequestException
Message
Description
Information about a message.
Members
- inputName
-
- Required: Yes
- Type: string
The name of the input into which the message payload is transformed.
- messageId
-
- Required: Yes
- Type: string
The ID to assign to the message. Within each batch sent, each
"messageId"must be unique. - payload
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).
- timestamp
-
- Type: TimestampValue structure
The timestamp associated with the message.
ResetActionConfiguration
Description
Contains the configuration information of a reset action.
Members
ResetAlarmActionRequest
Description
Information needed to reset the alarm.
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- note
-
- Type: string
The note that you can leave when you reset the alarm.
- requestId
-
- Required: Yes
- Type: string
The request ID. Each ID must be unique within each batch.
ResourceNotFoundException
RuleEvaluation
Description
Information needed to evaluate data.
Members
- simpleRuleEvaluation
-
- Type: SimpleRuleEvaluation structure
Information needed to compare two values with a comparison operator.
ServiceUnavailableException
Description
The service is currently unavailable.
Members
SimpleRuleEvaluation
Description
Information needed to compare two values with a comparison operator.
Members
SnoozeActionConfiguration
Description
Contains the configuration information of a snooze action.
Members
SnoozeAlarmActionRequest
Description
Information needed to snooze the alarm.
Members
- alarmModelName
-
- Required: Yes
- Type: string
The name of the alarm model.
- keyValue
-
- Type: string
The value of the key used as a filter to select only the alarms associated with the key.
- note
-
- Type: string
The note that you can leave when you snooze the alarm.
- requestId
-
- Required: Yes
- Type: string
The request ID. Each ID must be unique within each batch.
- snoozeDuration
-
- Required: Yes
- Type: int
The snooze time in seconds. The alarm automatically changes to the
NORMALstate after this duration.
StateChangeConfiguration
Description
Contains the configuration information of alarm state changes.
Members
SystemEvent
Description
Contains information about alarm state changes.
Members
- eventType
-
- Type: string
The event type. If the value is
STATE_CHANGE, the event contains information about alarm state changes. - stateChangeConfiguration
-
- Type: StateChangeConfiguration structure
Contains the configuration information of alarm state changes.
ThrottlingException
Description
The request could not be completed due to throttling.
Members
Timer
Description
The current state of a timer.
Members
TimerDefinition
Description
The new setting of a timer.
Members
TimestampValue
Description
Contains information about a timestamp.
Members
UpdateDetectorRequest
Description
Information used to update the detector (instance).
Members
- detectorModelName
-
- Required: Yes
- Type: string
The name of the detector model that created the detectors (instances).
- keyValue
-
- Type: string
The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).
- messageId
-
- Required: Yes
- Type: string
The ID to assign to the detector update
"message". Each"messageId"must be unique within each batch sent. - state
-
- Required: Yes
- Type: DetectorStateDefinition structure
The new state, variable values, and timer settings of the detector (instance).
Variable
Description
The current state of the variable.