Package software.amazon.awssdk.services.iotevents

Interface IotEventsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IotEventsAsyncClient extends AwsClient
Service client for accessing AWS IoT Events asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference 
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 Details

  • 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 invoke Throwable.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 via CreateAlarmModelRequest.builder()

      Parameters:
      createAlarmModelRequest - A Consumer that will call methods on CreateAlarmModelRequest.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 invoke Throwable.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 invoke Throwable.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 via CreateDetectorModelRequest.builder()

      Parameters:
      createDetectorModelRequest - A Consumer that will call methods on CreateDetectorModelRequest.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 invoke Throwable.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

      default CompletableFuture<CreateInputResponse> createInput(CreateInputRequest createInputRequest)

      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 invoke Throwable.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 via CreateInputRequest.builder()

      Parameters:
      createInputRequest - A Consumer that will call methods on CreateInputRequest.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 invoke Throwable.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 invoke Throwable.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 via DeleteAlarmModelRequest.builder()

      Parameters:
      deleteAlarmModelRequest - A Consumer that will call methods on DeleteAlarmModelRequest.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 invoke Throwable.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 invoke Throwable.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 via DeleteDetectorModelRequest.builder()

      Parameters:
      deleteDetectorModelRequest - A Consumer that will call methods on DeleteDetectorModelRequest.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 invoke Throwable.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

      default CompletableFuture<DeleteInputResponse> deleteInput(DeleteInputRequest deleteInputRequest)

      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 invoke Throwable.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 via DeleteInputRequest.builder()

      Parameters:
      deleteInputRequest - A Consumer that will call methods on DeleteInputRequest.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 invoke Throwable.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 invoke Throwable.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 via DescribeAlarmModelRequest.builder()

      Parameters:
      describeAlarmModelRequest - A Consumer that will call methods on DescribeAlarmModelRequest.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 invoke Throwable.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 invoke Throwable.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 via DescribeDetectorModelRequest.builder()

      Parameters:
      describeDetectorModelRequest - A Consumer that will call methods on DescribeDetectorModelRequest.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 invoke Throwable.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 invoke Throwable.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 via DescribeDetectorModelAnalysisRequest.builder()

      Parameters:
      describeDetectorModelAnalysisRequest - A Consumer that will call methods on DescribeDetectorModelAnalysisRequest.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 invoke Throwable.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 invoke Throwable.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 via DescribeInputRequest.builder()

      Parameters:
      describeInputRequest - A Consumer that will call methods on DescribeInputRequest.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 invoke Throwable.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 invoke Throwable.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 via DescribeLoggingOptionsRequest.builder()

      Parameters:
      describeLoggingOptionsRequest - A Consumer that will call methods on DescribeLoggingOptionsRequest.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 invoke Throwable.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 invoke Throwable.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 via GetDetectorModelAnalysisResultsRequest.builder()

      Parameters:
      getDetectorModelAnalysisResultsRequest - A Consumer that will call methods on GetDetectorModelAnalysisResultsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListAlarmModelVersionsRequest.builder()

      Parameters:
      listAlarmModelVersionsRequest - A Consumer that will call methods on ListAlarmModelVersionsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListAlarmModelsRequest.builder()

      Parameters:
      listAlarmModelsRequest - A Consumer that will call methods on ListAlarmModelsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListDetectorModelVersionsRequest.builder()

      Parameters:
      listDetectorModelVersionsRequest - A Consumer that will call methods on ListDetectorModelVersionsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListDetectorModelsRequest.builder()

      Parameters:
      listDetectorModelsRequest - A Consumer that will call methods on ListDetectorModelsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListInputRoutingsRequest.builder()

      Parameters:
      listInputRoutingsRequest - A Consumer that will call methods on ListInputRoutingsRequest.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 invoke Throwable.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

      default CompletableFuture<ListInputsResponse> listInputs(ListInputsRequest listInputsRequest)

      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 invoke Throwable.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 via ListInputsRequest.builder()

      Parameters:
      listInputsRequest - A Consumer that will call methods on ListInputsRequest.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 invoke Throwable.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 invoke Throwable.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 via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.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 invoke Throwable.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 the roleArn 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 invoke Throwable.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 the roleArn 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 via PutLoggingOptionsRequest.builder()

      Parameters:
      putLoggingOptionsRequest - A Consumer that will call methods on PutLoggingOptionsRequest.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 invoke Throwable.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 invoke Throwable.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 via StartDetectorModelAnalysisRequest.builder()

      Parameters:
      startDetectorModelAnalysisRequest - A Consumer that will call methods on StartDetectorModelAnalysisRequest.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 invoke Throwable.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

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      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 invoke Throwable.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 via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.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 invoke Throwable.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 invoke Throwable.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 via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.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 invoke Throwable.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 invoke Throwable.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 via UpdateAlarmModelRequest.builder()

      Parameters:
      updateAlarmModelRequest - A Consumer that will call methods on UpdateAlarmModelRequest.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 invoke Throwable.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 invoke Throwable.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 via UpdateDetectorModelRequest.builder()

      Parameters:
      updateDetectorModelRequest - A Consumer that will call methods on UpdateDetectorModelRequest.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 invoke Throwable.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

      default CompletableFuture<UpdateInputResponse> updateInput(UpdateInputRequest updateInputRequest)

      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 invoke Throwable.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 via UpdateInputRequest.builder()

      Parameters:
      updateInputRequest - A Consumer that will call methods on UpdateInputRequest.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 invoke Throwable.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

      default IotEventsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static IotEventsAsyncClient create()
      Create a IotEventsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static IotEventsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a IotEventsAsyncClient.