com.amazonaws.services.ioteventsdata.AWSIoTEventsData Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ioteventsdata;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.ioteventsdata.model.*;
/**
* Interface for accessing AWS IoT Events Data.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.ioteventsdata.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTEventsData {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "data.iotevents";
/**
*
* Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge
* them.
*
*
* @param batchAcknowledgeAlarmRequest
* @return Result of the BatchAcknowledgeAlarm operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchAcknowledgeAlarm
* @see AWS API Documentation
*/
BatchAcknowledgeAlarmResult batchAcknowledgeAlarm(BatchAcknowledgeAlarmRequest batchAcknowledgeAlarmRequest);
/**
*
* 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.
*
*
* @param batchDeleteDetectorRequest
* @return Result of the BatchDeleteDetector operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchDeleteDetector
* @see AWS API Documentation
*/
BatchDeleteDetectorResult batchDeleteDetector(BatchDeleteDetectorRequest batchDeleteDetectorRequest);
/**
*
* Disables one or more alarms. The alarms change to the DISABLED state after you disable them.
*
*
* @param batchDisableAlarmRequest
* @return Result of the BatchDisableAlarm operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchDisableAlarm
* @see AWS API Documentation
*/
BatchDisableAlarmResult batchDisableAlarm(BatchDisableAlarmRequest batchDisableAlarmRequest);
/**
*
* Enables one or more alarms. The alarms change to the NORMAL state after you enable them.
*
*
* @param batchEnableAlarmRequest
* @return Result of the BatchEnableAlarm operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchEnableAlarm
* @see AWS API Documentation
*/
BatchEnableAlarmResult batchEnableAlarm(BatchEnableAlarmRequest batchEnableAlarmRequest);
/**
*
* 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.
*
*
* @param batchPutMessageRequest
* @return Result of the BatchPutMessage operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchPutMessage
* @see AWS
* API Documentation
*/
BatchPutMessageResult batchPutMessage(BatchPutMessageRequest batchPutMessageRequest);
/**
*
* Resets one or more alarms. The alarms return to the NORMAL state after you reset them.
*
*
* @param batchResetAlarmRequest
* @return Result of the BatchResetAlarm operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchResetAlarm
* @see AWS
* API Documentation
*/
BatchResetAlarmResult batchResetAlarm(BatchResetAlarmRequest batchResetAlarmRequest);
/**
*
* 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.
*
*
* @param batchSnoozeAlarmRequest
* @return Result of the BatchSnoozeAlarm operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchSnoozeAlarm
* @see AWS API Documentation
*/
BatchSnoozeAlarmResult batchSnoozeAlarm(BatchSnoozeAlarmRequest batchSnoozeAlarmRequest);
/**
*
* Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified
* detector model.
*
*
* @param batchUpdateDetectorRequest
* @return Result of the BatchUpdateDetector operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @sample AWSIoTEventsData.BatchUpdateDetector
* @see AWS API Documentation
*/
BatchUpdateDetectorResult batchUpdateDetector(BatchUpdateDetectorRequest batchUpdateDetectorRequest);
/**
*
* Retrieves information about an alarm.
*
*
* @param describeAlarmRequest
* @return Result of the DescribeAlarm operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @sample AWSIoTEventsData.DescribeAlarm
* @see AWS
* API Documentation
*/
DescribeAlarmResult describeAlarm(DescribeAlarmRequest describeAlarmRequest);
/**
*
* Returns information about the specified detector (instance).
*
*
* @param describeDetectorRequest
* @return Result of the DescribeDetector operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @sample AWSIoTEventsData.DescribeDetector
* @see AWS API Documentation
*/
DescribeDetectorResult describeDetector(DescribeDetectorRequest describeDetectorRequest);
/**
*
* Lists one or more alarms. The operation returns only the metadata associated with each alarm.
*
*
* @param listAlarmsRequest
* @return Result of the ListAlarms operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @sample AWSIoTEventsData.ListAlarms
* @see AWS API
* Documentation
*/
ListAlarmsResult listAlarms(ListAlarmsRequest listAlarmsRequest);
/**
*
* Lists detectors (the instances of a detector model).
*
*
* @param listDetectorsRequest
* @return Result of the ListDetectors operation returned by the service.
* @throws InvalidRequestException
* The request was invalid.
* @throws ResourceNotFoundException
* The resource was not found.
* @throws ThrottlingException
* The request could not be completed due to throttling.
* @throws InternalFailureException
* An internal failure occurred.
* @throws ServiceUnavailableException
* The service is currently unavailable.
* @sample AWSIoTEventsData.ListDetectors
* @see AWS
* API Documentation
*/
ListDetectorsResult listDetectors(ListDetectorsRequest listDetectorsRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}