Package software.amazon.awssdk.services.iotdeviceadvisor

Interface IotDeviceAdvisorAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface IotDeviceAdvisorAsyncClient extends AwsClient
Service client for accessing AWSIoTDeviceAdvisor asynchronously. This can be created using the static 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.

Amazon Web Services IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with Amazon Web Services IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to Amazon Web Services IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the Amazon Web Services Partner Network to get your device qualified for the Amazon Web Services Partner Device Catalog without the need to send your device in and wait for it to be tested.

  • Field Details

  • Method Details

    • createSuiteDefinition

      default CompletableFuture<CreateSuiteDefinitionResponse> createSuiteDefinition(CreateSuiteDefinitionRequest createSuiteDefinitionRequest)

      Creates a Device Advisor test suite.

      Requires permission to access the CreateSuiteDefinition action.

      Parameters:
      createSuiteDefinitionRequest -
      Returns:
      A Java Future containing the result of the CreateSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSuiteDefinition

      default CompletableFuture<CreateSuiteDefinitionResponse> createSuiteDefinition(Consumer<CreateSuiteDefinitionRequest.Builder> createSuiteDefinitionRequest)

      Creates a Device Advisor test suite.

      Requires permission to access the CreateSuiteDefinition action.


      This is a convenience which creates an instance of the CreateSuiteDefinitionRequest.Builder avoiding the need to create one manually via CreateSuiteDefinitionRequest.builder()

      Parameters:
      createSuiteDefinitionRequest - A Consumer that will call methods on CreateSuiteDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSuiteDefinition

      default CompletableFuture<DeleteSuiteDefinitionResponse> deleteSuiteDefinition(DeleteSuiteDefinitionRequest deleteSuiteDefinitionRequest)

      Deletes a Device Advisor test suite.

      Requires permission to access the DeleteSuiteDefinition action.

      Parameters:
      deleteSuiteDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeleteSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSuiteDefinition

      default CompletableFuture<DeleteSuiteDefinitionResponse> deleteSuiteDefinition(Consumer<DeleteSuiteDefinitionRequest.Builder> deleteSuiteDefinitionRequest)

      Deletes a Device Advisor test suite.

      Requires permission to access the DeleteSuiteDefinition action.


      This is a convenience which creates an instance of the DeleteSuiteDefinitionRequest.Builder avoiding the need to create one manually via DeleteSuiteDefinitionRequest.builder()

      Parameters:
      deleteSuiteDefinitionRequest - A Consumer that will call methods on DeleteSuiteDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEndpoint

      default CompletableFuture<GetEndpointResponse> getEndpoint(GetEndpointRequest getEndpointRequest)

      Gets information about an Device Advisor endpoint.

      Parameters:
      getEndpointRequest -
      Returns:
      A Java Future containing the result of the GetEndpoint 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEndpoint

      default CompletableFuture<GetEndpointResponse> getEndpoint(Consumer<GetEndpointRequest.Builder> getEndpointRequest)

      Gets information about an Device Advisor endpoint.


      This is a convenience which creates an instance of the GetEndpointRequest.Builder avoiding the need to create one manually via GetEndpointRequest.builder()

      Parameters:
      getEndpointRequest - A Consumer that will call methods on GetEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEndpoint 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSuiteDefinition

      default CompletableFuture<GetSuiteDefinitionResponse> getSuiteDefinition(GetSuiteDefinitionRequest getSuiteDefinitionRequest)

      Gets information about a Device Advisor test suite.

      Requires permission to access the GetSuiteDefinition action.

      Parameters:
      getSuiteDefinitionRequest -
      Returns:
      A Java Future containing the result of the GetSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSuiteDefinition

      default CompletableFuture<GetSuiteDefinitionResponse> getSuiteDefinition(Consumer<GetSuiteDefinitionRequest.Builder> getSuiteDefinitionRequest)

      Gets information about a Device Advisor test suite.

      Requires permission to access the GetSuiteDefinition action.


      This is a convenience which creates an instance of the GetSuiteDefinitionRequest.Builder avoiding the need to create one manually via GetSuiteDefinitionRequest.builder()

      Parameters:
      getSuiteDefinitionRequest - A Consumer that will call methods on GetSuiteDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSuiteRun

      default CompletableFuture<GetSuiteRunResponse> getSuiteRun(GetSuiteRunRequest getSuiteRunRequest)

      Gets information about a Device Advisor test suite run.

      Requires permission to access the GetSuiteRun action.

      Parameters:
      getSuiteRunRequest -
      Returns:
      A Java Future containing the result of the GetSuiteRun 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSuiteRun

      default CompletableFuture<GetSuiteRunResponse> getSuiteRun(Consumer<GetSuiteRunRequest.Builder> getSuiteRunRequest)

      Gets information about a Device Advisor test suite run.

      Requires permission to access the GetSuiteRun action.


      This is a convenience which creates an instance of the GetSuiteRunRequest.Builder avoiding the need to create one manually via GetSuiteRunRequest.builder()

      Parameters:
      getSuiteRunRequest - A Consumer that will call methods on GetSuiteRunRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSuiteRun 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSuiteRunReport

      default CompletableFuture<GetSuiteRunReportResponse> getSuiteRunReport(GetSuiteRunReportRequest getSuiteRunReportRequest)

      Gets a report download link for a successful Device Advisor qualifying test suite run.

      Requires permission to access the GetSuiteRunReport action.

      Parameters:
      getSuiteRunReportRequest -
      Returns:
      A Java Future containing the result of the GetSuiteRunReport 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSuiteRunReport

      default CompletableFuture<GetSuiteRunReportResponse> getSuiteRunReport(Consumer<GetSuiteRunReportRequest.Builder> getSuiteRunReportRequest)

      Gets a report download link for a successful Device Advisor qualifying test suite run.

      Requires permission to access the GetSuiteRunReport action.


      This is a convenience which creates an instance of the GetSuiteRunReportRequest.Builder avoiding the need to create one manually via GetSuiteRunReportRequest.builder()

      Parameters:
      getSuiteRunReportRequest - A Consumer that will call methods on GetSuiteRunReportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSuiteRunReport 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteDefinitions

      default CompletableFuture<ListSuiteDefinitionsResponse> listSuiteDefinitions(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest)

      Lists the Device Advisor test suites you have created.

      Requires permission to access the ListSuiteDefinitions action.

      Parameters:
      listSuiteDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListSuiteDefinitions 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteDefinitions

      default CompletableFuture<ListSuiteDefinitionsResponse> listSuiteDefinitions(Consumer<ListSuiteDefinitionsRequest.Builder> listSuiteDefinitionsRequest)

      Lists the Device Advisor test suites you have created.

      Requires permission to access the ListSuiteDefinitions action.


      This is a convenience which creates an instance of the ListSuiteDefinitionsRequest.Builder avoiding the need to create one manually via ListSuiteDefinitionsRequest.builder()

      Parameters:
      listSuiteDefinitionsRequest - A Consumer that will call methods on ListSuiteDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSuiteDefinitions 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteDefinitionsPaginator

      default ListSuiteDefinitionsPublisher listSuiteDefinitionsPaginator(ListSuiteDefinitionsRequest listSuiteDefinitionsRequest)

      This is a variant of listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsPublisher publisher = client.listSuiteDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsPublisher publisher = client.listSuiteDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest) operation.

      Parameters:
      listSuiteDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteDefinitionsPaginator

      default ListSuiteDefinitionsPublisher listSuiteDefinitionsPaginator(Consumer<ListSuiteDefinitionsRequest.Builder> listSuiteDefinitionsRequest)

      This is a variant of listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsPublisher publisher = client.listSuiteDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteDefinitionsPublisher publisher = client.listSuiteDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSuiteDefinitions(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteDefinitionsRequest) operation.


      This is a convenience which creates an instance of the ListSuiteDefinitionsRequest.Builder avoiding the need to create one manually via ListSuiteDefinitionsRequest.builder()

      Parameters:
      listSuiteDefinitionsRequest - A Consumer that will call methods on ListSuiteDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteRuns

      default CompletableFuture<ListSuiteRunsResponse> listSuiteRuns(ListSuiteRunsRequest listSuiteRunsRequest)

      Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

      Requires permission to access the ListSuiteRuns action.

      Parameters:
      listSuiteRunsRequest -
      Returns:
      A Java Future containing the result of the ListSuiteRuns 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteRuns

      default CompletableFuture<ListSuiteRunsResponse> listSuiteRuns(Consumer<ListSuiteRunsRequest.Builder> listSuiteRunsRequest)

      Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.

      Requires permission to access the ListSuiteRuns action.


      This is a convenience which creates an instance of the ListSuiteRunsRequest.Builder avoiding the need to create one manually via ListSuiteRunsRequest.builder()

      Parameters:
      listSuiteRunsRequest - A Consumer that will call methods on ListSuiteRunsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListSuiteRuns 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteRunsPaginator

      default ListSuiteRunsPublisher listSuiteRunsPaginator(ListSuiteRunsRequest listSuiteRunsRequest)

      This is a variant of listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsPublisher publisher = client.listSuiteRunsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsPublisher publisher = client.listSuiteRunsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest) operation.

      Parameters:
      listSuiteRunsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listSuiteRunsPaginator

      default ListSuiteRunsPublisher listSuiteRunsPaginator(Consumer<ListSuiteRunsRequest.Builder> listSuiteRunsRequest)

      This is a variant of listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsPublisher publisher = client.listSuiteRunsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.iotdeviceadvisor.paginators.ListSuiteRunsPublisher publisher = client.listSuiteRunsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listSuiteRuns(software.amazon.awssdk.services.iotdeviceadvisor.model.ListSuiteRunsRequest) operation.


      This is a convenience which creates an instance of the ListSuiteRunsRequest.Builder avoiding the need to create one manually via ListSuiteRunsRequest.builder()

      Parameters:
      listSuiteRunsRequest - A Consumer that will call methods on ListSuiteRunsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException 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 attached to an IoT Device Advisor resource.

      Requires permission to access the ListTagsForResource action.

      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.
      • InternalServerException Sends an Internal Failure exception.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException 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 attached to an IoT Device Advisor resource.

      Requires permission to access the ListTagsForResource action.


      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.
      • InternalServerException Sends an Internal Failure exception.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSuiteRun

      default CompletableFuture<StartSuiteRunResponse> startSuiteRun(StartSuiteRunRequest startSuiteRunRequest)

      Starts a Device Advisor test suite run.

      Requires permission to access the StartSuiteRun action.

      Parameters:
      startSuiteRunRequest -
      Returns:
      A Java Future containing the result of the StartSuiteRun 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ConflictException Sends a Conflict Exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startSuiteRun

      default CompletableFuture<StartSuiteRunResponse> startSuiteRun(Consumer<StartSuiteRunRequest.Builder> startSuiteRunRequest)

      Starts a Device Advisor test suite run.

      Requires permission to access the StartSuiteRun action.


      This is a convenience which creates an instance of the StartSuiteRunRequest.Builder avoiding the need to create one manually via StartSuiteRunRequest.builder()

      Parameters:
      startSuiteRunRequest - A Consumer that will call methods on StartSuiteRunRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartSuiteRun 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • ConflictException Sends a Conflict Exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopSuiteRun

      default CompletableFuture<StopSuiteRunResponse> stopSuiteRun(StopSuiteRunRequest stopSuiteRunRequest)

      Stops a Device Advisor test suite run that is currently running.

      Requires permission to access the StopSuiteRun action.

      Parameters:
      stopSuiteRunRequest -
      Returns:
      A Java Future containing the result of the StopSuiteRun 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.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopSuiteRun

      default CompletableFuture<StopSuiteRunResponse> stopSuiteRun(Consumer<StopSuiteRunRequest.Builder> stopSuiteRunRequest)

      Stops a Device Advisor test suite run that is currently running.

      Requires permission to access the StopSuiteRun action.


      This is a convenience which creates an instance of the StopSuiteRunRequest.Builder avoiding the need to create one manually via StopSuiteRunRequest.builder()

      Parameters:
      stopSuiteRunRequest - A Consumer that will call methods on StopSuiteRunRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopSuiteRun 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.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException 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 and modifies existing tags of an IoT Device Advisor resource.

      Requires permission to access the TagResource action.

      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.
      • InternalServerException Sends an Internal Failure exception.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException 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 and modifies existing tags of an IoT Device Advisor resource.

      Requires permission to access the TagResource action.


      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.
      • InternalServerException Sends an Internal Failure exception.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException 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 tags from an IoT Device Advisor resource.

      Requires permission to access the UntagResource action.

      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.
      • InternalServerException Sends an Internal Failure exception.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException 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 tags from an IoT Device Advisor resource.

      Requires permission to access the UntagResource action.


      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.
      • InternalServerException Sends an Internal Failure exception.
      • ValidationException Sends a validation exception.
      • ResourceNotFoundException Sends a Resource Not Found exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSuiteDefinition

      default CompletableFuture<UpdateSuiteDefinitionResponse> updateSuiteDefinition(UpdateSuiteDefinitionRequest updateSuiteDefinitionRequest)

      Updates a Device Advisor test suite.

      Requires permission to access the UpdateSuiteDefinition action.

      Parameters:
      updateSuiteDefinitionRequest -
      Returns:
      A Java Future containing the result of the UpdateSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSuiteDefinition

      default CompletableFuture<UpdateSuiteDefinitionResponse> updateSuiteDefinition(Consumer<UpdateSuiteDefinitionRequest.Builder> updateSuiteDefinitionRequest)

      Updates a Device Advisor test suite.

      Requires permission to access the UpdateSuiteDefinition action.


      This is a convenience which creates an instance of the UpdateSuiteDefinitionRequest.Builder avoiding the need to create one manually via UpdateSuiteDefinitionRequest.builder()

      Parameters:
      updateSuiteDefinitionRequest - A Consumer that will call methods on UpdateSuiteDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSuiteDefinition 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.
      • ValidationException Sends a validation exception.
      • InternalServerException Sends an Internal Failure exception.
      • 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.
      • IotDeviceAdvisorException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default IotDeviceAdvisorServiceClientConfiguration 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 IotDeviceAdvisorAsyncClient create()
      Create a IotDeviceAdvisorAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static IotDeviceAdvisorAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a IotDeviceAdvisorAsyncClient.