Interface IotEventsAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic IotEventsAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aIotEventsAsyncClient
.static IotEventsAsyncClient
create()
Create aIotEventsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAlarmModel
(Consumer<CreateAlarmModelRequest.Builder> createAlarmModelRequest) Creates an alarm model to monitor an AWS IoT Events input attribute.createAlarmModel
(CreateAlarmModelRequest createAlarmModelRequest) Creates an alarm model to monitor an AWS IoT Events input attribute.createDetectorModel
(Consumer<CreateDetectorModelRequest.Builder> createDetectorModelRequest) Creates a detector model.createDetectorModel
(CreateDetectorModelRequest createDetectorModelRequest) Creates a detector model.default CompletableFuture
<CreateInputResponse> createInput
(Consumer<CreateInputRequest.Builder> createInputRequest) Creates an input.default CompletableFuture
<CreateInputResponse> createInput
(CreateInputRequest createInputRequest) Creates an input.deleteAlarmModel
(Consumer<DeleteAlarmModelRequest.Builder> deleteAlarmModelRequest) Deletes an alarm model.deleteAlarmModel
(DeleteAlarmModelRequest deleteAlarmModelRequest) Deletes an alarm model.deleteDetectorModel
(Consumer<DeleteDetectorModelRequest.Builder> deleteDetectorModelRequest) Deletes a detector model.deleteDetectorModel
(DeleteDetectorModelRequest deleteDetectorModelRequest) Deletes a detector model.default CompletableFuture
<DeleteInputResponse> deleteInput
(Consumer<DeleteInputRequest.Builder> deleteInputRequest) Deletes an input.default CompletableFuture
<DeleteInputResponse> deleteInput
(DeleteInputRequest deleteInputRequest) Deletes an input.describeAlarmModel
(Consumer<DescribeAlarmModelRequest.Builder> describeAlarmModelRequest) Retrieves information about an alarm model.describeAlarmModel
(DescribeAlarmModelRequest describeAlarmModelRequest) Retrieves information about an alarm model.describeDetectorModel
(Consumer<DescribeDetectorModelRequest.Builder> describeDetectorModelRequest) Describes a detector model.describeDetectorModel
(DescribeDetectorModelRequest describeDetectorModelRequest) Describes a detector model.describeDetectorModelAnalysis
(Consumer<DescribeDetectorModelAnalysisRequest.Builder> describeDetectorModelAnalysisRequest) Retrieves runtime information about a detector model analysis.describeDetectorModelAnalysis
(DescribeDetectorModelAnalysisRequest describeDetectorModelAnalysisRequest) Retrieves runtime information about a detector model analysis.default CompletableFuture
<DescribeInputResponse> describeInput
(Consumer<DescribeInputRequest.Builder> describeInputRequest) Describes an input.default CompletableFuture
<DescribeInputResponse> describeInput
(DescribeInputRequest describeInputRequest) Describes an input.describeLoggingOptions
(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.describeLoggingOptions
(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.getDetectorModelAnalysisResults
(Consumer<GetDetectorModelAnalysisResultsRequest.Builder> getDetectorModelAnalysisResultsRequest) Retrieves one or more analysis results of the detector model.getDetectorModelAnalysisResults
(GetDetectorModelAnalysisResultsRequest getDetectorModelAnalysisResultsRequest) Retrieves one or more analysis results of the detector model.default CompletableFuture
<ListAlarmModelsResponse> listAlarmModels
(Consumer<ListAlarmModelsRequest.Builder> listAlarmModelsRequest) Lists the alarm models that you created.default CompletableFuture
<ListAlarmModelsResponse> listAlarmModels
(ListAlarmModelsRequest listAlarmModelsRequest) Lists the alarm models that you created.listAlarmModelVersions
(Consumer<ListAlarmModelVersionsRequest.Builder> listAlarmModelVersionsRequest) Lists all the versions of an alarm model.listAlarmModelVersions
(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest) Lists all the versions of an alarm model.listDetectorModels
(Consumer<ListDetectorModelsRequest.Builder> listDetectorModelsRequest) Lists the detector models you have created.listDetectorModels
(ListDetectorModelsRequest listDetectorModelsRequest) Lists the detector models you have created.listDetectorModelVersions
(Consumer<ListDetectorModelVersionsRequest.Builder> listDetectorModelVersionsRequest) Lists all the versions of a detector model.listDetectorModelVersions
(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest) Lists all the versions of a detector model.listInputRoutings
(Consumer<ListInputRoutingsRequest.Builder> listInputRoutingsRequest) Lists one or more input routings.listInputRoutings
(ListInputRoutingsRequest listInputRoutingsRequest) Lists one or more input routings.default CompletableFuture
<ListInputsResponse> listInputs
(Consumer<ListInputsRequest.Builder> listInputsRequest) Lists the inputs you have created.default CompletableFuture
<ListInputsResponse> listInputs
(ListInputsRequest listInputsRequest) Lists the inputs you have created.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.putLoggingOptions
(Consumer<PutLoggingOptionsRequest.Builder> putLoggingOptionsRequest) Sets or updates the AWS IoT Events logging options.putLoggingOptions
(PutLoggingOptionsRequest putLoggingOptionsRequest) Sets or updates the AWS IoT Events logging options.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartDetectorModelAnalysis
(Consumer<StartDetectorModelAnalysisRequest.Builder> startDetectorModelAnalysisRequest) Performs an analysis of your detector model.startDetectorModelAnalysis
(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest) Performs an analysis of your detector model.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds to or modifies the tags of the given resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.updateAlarmModel
(Consumer<UpdateAlarmModelRequest.Builder> updateAlarmModelRequest) Updates an alarm model.updateAlarmModel
(UpdateAlarmModelRequest updateAlarmModelRequest) Updates an alarm model.updateDetectorModel
(Consumer<UpdateDetectorModelRequest.Builder> updateDetectorModelRequest) Updates a detector model.updateDetectorModel
(UpdateDetectorModelRequest updateDetectorModelRequest) Updates a detector model.default CompletableFuture
<UpdateInputResponse> updateInput
(Consumer<UpdateInputRequest.Builder> updateInputRequest) Updates an input.default CompletableFuture
<UpdateInputResponse> updateInput
(UpdateInputRequest updateInputRequest) Updates an input.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
-
createAlarmModel
default CompletableFuture<CreateAlarmModelResponse> createAlarmModel(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.
- Parameters:
createAlarmModelRequest
-- Returns:
- A Java Future containing the result of the CreateAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceAlreadyExistsException The resource already exists.
- LimitExceededException A limit was exceeded.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlarmModel
default CompletableFuture<CreateAlarmModelResponse> createAlarmModel(Consumer<CreateAlarmModelRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateAlarmModelRequest.Builder
avoiding the need to create one manually viaCreateAlarmModelRequest.builder()
- Parameters:
createAlarmModelRequest
- AConsumer
that will call methods onCreateAlarmModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceAlreadyExistsException The resource already exists.
- LimitExceededException A limit was exceeded.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDetectorModel
default CompletableFuture<CreateDetectorModelResponse> createDetectorModel(CreateDetectorModelRequest createDetectorModelRequest) Creates a detector model.
- Parameters:
createDetectorModelRequest
-- Returns:
- A Java Future containing the result of the CreateDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceAlreadyExistsException The resource already exists.
- LimitExceededException A limit was exceeded.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDetectorModel
default CompletableFuture<CreateDetectorModelResponse> createDetectorModel(Consumer<CreateDetectorModelRequest.Builder> createDetectorModelRequest) Creates a detector model.
This is a convenience which creates an instance of the
CreateDetectorModelRequest.Builder
avoiding the need to create one manually viaCreateDetectorModelRequest.builder()
- Parameters:
createDetectorModelRequest
- AConsumer
that will call methods onCreateDetectorModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceAlreadyExistsException The resource already exists.
- LimitExceededException A limit was exceeded.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createInput
Creates an input.
- Parameters:
createInputRequest
-- Returns:
- A Java Future containing the result of the CreateInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceAlreadyExistsException The resource already exists.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createInput
default CompletableFuture<CreateInputResponse> createInput(Consumer<CreateInputRequest.Builder> createInputRequest) Creates an input.
This is a convenience which creates an instance of the
CreateInputRequest.Builder
avoiding the need to create one manually viaCreateInputRequest.builder()
- Parameters:
createInputRequest
- AConsumer
that will call methods onCreateInputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceAlreadyExistsException The resource already exists.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlarmModel
default CompletableFuture<DeleteAlarmModelResponse> deleteAlarmModel(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.
- Parameters:
deleteAlarmModelRequest
-- Returns:
- A Java Future containing the result of the DeleteAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlarmModel
default CompletableFuture<DeleteAlarmModelResponse> deleteAlarmModel(Consumer<DeleteAlarmModelRequest.Builder> 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.
This is a convenience which creates an instance of the
DeleteAlarmModelRequest.Builder
avoiding the need to create one manually viaDeleteAlarmModelRequest.builder()
- Parameters:
deleteAlarmModelRequest
- AConsumer
that will call methods onDeleteAlarmModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDetectorModel
default CompletableFuture<DeleteDetectorModelResponse> deleteDetectorModel(DeleteDetectorModelRequest deleteDetectorModelRequest) Deletes a detector model. Any active instances of the detector model are also deleted.
- Parameters:
deleteDetectorModelRequest
-- Returns:
- A Java Future containing the result of the DeleteDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDetectorModel
default CompletableFuture<DeleteDetectorModelResponse> deleteDetectorModel(Consumer<DeleteDetectorModelRequest.Builder> deleteDetectorModelRequest) Deletes a detector model. Any active instances of the detector model are also deleted.
This is a convenience which creates an instance of the
DeleteDetectorModelRequest.Builder
avoiding the need to create one manually viaDeleteDetectorModelRequest.builder()
- Parameters:
deleteDetectorModelRequest
- AConsumer
that will call methods onDeleteDetectorModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInput
Deletes an input.
- Parameters:
deleteInputRequest
-- Returns:
- A Java Future containing the result of the DeleteInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceInUseException The resource is in use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteInput
default CompletableFuture<DeleteInputResponse> deleteInput(Consumer<DeleteInputRequest.Builder> deleteInputRequest) Deletes an input.
This is a convenience which creates an instance of the
DeleteInputRequest.Builder
avoiding the need to create one manually viaDeleteInputRequest.builder()
- Parameters:
deleteInputRequest
- AConsumer
that will call methods onDeleteInputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceInUseException The resource is in use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlarmModel
default CompletableFuture<DescribeAlarmModelResponse> describeAlarmModel(DescribeAlarmModelRequest describeAlarmModelRequest) Retrieves information about an alarm model. If you don't specify a value for the
alarmModelVersion
parameter, the latest version is returned.- Parameters:
describeAlarmModelRequest
-- Returns:
- A Java Future containing the result of the DescribeAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAlarmModel
default CompletableFuture<DescribeAlarmModelResponse> describeAlarmModel(Consumer<DescribeAlarmModelRequest.Builder> describeAlarmModelRequest) Retrieves information about an alarm model. If you don't specify a value for the
alarmModelVersion
parameter, the latest version is returned.
This is a convenience which creates an instance of the
DescribeAlarmModelRequest.Builder
avoiding the need to create one manually viaDescribeAlarmModelRequest.builder()
- Parameters:
describeAlarmModelRequest
- AConsumer
that will call methods onDescribeAlarmModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDetectorModel
default CompletableFuture<DescribeDetectorModelResponse> describeDetectorModel(DescribeDetectorModelRequest describeDetectorModelRequest) Describes a detector model. If the
version
parameter is not specified, information about the latest version is returned.- Parameters:
describeDetectorModelRequest
-- Returns:
- A Java Future containing the result of the DescribeDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDetectorModel
default CompletableFuture<DescribeDetectorModelResponse> describeDetectorModel(Consumer<DescribeDetectorModelRequest.Builder> describeDetectorModelRequest) Describes a detector model. If the
version
parameter is not specified, information about the latest version is returned.
This is a convenience which creates an instance of the
DescribeDetectorModelRequest.Builder
avoiding the need to create one manually viaDescribeDetectorModelRequest.builder()
- Parameters:
describeDetectorModelRequest
- AConsumer
that will call methods onDescribeDetectorModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDetectorModelAnalysis
default CompletableFuture<DescribeDetectorModelAnalysisResponse> describeDetectorModelAnalysis(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.
- Parameters:
describeDetectorModelAnalysisRequest
-- Returns:
- A Java Future containing the result of the DescribeDetectorModelAnalysis operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDetectorModelAnalysis
default CompletableFuture<DescribeDetectorModelAnalysisResponse> describeDetectorModelAnalysis(Consumer<DescribeDetectorModelAnalysisRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeDetectorModelAnalysisRequest.Builder
avoiding the need to create one manually viaDescribeDetectorModelAnalysisRequest.builder()
- Parameters:
describeDetectorModelAnalysisRequest
- AConsumer
that will call methods onDescribeDetectorModelAnalysisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeDetectorModelAnalysis operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInput
default CompletableFuture<DescribeInputResponse> describeInput(DescribeInputRequest describeInputRequest) Describes an input.
- Parameters:
describeInputRequest
-- Returns:
- A Java Future containing the result of the DescribeInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeInput
default CompletableFuture<DescribeInputResponse> describeInput(Consumer<DescribeInputRequest.Builder> describeInputRequest) Describes an input.
This is a convenience which creates an instance of the
DescribeInputRequest.Builder
avoiding the need to create one manually viaDescribeInputRequest.builder()
- Parameters:
describeInputRequest
- AConsumer
that will call methods onDescribeInputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoggingOptions
default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.
- Parameters:
describeLoggingOptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException The resource was not found.
- ServiceUnavailableException The service is currently unavailable.
- UnsupportedOperationException The requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeLoggingOptions
default CompletableFuture<DescribeLoggingOptionsResponse> describeLoggingOptions(Consumer<DescribeLoggingOptionsRequest.Builder> describeLoggingOptionsRequest) Retrieves the current settings of the AWS IoT Events logging options.
This is a convenience which creates an instance of the
DescribeLoggingOptionsRequest.Builder
avoiding the need to create one manually viaDescribeLoggingOptionsRequest.builder()
- Parameters:
describeLoggingOptionsRequest
- AConsumer
that will call methods onDescribeLoggingOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ResourceNotFoundException The resource was not found.
- ServiceUnavailableException The service is currently unavailable.
- UnsupportedOperationException The requested operation is not supported.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDetectorModelAnalysisResults
default CompletableFuture<GetDetectorModelAnalysisResultsResponse> getDetectorModelAnalysisResults(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.
- Parameters:
getDetectorModelAnalysisResultsRequest
-- Returns:
- A Java Future containing the result of the GetDetectorModelAnalysisResults operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDetectorModelAnalysisResults
default CompletableFuture<GetDetectorModelAnalysisResultsResponse> getDetectorModelAnalysisResults(Consumer<GetDetectorModelAnalysisResultsRequest.Builder> 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.
This is a convenience which creates an instance of the
GetDetectorModelAnalysisResultsRequest.Builder
avoiding the need to create one manually viaGetDetectorModelAnalysisResultsRequest.builder()
- Parameters:
getDetectorModelAnalysisResultsRequest
- AConsumer
that will call methods onGetDetectorModelAnalysisResultsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDetectorModelAnalysisResults operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlarmModelVersions
default CompletableFuture<ListAlarmModelVersionsResponse> listAlarmModelVersions(ListAlarmModelVersionsRequest listAlarmModelVersionsRequest) Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
- Parameters:
listAlarmModelVersionsRequest
-- Returns:
- A Java Future containing the result of the ListAlarmModelVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlarmModelVersions
default CompletableFuture<ListAlarmModelVersionsResponse> listAlarmModelVersions(Consumer<ListAlarmModelVersionsRequest.Builder> listAlarmModelVersionsRequest) Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.
This is a convenience which creates an instance of the
ListAlarmModelVersionsRequest.Builder
avoiding the need to create one manually viaListAlarmModelVersionsRequest.builder()
- Parameters:
listAlarmModelVersionsRequest
- AConsumer
that will call methods onListAlarmModelVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAlarmModelVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlarmModels
default CompletableFuture<ListAlarmModelsResponse> listAlarmModels(ListAlarmModelsRequest listAlarmModelsRequest) Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
- Parameters:
listAlarmModelsRequest
-- Returns:
- A Java Future containing the result of the ListAlarmModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlarmModels
default CompletableFuture<ListAlarmModelsResponse> listAlarmModels(Consumer<ListAlarmModelsRequest.Builder> listAlarmModelsRequest) Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.
This is a convenience which creates an instance of the
ListAlarmModelsRequest.Builder
avoiding the need to create one manually viaListAlarmModelsRequest.builder()
- Parameters:
listAlarmModelsRequest
- AConsumer
that will call methods onListAlarmModelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAlarmModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDetectorModelVersions
default CompletableFuture<ListDetectorModelVersionsResponse> listDetectorModelVersions(ListDetectorModelVersionsRequest listDetectorModelVersionsRequest) Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
- Parameters:
listDetectorModelVersionsRequest
-- Returns:
- A Java Future containing the result of the ListDetectorModelVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDetectorModelVersions
default CompletableFuture<ListDetectorModelVersionsResponse> listDetectorModelVersions(Consumer<ListDetectorModelVersionsRequest.Builder> listDetectorModelVersionsRequest) Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.
This is a convenience which creates an instance of the
ListDetectorModelVersionsRequest.Builder
avoiding the need to create one manually viaListDetectorModelVersionsRequest.builder()
- Parameters:
listDetectorModelVersionsRequest
- AConsumer
that will call methods onListDetectorModelVersionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDetectorModelVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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 occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDetectorModels
default CompletableFuture<ListDetectorModelsResponse> listDetectorModels(ListDetectorModelsRequest listDetectorModelsRequest) Lists the detector models you have created. Only the metadata associated with each detector model is returned.
- Parameters:
listDetectorModelsRequest
-- Returns:
- A Java Future containing the result of the ListDetectorModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDetectorModels
default CompletableFuture<ListDetectorModelsResponse> listDetectorModels(Consumer<ListDetectorModelsRequest.Builder> listDetectorModelsRequest) Lists the detector models you have created. Only the metadata associated with each detector model is returned.
This is a convenience which creates an instance of the
ListDetectorModelsRequest.Builder
avoiding the need to create one manually viaListDetectorModelsRequest.builder()
- Parameters:
listDetectorModelsRequest
- AConsumer
that will call methods onListDetectorModelsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDetectorModels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInputRoutings
default CompletableFuture<ListInputRoutingsResponse> listInputRoutings(ListInputRoutingsRequest listInputRoutingsRequest) Lists one or more input routings.
- Parameters:
listInputRoutingsRequest
-- Returns:
- A Java Future containing the result of the ListInputRoutings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceNotFoundException The resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInputRoutings
default CompletableFuture<ListInputRoutingsResponse> listInputRoutings(Consumer<ListInputRoutingsRequest.Builder> listInputRoutingsRequest) Lists one or more input routings.
This is a convenience which creates an instance of the
ListInputRoutingsRequest.Builder
avoiding the need to create one manually viaListInputRoutingsRequest.builder()
- Parameters:
listInputRoutingsRequest
- AConsumer
that will call methods onListInputRoutingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInputRoutings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceNotFoundException The resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInputs
Lists the inputs you have created.
- Parameters:
listInputsRequest
-- Returns:
- A Java Future containing the result of the ListInputs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listInputs
default CompletableFuture<ListInputsResponse> listInputs(Consumer<ListInputsRequest.Builder> listInputsRequest) Lists the inputs you have created.
This is a convenience which creates an instance of the
ListInputsRequest.Builder
avoiding the need to create one manually viaListInputsRequest.builder()
- Parameters:
listInputsRequest
- AConsumer
that will call methods onListInputsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListInputs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ResourceInUseException The resource is in use.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags (metadata) you have assigned to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ResourceInUseException The resource is in use.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLoggingOptions
default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(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 theroleArn
field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.- Parameters:
putLoggingOptionsRequest
-- Returns:
- A Java Future containing the result of the PutLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- UnsupportedOperationException The requested operation is not supported.
- ResourceInUseException The resource is in use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putLoggingOptions
default CompletableFuture<PutLoggingOptionsResponse> putLoggingOptions(Consumer<PutLoggingOptionsRequest.Builder> 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 theroleArn
field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
This is a convenience which creates an instance of the
PutLoggingOptionsRequest.Builder
avoiding the need to create one manually viaPutLoggingOptionsRequest.builder()
- Parameters:
putLoggingOptionsRequest
- AConsumer
that will call methods onPutLoggingOptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutLoggingOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- UnsupportedOperationException The requested operation is not supported.
- ResourceInUseException The resource is in use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDetectorModelAnalysis
default CompletableFuture<StartDetectorModelAnalysisResponse> startDetectorModelAnalysis(StartDetectorModelAnalysisRequest startDetectorModelAnalysisRequest) Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
- Parameters:
startDetectorModelAnalysisRequest
-- Returns:
- A Java Future containing the result of the StartDetectorModelAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- LimitExceededException A limit was exceeded.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDetectorModelAnalysis
default CompletableFuture<StartDetectorModelAnalysisResponse> startDetectorModelAnalysis(Consumer<StartDetectorModelAnalysisRequest.Builder> startDetectorModelAnalysisRequest) Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.
This is a convenience which creates an instance of the
StartDetectorModelAnalysisRequest.Builder
avoiding the need to create one manually viaStartDetectorModelAnalysisRequest.builder()
- Parameters:
startDetectorModelAnalysisRequest
- AConsumer
that will call methods onStartDetectorModelAnalysisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDetectorModelAnalysis operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- LimitExceededException A limit was exceeded.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ResourceInUseException The resource is in use.
- ThrottlingException The request could not be completed due to throttling.
- LimitExceededException A limit was exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ResourceInUseException The resource is in use.
- ThrottlingException The request could not be completed due to throttling.
- LimitExceededException A limit was exceeded.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the given tags (metadata) from the resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ResourceInUseException The resource is in use.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the given tags (metadata) from the resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceNotFoundException The resource was not found.
- ResourceInUseException The resource is in use.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAlarmModel
default CompletableFuture<UpdateAlarmModelResponse> updateAlarmModel(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.
- Parameters:
updateAlarmModelRequest
-- Returns:
- A Java Future containing the result of the UpdateAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAlarmModel
default CompletableFuture<UpdateAlarmModelResponse> updateAlarmModel(Consumer<UpdateAlarmModelRequest.Builder> 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.
This is a convenience which creates an instance of the
UpdateAlarmModelRequest.Builder
avoiding the need to create one manually viaUpdateAlarmModelRequest.builder()
- Parameters:
updateAlarmModelRequest
- AConsumer
that will call methods onUpdateAlarmModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAlarmModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDetectorModel
default CompletableFuture<UpdateDetectorModelResponse> updateDetectorModel(UpdateDetectorModelRequest updateDetectorModelRequest) Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
- Parameters:
updateDetectorModelRequest
-- Returns:
- A Java Future containing the result of the UpdateDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDetectorModel
default CompletableFuture<UpdateDetectorModelResponse> updateDetectorModel(Consumer<UpdateDetectorModelRequest.Builder> updateDetectorModelRequest) Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.
This is a convenience which creates an instance of the
UpdateDetectorModelRequest.Builder
avoiding the need to create one manually viaUpdateDetectorModelRequest.builder()
- Parameters:
updateDetectorModelRequest
- AConsumer
that will call methods onUpdateDetectorModelRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDetectorModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ResourceInUseException The resource is in use.
- ResourceNotFoundException The resource was not found.
- ThrottlingException The request could not be completed due to throttling.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateInput
Updates an input.
- Parameters:
updateInputRequest
-- Returns:
- A Java Future containing the result of the UpdateInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- ResourceNotFoundException The resource was not found.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceInUseException The resource is in use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateInput
default CompletableFuture<UpdateInputResponse> updateInput(Consumer<UpdateInputRequest.Builder> updateInputRequest) Updates an input.
This is a convenience which creates an instance of the
UpdateInputRequest.Builder
avoiding the need to create one manually viaUpdateInputRequest.builder()
- Parameters:
updateInputRequest
- AConsumer
that will call methods onUpdateInputRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateInput operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request was invalid.
- ThrottlingException The request could not be completed due to throttling.
- ResourceNotFoundException The resource was not found.
- InternalFailureException An internal failure occurred.
- ServiceUnavailableException The service is currently unavailable.
- ResourceInUseException The resource is in use.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- IotEventsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
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
-
create
Create aIotEventsAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aIotEventsAsyncClient
.
-