com.amazonaws.services.ioteventsdata

Interface AWSIoTEventsData

All Known Subinterfaces:

AWSIoTEventsDataAsync

All Known Implementing Classes:

AbstractAWSIoTEventsData, AbstractAWSIoTEventsDataAsync, AWSIoTEventsDataAsyncClient, AWSIoTEventsDataClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTEventsData

Interface for accessing AWS IoT Events Data.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
BatchAcknowledgeAlarmResult	batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest) Acknowledges one or more alarms.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

batchAcknowledgeAlarm

BatchAcknowledgeAlarmResult batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest)

Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.

Parameters:

batchAcknowledgeAlarmRequest -

Returns:

Result of the BatchAcknowledgeAlarm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchDisableAlarm

BatchDisableAlarmResult batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest)

Disables one or more alarms. The alarms change to the DISABLED state after you disable them.

Parameters:

batchDisableAlarmRequest -

Returns:

Result of the BatchDisableAlarm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchEnableAlarm

BatchEnableAlarmResult batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest)

Enables one or more alarms. The alarms change to the NORMAL state after you enable them.

Parameters:

batchEnableAlarmRequest -

Returns:

Result of the BatchEnableAlarm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchPutMessage

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.

Parameters:

batchPutMessageRequest -

Returns:

Result of the BatchPutMessage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchResetAlarm

BatchResetAlarmResult batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest)

Resets one or more alarms. The alarms return to the NORMAL state after you reset them.

Parameters:

batchResetAlarmRequest -

Returns:

Result of the BatchResetAlarm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchSnoozeAlarm

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.

Parameters:

batchSnoozeAlarmRequest -

Returns:

Result of the BatchSnoozeAlarm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

batchUpdateDetector

BatchUpdateDetectorResult batchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest)

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

Parameters:

batchUpdateDetectorRequest -

Returns:

Result of the BatchUpdateDetector operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeAlarm

DescribeAlarmResult describeAlarm(DescribeAlarmRequest describeAlarmRequest)

Retrieves information about an alarm.

Parameters:

describeAlarmRequest -

Returns:

Result of the DescribeAlarm operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

describeDetector

DescribeDetectorResult describeDetector(DescribeDetectorRequest describeDetectorRequest)

Returns information about the specified detector (instance).

Parameters:

describeDetectorRequest -

Returns:

Result of the DescribeDetector operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listAlarms

ListAlarmsResult listAlarms(ListAlarmsRequest listAlarmsRequest)

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

Parameters:

listAlarmsRequest -

Returns:

Result of the ListAlarms operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

listDetectors

ListDetectorsResult listDetectors(ListDetectorsRequest listDetectorsRequest)

Lists detectors (the instances of a detector model).

Parameters:

listDetectorsRequest -

Returns:

Result of the ListDetectors operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.