Package software.amazon.awssdk.services.datasync

Interface DataSyncAsyncClient

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

DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.

This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .

  • Field Details

  • Method Details

    • addStorageSystem

      default CompletableFuture<AddStorageSystemResponse> addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)

      Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

      Parameters:
      addStorageSystemRequest -
      Returns:
      A Java Future containing the result of the AddStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addStorageSystem

      default CompletableFuture<AddStorageSystemResponse> addStorageSystem(Consumer<AddStorageSystemRequest.Builder> addStorageSystemRequest)

      Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.


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

      Parameters:
      addStorageSystemRequest - A Consumer that will call methods on AddStorageSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AddStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelTaskExecution

      default CompletableFuture<CancelTaskExecutionResponse> cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)

      Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.

      However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.

      Parameters:
      cancelTaskExecutionRequest - CancelTaskExecutionRequest
      Returns:
      A Java Future containing the result of the CancelTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelTaskExecution

      default CompletableFuture<CancelTaskExecutionResponse> cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)

      Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.

      However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.


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

      Parameters:
      cancelTaskExecutionRequest - A Consumer that will call methods on CancelTaskExecutionRequest.Builder to create a request. CancelTaskExecutionRequest
      Returns:
      A Java Future containing the result of the CancelTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgent

      default CompletableFuture<CreateAgentResponse> createAgent(CreateAgentRequest createAgentRequest)

      Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.

      If you haven't deployed an agent yet, see the following topics to learn more:

      If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.

      Parameters:
      createAgentRequest - CreateAgentRequest
      Returns:
      A Java Future containing the result of the CreateAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgent

      default CompletableFuture<CreateAgentResponse> createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)

      Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.

      If you haven't deployed an agent yet, see the following topics to learn more:

      If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.


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

      Parameters:
      createAgentRequest - A Consumer that will call methods on CreateAgentRequest.Builder to create a request. CreateAgentRequest
      Returns:
      A Java Future containing the result of the CreateAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationAzureBlob

      default CompletableFuture<CreateLocationAzureBlobResponse> createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)

      Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.

      Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.

      Parameters:
      createLocationAzureBlobRequest -
      Returns:
      A Java Future containing the result of the CreateLocationAzureBlob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationAzureBlob

      default CompletableFuture<CreateLocationAzureBlobResponse> createLocationAzureBlob(Consumer<CreateLocationAzureBlobRequest.Builder> createLocationAzureBlobRequest)

      Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.

      Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.


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

      Parameters:
      createLocationAzureBlobRequest - A Consumer that will call methods on CreateLocationAzureBlobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLocationAzureBlob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationEfs

      default CompletableFuture<CreateLocationEfsResponse> createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)

      Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.

      Parameters:
      createLocationEfsRequest - CreateLocationEfsRequest
      Returns:
      A Java Future containing the result of the CreateLocationEfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationEfs

      default CompletableFuture<CreateLocationEfsResponse> createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)

      Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.


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

      Parameters:
      createLocationEfsRequest - A Consumer that will call methods on CreateLocationEfsRequest.Builder to create a request. CreateLocationEfsRequest
      Returns:
      A Java Future containing the result of the CreateLocationEfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxLustre

      default CompletableFuture<CreateLocationFsxLustreResponse> createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)

      Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.

      Parameters:
      createLocationFsxLustreRequest -
      Returns:
      A Java Future containing the result of the CreateLocationFsxLustre operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxLustre

      default CompletableFuture<CreateLocationFsxLustreResponse> createLocationFsxLustre(Consumer<CreateLocationFsxLustreRequest.Builder> createLocationFsxLustreRequest)

      Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.


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

      Parameters:
      createLocationFsxLustreRequest - A Consumer that will call methods on CreateLocationFsxLustreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLocationFsxLustre operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxOntap

      default CompletableFuture<CreateLocationFsxOntapResponse> createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)

      Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.

      Parameters:
      createLocationFsxOntapRequest -
      Returns:
      A Java Future containing the result of the CreateLocationFsxOntap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxOntap

      default CompletableFuture<CreateLocationFsxOntapResponse> createLocationFsxOntap(Consumer<CreateLocationFsxOntapRequest.Builder> createLocationFsxOntapRequest)

      Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.


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

      Parameters:
      createLocationFsxOntapRequest - A Consumer that will call methods on CreateLocationFsxOntapRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLocationFsxOntap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxOpenZfs

      default CompletableFuture<CreateLocationFsxOpenZfsResponse> createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)

      Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.

      Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.

      Parameters:
      createLocationFsxOpenZfsRequest -
      Returns:
      A Java Future containing the result of the CreateLocationFsxOpenZfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxOpenZfs

      default CompletableFuture<CreateLocationFsxOpenZfsResponse> createLocationFsxOpenZfs(Consumer<CreateLocationFsxOpenZfsRequest.Builder> createLocationFsxOpenZfsRequest)

      Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.

      Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.


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

      Parameters:
      createLocationFsxOpenZfsRequest - A Consumer that will call methods on CreateLocationFsxOpenZfsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLocationFsxOpenZfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxWindows

      default CompletableFuture<CreateLocationFsxWindowsResponse> createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)

      Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.

      Parameters:
      createLocationFsxWindowsRequest -
      Returns:
      A Java Future containing the result of the CreateLocationFsxWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationFsxWindows

      default CompletableFuture<CreateLocationFsxWindowsResponse> createLocationFsxWindows(Consumer<CreateLocationFsxWindowsRequest.Builder> createLocationFsxWindowsRequest)

      Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.


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

      Parameters:
      createLocationFsxWindowsRequest - A Consumer that will call methods on CreateLocationFsxWindowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLocationFsxWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationHdfs

      default CompletableFuture<CreateLocationHdfsResponse> createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)

      Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses HDFS clusters.

      Parameters:
      createLocationHdfsRequest -
      Returns:
      A Java Future containing the result of the CreateLocationHdfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationHdfs

      default CompletableFuture<CreateLocationHdfsResponse> createLocationHdfs(Consumer<CreateLocationHdfsRequest.Builder> createLocationHdfsRequest)

      Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses HDFS clusters.


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

      Parameters:
      createLocationHdfsRequest - A Consumer that will call methods on CreateLocationHdfsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateLocationHdfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationNfs

      default CompletableFuture<CreateLocationNfsResponse> createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)

      Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses NFS file servers.

      If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.

      Parameters:
      createLocationNfsRequest - CreateLocationNfsRequest
      Returns:
      A Java Future containing the result of the CreateLocationNfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationNfs

      default CompletableFuture<CreateLocationNfsResponse> createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)

      Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses NFS file servers.

      If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.


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

      Parameters:
      createLocationNfsRequest - A Consumer that will call methods on CreateLocationNfsRequest.Builder to create a request. CreateLocationNfsRequest
      Returns:
      A Java Future containing the result of the CreateLocationNfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationObjectStorage

      default CompletableFuture<CreateLocationObjectStorageResponse> createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)

      Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.

      Parameters:
      createLocationObjectStorageRequest - CreateLocationObjectStorageRequest
      Returns:
      A Java Future containing the result of the CreateLocationObjectStorage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationObjectStorage

      default CompletableFuture<CreateLocationObjectStorageResponse> createLocationObjectStorage(Consumer<CreateLocationObjectStorageRequest.Builder> createLocationObjectStorageRequest)

      Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.


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

      Parameters:
      createLocationObjectStorageRequest - A Consumer that will call methods on CreateLocationObjectStorageRequest.Builder to create a request. CreateLocationObjectStorageRequest
      Returns:
      A Java Future containing the result of the CreateLocationObjectStorage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationS3

      default CompletableFuture<CreateLocationS3Response> createLocationS3(CreateLocationS3Request createLocationS3Request)

      Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you read the following topics:

      For more information, see Configuring transfers with Amazon S3.

      Parameters:
      createLocationS3Request - CreateLocationS3Request
      Returns:
      A Java Future containing the result of the CreateLocationS3 operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationS3

      default CompletableFuture<CreateLocationS3Response> createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)

      Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you read the following topics:

      For more information, see Configuring transfers with Amazon S3.


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

      Parameters:
      createLocationS3Request - A Consumer that will call methods on CreateLocationS3Request.Builder to create a request. CreateLocationS3Request
      Returns:
      A Java Future containing the result of the CreateLocationS3 operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationSmb

      default CompletableFuture<CreateLocationSmbResponse> createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)

      Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses SMB file servers.

      Parameters:
      createLocationSmbRequest - CreateLocationSmbRequest
      Returns:
      A Java Future containing the result of the CreateLocationSmb operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLocationSmb

      default CompletableFuture<CreateLocationSmbResponse> createLocationSmb(Consumer<CreateLocationSmbRequest.Builder> createLocationSmbRequest)

      Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.

      Before you begin, make sure that you understand how DataSync accesses SMB file servers.


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

      Parameters:
      createLocationSmbRequest - A Consumer that will call methods on CreateLocationSmbRequest.Builder to create a request. CreateLocationSmbRequest
      Returns:
      A Java Future containing the result of the CreateLocationSmb operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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)

      Configures a task, which defines where and how DataSync transfers your data.

      A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).

      If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

      Parameters:
      createTaskRequest - 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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)

      Configures a task, which defines where and how DataSync transfers your data.

      A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).

      If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.


      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. 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgent

      default CompletableFuture<DeleteAgentResponse> deleteAgent(DeleteAgentRequest deleteAgentRequest)

      Removes an DataSync agent resource from your Amazon Web Services account.

      Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.

      Parameters:
      deleteAgentRequest - DeleteAgentRequest
      Returns:
      A Java Future containing the result of the DeleteAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgent

      default CompletableFuture<DeleteAgentResponse> deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)

      Removes an DataSync agent resource from your Amazon Web Services account.

      Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.


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

      Parameters:
      deleteAgentRequest - A Consumer that will call methods on DeleteAgentRequest.Builder to create a request. DeleteAgentRequest
      Returns:
      A Java Future containing the result of the DeleteAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLocation

      default CompletableFuture<DeleteLocationResponse> deleteLocation(DeleteLocationRequest deleteLocationRequest)

      Deletes a transfer location resource from DataSync.

      Parameters:
      deleteLocationRequest - DeleteLocation
      Returns:
      A Java Future containing the result of the DeleteLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLocation

      default CompletableFuture<DeleteLocationResponse> deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)

      Deletes a transfer location resource from DataSync.


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

      Parameters:
      deleteLocationRequest - A Consumer that will call methods on DeleteLocationRequest.Builder to create a request. DeleteLocation
      Returns:
      A Java Future containing the result of the DeleteLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTask

      default CompletableFuture<DeleteTaskResponse> deleteTask(DeleteTaskRequest deleteTaskRequest)

      Deletes a transfer task resource from DataSync.

      Parameters:
      deleteTaskRequest - DeleteTask
      Returns:
      A Java Future containing the result of the DeleteTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteTask

      default CompletableFuture<DeleteTaskResponse> deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)

      Deletes a transfer task resource from DataSync.


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

      Parameters:
      deleteTaskRequest - A Consumer that will call methods on DeleteTaskRequest.Builder to create a request. DeleteTask
      Returns:
      A Java Future containing the result of the DeleteTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAgent

      default CompletableFuture<DescribeAgentResponse> describeAgent(DescribeAgentRequest describeAgentRequest)

      Returns information about an DataSync agent, such as its name, service endpoint type, and status.

      Parameters:
      describeAgentRequest - DescribeAgent
      Returns:
      A Java Future containing the result of the DescribeAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeAgent

      default CompletableFuture<DescribeAgentResponse> describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)

      Returns information about an DataSync agent, such as its name, service endpoint type, and status.


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

      Parameters:
      describeAgentRequest - A Consumer that will call methods on DescribeAgentRequest.Builder to create a request. DescribeAgent
      Returns:
      A Java Future containing the result of the DescribeAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDiscoveryJob

      default CompletableFuture<DescribeDiscoveryJobResponse> describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)

      Returns information about a DataSync discovery job.

      Parameters:
      describeDiscoveryJobRequest -
      Returns:
      A Java Future containing the result of the DescribeDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDiscoveryJob

      default CompletableFuture<DescribeDiscoveryJobResponse> describeDiscoveryJob(Consumer<DescribeDiscoveryJobRequest.Builder> describeDiscoveryJobRequest)

      Returns information about a DataSync discovery job.


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

      Parameters:
      describeDiscoveryJobRequest - A Consumer that will call methods on DescribeDiscoveryJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationAzureBlob

      default CompletableFuture<DescribeLocationAzureBlobResponse> describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)

      Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

      Parameters:
      describeLocationAzureBlobRequest -
      Returns:
      A Java Future containing the result of the DescribeLocationAzureBlob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationAzureBlob

      default CompletableFuture<DescribeLocationAzureBlobResponse> describeLocationAzureBlob(Consumer<DescribeLocationAzureBlobRequest.Builder> describeLocationAzureBlobRequest)

      Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.


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

      Parameters:
      describeLocationAzureBlobRequest - A Consumer that will call methods on DescribeLocationAzureBlobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLocationAzureBlob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationEfs

      default CompletableFuture<DescribeLocationEfsResponse> describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)

      Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

      Parameters:
      describeLocationEfsRequest - DescribeLocationEfsRequest
      Returns:
      A Java Future containing the result of the DescribeLocationEfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationEfs

      default CompletableFuture<DescribeLocationEfsResponse> describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)

      Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.


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

      Parameters:
      describeLocationEfsRequest - A Consumer that will call methods on DescribeLocationEfsRequest.Builder to create a request. DescribeLocationEfsRequest
      Returns:
      A Java Future containing the result of the DescribeLocationEfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxLustre

      default CompletableFuture<DescribeLocationFsxLustreResponse> describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.

      Parameters:
      describeLocationFsxLustreRequest -
      Returns:
      A Java Future containing the result of the DescribeLocationFsxLustre operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxLustre

      default CompletableFuture<DescribeLocationFsxLustreResponse> describeLocationFsxLustre(Consumer<DescribeLocationFsxLustreRequest.Builder> describeLocationFsxLustreRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.


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

      Parameters:
      describeLocationFsxLustreRequest - A Consumer that will call methods on DescribeLocationFsxLustreRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLocationFsxLustre operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxOntap

      default CompletableFuture<DescribeLocationFsxOntapResponse> describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

      If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.

      Parameters:
      describeLocationFsxOntapRequest -
      Returns:
      A Java Future containing the result of the DescribeLocationFsxOntap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxOntap

      default CompletableFuture<DescribeLocationFsxOntapResponse> describeLocationFsxOntap(Consumer<DescribeLocationFsxOntapRequest.Builder> describeLocationFsxOntapRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.

      If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.


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

      Parameters:
      describeLocationFsxOntapRequest - A Consumer that will call methods on DescribeLocationFsxOntapRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLocationFsxOntap operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxOpenZfs

      default CompletableFuture<DescribeLocationFsxOpenZfsResponse> describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.

      Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.

      Parameters:
      describeLocationFsxOpenZfsRequest -
      Returns:
      A Java Future containing the result of the DescribeLocationFsxOpenZfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxOpenZfs

      default CompletableFuture<DescribeLocationFsxOpenZfsResponse> describeLocationFsxOpenZfs(Consumer<DescribeLocationFsxOpenZfsRequest.Builder> describeLocationFsxOpenZfsRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.

      Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.


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

      Parameters:
      describeLocationFsxOpenZfsRequest - A Consumer that will call methods on DescribeLocationFsxOpenZfsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLocationFsxOpenZfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxWindows

      default CompletableFuture<DescribeLocationFsxWindowsResponse> describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

      Parameters:
      describeLocationFsxWindowsRequest -
      Returns:
      A Java Future containing the result of the DescribeLocationFsxWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationFsxWindows

      default CompletableFuture<DescribeLocationFsxWindowsResponse> describeLocationFsxWindows(Consumer<DescribeLocationFsxWindowsRequest.Builder> describeLocationFsxWindowsRequest)

      Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.


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

      Parameters:
      describeLocationFsxWindowsRequest - A Consumer that will call methods on DescribeLocationFsxWindowsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLocationFsxWindows operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationHdfs

      default CompletableFuture<DescribeLocationHdfsResponse> describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)

      Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

      Parameters:
      describeLocationHdfsRequest -
      Returns:
      A Java Future containing the result of the DescribeLocationHdfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationHdfs

      default CompletableFuture<DescribeLocationHdfsResponse> describeLocationHdfs(Consumer<DescribeLocationHdfsRequest.Builder> describeLocationHdfsRequest)

      Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.


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

      Parameters:
      describeLocationHdfsRequest - A Consumer that will call methods on DescribeLocationHdfsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeLocationHdfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationNfs

      default CompletableFuture<DescribeLocationNfsResponse> describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)

      Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

      Parameters:
      describeLocationNfsRequest - DescribeLocationNfsRequest
      Returns:
      A Java Future containing the result of the DescribeLocationNfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationNfs

      default CompletableFuture<DescribeLocationNfsResponse> describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)

      Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.


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

      Parameters:
      describeLocationNfsRequest - A Consumer that will call methods on DescribeLocationNfsRequest.Builder to create a request. DescribeLocationNfsRequest
      Returns:
      A Java Future containing the result of the DescribeLocationNfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationObjectStorage

      default CompletableFuture<DescribeLocationObjectStorageResponse> describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)

      Provides details about how an DataSync transfer location for an object storage system is configured.

      Parameters:
      describeLocationObjectStorageRequest - DescribeLocationObjectStorageRequest
      Returns:
      A Java Future containing the result of the DescribeLocationObjectStorage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationObjectStorage

      default CompletableFuture<DescribeLocationObjectStorageResponse> describeLocationObjectStorage(Consumer<DescribeLocationObjectStorageRequest.Builder> describeLocationObjectStorageRequest)

      Provides details about how an DataSync transfer location for an object storage system is configured.


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

      Parameters:
      describeLocationObjectStorageRequest - A Consumer that will call methods on DescribeLocationObjectStorageRequest.Builder to create a request. DescribeLocationObjectStorageRequest
      Returns:
      A Java Future containing the result of the DescribeLocationObjectStorage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationS3

      default CompletableFuture<DescribeLocationS3Response> describeLocationS3(DescribeLocationS3Request describeLocationS3Request)

      Provides details about how an DataSync transfer location for an S3 bucket is configured.

      Parameters:
      describeLocationS3Request - DescribeLocationS3Request
      Returns:
      A Java Future containing the result of the DescribeLocationS3 operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationS3

      default CompletableFuture<DescribeLocationS3Response> describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)

      Provides details about how an DataSync transfer location for an S3 bucket is configured.


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

      Parameters:
      describeLocationS3Request - A Consumer that will call methods on DescribeLocationS3Request.Builder to create a request. DescribeLocationS3Request
      Returns:
      A Java Future containing the result of the DescribeLocationS3 operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationSmb

      default CompletableFuture<DescribeLocationSmbResponse> describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)

      Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

      Parameters:
      describeLocationSmbRequest - DescribeLocationSmbRequest
      Returns:
      A Java Future containing the result of the DescribeLocationSmb operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLocationSmb

      default CompletableFuture<DescribeLocationSmbResponse> describeLocationSmb(Consumer<DescribeLocationSmbRequest.Builder> describeLocationSmbRequest)

      Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.


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

      Parameters:
      describeLocationSmbRequest - A Consumer that will call methods on DescribeLocationSmbRequest.Builder to create a request. DescribeLocationSmbRequest
      Returns:
      A Java Future containing the result of the DescribeLocationSmb operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystem

      default CompletableFuture<DescribeStorageSystemResponse> describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)

      Returns information about an on-premises storage system that you're using with DataSync Discovery.

      Parameters:
      describeStorageSystemRequest -
      Returns:
      A Java Future containing the result of the DescribeStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystem

      default CompletableFuture<DescribeStorageSystemResponse> describeStorageSystem(Consumer<DescribeStorageSystemRequest.Builder> describeStorageSystemRequest)

      Returns information about an on-premises storage system that you're using with DataSync Discovery.


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

      Parameters:
      describeStorageSystemRequest - A Consumer that will call methods on DescribeStorageSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResourceMetrics

      default CompletableFuture<DescribeStorageSystemResourceMetricsResponse> describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)

      Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

      Parameters:
      describeStorageSystemResourceMetricsRequest -
      Returns:
      A Java Future containing the result of the DescribeStorageSystemResourceMetrics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResourceMetrics

      default CompletableFuture<DescribeStorageSystemResourceMetricsResponse> describeStorageSystemResourceMetrics(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)

      Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.


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

      Parameters:
      describeStorageSystemResourceMetricsRequest - A Consumer that will call methods on DescribeStorageSystemResourceMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStorageSystemResourceMetrics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResourceMetricsPaginator

      default DescribeStorageSystemResourceMetricsPublisher describeStorageSystemResourceMetricsPaginator(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)

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

      Parameters:
      describeStorageSystemResourceMetricsRequest -
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResourceMetricsPaginator

      default DescribeStorageSystemResourceMetricsPublisher describeStorageSystemResourceMetricsPaginator(Consumer<DescribeStorageSystemResourceMetricsRequest.Builder> describeStorageSystemResourceMetricsRequest)

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


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

      Parameters:
      describeStorageSystemResourceMetricsRequest - A Consumer that will call methods on DescribeStorageSystemResourceMetricsRequest.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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResources

      default CompletableFuture<DescribeStorageSystemResourcesResponse> describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)

      Returns information that DataSync Discovery collects about resources in your on-premises storage system.

      Parameters:
      describeStorageSystemResourcesRequest -
      Returns:
      A Java Future containing the result of the DescribeStorageSystemResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResources

      default CompletableFuture<DescribeStorageSystemResourcesResponse> describeStorageSystemResources(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)

      Returns information that DataSync Discovery collects about resources in your on-premises storage system.


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

      Parameters:
      describeStorageSystemResourcesRequest - A Consumer that will call methods on DescribeStorageSystemResourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeStorageSystemResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResourcesPaginator

      default DescribeStorageSystemResourcesPublisher describeStorageSystemResourcesPaginator(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)

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

      Parameters:
      describeStorageSystemResourcesRequest -
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeStorageSystemResourcesPaginator

      default DescribeStorageSystemResourcesPublisher describeStorageSystemResourcesPaginator(Consumer<DescribeStorageSystemResourcesRequest.Builder> describeStorageSystemResourcesRequest)

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


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

      Parameters:
      describeStorageSystemResourcesRequest - A Consumer that will call methods on DescribeStorageSystemResourcesRequest.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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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)

      Provides information about a task, which defines where and how DataSync transfers your data.

      Parameters:
      describeTaskRequest - 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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)

      Provides information about a task, which defines where and how DataSync transfers your data.


      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. 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTaskExecution

      default CompletableFuture<DescribeTaskExecutionResponse> describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)

      Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.

      Parameters:
      describeTaskExecutionRequest - DescribeTaskExecutionRequest
      Returns:
      A Java Future containing the result of the DescribeTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeTaskExecution

      default CompletableFuture<DescribeTaskExecutionResponse> describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)

      Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.


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

      Parameters:
      describeTaskExecutionRequest - A Consumer that will call methods on DescribeTaskExecutionRequest.Builder to create a request. DescribeTaskExecutionRequest
      Returns:
      A Java Future containing the result of the DescribeTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateRecommendations

      default CompletableFuture<GenerateRecommendationsResponse> generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)

      Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.

      Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.

      Parameters:
      generateRecommendationsRequest -
      Returns:
      A Java Future containing the result of the GenerateRecommendations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateRecommendations

      default CompletableFuture<GenerateRecommendationsResponse> generateRecommendations(Consumer<GenerateRecommendationsRequest.Builder> generateRecommendationsRequest)

      Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.

      Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.


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

      Parameters:
      generateRecommendationsRequest - A Consumer that will call methods on GenerateRecommendationsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GenerateRecommendations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgents

      default CompletableFuture<ListAgentsResponse> listAgents(ListAgentsRequest listAgentsRequest)

      Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

      With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.

      ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.

      Parameters:
      listAgentsRequest - ListAgentsRequest
      Returns:
      A Java Future containing the result of the ListAgents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgents

      default CompletableFuture<ListAgentsResponse> listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)

      Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

      With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.

      ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.


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

      Parameters:
      listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request. ListAgentsRequest
      Returns:
      A Java Future containing the result of the ListAgents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgents

      default CompletableFuture<ListAgentsResponse> listAgents()

      Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

      With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.

      ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.

      Returns:
      A Java Future containing the result of the ListAgents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentsPaginator

      default ListAgentsPublisher listAgentsPaginator()

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

      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentsPaginator

      default ListAgentsPublisher listAgentsPaginator(ListAgentsRequest listAgentsRequest)

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

      Parameters:
      listAgentsRequest - ListAgentsRequest
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentsPaginator

      default ListAgentsPublisher listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)

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


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

      Parameters:
      listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request. ListAgentsRequest
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoveryJobs

      default CompletableFuture<ListDiscoveryJobsResponse> listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest)

      Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.

      Parameters:
      listDiscoveryJobsRequest -
      Returns:
      A Java Future containing the result of the ListDiscoveryJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoveryJobs

      default CompletableFuture<ListDiscoveryJobsResponse> listDiscoveryJobs(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)

      Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.


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

      Parameters:
      listDiscoveryJobsRequest - A Consumer that will call methods on ListDiscoveryJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDiscoveryJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoveryJobsPaginator

      default ListDiscoveryJobsPublisher listDiscoveryJobsPaginator(ListDiscoveryJobsRequest listDiscoveryJobsRequest)

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

      Parameters:
      listDiscoveryJobsRequest -
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDiscoveryJobsPaginator

      default ListDiscoveryJobsPublisher listDiscoveryJobsPaginator(Consumer<ListDiscoveryJobsRequest.Builder> listDiscoveryJobsRequest)

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


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

      Parameters:
      listDiscoveryJobsRequest - A Consumer that will call methods on ListDiscoveryJobsRequest.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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocations

      default CompletableFuture<ListLocationsResponse> listLocations(ListLocationsRequest listLocationsRequest)

      Returns a list of source and destination locations.

      If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.

      Parameters:
      listLocationsRequest - ListLocationsRequest
      Returns:
      A Java Future containing the result of the ListLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocations

      default CompletableFuture<ListLocationsResponse> listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)

      Returns a list of source and destination locations.

      If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.


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

      Parameters:
      listLocationsRequest - A Consumer that will call methods on ListLocationsRequest.Builder to create a request. ListLocationsRequest
      Returns:
      A Java Future containing the result of the ListLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocations

      default CompletableFuture<ListLocationsResponse> listLocations()

      Returns a list of source and destination locations.

      If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.

      Returns:
      A Java Future containing the result of the ListLocations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocationsPaginator

      default ListLocationsPublisher listLocationsPaginator()

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

      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocationsPaginator

      default ListLocationsPublisher listLocationsPaginator(ListLocationsRequest listLocationsRequest)

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

      Parameters:
      listLocationsRequest - ListLocationsRequest
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLocationsPaginator

      default ListLocationsPublisher listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)

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


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

      Parameters:
      listLocationsRequest - A Consumer that will call methods on ListLocationsRequest.Builder to create a request. ListLocationsRequest
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageSystems

      default CompletableFuture<ListStorageSystemsResponse> listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)

      Lists the on-premises storage systems that you're using with DataSync Discovery.

      Parameters:
      listStorageSystemsRequest -
      Returns:
      A Java Future containing the result of the ListStorageSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageSystems

      default CompletableFuture<ListStorageSystemsResponse> listStorageSystems(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)

      Lists the on-premises storage systems that you're using with DataSync Discovery.


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

      Parameters:
      listStorageSystemsRequest - A Consumer that will call methods on ListStorageSystemsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListStorageSystems operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageSystemsPaginator

      default ListStorageSystemsPublisher listStorageSystemsPaginator(ListStorageSystemsRequest listStorageSystemsRequest)

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

      Parameters:
      listStorageSystemsRequest -
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listStorageSystemsPaginator

      default ListStorageSystemsPublisher listStorageSystemsPaginator(Consumer<ListStorageSystemsRequest.Builder> listStorageSystemsRequest)

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


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

      Parameters:
      listStorageSystemsRequest - A Consumer that will call methods on ListStorageSystemsRequest.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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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 all the tags associated with an Amazon Web Services resource.

      Parameters:
      listTagsForResourceRequest - ListTagsForResourceRequest
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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 all the tags associated with an Amazon Web Services resource.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. ListTagsForResourceRequest
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

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

      Parameters:
      listTagsForResourceRequest - ListTagsForResourceRequest
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

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


      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. ListTagsForResourceRequest
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskExecutions

      default CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)

      Returns a list of executions for an DataSync transfer task.

      Parameters:
      listTaskExecutionsRequest - ListTaskExecutions
      Returns:
      A Java Future containing the result of the ListTaskExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskExecutions

      default CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)

      Returns a list of executions for an DataSync transfer task.


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

      Parameters:
      listTaskExecutionsRequest - A Consumer that will call methods on ListTaskExecutionsRequest.Builder to create a request. ListTaskExecutions
      Returns:
      A Java Future containing the result of the ListTaskExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskExecutions

      default CompletableFuture<ListTaskExecutionsResponse> listTaskExecutions()

      Returns a list of executions for an DataSync transfer task.

      Returns:
      A Java Future containing the result of the ListTaskExecutions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskExecutionsPaginator

      default ListTaskExecutionsPublisher listTaskExecutionsPaginator()

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

      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskExecutionsPaginator

      default ListTaskExecutionsPublisher listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)

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

      Parameters:
      listTaskExecutionsRequest - ListTaskExecutions
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTaskExecutionsPaginator

      default ListTaskExecutionsPublisher listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)

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


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

      Parameters:
      listTaskExecutionsRequest - A Consumer that will call methods on ListTaskExecutionsRequest.Builder to create a request. ListTaskExecutions
      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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 the DataSync tasks you created.

      Parameters:
      listTasksRequest - 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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 the DataSync tasks you created.


      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. 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks()

      Returns a list of the DataSync tasks you created.

      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator()

      This is a variant of listTasks(software.amazon.awssdk.services.datasync.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.datasync.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.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.datasync.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.datasync.model.ListTasksRequest) operation.

      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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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.datasync.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.datasync.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.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.datasync.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.datasync.model.ListTasksRequest) operation.

      Parameters:
      listTasksRequest - 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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.datasync.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.datasync.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.datasync.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.datasync.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.datasync.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.datasync.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. 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.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeStorageSystem

      default CompletableFuture<RemoveStorageSystemResponse> removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)

      Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

      Parameters:
      removeStorageSystemRequest -
      Returns:
      A Java Future containing the result of the RemoveStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeStorageSystem

      default CompletableFuture<RemoveStorageSystemResponse> removeStorageSystem(Consumer<RemoveStorageSystemRequest.Builder> removeStorageSystemRequest)

      Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.


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

      Parameters:
      removeStorageSystemRequest - A Consumer that will call methods on RemoveStorageSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RemoveStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDiscoveryJob

      default CompletableFuture<StartDiscoveryJobResponse> startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest)

      Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.

      Parameters:
      startDiscoveryJobRequest -
      Returns:
      A Java Future containing the result of the StartDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startDiscoveryJob

      default CompletableFuture<StartDiscoveryJobResponse> startDiscoveryJob(Consumer<StartDiscoveryJobRequest.Builder> startDiscoveryJobRequest)

      Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.


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

      Parameters:
      startDiscoveryJobRequest - A Consumer that will call methods on StartDiscoveryJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTaskExecution

      default CompletableFuture<StartTaskExecutionResponse> startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)

      Starts an DataSync transfer task. For each task, you can only run one task execution at a time.

      There are several phases to a task execution. For more information, see Task execution statuses.

      If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.

      Parameters:
      startTaskExecutionRequest - StartTaskExecutionRequest
      Returns:
      A Java Future containing the result of the StartTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTaskExecution

      default CompletableFuture<StartTaskExecutionResponse> startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)

      Starts an DataSync transfer task. For each task, you can only run one task execution at a time.

      There are several phases to a task execution. For more information, see Task execution statuses.

      If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.


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

      Parameters:
      startTaskExecutionRequest - A Consumer that will call methods on StartTaskExecutionRequest.Builder to create a request. StartTaskExecutionRequest
      Returns:
      A Java Future containing the result of the StartTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopDiscoveryJob

      default CompletableFuture<StopDiscoveryJobResponse> stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)

      Stops a running DataSync discovery job.

      You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.

      Parameters:
      stopDiscoveryJobRequest -
      Returns:
      A Java Future containing the result of the StopDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • stopDiscoveryJob

      default CompletableFuture<StopDiscoveryJobResponse> stopDiscoveryJob(Consumer<StopDiscoveryJobRequest.Builder> stopDiscoveryJobRequest)

      Stops a running DataSync discovery job.

      You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.


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

      Parameters:
      stopDiscoveryJobRequest - A Consumer that will call methods on StopDiscoveryJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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)

      Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.

      These include DataSync resources, such as locations, tasks, and task executions.

      Parameters:
      tagResourceRequest - TagResourceRequest
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException 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)

      Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.

      These include DataSync resources, such as locations, tasks, and task executions.


      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. TagResourceRequest
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from an Amazon Web Services resource.

      Parameters:
      untagResourceRequest - UntagResourceRequest
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

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

      Removes tags from an Amazon Web Services resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. UntagResourceRequest
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgent

      default CompletableFuture<UpdateAgentResponse> updateAgent(UpdateAgentRequest updateAgentRequest)

      Updates the name of an DataSync agent.

      Parameters:
      updateAgentRequest - UpdateAgentRequest
      Returns:
      A Java Future containing the result of the UpdateAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgent

      default CompletableFuture<UpdateAgentResponse> updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)

      Updates the name of an DataSync agent.


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

      Parameters:
      updateAgentRequest - A Consumer that will call methods on UpdateAgentRequest.Builder to create a request. UpdateAgentRequest
      Returns:
      A Java Future containing the result of the UpdateAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDiscoveryJob

      default CompletableFuture<UpdateDiscoveryJobResponse> updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)

      Edits a DataSync discovery job configuration.

      Parameters:
      updateDiscoveryJobRequest -
      Returns:
      A Java Future containing the result of the UpdateDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDiscoveryJob

      default CompletableFuture<UpdateDiscoveryJobResponse> updateDiscoveryJob(Consumer<UpdateDiscoveryJobRequest.Builder> updateDiscoveryJobRequest)

      Edits a DataSync discovery job configuration.


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

      Parameters:
      updateDiscoveryJobRequest - A Consumer that will call methods on UpdateDiscoveryJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDiscoveryJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationAzureBlob

      default CompletableFuture<UpdateLocationAzureBlobResponse> updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)

      Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

      Parameters:
      updateLocationAzureBlobRequest -
      Returns:
      A Java Future containing the result of the UpdateLocationAzureBlob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationAzureBlob

      default CompletableFuture<UpdateLocationAzureBlobResponse> updateLocationAzureBlob(Consumer<UpdateLocationAzureBlobRequest.Builder> updateLocationAzureBlobRequest)

      Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.


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

      Parameters:
      updateLocationAzureBlobRequest - A Consumer that will call methods on UpdateLocationAzureBlobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLocationAzureBlob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationHdfs

      default CompletableFuture<UpdateLocationHdfsResponse> updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)

      Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

      Parameters:
      updateLocationHdfsRequest -
      Returns:
      A Java Future containing the result of the UpdateLocationHdfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationHdfs

      default CompletableFuture<UpdateLocationHdfsResponse> updateLocationHdfs(Consumer<UpdateLocationHdfsRequest.Builder> updateLocationHdfsRequest)

      Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.


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

      Parameters:
      updateLocationHdfsRequest - A Consumer that will call methods on UpdateLocationHdfsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLocationHdfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationNfs

      default CompletableFuture<UpdateLocationNfsResponse> updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)

      Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.

      For more information, see Configuring transfers to or from an NFS file server.

      Parameters:
      updateLocationNfsRequest -
      Returns:
      A Java Future containing the result of the UpdateLocationNfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationNfs

      default CompletableFuture<UpdateLocationNfsResponse> updateLocationNfs(Consumer<UpdateLocationNfsRequest.Builder> updateLocationNfsRequest)

      Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.

      For more information, see Configuring transfers to or from an NFS file server.


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

      Parameters:
      updateLocationNfsRequest - A Consumer that will call methods on UpdateLocationNfsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLocationNfs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationObjectStorage

      default CompletableFuture<UpdateLocationObjectStorageResponse> updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)

      Updates some parameters of an existing DataSync location for an object storage system.

      Parameters:
      updateLocationObjectStorageRequest -
      Returns:
      A Java Future containing the result of the UpdateLocationObjectStorage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationObjectStorage

      default CompletableFuture<UpdateLocationObjectStorageResponse> updateLocationObjectStorage(Consumer<UpdateLocationObjectStorageRequest.Builder> updateLocationObjectStorageRequest)

      Updates some parameters of an existing DataSync location for an object storage system.


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

      Parameters:
      updateLocationObjectStorageRequest - A Consumer that will call methods on UpdateLocationObjectStorageRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLocationObjectStorage operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationSmb

      default CompletableFuture<UpdateLocationSmbResponse> updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)

      Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.

      Parameters:
      updateLocationSmbRequest -
      Returns:
      A Java Future containing the result of the UpdateLocationSmb operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateLocationSmb

      default CompletableFuture<UpdateLocationSmbResponse> updateLocationSmb(Consumer<UpdateLocationSmbRequest.Builder> updateLocationSmbRequest)

      Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.


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

      Parameters:
      updateLocationSmbRequest - A Consumer that will call methods on UpdateLocationSmbRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateLocationSmb operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStorageSystem

      default CompletableFuture<UpdateStorageSystemResponse> updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)

      Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

      Parameters:
      updateStorageSystemRequest -
      Returns:
      A Java Future containing the result of the UpdateStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateStorageSystem

      default CompletableFuture<UpdateStorageSystemResponse> updateStorageSystem(Consumer<UpdateStorageSystemRequest.Builder> updateStorageSystemRequest)

      Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.


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

      Parameters:
      updateStorageSystemRequest - A Consumer that will call methods on UpdateStorageSystemRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateStorageSystem operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTask

      default CompletableFuture<UpdateTaskResponse> updateTask(UpdateTaskRequest updateTaskRequest)

      Updates the configuration of a task, which defines where and how DataSync transfers your data.

      Parameters:
      updateTaskRequest - UpdateTaskResponse
      Returns:
      A Java Future containing the result of the UpdateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTask

      default CompletableFuture<UpdateTaskResponse> updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)

      Updates the configuration of a task, which defines where and how DataSync transfers your data.


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

      Parameters:
      updateTaskRequest - A Consumer that will call methods on UpdateTaskRequest.Builder to create a request. UpdateTaskResponse
      Returns:
      A Java Future containing the result of the UpdateTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTaskExecution

      default CompletableFuture<UpdateTaskExecutionResponse> updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)

      Updates the configuration of a running DataSync task execution.

      Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.

      Parameters:
      updateTaskExecutionRequest -
      Returns:
      A Java Future containing the result of the UpdateTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTaskExecution

      default CompletableFuture<UpdateTaskExecutionResponse> updateTaskExecution(Consumer<UpdateTaskExecutionRequest.Builder> updateTaskExecutionRequest)

      Updates the configuration of a running DataSync task execution.

      Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.


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

      Parameters:
      updateTaskExecutionRequest - A Consumer that will call methods on UpdateTaskExecutionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTaskExecution operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException This exception is thrown when the client submits a malformed request.
      • InternalException This exception is thrown when an error occurs in the DataSync 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.
      • DataSyncException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static DataSyncAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a DataSyncAsyncClient.