@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTEventsData
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSIoTEventsData
instead.
IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.
For more information, see What is IoT Events? in the IoT Events Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchAcknowledgeAlarmResult |
batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest)
Acknowledges one or more alarms.
|
BatchDeleteDetectorResult |
batchDeleteDetector(BatchDeleteDetectorRequest batchDeleteDetectorRequest)
Deletes one or more detectors that were created.
|
BatchDisableAlarmResult |
batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest)
Disables one or more alarms.
|
BatchEnableAlarmResult |
batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest)
Enables one or more alarms.
|
BatchPutMessageResult |
batchPutMessage(BatchPutMessageRequest batchPutMessageRequest)
Sends a set of messages to the IoT Events system.
|
BatchResetAlarmResult |
batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest)
Resets one or more alarms.
|
BatchSnoozeAlarmResult |
batchSnoozeAlarm(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest)
Changes one or more alarms to the snooze mode.
|
BatchUpdateDetectorResult |
batchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest)
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified
detector model.
|
DescribeAlarmResult |
describeAlarm(DescribeAlarmRequest describeAlarmRequest)
Retrieves information about an alarm.
|
DescribeDetectorResult |
describeDetector(DescribeDetectorRequest describeDetectorRequest)
Returns information about the specified detector (instance).
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAlarmsResult |
listAlarms(ListAlarmsRequest listAlarmsRequest)
Lists one or more alarms.
|
ListDetectorsResult |
listDetectors(ListDetectorsRequest listDetectorsRequest)
Lists detectors (the instances of a detector model).
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
static final String ENDPOINT_PREFIX
BatchAcknowledgeAlarmResult batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest)
Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED
state after you acknowledge
them.
batchAcknowledgeAlarmRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchDeleteDetectorResult batchDeleteDetector(BatchDeleteDetectorRequest batchDeleteDetectorRequest)
Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.
batchDeleteDetectorRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchDisableAlarmResult batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest)
Disables one or more alarms. The alarms change to the DISABLED
state after you disable them.
batchDisableAlarmRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchEnableAlarmResult batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest)
Enables one or more alarms. The alarms change to the NORMAL
state after you enable them.
batchEnableAlarmRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchPutMessageResult batchPutMessage(BatchPutMessageRequest batchPutMessageRequest)
Sends a set of messages to the 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.
batchPutMessageRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchResetAlarmResult batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest)
Resets one or more alarms. The alarms return to the NORMAL
state after you reset them.
batchResetAlarmRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchSnoozeAlarmResult batchSnoozeAlarm(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest)
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.
batchSnoozeAlarmRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.BatchUpdateDetectorResult batchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest)
Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
batchUpdateDetectorRequest
- InvalidRequestException
- The request was invalid.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ThrottlingException
- The request could not be completed due to throttling.DescribeAlarmResult describeAlarm(DescribeAlarmRequest describeAlarmRequest)
Retrieves information about an alarm.
describeAlarmRequest
- InvalidRequestException
- The request was invalid.ResourceNotFoundException
- The resource was not found.ThrottlingException
- The request could not be completed due to throttling.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.DescribeDetectorResult describeDetector(DescribeDetectorRequest describeDetectorRequest)
Returns information about the specified detector (instance).
describeDetectorRequest
- InvalidRequestException
- The request was invalid.ResourceNotFoundException
- The resource was not found.ThrottlingException
- The request could not be completed due to throttling.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ListAlarmsResult listAlarms(ListAlarmsRequest listAlarmsRequest)
Lists one or more alarms. The operation returns only the metadata associated with each alarm.
listAlarmsRequest
- InvalidRequestException
- The request was invalid.ResourceNotFoundException
- The resource was not found.ThrottlingException
- The request could not be completed due to throttling.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.ListDetectorsResult listDetectors(ListDetectorsRequest listDetectorsRequest)
Lists detectors (the instances of a detector model).
listDetectorsRequest
- InvalidRequestException
- The request was invalid.ResourceNotFoundException
- The resource was not found.ThrottlingException
- The request could not be completed due to throttling.InternalFailureException
- An internal failure occurred.ServiceUnavailableException
- The service is currently unavailable.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.