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.

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events Data API commands enable you to send inputs to detectors, list detectors, and view or update a detector's status.

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, 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
BatchPutMessageResult	batchPutMessage(BatchPutMessageRequest request) Sends a set of messages to the AWS IoT Events system.
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()
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.
ListDetectorsResult	listDetectors(ListDetectorsRequest request) Lists detectors (the instances of a detector model).

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, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSIoTEventsDataClientBuilder builder()

batchPutMessage

public BatchPutMessageResult batchPutMessage(BatchPutMessageRequest request)

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.

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 occured.

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 occured.

ServiceUnavailableException - The service is currently unavailable.

ThrottlingException - The request could not be completed due to throttling.

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 occured.

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 occured.

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.