Package software.amazon.awssdk.services.iotfleethub

Interface IoTFleetHubAsyncClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
    @Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface IoTFleetHubAsyncClient
extends AwsClient
    Service client for accessing AWS IoT Fleet Hub asynchronously. This can be created using the static builder() method.

    With Fleet Hub for AWS IoT Device Management you can build stand-alone web applications for monitoring the health of your device fleets.

    Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

    • Method Detail

      • createApplication

        default CompletableFuture<CreateApplicationResponse> createApplication​(CreateApplicationRequest createApplicationRequest)

        Creates a Fleet Hub for AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        Parameters:
        createApplicationRequest -
        Returns:
        A Java Future containing the result of the CreateApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • LimitExceededException A limit has been exceeded.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • createApplication

        default CompletableFuture<CreateApplicationResponse> createApplication​(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)

        Creates a Fleet Hub for AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


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

        Parameters:
        createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the CreateApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • LimitExceededException A limit has been exceeded.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteApplication

        default CompletableFuture<DeleteApplicationResponse> deleteApplication​(DeleteApplicationRequest deleteApplicationRequest)

        Deletes a Fleet Hub for AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        Parameters:
        deleteApplicationRequest -
        Returns:
        A Java Future containing the result of the DeleteApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • deleteApplication

        default CompletableFuture<DeleteApplicationResponse> deleteApplication​(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)

        Deletes a Fleet Hub for AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


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

        Parameters:
        deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DeleteApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeApplication

        default CompletableFuture<DescribeApplicationResponse> describeApplication​(DescribeApplicationRequest describeApplicationRequest)

        Gets information about a Fleet Hub for AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        Parameters:
        describeApplicationRequest -
        Returns:
        A Java Future containing the result of the DescribeApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • describeApplication

        default CompletableFuture<DescribeApplicationResponse> describeApplication​(Consumer<DescribeApplicationRequest.Builder> describeApplicationRequest)

        Gets information about a Fleet Hub for AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


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

        Parameters:
        describeApplicationRequest - A Consumer that will call methods on DescribeApplicationRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the DescribeApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listApplications

        default CompletableFuture<ListApplicationsResponse> listApplications​(ListApplicationsRequest listApplicationsRequest)

        Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        Parameters:
        listApplicationsRequest -
        Returns:
        A Java Future containing the result of the ListApplications operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listApplications

        default CompletableFuture<ListApplicationsResponse> listApplications​(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

        Gets a list of Fleet Hub for AWS IoT Device Management web applications for the current account.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


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

        Parameters:
        listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the ListApplications operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listApplicationsPaginator

        default ListApplicationsPublisher listApplicationsPaginator​(ListApplicationsRequest listApplicationsRequest)

        This is a variant of listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) 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.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse 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 null 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 listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation.

        Parameters:
        listApplicationsRequest -
        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.
        • InvalidRequestException The request is not valid.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listApplicationsPaginator

        default ListApplicationsPublisher listApplicationsPaginator​(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)

        This is a variant of listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) 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.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
        2) Using a custom subscriber 
         
 software.amazon.awssdk.services.iotfleethub.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsResponse 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 null 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 listApplications(software.amazon.awssdk.services.iotfleethub.model.ListApplicationsRequest) operation.


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

        Parameters:
        listApplicationsRequest - A Consumer that will call methods on ListApplicationsRequest.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.
        • InvalidRequestException The request is not valid.
        • InternalFailureException An unexpected error has occurred.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsForResource

        default CompletableFuture<ListTagsForResourceResponse> listTagsForResource​(ListTagsForResourceRequest listTagsForResourceRequest)

        Lists the tags for the specified resource.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        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.
        • InternalFailureException An unexpected error has occurred.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • listTagsForResource

        default CompletableFuture<ListTagsForResourceResponse> listTagsForResource​(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

        Lists the tags for the specified resource.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


        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.
        • InternalFailureException An unexpected error has occurred.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(TagResourceRequest tagResourceRequest)

        Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        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.
        • InternalFailureException An unexpected error has occurred.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • tagResource

        default CompletableFuture<TagResourceResponse> tagResource​(Consumer<TagResourceRequest.Builder> tagResourceRequest)

        Adds to or modifies the tags of the specified resource. Tags are metadata which can be used to manage a resource.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


        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.
        • InternalFailureException An unexpected error has occurred.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(UntagResourceRequest untagResourceRequest)

        Removes the specified tags (metadata) from the resource.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        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.
        • InternalFailureException An unexpected error has occurred.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • untagResource

        default CompletableFuture<UntagResourceResponse> untagResource​(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

        Removes the specified tags (metadata) from the resource.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


        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.
        • InternalFailureException An unexpected error has occurred.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateApplication

        default CompletableFuture<UpdateApplicationResponse> updateApplication​(UpdateApplicationRequest updateApplicationRequest)

        Updates information about a Fleet Hub for a AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

        Parameters:
        updateApplicationRequest -
        Returns:
        A Java Future containing the result of the UpdateApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • InternalFailureException An unexpected error has occurred.
        • ConflictException The request conflicts with the current state of the resource.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation

      • updateApplication

        default CompletableFuture<UpdateApplicationResponse> updateApplication​(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)

        Updates information about a Fleet Hub for a AWS IoT Device Management web application.

        Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.


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

        Parameters:
        updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request.
        Returns:
        A Java Future containing the result of the UpdateApplication operation returned by the service.
        The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
        • InvalidRequestException The request is not valid.
        • ResourceNotFoundException The specified resource does not exist.
        • InternalFailureException An unexpected error has occurred.
        • ConflictException The request conflicts with the current state of the resource.
        • ThrottlingException The rate exceeds the limit.
        • 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.
        • IoTFleetHubException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        See Also:
        AWS API Documentation