@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTEventsAsync extends AWSIoTEvents
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
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.
ENDPOINT_PREFIXcreateAlarmModel, createDetectorModel, createInput, deleteAlarmModel, deleteDetectorModel, deleteInput, describeAlarmModel, describeDetectorModel, describeDetectorModelAnalysis, describeInput, describeLoggingOptions, getCachedResponseMetadata, getDetectorModelAnalysisResults, listAlarmModels, listAlarmModelVersions, listDetectorModels, listDetectorModelVersions, listInputRoutings, listInputs, listTagsForResource, putLoggingOptions, shutdown, startDetectorModelAnalysis, tagResource, untagResource, updateAlarmModel, updateDetectorModel, updateInputFuture<CreateAlarmModelResult> createAlarmModelAsync(CreateAlarmModelRequest createAlarmModelRequest)
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.
createAlarmModelRequest - Future<CreateAlarmModelResult> createAlarmModelAsync(CreateAlarmModelRequest createAlarmModelRequest, AsyncHandler<CreateAlarmModelRequest,CreateAlarmModelResult> asyncHandler)
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.
createAlarmModelRequest - 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.Future<CreateDetectorModelResult> createDetectorModelAsync(CreateDetectorModelRequest createDetectorModelRequest)
Creates a detector model.
createDetectorModelRequest - Future<CreateDetectorModelResult> createDetectorModelAsync(CreateDetectorModelRequest createDetectorModelRequest, AsyncHandler<CreateDetectorModelRequest,CreateDetectorModelResult> asyncHandler)
Creates a detector model.
createDetectorModelRequest - 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.Future<CreateInputResult> createInputAsync(CreateInputRequest createInputRequest)
Creates an input.
createInputRequest - Future<CreateInputResult> createInputAsync(CreateInputRequest createInputRequest, AsyncHandler<CreateInputRequest,CreateInputResult> asyncHandler)
Creates an input.
createInputRequest - 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.Future<DeleteAlarmModelResult> deleteAlarmModelAsync(DeleteAlarmModelRequest deleteAlarmModelRequest)
Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
deleteAlarmModelRequest - Future<DeleteAlarmModelResult> deleteAlarmModelAsync(DeleteAlarmModelRequest deleteAlarmModelRequest, AsyncHandler<DeleteAlarmModelRequest,DeleteAlarmModelResult> asyncHandler)
Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.
deleteAlarmModelRequest - 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.Future<DeleteDetectorModelResult> deleteDetectorModelAsync(DeleteDetectorModelRequest deleteDetectorModelRequest)
Deletes a detector model. Any active instances of the detector model are also deleted.
deleteDetectorModelRequest - Future<DeleteDetectorModelResult> deleteDetectorModelAsync(DeleteDetectorModelRequest deleteDetectorModelRequest, AsyncHandler<DeleteDetectorModelRequest,DeleteDetectorModelResult> asyncHandler)
Deletes a detector model. Any active instances of the detector model are also deleted.
deleteDetectorModelRequest - 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.Future<DeleteInputResult> deleteInputAsync(DeleteInputRequest deleteInputRequest)
Deletes an input.
deleteInputRequest - Future<DeleteInputResult> deleteInputAsync(DeleteInputRequest deleteInputRequest, AsyncHandler<DeleteInputRequest,DeleteInputResult> asyncHandler)
Deletes an input.
deleteInputRequest - 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.Future<DescribeAlarmModelResult> describeAlarmModelAsync(DescribeAlarmModelRequest describeAlarmModelRequest)
Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
parameter, the latest version is returned.
describeAlarmModelRequest - Future<DescribeAlarmModelResult> describeAlarmModelAsync(DescribeAlarmModelRequest describeAlarmModelRequest, AsyncHandler<DescribeAlarmModelRequest,DescribeAlarmModelResult> asyncHandler)
Retrieves information about an alarm model. If you don't specify a value for the alarmModelVersion
parameter, the latest version is returned.
describeAlarmModelRequest - 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.Future<DescribeDetectorModelResult> describeDetectorModelAsync(DescribeDetectorModelRequest describeDetectorModelRequest)
Describes a detector model. If the version parameter is not specified, information about the latest
version is returned.
describeDetectorModelRequest - Future<DescribeDetectorModelResult> describeDetectorModelAsync(DescribeDetectorModelRequest describeDetectorModelRequest, AsyncHandler<DescribeDetectorModelRequest,DescribeDetectorModelResult> asyncHandler)
Describes a detector model. If the version parameter is not specified, information about the latest
version is returned.
describeDetectorModelRequest - 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.Future<DescribeDetectorModelAnalysisResult> describeDetectorModelAnalysisAsync(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest)
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.
describeDetectorModelAnalysisRequest - Future<DescribeDetectorModelAnalysisResult> describeDetectorModelAnalysisAsync(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest, AsyncHandler<DescribeDetectorModelAnalysisRequest,DescribeDetectorModelAnalysisResult> asyncHandler)
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.
describeDetectorModelAnalysisRequest - 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.Future<DescribeInputResult> describeInputAsync(DescribeInputRequest describeInputRequest)
Describes an input.
describeInputRequest - Future<DescribeInputResult> describeInputAsync(DescribeInputRequest describeInputRequest, AsyncHandler<DescribeInputRequest,DescribeInputResult> asyncHandler)
Describes an input.
describeInputRequest - 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.Future<DescribeLoggingOptionsResult> describeLoggingOptionsAsync(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
Retrieves the current settings of the AWS IoT Events logging options.
describeLoggingOptionsRequest - Future<DescribeLoggingOptionsResult> describeLoggingOptionsAsync(DescribeLoggingOptionsRequest describeLoggingOptionsRequest, AsyncHandler<DescribeLoggingOptionsRequest,DescribeLoggingOptionsResult> asyncHandler)
Retrieves the current settings of the AWS IoT Events logging options.
describeLoggingOptionsRequest - 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.Future<GetDetectorModelAnalysisResultsResult> getDetectorModelAnalysisResultsAsync(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest)
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.
getDetectorModelAnalysisResultsRequest - Future<GetDetectorModelAnalysisResultsResult> getDetectorModelAnalysisResultsAsync(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest, AsyncHandler<GetDetectorModelAnalysisResultsRequest,GetDetectorModelAnalysisResultsResult> asyncHandler)
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.
getDetectorModelAnalysisResultsRequest - 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.Future<ListAlarmModelVersionsResult> listAlarmModelVersionsAsync(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest)
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
listAlarmModelVersionsRequest - Future<ListAlarmModelVersionsResult> listAlarmModelVersionsAsync(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest, AsyncHandler<ListAlarmModelVersionsRequest,ListAlarmModelVersionsResult> asyncHandler)
Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
listAlarmModelVersionsRequest - 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.Future<ListAlarmModelsResult> listAlarmModelsAsync(ListAlarmModelsRequest listAlarmModelsRequest)
Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
listAlarmModelsRequest - Future<ListAlarmModelsResult> listAlarmModelsAsync(ListAlarmModelsRequest listAlarmModelsRequest, AsyncHandler<ListAlarmModelsRequest,ListAlarmModelsResult> asyncHandler)
Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
listAlarmModelsRequest - 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.Future<ListDetectorModelVersionsResult> listDetectorModelVersionsAsync(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest)
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
listDetectorModelVersionsRequest - Future<ListDetectorModelVersionsResult> listDetectorModelVersionsAsync(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest, AsyncHandler<ListDetectorModelVersionsRequest,ListDetectorModelVersionsResult> asyncHandler)
Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
listDetectorModelVersionsRequest - 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.Future<ListDetectorModelsResult> listDetectorModelsAsync(ListDetectorModelsRequest listDetectorModelsRequest)
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
listDetectorModelsRequest - Future<ListDetectorModelsResult> listDetectorModelsAsync(ListDetectorModelsRequest listDetectorModelsRequest, AsyncHandler<ListDetectorModelsRequest,ListDetectorModelsResult> asyncHandler)
Lists the detector models you have created. Only the metadata associated with each detector model is returned.
listDetectorModelsRequest - 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.Future<ListInputRoutingsResult> listInputRoutingsAsync(ListInputRoutingsRequest listInputRoutingsRequest)
Lists one or more input routings.
listInputRoutingsRequest - Future<ListInputRoutingsResult> listInputRoutingsAsync(ListInputRoutingsRequest listInputRoutingsRequest, AsyncHandler<ListInputRoutingsRequest,ListInputRoutingsResult> asyncHandler)
Lists one or more input routings.
listInputRoutingsRequest - 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.Future<ListInputsResult> listInputsAsync(ListInputsRequest listInputsRequest)
Lists the inputs you have created.
listInputsRequest - Future<ListInputsResult> listInputsAsync(ListInputsRequest listInputsRequest, AsyncHandler<ListInputsRequest,ListInputsResult> asyncHandler)
Lists the inputs you have created.
listInputsRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags (metadata) you have assigned to the resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists the tags (metadata) you have assigned to the resource.
listTagsForResourceRequest - 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.Future<PutLoggingOptionsResult> putLoggingOptionsAsync(PutLoggingOptionsRequest putLoggingOptionsRequest)
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.
putLoggingOptionsRequest - Future<PutLoggingOptionsResult> putLoggingOptionsAsync(PutLoggingOptionsRequest putLoggingOptionsRequest, AsyncHandler<PutLoggingOptionsRequest,PutLoggingOptionsResult> asyncHandler)
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.
putLoggingOptionsRequest - 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.Future<StartDetectorModelAnalysisResult> startDetectorModelAnalysisAsync(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest)
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
startDetectorModelAnalysisRequest - Future<StartDetectorModelAnalysisResult> startDetectorModelAnalysisAsync(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest, AsyncHandler<StartDetectorModelAnalysisRequest,StartDetectorModelAnalysisResult> asyncHandler)
Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
startDetectorModelAnalysisRequest - 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.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
tagResourceRequest - 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes the given tags (metadata) from the resource.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes the given tags (metadata) from the resource.
untagResourceRequest - 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.Future<UpdateAlarmModelResult> updateAlarmModelAsync(UpdateAlarmModelRequest updateAlarmModelRequest)
Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
updateAlarmModelRequest - Future<UpdateAlarmModelResult> updateAlarmModelAsync(UpdateAlarmModelRequest updateAlarmModelRequest, AsyncHandler<UpdateAlarmModelRequest,UpdateAlarmModelResult> asyncHandler)
Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.
updateAlarmModelRequest - 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.Future<UpdateDetectorModelResult> updateDetectorModelAsync(UpdateDetectorModelRequest updateDetectorModelRequest)
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
updateDetectorModelRequest - Future<UpdateDetectorModelResult> updateDetectorModelAsync(UpdateDetectorModelRequest updateDetectorModelRequest, AsyncHandler<UpdateDetectorModelRequest,UpdateDetectorModelResult> asyncHandler)
Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
updateDetectorModelRequest - 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.Future<UpdateInputResult> updateInputAsync(UpdateInputRequest updateInputRequest)
Updates an input.
updateInputRequest - Future<UpdateInputResult> updateInputAsync(UpdateInputRequest updateInputRequest, AsyncHandler<UpdateInputRequest,UpdateInputResult> asyncHandler)
Updates an input.
updateInputRequest - 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.