com.amazonaws.services.ioteventsdata

Class AWSIoTEventsDataClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ioteventsdata.AWSIoTEventsDataClient

All Implemented Interfaces:

AWSIoTEventsData

Direct Known Subclasses:

AWSIoTEventsDataAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSIoTEventsDataClient
extends AmazonWebServiceClient
implements AWSIoTEventsData

Client for accessing AWS IoT Events Data. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.ioteventsdata.AWSIoTEventsData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
BatchAcknowledgeAlarmResult	batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest request) Acknowledges one or more alarms.
BatchDeleteDetectorResult	batchDeleteDetector(BatchDeleteDetectorRequest request) Deletes one or more detectors that were created.
BatchDisableAlarmResult	batchDisableAlarm(BatchDisableAlarmRequest request) Disables one or more alarms.
BatchEnableAlarmResult	batchEnableAlarm(BatchEnableAlarmRequest request) Enables one or more alarms.
BatchPutMessageResult	batchPutMessage(BatchPutMessageRequest request) Sends a set of messages to the IoT Events system.
BatchResetAlarmResult	batchResetAlarm(BatchResetAlarmRequest request) Resets one or more alarms.
BatchSnoozeAlarmResult	batchSnoozeAlarm(BatchSnoozeAlarmRequest request) Changes one or more alarms to the snooze mode.
BatchUpdateDetectorResult	batchUpdateDetector(BatchUpdateDetectorRequest request) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
static AWSIoTEventsDataClientBuilder	builder()
DescribeAlarmResult	describeAlarm(DescribeAlarmRequest request) Retrieves information about an alarm.
DescribeDetectorResult	describeDetector(DescribeDetectorRequest request) 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 request) Lists one or more alarms.
ListDetectorsResult	listDetectors(ListDetectorsRequest request) Lists detectors (the instances of a detector model).
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSIoTEventsDataClientBuilder builder()

batchAcknowledgeAlarm

public BatchAcknowledgeAlarmResult batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest request)

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

Specified by:

batchAcknowledgeAlarm in interface AWSIoTEventsData

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

batchDeleteDetector

public BatchDeleteDetectorResult batchDeleteDetector(BatchDeleteDetectorRequest request)

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.

Specified by:

batchDeleteDetector in interface AWSIoTEventsData

Parameters:

batchDeleteDetectorRequest -

Returns:

Result of the BatchDeleteDetector 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

public BatchDisableAlarmResult batchDisableAlarm(BatchDisableAlarmRequest request)

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

Specified by:

batchDisableAlarm in interface AWSIoTEventsData

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

public BatchEnableAlarmResult batchEnableAlarm(BatchEnableAlarmRequest request)

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

Specified by:

batchEnableAlarm in interface AWSIoTEventsData

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

public BatchPutMessageResult batchPutMessage(BatchPutMessageRequest request)

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.

Specified by:

batchPutMessage in interface AWSIoTEventsData

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

public BatchResetAlarmResult batchResetAlarm(BatchResetAlarmRequest request)

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

Specified by:

batchResetAlarm in interface AWSIoTEventsData

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

public BatchSnoozeAlarmResult batchSnoozeAlarm(BatchSnoozeAlarmRequest request)

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.

Specified by:

batchSnoozeAlarm in interface AWSIoTEventsData

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

public BatchUpdateDetectorResult batchUpdateDetector(BatchUpdateDetectorRequest request)

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

Specified by:

batchUpdateDetector in interface AWSIoTEventsData

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

public DescribeAlarmResult describeAlarm(DescribeAlarmRequest request)

Retrieves information about an alarm.

Specified by:

describeAlarm in interface AWSIoTEventsData

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

public DescribeDetectorResult describeDetector(DescribeDetectorRequest request)

Returns information about the specified detector (instance).

Specified by:

describeDetector in interface AWSIoTEventsData

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

public ListAlarmsResult listAlarms(ListAlarmsRequest request)

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

Specified by:

listAlarms in interface AWSIoTEventsData

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

public ListDetectorsResult listDetectors(ListDetectorsRequest request)

Lists detectors (the instances of a detector model).

Specified by:

listDetectors in interface AWSIoTEventsData

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSIoTEventsData

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from interface: AWSIoTEventsData

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.

Specified by:

shutdown in interface AWSIoTEventsData

Overrides:

shutdown in class AmazonWebServiceClient