@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSDataSyncAsyncClient extends AWSDataSyncClient implements AWSDataSyncAsync
AsyncHandler
can be used to receive notification when
an asynchronous operation completes.
DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Web Services storage services. You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, cancelTaskExecution, createAgent, createLocationEfs, createLocationFsxLustre, createLocationFsxOntap, createLocationFsxOpenZfs, createLocationFsxWindows, createLocationHdfs, createLocationNfs, createLocationObjectStorage, createLocationS3, createLocationSmb, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationFsxLustre, describeLocationFsxOntap, describeLocationFsxOpenZfs, describeLocationFsxWindows, describeLocationHdfs, describeLocationNfs, describeLocationObjectStorage, describeLocationS3, describeLocationSmb, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, startTaskExecution, tagResource, untagResource, updateAgent, updateLocationHdfs, updateLocationNfs, updateLocationObjectStorage, updateLocationSmb, updateTask, updateTaskExecution
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelTaskExecution, createAgent, createLocationEfs, createLocationFsxLustre, createLocationFsxOntap, createLocationFsxOpenZfs, createLocationFsxWindows, createLocationHdfs, createLocationNfs, createLocationObjectStorage, createLocationS3, createLocationSmb, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationFsxLustre, describeLocationFsxOntap, describeLocationFsxOpenZfs, describeLocationFsxWindows, describeLocationHdfs, describeLocationNfs, describeLocationObjectStorage, describeLocationS3, describeLocationSmb, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, startTaskExecution, tagResource, untagResource, updateAgent, updateLocationHdfs, updateLocationNfs, updateLocationObjectStorage, updateLocationSmb, updateTask, updateTaskExecution
public static AWSDataSyncAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest request)
AWSDataSyncAsync
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.
cancelTaskExecutionAsync
in interface AWSDataSyncAsync
request
- CancelTaskExecutionRequestpublic Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest request, AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
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.
cancelTaskExecutionAsync
in interface AWSDataSyncAsync
request
- CancelTaskExecutionRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAgentResult> createAgentAsync(CreateAgentRequest request)
AWSDataSyncAsync
Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgentAsync
in interface AWSDataSyncAsync
request
- CreateAgentRequestpublic Future<CreateAgentResult> createAgentAsync(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
AWSDataSyncAsync
Activates an DataSync agent that you have deployed in your storage environment. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgentAsync
in interface AWSDataSyncAsync
request
- CreateAgentRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest request)
AWSDataSyncAsync
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
createLocationEfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationEfsRequestpublic Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest request, AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
createLocationEfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationEfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationFsxLustreResult> createLocationFsxLustreAsync(CreateLocationFsxLustreRequest request)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreAsync
in interface AWSDataSyncAsync
public Future<CreateLocationFsxLustreResult> createLocationFsxLustreAsync(CreateLocationFsxLustreRequest request, AsyncHandler<CreateLocationFsxLustreRequest,CreateLocationFsxLustreResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationFsxOntapResult> createLocationFsxOntapAsync(CreateLocationFsxOntapRequest request)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
createLocationFsxOntapAsync
in interface AWSDataSyncAsync
public Future<CreateLocationFsxOntapResult> createLocationFsxOntapAsync(CreateLocationFsxOntapRequest request, AsyncHandler<CreateLocationFsxOntapRequest,CreateLocationFsxOntapResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
createLocationFsxOntapAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationFsxOpenZfsResult> createLocationFsxOpenZfsAsync(CreateLocationFsxOpenZfsRequest request)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
Request parameters related to SMB
aren't supported with the CreateLocationFsxOpenZfs
operation.
createLocationFsxOpenZfsAsync
in interface AWSDataSyncAsync
public Future<CreateLocationFsxOpenZfsResult> createLocationFsxOpenZfsAsync(CreateLocationFsxOpenZfsRequest request, AsyncHandler<CreateLocationFsxOpenZfsRequest,CreateLocationFsxOpenZfsResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
Request parameters related to SMB
aren't supported with the CreateLocationFsxOpenZfs
operation.
createLocationFsxOpenZfsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationFsxWindowsResult> createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest request)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsAsync
in interface AWSDataSyncAsync
public Future<CreateLocationFsxWindowsResult> createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest request, AsyncHandler<CreateLocationFsxWindowsRequest,CreateLocationFsxWindowsResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationHdfsResult> createLocationHdfsAsync(CreateLocationHdfsRequest request)
AWSDataSyncAsync
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsAsync
in interface AWSDataSyncAsync
public Future<CreateLocationHdfsResult> createLocationHdfsAsync(CreateLocationHdfsRequest request, AsyncHandler<CreateLocationHdfsRequest,CreateLocationHdfsResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest request)
AWSDataSyncAsync
Defines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationNfsRequestpublic Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest request, AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)
AWSDataSyncAsync
Defines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationNfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationObjectStorageResult> createLocationObjectStorageAsync(CreateLocationObjectStorageRequest request)
AWSDataSyncAsync
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
createLocationObjectStorageAsync
in interface AWSDataSyncAsync
request
- CreateLocationObjectStorageRequestpublic Future<CreateLocationObjectStorageResult> createLocationObjectStorageAsync(CreateLocationObjectStorageRequest request, AsyncHandler<CreateLocationObjectStorageRequest,CreateLocationObjectStorageResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
createLocationObjectStorageAsync
in interface AWSDataSyncAsync
request
- CreateLocationObjectStorageRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request request)
AWSDataSyncAsync
Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
createLocationS3Async
in interface AWSDataSyncAsync
request
- CreateLocationS3Requestpublic Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request request, AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
createLocationS3Async
in interface AWSDataSyncAsync
request
- CreateLocationS3RequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest request)
AWSDataSyncAsync
Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
createLocationSmbAsync
in interface AWSDataSyncAsync
request
- CreateLocationSmbRequestpublic Future<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest request, AsyncHandler<CreateLocationSmbRequest,CreateLocationSmbResult> asyncHandler)
AWSDataSyncAsync
Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
createLocationSmbAsync
in interface AWSDataSyncAsync
request
- CreateLocationSmbRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request)
AWSDataSyncAsync
Configures a task, which defines where and how DataSync transfers your data.
A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync.
For more information, see the following topics:
createTaskAsync
in interface AWSDataSyncAsync
request
- CreateTaskRequestpublic Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request, AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)
AWSDataSyncAsync
Configures a task, which defines where and how DataSync transfers your data.
A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync.
For more information, see the following topics:
createTaskAsync
in interface AWSDataSyncAsync
request
- CreateTaskRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest request)
AWSDataSyncAsync
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgentAsync
in interface AWSDataSyncAsync
request
- DeleteAgentRequestpublic Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResult> asyncHandler)
AWSDataSyncAsync
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgentAsync
in interface AWSDataSyncAsync
request
- DeleteAgentRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest request)
AWSDataSyncAsync
Deletes the configuration of a location used by DataSync.
deleteLocationAsync
in interface AWSDataSyncAsync
request
- DeleteLocationpublic Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest request, AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)
AWSDataSyncAsync
Deletes the configuration of a location used by DataSync.
deleteLocationAsync
in interface AWSDataSyncAsync
request
- DeleteLocationasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest request)
AWSDataSyncAsync
Deletes a task.
deleteTaskAsync
in interface AWSDataSyncAsync
request
- DeleteTaskpublic Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest request, AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)
AWSDataSyncAsync
Deletes a task.
deleteTaskAsync
in interface AWSDataSyncAsync
request
- DeleteTaskasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest request)
AWSDataSyncAsync
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
describeAgentAsync
in interface AWSDataSyncAsync
request
- DescribeAgentpublic Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest request, AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)
AWSDataSyncAsync
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
describeAgentAsync
in interface AWSDataSyncAsync
request
- DescribeAgentasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest request)
AWSDataSyncAsync
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationEfsRequestpublic Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest request, AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)
AWSDataSyncAsync
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationEfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationFsxLustreResult> describeLocationFsxLustreAsync(DescribeLocationFsxLustreRequest request)
AWSDataSyncAsync
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreAsync
in interface AWSDataSyncAsync
public Future<DescribeLocationFsxLustreResult> describeLocationFsxLustreAsync(DescribeLocationFsxLustreRequest request, AsyncHandler<DescribeLocationFsxLustreRequest,DescribeLocationFsxLustreResult> asyncHandler)
AWSDataSyncAsync
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationFsxOntapResult> describeLocationFsxOntapAsync(DescribeLocationFsxOntapRequest request)
AWSDataSyncAsync
Provides details about how an DataSync 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
.
describeLocationFsxOntapAsync
in interface AWSDataSyncAsync
public Future<DescribeLocationFsxOntapResult> describeLocationFsxOntapAsync(DescribeLocationFsxOntapRequest request, AsyncHandler<DescribeLocationFsxOntapRequest,DescribeLocationFsxOntapResult> asyncHandler)
AWSDataSyncAsync
Provides details about how an DataSync 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
.
describeLocationFsxOntapAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationFsxOpenZfsResult> describeLocationFsxOpenZfsAsync(DescribeLocationFsxOpenZfsRequest request)
AWSDataSyncAsync
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB
aren't supported with the DescribeLocationFsxOpenZfs
operation.
describeLocationFsxOpenZfsAsync
in interface AWSDataSyncAsync
public Future<DescribeLocationFsxOpenZfsResult> describeLocationFsxOpenZfsAsync(DescribeLocationFsxOpenZfsRequest request, AsyncHandler<DescribeLocationFsxOpenZfsRequest,DescribeLocationFsxOpenZfsResult> asyncHandler)
AWSDataSyncAsync
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB
aren't supported with the DescribeLocationFsxOpenZfs
operation.
describeLocationFsxOpenZfsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationFsxWindowsResult> describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest request)
AWSDataSyncAsync
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsAsync
in interface AWSDataSyncAsync
public Future<DescribeLocationFsxWindowsResult> describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest request, AsyncHandler<DescribeLocationFsxWindowsRequest,DescribeLocationFsxWindowsResult> asyncHandler)
AWSDataSyncAsync
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationHdfsResult> describeLocationHdfsAsync(DescribeLocationHdfsRequest request)
AWSDataSyncAsync
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsAsync
in interface AWSDataSyncAsync
public Future<DescribeLocationHdfsResult> describeLocationHdfsAsync(DescribeLocationHdfsRequest request, AsyncHandler<DescribeLocationHdfsRequest,DescribeLocationHdfsResult> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest request)
AWSDataSyncAsync
Returns metadata, such as the path information, about an NFS location.
describeLocationNfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationNfsRequestpublic Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest request, AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as the path information, about an NFS location.
describeLocationNfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationNfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationObjectStorageResult> describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest request)
AWSDataSyncAsync
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageAsync
in interface AWSDataSyncAsync
request
- DescribeLocationObjectStorageRequestpublic Future<DescribeLocationObjectStorageResult> describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest request, AsyncHandler<DescribeLocationObjectStorageRequest,DescribeLocationObjectStorageResult> asyncHandler)
AWSDataSyncAsync
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageAsync
in interface AWSDataSyncAsync
request
- DescribeLocationObjectStorageRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request request)
AWSDataSyncAsync
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Async
in interface AWSDataSyncAsync
request
- DescribeLocationS3Requestpublic Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request request, AsyncHandler<DescribeLocationS3Request,DescribeLocationS3Result> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Async
in interface AWSDataSyncAsync
request
- DescribeLocationS3RequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest request)
AWSDataSyncAsync
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbAsync
in interface AWSDataSyncAsync
request
- DescribeLocationSmbRequestpublic Future<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest request, AsyncHandler<DescribeLocationSmbRequest,DescribeLocationSmbResult> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbAsync
in interface AWSDataSyncAsync
request
- DescribeLocationSmbRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request)
AWSDataSyncAsync
Returns metadata about a task.
describeTaskAsync
in interface AWSDataSyncAsync
request
- DescribeTaskRequestpublic Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request, AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)
AWSDataSyncAsync
Returns metadata about a task.
describeTaskAsync
in interface AWSDataSyncAsync
request
- DescribeTaskRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest request)
AWSDataSyncAsync
Returns detailed metadata about a task that is being executed.
describeTaskExecutionAsync
in interface AWSDataSyncAsync
request
- DescribeTaskExecutionRequestpublic Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest request, AsyncHandler<DescribeTaskExecutionRequest,DescribeTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
Returns detailed metadata about a task that is being executed.
describeTaskExecutionAsync
in interface AWSDataSyncAsync
request
- DescribeTaskExecutionRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest request)
AWSDataSyncAsync
Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
listAgentsAsync
in interface AWSDataSyncAsync
request
- ListAgentsRequestpublic Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
AWSDataSyncAsync
Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
listAgentsAsync
in interface AWSDataSyncAsync
request
- ListAgentsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest request)
AWSDataSyncAsync
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.
listLocationsAsync
in interface AWSDataSyncAsync
request
- ListLocationsRequestpublic Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest request, AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)
AWSDataSyncAsync
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.
listLocationsAsync
in interface AWSDataSyncAsync
request
- ListLocationsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSDataSyncAsync
Returns all the tags associated with a specified resource.
listTagsForResourceAsync
in interface AWSDataSyncAsync
request
- ListTagsForResourceRequestpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSDataSyncAsync
Returns all the tags associated with a specified resource.
listTagsForResourceAsync
in interface AWSDataSyncAsync
request
- ListTagsForResourceRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest request)
AWSDataSyncAsync
Returns a list of executed tasks.
listTaskExecutionsAsync
in interface AWSDataSyncAsync
request
- ListTaskExecutionspublic Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest request, AsyncHandler<ListTaskExecutionsRequest,ListTaskExecutionsResult> asyncHandler)
AWSDataSyncAsync
Returns a list of executed tasks.
listTaskExecutionsAsync
in interface AWSDataSyncAsync
request
- ListTaskExecutionsasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTasksResult> listTasksAsync(ListTasksRequest request)
AWSDataSyncAsync
Returns a list of the DataSync tasks you created.
listTasksAsync
in interface AWSDataSyncAsync
request
- ListTasksRequestpublic Future<ListTasksResult> listTasksAsync(ListTasksRequest request, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
AWSDataSyncAsync
Returns a list of the DataSync tasks you created.
listTasksAsync
in interface AWSDataSyncAsync
request
- ListTasksRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest request)
AWSDataSyncAsync
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.
startTaskExecutionAsync
in interface AWSDataSyncAsync
request
- StartTaskExecutionRequestpublic Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest request, AsyncHandler<StartTaskExecutionRequest,StartTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.
startTaskExecutionAsync
in interface AWSDataSyncAsync
request
- StartTaskExecutionRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSDataSyncAsync
Applies a key-value pair to an Amazon Web Services resource.
tagResourceAsync
in interface AWSDataSyncAsync
request
- TagResourceRequestpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSDataSyncAsync
Applies a key-value pair to an Amazon Web Services resource.
tagResourceAsync
in interface AWSDataSyncAsync
request
- TagResourceRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSDataSyncAsync
Removes a tag from an Amazon Web Services resource.
untagResourceAsync
in interface AWSDataSyncAsync
request
- UntagResourceRequestpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSDataSyncAsync
Removes a tag from an Amazon Web Services resource.
untagResourceAsync
in interface AWSDataSyncAsync
request
- UntagResourceRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest request)
AWSDataSyncAsync
Updates the name of an agent.
updateAgentAsync
in interface AWSDataSyncAsync
request
- UpdateAgentRequestpublic Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
AWSDataSyncAsync
Updates the name of an agent.
updateAgentAsync
in interface AWSDataSyncAsync
request
- UpdateAgentRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLocationHdfsResult> updateLocationHdfsAsync(UpdateLocationHdfsRequest request)
AWSDataSyncAsync
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsAsync
in interface AWSDataSyncAsync
public Future<UpdateLocationHdfsResult> updateLocationHdfsAsync(UpdateLocationHdfsRequest request, AsyncHandler<UpdateLocationHdfsRequest,UpdateLocationHdfsResult> asyncHandler)
AWSDataSyncAsync
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLocationNfsResult> updateLocationNfsAsync(UpdateLocationNfsRequest request)
AWSDataSyncAsync
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
updateLocationNfsAsync
in interface AWSDataSyncAsync
public Future<UpdateLocationNfsResult> updateLocationNfsAsync(UpdateLocationNfsRequest request, AsyncHandler<UpdateLocationNfsRequest,UpdateLocationNfsResult> asyncHandler)
AWSDataSyncAsync
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
updateLocationNfsAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLocationObjectStorageResult> updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest request)
AWSDataSyncAsync
Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
updateLocationObjectStorageAsync
in interface AWSDataSyncAsync
public Future<UpdateLocationObjectStorageResult> updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest request, AsyncHandler<UpdateLocationObjectStorageRequest,UpdateLocationObjectStorageResult> asyncHandler)
AWSDataSyncAsync
Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
updateLocationObjectStorageAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateLocationSmbResult> updateLocationSmbAsync(UpdateLocationSmbRequest request)
AWSDataSyncAsync
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
updateLocationSmbAsync
in interface AWSDataSyncAsync
public Future<UpdateLocationSmbResult> updateLocationSmbAsync(UpdateLocationSmbRequest request, AsyncHandler<UpdateLocationSmbRequest,UpdateLocationSmbResult> asyncHandler)
AWSDataSyncAsync
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
updateLocationSmbAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest request)
AWSDataSyncAsync
Updates the metadata associated with a task.
updateTaskAsync
in interface AWSDataSyncAsync
request
- UpdateTaskResponsepublic Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest request, AsyncHandler<UpdateTaskRequest,UpdateTaskResult> asyncHandler)
AWSDataSyncAsync
Updates the metadata associated with a task.
updateTaskAsync
in interface AWSDataSyncAsync
request
- UpdateTaskResponseasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTaskExecutionResult> updateTaskExecutionAsync(UpdateTaskExecutionRequest request)
AWSDataSyncAsync
Updates execution of a task.
You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.
The only Option
that can be modified by UpdateTaskExecution
is
BytesPerSecond
.
updateTaskExecutionAsync
in interface AWSDataSyncAsync
public Future<UpdateTaskExecutionResult> updateTaskExecutionAsync(UpdateTaskExecutionRequest request, AsyncHandler<UpdateTaskExecutionRequest,UpdateTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
Updates execution of a task.
You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.
The only Option
that can be modified by UpdateTaskExecution
is
BytesPerSecond
.
updateTaskExecutionAsync
in interface AWSDataSyncAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSDataSync
shutdown
in class AWSDataSyncClient