Interface IotEventsDataClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault BatchAcknowledgeAlarmResponse
batchAcknowledgeAlarm
(Consumer<BatchAcknowledgeAlarmRequest.Builder> batchAcknowledgeAlarmRequest) Acknowledges one or more alarms.default BatchAcknowledgeAlarmResponse
batchAcknowledgeAlarm
(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest) Acknowledges one or more alarms.default BatchDeleteDetectorResponse
batchDeleteDetector
(Consumer<BatchDeleteDetectorRequest.Builder> batchDeleteDetectorRequest) Deletes one or more detectors that were created.default BatchDeleteDetectorResponse
batchDeleteDetector
(BatchDeleteDetectorRequest batchDeleteDetectorRequest) Deletes one or more detectors that were created.default BatchDisableAlarmResponse
batchDisableAlarm
(Consumer<BatchDisableAlarmRequest.Builder> batchDisableAlarmRequest) Disables one or more alarms.default BatchDisableAlarmResponse
batchDisableAlarm
(BatchDisableAlarmRequest batchDisableAlarmRequest) Disables one or more alarms.default BatchEnableAlarmResponse
batchEnableAlarm
(Consumer<BatchEnableAlarmRequest.Builder> batchEnableAlarmRequest) Enables one or more alarms.default BatchEnableAlarmResponse
batchEnableAlarm
(BatchEnableAlarmRequest batchEnableAlarmRequest) Enables one or more alarms.default BatchPutMessageResponse
batchPutMessage
(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest) Sends a set of messages to the IoT Events system.default BatchPutMessageResponse
batchPutMessage
(BatchPutMessageRequest batchPutMessageRequest) Sends a set of messages to the IoT Events system.default BatchResetAlarmResponse
batchResetAlarm
(Consumer<BatchResetAlarmRequest.Builder> batchResetAlarmRequest) Resets one or more alarms.default BatchResetAlarmResponse
batchResetAlarm
(BatchResetAlarmRequest batchResetAlarmRequest) Resets one or more alarms.default BatchSnoozeAlarmResponse
batchSnoozeAlarm
(Consumer<BatchSnoozeAlarmRequest.Builder> batchSnoozeAlarmRequest) Changes one or more alarms to the snooze mode.default BatchSnoozeAlarmResponse
batchSnoozeAlarm
(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest) Changes one or more alarms to the snooze mode.default BatchUpdateDetectorResponse
batchUpdateDetector
(Consumer<BatchUpdateDetectorRequest.Builder> batchUpdateDetectorRequest) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.default BatchUpdateDetectorResponse
batchUpdateDetector
(BatchUpdateDetectorRequest batchUpdateDetectorRequest) Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.static IotEventsDataClientBuilder
builder()
Create a builder that can be used to configure and create aIotEventsDataClient
.static IotEventsDataClient
create()
Create aIotEventsDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default DescribeAlarmResponse
describeAlarm
(Consumer<DescribeAlarmRequest.Builder> describeAlarmRequest) Retrieves information about an alarm.default DescribeAlarmResponse
describeAlarm
(DescribeAlarmRequest describeAlarmRequest) Retrieves information about an alarm.default DescribeDetectorResponse
describeDetector
(Consumer<DescribeDetectorRequest.Builder> describeDetectorRequest) Returns information about the specified detector (instance).default DescribeDetectorResponse
describeDetector
(DescribeDetectorRequest describeDetectorRequest) Returns information about the specified detector (instance).default ListAlarmsResponse
listAlarms
(Consumer<ListAlarmsRequest.Builder> listAlarmsRequest) Lists one or more alarms.default ListAlarmsResponse
listAlarms
(ListAlarmsRequest listAlarmsRequest) Lists one or more alarms.default ListDetectorsResponse
listDetectors
(Consumer<ListDetectorsRequest.Builder> listDetectorsRequest) Lists detectors (the instances of a detector model).default ListDetectorsResponse
listDetectors
(ListDetectorsRequest listDetectorsRequest) Lists detectors (the instances of a detector model).The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchAcknowledgeAlarm
default BatchAcknowledgeAlarmResponse batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchAcknowledgeAlarm
default BatchAcknowledgeAlarmResponse batchAcknowledgeAlarm(Consumer<BatchAcknowledgeAlarmRequest.Builder> batchAcknowledgeAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException Acknowledges one or more alarms. The alarms change to the
ACKNOWLEDGED
state after you acknowledge them.
This is a convenience which creates an instance of the
BatchAcknowledgeAlarmRequest.Builder
avoiding the need to create one manually viaBatchAcknowledgeAlarmRequest.builder()
- Parameters:
batchAcknowledgeAlarmRequest
- AConsumer
that will call methods onBatchAcknowledgeAlarmRequest.Builder
to create a request.- Returns:
- Result of the BatchAcknowledgeAlarm operation returned by the service.
- See Also:
-
batchDeleteDetector
default BatchDeleteDetectorResponse batchDeleteDetector(BatchDeleteDetectorRequest batchDeleteDetectorRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- Parameters:
batchDeleteDetectorRequest
-- Returns:
- Result of the BatchDeleteDetector operation returned by the service.
- See Also:
-
batchDeleteDetector
default BatchDeleteDetectorResponse batchDeleteDetector(Consumer<BatchDeleteDetectorRequest.Builder> batchDeleteDetectorRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
This is a convenience which creates an instance of the
BatchDeleteDetectorRequest.Builder
avoiding the need to create one manually viaBatchDeleteDetectorRequest.builder()
- Parameters:
batchDeleteDetectorRequest
- AConsumer
that will call methods onBatchDeleteDetectorRequest.Builder
to create a request.- Returns:
- Result of the BatchDeleteDetector operation returned by the service.
- See Also:
-
batchDisableAlarm
default BatchDisableAlarmResponse batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchDisableAlarm
default BatchDisableAlarmResponse batchDisableAlarm(Consumer<BatchDisableAlarmRequest.Builder> batchDisableAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException Disables one or more alarms. The alarms change to the
DISABLED
state after you disable them.
This is a convenience which creates an instance of the
BatchDisableAlarmRequest.Builder
avoiding the need to create one manually viaBatchDisableAlarmRequest.builder()
- Parameters:
batchDisableAlarmRequest
- AConsumer
that will call methods onBatchDisableAlarmRequest.Builder
to create a request.- Returns:
- Result of the BatchDisableAlarm operation returned by the service.
- See Also:
-
batchEnableAlarm
default BatchEnableAlarmResponse batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchEnableAlarm
default BatchEnableAlarmResponse batchEnableAlarm(Consumer<BatchEnableAlarmRequest.Builder> batchEnableAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException Enables one or more alarms. The alarms change to the
NORMAL
state after you enable them.
This is a convenience which creates an instance of the
BatchEnableAlarmRequest.Builder
avoiding the need to create one manually viaBatchEnableAlarmRequest.builder()
- Parameters:
batchEnableAlarmRequest
- AConsumer
that will call methods onBatchEnableAlarmRequest.Builder
to create a request.- Returns:
- Result of the BatchEnableAlarm operation returned by the service.
- See Also:
-
batchPutMessage
default BatchPutMessageResponse batchPutMessage(BatchPutMessageRequest batchPutMessageRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchPutMessage
default BatchPutMessageResponse batchPutMessage(Consumer<BatchPutMessageRequest.Builder> batchPutMessageRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
This is a convenience which creates an instance of the
BatchPutMessageRequest.Builder
avoiding the need to create one manually viaBatchPutMessageRequest.builder()
- Parameters:
batchPutMessageRequest
- AConsumer
that will call methods onBatchPutMessageRequest.Builder
to create a request.- Returns:
- Result of the BatchPutMessage operation returned by the service.
- See Also:
-
batchResetAlarm
default BatchResetAlarmResponse batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchResetAlarm
default BatchResetAlarmResponse batchResetAlarm(Consumer<BatchResetAlarmRequest.Builder> batchResetAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException Resets one or more alarms. The alarms return to the
NORMAL
state after you reset them.
This is a convenience which creates an instance of the
BatchResetAlarmRequest.Builder
avoiding the need to create one manually viaBatchResetAlarmRequest.builder()
- Parameters:
batchResetAlarmRequest
- AConsumer
that will call methods onBatchResetAlarmRequest.Builder
to create a request.- Returns:
- Result of the BatchResetAlarm operation returned by the service.
- See Also:
-
batchSnoozeAlarm
default BatchSnoozeAlarmResponse batchSnoozeAlarm(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchSnoozeAlarm
default BatchSnoozeAlarmResponse batchSnoozeAlarm(Consumer<BatchSnoozeAlarmRequest.Builder> batchSnoozeAlarmRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
This is a convenience which creates an instance of the
BatchSnoozeAlarmRequest.Builder
avoiding the need to create one manually viaBatchSnoozeAlarmRequest.builder()
- Parameters:
batchSnoozeAlarmRequest
- AConsumer
that will call methods onBatchSnoozeAlarmRequest.Builder
to create a request.- Returns:
- Result of the BatchSnoozeAlarm operation returned by the service.
- See Also:
-
batchUpdateDetector
default BatchUpdateDetectorResponse batchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
batchUpdateDetector
default BatchUpdateDetectorResponse batchUpdateDetector(Consumer<BatchUpdateDetectorRequest.Builder> batchUpdateDetectorRequest) throws InvalidRequestException, InternalFailureException, ServiceUnavailableException, ThrottlingException, AwsServiceException, SdkClientException, IotEventsDataException Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.
This is a convenience which creates an instance of the
BatchUpdateDetectorRequest.Builder
avoiding the need to create one manually viaBatchUpdateDetectorRequest.builder()
- Parameters:
batchUpdateDetectorRequest
- AConsumer
that will call methods onBatchUpdateDetectorRequest.Builder
to create a request.- Returns:
- Result of the BatchUpdateDetector operation returned by the service.
- See Also:
-
describeAlarm
default DescribeAlarmResponse describeAlarm(DescribeAlarmRequest describeAlarmRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Retrieves information about an alarm.
- Parameters:
describeAlarmRequest
-- Returns:
- Result of the DescribeAlarm operation returned by the service.
- See Also:
-
describeAlarm
default DescribeAlarmResponse describeAlarm(Consumer<DescribeAlarmRequest.Builder> describeAlarmRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Retrieves information about an alarm.
This is a convenience which creates an instance of the
DescribeAlarmRequest.Builder
avoiding the need to create one manually viaDescribeAlarmRequest.builder()
- Parameters:
describeAlarmRequest
- AConsumer
that will call methods onDescribeAlarmRequest.Builder
to create a request.- Returns:
- Result of the DescribeAlarm operation returned by the service.
- See Also:
-
describeDetector
default DescribeDetectorResponse describeDetector(DescribeDetectorRequest describeDetectorRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Returns information about the specified detector (instance).
- Parameters:
describeDetectorRequest
-- Returns:
- Result of the DescribeDetector operation returned by the service.
- See Also:
-
describeDetector
default DescribeDetectorResponse describeDetector(Consumer<DescribeDetectorRequest.Builder> describeDetectorRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Returns information about the specified detector (instance).
This is a convenience which creates an instance of the
DescribeDetectorRequest.Builder
avoiding the need to create one manually viaDescribeDetectorRequest.builder()
- Parameters:
describeDetectorRequest
- AConsumer
that will call methods onDescribeDetectorRequest.Builder
to create a request.- Returns:
- Result of the DescribeDetector operation returned by the service.
- See Also:
-
listAlarms
default ListAlarmsResponse listAlarms(ListAlarmsRequest listAlarmsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException 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.
- See Also:
-
listAlarms
default ListAlarmsResponse listAlarms(Consumer<ListAlarmsRequest.Builder> listAlarmsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Lists one or more alarms. The operation returns only the metadata associated with each alarm.
This is a convenience which creates an instance of the
ListAlarmsRequest.Builder
avoiding the need to create one manually viaListAlarmsRequest.builder()
- Parameters:
listAlarmsRequest
- AConsumer
that will call methods onListAlarmsRequest.Builder
to create a request.- Returns:
- Result of the ListAlarms operation returned by the service.
- See Also:
-
listDetectors
default ListDetectorsResponse listDetectors(ListDetectorsRequest listDetectorsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Lists detectors (the instances of a detector model).
- Parameters:
listDetectorsRequest
-- Returns:
- Result of the ListDetectors operation returned by the service.
- See Also:
-
listDetectors
default ListDetectorsResponse listDetectors(Consumer<ListDetectorsRequest.Builder> listDetectorsRequest) throws InvalidRequestException, ResourceNotFoundException, ThrottlingException, InternalFailureException, ServiceUnavailableException, AwsServiceException, SdkClientException, IotEventsDataException Lists detectors (the instances of a detector model).
This is a convenience which creates an instance of the
ListDetectorsRequest.Builder
avoiding the need to create one manually viaListDetectorsRequest.builder()
- Parameters:
listDetectorsRequest
- AConsumer
that will call methods onListDetectorsRequest.Builder
to create a request.- Returns:
- Result of the ListDetectors operation returned by the service.
- See Also:
-
create
Create aIotEventsDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotEventsDataClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-