Package software.amazon.awssdk.services.snowdevicemanagement

Interface SnowDeviceManagementAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SnowDeviceManagementAsyncClient extends AwsClient
Service client for accessing AWS Snow Device Management 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 Snow Device Management documentation.

  • Field Details

  • Method Details

    • cancelTask

      default CompletableFuture<CancelTaskResponse> cancelTask(CancelTaskRequest cancelTaskRequest)

      Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

      A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.

      Parameters:
      cancelTaskRequest -
      Returns:
      A Java Future containing the result of the CancelTask 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelTask

      default CompletableFuture<CancelTaskResponse> cancelTask(Consumer<CancelTaskRequest.Builder> cancelTaskRequest)

      Sends a cancel request for a specified task. You can cancel a task only if it's still in a QUEUED state. Tasks that are already running can't be cancelled.

      A task might still run if it's processed from the queue before the CancelTask operation changes the task's state.


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

      Parameters:
      cancelTaskRequest - A Consumer that will call methods on CancelTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelTask 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTask

      default CompletableFuture<CreateTaskResponse> createTask(CreateTaskRequest createTaskRequest)

      Instructs one or more devices to start a task, such as unlocking or rebooting.

      Parameters:
      createTaskRequest -
      Returns:
      A Java Future containing the result of the CreateTask 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.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createTask

      default CompletableFuture<CreateTaskResponse> createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)

      Instructs one or more devices to start a task, such as unlocking or rebooting.


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

      Parameters:
      createTaskRequest - A Consumer that will call methods on CreateTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTask 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.
      • ServiceQuotaExceededException The request would cause a service quota to be exceeded.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDevice

      default CompletableFuture<DescribeDeviceResponse> describeDevice(DescribeDeviceRequest describeDeviceRequest)

      Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

      Parameters:
      describeDeviceRequest -
      Returns:
      A Java Future containing the result of the DescribeDevice 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDevice

      default CompletableFuture<DescribeDeviceResponse> describeDevice(Consumer<DescribeDeviceRequest.Builder> describeDeviceRequest)

      Checks device-specific information, such as the device type, software version, IP addresses, and lock status.


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

      Parameters:
      describeDeviceRequest - A Consumer that will call methods on DescribeDeviceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDevice 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDeviceEc2Instances

      default CompletableFuture<DescribeDeviceEc2InstancesResponse> describeDeviceEc2Instances(DescribeDeviceEc2InstancesRequest describeDeviceEc2InstancesRequest)

      Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.

      Parameters:
      describeDeviceEc2InstancesRequest -
      Returns:
      A Java Future containing the result of the DescribeDeviceEc2Instances 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDeviceEc2Instances

      default CompletableFuture<DescribeDeviceEc2InstancesResponse> describeDeviceEc2Instances(Consumer<DescribeDeviceEc2InstancesRequest.Builder> describeDeviceEc2InstancesRequest)

      Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice, but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.


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

      Parameters:
      describeDeviceEc2InstancesRequest - A Consumer that will call methods on DescribeDeviceEc2InstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDeviceEc2Instances 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(DescribeExecutionRequest describeExecutionRequest)

      Checks the status of a remote task running on one or more target devices.

      Parameters:
      describeExecutionRequest -
      Returns:
      A Java Future containing the result of the DescribeExecution 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeExecution

      default CompletableFuture<DescribeExecutionResponse> describeExecution(Consumer<DescribeExecutionRequest.Builder> describeExecutionRequest)

      Checks the status of a remote task running on one or more target devices.


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

      Parameters:
      describeExecutionRequest - A Consumer that will call methods on DescribeExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeExecution 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTask

      default CompletableFuture<DescribeTaskResponse> describeTask(DescribeTaskRequest describeTaskRequest)

      Checks the metadata for a given task on a device.

      Parameters:
      describeTaskRequest -
      Returns:
      A Java Future containing the result of the DescribeTask 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTask

      default CompletableFuture<DescribeTaskResponse> describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)

      Checks the metadata for a given task on a device.


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

      Parameters:
      describeTaskRequest - A Consumer that will call methods on DescribeTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTask 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceResources

      default CompletableFuture<ListDeviceResourcesResponse> listDeviceResources(ListDeviceResourcesRequest listDeviceResourcesRequest)

      Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.

      Parameters:
      listDeviceResourcesRequest -
      Returns:
      A Java Future containing the result of the ListDeviceResources 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceResources

      default CompletableFuture<ListDeviceResourcesResponse> listDeviceResources(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)

      Returns a list of the Amazon Web Services resources available for a device. Currently, Amazon EC2 instances are the only supported resource type.


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

      Parameters:
      listDeviceResourcesRequest - A Consumer that will call methods on ListDeviceResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDeviceResources 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceResourcesPaginator

      default ListDeviceResourcesPublisher listDeviceResourcesPaginator(ListDeviceResourcesRequest listDeviceResourcesRequest)

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

      Parameters:
      listDeviceResourcesRequest -
      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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDeviceResourcesPaginator

      default ListDeviceResourcesPublisher listDeviceResourcesPaginator(Consumer<ListDeviceResourcesRequest.Builder> listDeviceResourcesRequest)

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


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

      Parameters:
      listDeviceResourcesRequest - A Consumer that will call methods on ListDeviceResourcesRequest.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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevices

      default CompletableFuture<ListDevicesResponse> listDevices(ListDevicesRequest listDevicesRequest)

      Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.

      Parameters:
      listDevicesRequest -
      Returns:
      A Java Future containing the result of the ListDevices 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevices

      default CompletableFuture<ListDevicesResponse> listDevices(Consumer<ListDevicesRequest.Builder> listDevicesRequest)

      Returns a list of all devices on your Amazon Web Services account that have Amazon Web Services Snow Device Management enabled in the Amazon Web Services Region where the command is run.


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

      Parameters:
      listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDevices 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevicesPaginator

      default ListDevicesPublisher listDevicesPaginator(ListDevicesRequest listDevicesRequest)

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

      Parameters:
      listDevicesRequest -
      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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDevicesPaginator

      default ListDevicesPublisher listDevicesPaginator(Consumer<ListDevicesRequest.Builder> listDevicesRequest)

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


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

      Parameters:
      listDevicesRequest - A Consumer that will call methods on ListDevicesRequest.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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(ListExecutionsRequest listExecutionsRequest)

      Returns the status of tasks for one or more target devices.

      Parameters:
      listExecutionsRequest -
      Returns:
      A Java Future containing the result of the ListExecutions 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutions

      default CompletableFuture<ListExecutionsResponse> listExecutions(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

      Returns the status of tasks for one or more target devices.


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListExecutions 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(ListExecutionsRequest listExecutionsRequest)

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

      Parameters:
      listExecutionsRequest -
      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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listExecutionsPaginator

      default ListExecutionsPublisher listExecutionsPaginator(Consumer<ListExecutionsRequest.Builder> listExecutionsRequest)

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


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

      Parameters:
      listExecutionsRequest - A Consumer that will call methods on ListExecutionsRequest.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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException 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)

      Returns a list of tags for a managed device or task.

      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 An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • SnowDeviceManagementException 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)

      Returns a list of tags for a managed device or task.


      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 An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)

      Returns a list of tasks that can be filtered by state.

      Parameters:
      listTasksRequest -
      Returns:
      A Java Future containing the result of the ListTasks 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)

      Returns a list of tasks that can be filtered by state.


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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTasks 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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)

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

      Parameters:
      listTasksRequest -
      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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)

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


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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.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.
      • ThrottlingException The request was denied due to request throttling.
      • InternalServerException An unexpected error occurred while processing the request.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • AccessDeniedException You don't have sufficient access to perform this action.
      • 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.
      • SnowDeviceManagementException 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 or replaces tags on a device or task.

      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 An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • SnowDeviceManagementException 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 or replaces tags on a device or task.


      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 An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • SnowDeviceManagementException 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 a tag from a device or task.

      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 An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • SnowDeviceManagementException 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 a tag from a device or task.


      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 An unexpected error occurred while processing the request.
      • ResourceNotFoundException The request references a resource that doesn't exist.
      • ValidationException The input fails to satisfy the constraints specified by an Amazon Web Services service.
      • 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.
      • SnowDeviceManagementException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static SnowDeviceManagementAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a SnowDeviceManagementAsyncClient.