/* * Copyright 2018-2023 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.iotevents; import javax.annotation.Generated; import com.amazonaws.services.iotevents.model.*; /** * Interface for accessing AWS IoT Events asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.iotevents.AbstractAWSIoTEventsAsync} instead. *
**
* AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions * when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and * detector models, and to list their versions. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTEventsAsync extends AWSIoTEvents { /** ** Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when * the value is outside a specified range. For more information, see Create an alarm model * in the AWS IoT Events Developer Guide. *
* * @param createAlarmModelRequest * @return A Java Future containing the result of the CreateAlarmModel operation returned by the service. * @sample AWSIoTEventsAsync.CreateAlarmModel * @see AWS API * Documentation */ java.util.concurrent.Future* Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when * the value is outside a specified range. For more information, see Create an alarm model * in the AWS IoT Events Developer Guide. *
* * @param createAlarmModelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateAlarmModel operation returned by the service. * @sample AWSIoTEventsAsyncHandler.CreateAlarmModel * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a detector model. *
* * @param createDetectorModelRequest * @return A Java Future containing the result of the CreateDetectorModel operation returned by the service. * @sample AWSIoTEventsAsync.CreateDetectorModel * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a detector model. *
* * @param createDetectorModelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateDetectorModel operation returned by the service. * @sample AWSIoTEventsAsyncHandler.CreateDetectorModel * @see AWS * API Documentation */ java.util.concurrent.Future* Creates an input. *
* * @param createInputRequest * @return A Java Future containing the result of the CreateInput operation returned by the service. * @sample AWSIoTEventsAsync.CreateInput * @see AWS API * Documentation */ java.util.concurrent.Future* Creates an input. *
* * @param createInputRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateInput operation returned by the service. * @sample AWSIoTEventsAsyncHandler.CreateInput * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This * action can't be undone. *
* * @param deleteAlarmModelRequest * @return A Java Future containing the result of the DeleteAlarmModel operation returned by the service. * @sample AWSIoTEventsAsync.DeleteAlarmModel * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This * action can't be undone. *
* * @param deleteAlarmModelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteAlarmModel operation returned by the service. * @sample AWSIoTEventsAsyncHandler.DeleteAlarmModel * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a detector model. Any active instances of the detector model are also deleted. *
* * @param deleteDetectorModelRequest * @return A Java Future containing the result of the DeleteDetectorModel operation returned by the service. * @sample AWSIoTEventsAsync.DeleteDetectorModel * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a detector model. Any active instances of the detector model are also deleted. *
* * @param deleteDetectorModelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteDetectorModel operation returned by the service. * @sample AWSIoTEventsAsyncHandler.DeleteDetectorModel * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes an input. *
* * @param deleteInputRequest * @return A Java Future containing the result of the DeleteInput operation returned by the service. * @sample AWSIoTEventsAsync.DeleteInput * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes an input. *
* * @param deleteInputRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteInput operation returned by the service. * @sample AWSIoTEventsAsyncHandler.DeleteInput * @see AWS API * Documentation */ java.util.concurrent.Future
* Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
* parameter, the latest version is returned.
*
* Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
* parameter, the latest version is returned.
*
* Describes a detector model. If the version
parameter is not specified, information about the latest
* version is returned.
*
* Describes a detector model. If the version
parameter is not specified, information about the latest
* version is returned.
*
* Retrieves runtime information about a detector model analysis. *
** After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis * results. *
** Retrieves runtime information about a detector model analysis. *
** After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis * results. *
** Describes an input. *
* * @param describeInputRequest * @return A Java Future containing the result of the DescribeInput operation returned by the service. * @sample AWSIoTEventsAsync.DescribeInput * @see AWS API * Documentation */ java.util.concurrent.Future* Describes an input. *
* * @param describeInputRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeInput operation returned by the service. * @sample AWSIoTEventsAsyncHandler.DescribeInput * @see AWS API * Documentation */ java.util.concurrent.Future* Retrieves the current settings of the AWS IoT Events logging options. *
* * @param describeLoggingOptionsRequest * @return A Java Future containing the result of the DescribeLoggingOptions operation returned by the service. * @sample AWSIoTEventsAsync.DescribeLoggingOptions * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves the current settings of the AWS IoT Events logging options. *
* * @param describeLoggingOptionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DescribeLoggingOptions operation returned by the service. * @sample AWSIoTEventsAsyncHandler.DescribeLoggingOptions * @see AWS API Documentation */ java.util.concurrent.Future* Retrieves one or more analysis results of the detector model. *
** After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis * results. *
** Retrieves one or more analysis results of the detector model. *
** After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis * results. *
** Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm * model version. *
* * @param listAlarmModelVersionsRequest * @return A Java Future containing the result of the ListAlarmModelVersions operation returned by the service. * @sample AWSIoTEventsAsync.ListAlarmModelVersions * @see AWS API Documentation */ java.util.concurrent.Future* Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm * model version. *
* * @param listAlarmModelVersionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListAlarmModelVersions operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListAlarmModelVersions * @see AWS API Documentation */ java.util.concurrent.Future* Lists the alarm models that you created. The operation returns only the metadata associated with each alarm * model. *
* * @param listAlarmModelsRequest * @return A Java Future containing the result of the ListAlarmModels operation returned by the service. * @sample AWSIoTEventsAsync.ListAlarmModels * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the alarm models that you created. The operation returns only the metadata associated with each alarm * model. *
* * @param listAlarmModelsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListAlarmModels operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListAlarmModels * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all the versions of a detector model. Only the metadata associated with each detector model version is * returned. *
* * @param listDetectorModelVersionsRequest * @return A Java Future containing the result of the ListDetectorModelVersions operation returned by the service. * @sample AWSIoTEventsAsync.ListDetectorModelVersions * @see AWS API Documentation */ java.util.concurrent.Future* Lists all the versions of a detector model. Only the metadata associated with each detector model version is * returned. *
* * @param listDetectorModelVersionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDetectorModelVersions operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListDetectorModelVersions * @see AWS API Documentation */ java.util.concurrent.Future* Lists the detector models you have created. Only the metadata associated with each detector model is returned. *
* * @param listDetectorModelsRequest * @return A Java Future containing the result of the ListDetectorModels operation returned by the service. * @sample AWSIoTEventsAsync.ListDetectorModels * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the detector models you have created. Only the metadata associated with each detector model is returned. *
* * @param listDetectorModelsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListDetectorModels operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListDetectorModels * @see AWS * API Documentation */ java.util.concurrent.Future* Lists one or more input routings. *
* * @param listInputRoutingsRequest * @return A Java Future containing the result of the ListInputRoutings operation returned by the service. * @sample AWSIoTEventsAsync.ListInputRoutings * @see AWS * API Documentation */ java.util.concurrent.Future* Lists one or more input routings. *
* * @param listInputRoutingsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListInputRoutings operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListInputRoutings * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the inputs you have created. *
* * @param listInputsRequest * @return A Java Future containing the result of the ListInputs operation returned by the service. * @sample AWSIoTEventsAsync.ListInputs * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the inputs you have created. *
* * @param listInputsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListInputs operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListInputs * @see AWS API * Documentation */ java.util.concurrent.Future* Lists the tags (metadata) you have assigned to the resource. *
* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSIoTEventsAsync.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* Lists the tags (metadata) you have assigned to the resource. *
* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSIoTEventsAsyncHandler.ListTagsForResource * @see AWS * API Documentation */ java.util.concurrent.Future* Sets or updates the AWS IoT Events logging options. *
*
* If you update the value of any loggingOptions
field, it takes up to one minute for the change to
* take effect. If you change the policy attached to the role you specified in the roleArn
field (for
* example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
*
* Sets or updates the AWS IoT Events logging options. *
*
* If you update the value of any loggingOptions
field, it takes up to one minute for the change to
* take effect. If you change the policy attached to the role you specified in the roleArn
field (for
* example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
*
* Performs an analysis of your detector model. For more information, see Troubleshooting a * detector model in the AWS IoT Events Developer Guide. *
* * @param startDetectorModelAnalysisRequest * @return A Java Future containing the result of the StartDetectorModelAnalysis operation returned by the service. * @sample AWSIoTEventsAsync.StartDetectorModelAnalysis * @see AWS API Documentation */ java.util.concurrent.Future* Performs an analysis of your detector model. For more information, see Troubleshooting a * detector model in the AWS IoT Events Developer Guide. *
* * @param startDetectorModelAnalysisRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the StartDetectorModelAnalysis operation returned by the service. * @sample AWSIoTEventsAsyncHandler.StartDetectorModelAnalysis * @see AWS API Documentation */ java.util.concurrent.Future* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. *
* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSIoTEventsAsync.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. *
* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSIoTEventsAsyncHandler.TagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes the given tags (metadata) from the resource. *
* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSIoTEventsAsync.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Removes the given tags (metadata) from the resource. *
* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSIoTEventsAsyncHandler.UntagResource * @see AWS API * Documentation */ java.util.concurrent.Future* Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created * again as new data arrives. *
* * @param updateAlarmModelRequest * @return A Java Future containing the result of the UpdateAlarmModel operation returned by the service. * @sample AWSIoTEventsAsync.UpdateAlarmModel * @see AWS API * Documentation */ java.util.concurrent.Future* Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created * again as new data arrives. *
* * @param updateAlarmModelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateAlarmModel operation returned by the service. * @sample AWSIoTEventsAsyncHandler.UpdateAlarmModel * @see AWS API * Documentation */ java.util.concurrent.Future* Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created * as new inputs arrive. *
* * @param updateDetectorModelRequest * @return A Java Future containing the result of the UpdateDetectorModel operation returned by the service. * @sample AWSIoTEventsAsync.UpdateDetectorModel * @see AWS * API Documentation */ java.util.concurrent.Future* Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created * as new inputs arrive. *
* * @param updateDetectorModelRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateDetectorModel operation returned by the service. * @sample AWSIoTEventsAsyncHandler.UpdateDetectorModel * @see AWS * API Documentation */ java.util.concurrent.Future* Updates an input. *
* * @param updateInputRequest * @return A Java Future containing the result of the UpdateInput operation returned by the service. * @sample AWSIoTEventsAsync.UpdateInput * @see AWS API * Documentation */ java.util.concurrent.Future* Updates an input. *
* * @param updateInputRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateInput operation returned by the service. * @sample AWSIoTEventsAsyncHandler.UpdateInput * @see AWS API * Documentation */ java.util.concurrent.Future