@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSDataSyncAsync extends AWSDataSync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDataSyncAsync
instead.
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 .
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
Future<CancelTaskExecutionResult> |
cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Stops an DataSync task execution that's in progress.
|
Future<CancelTaskExecutionResult> |
cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest,
AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)
Stops an DataSync task execution that's in progress.
|
Future<CreateAgentResult> |
createAgentAsync(CreateAgentRequest createAgentRequest)
Activates an DataSync agent that you have deployed in your storage environment.
|
Future<CreateAgentResult> |
createAgentAsync(CreateAgentRequest createAgentRequest,
AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
Activates an DataSync agent that you have deployed in your storage environment.
|
Future<CreateLocationEfsResult> |
createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
Future<CreateLocationEfsResult> |
createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest,
AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
Future<CreateLocationFsxLustreResult> |
createLocationFsxLustreAsync(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
Future<CreateLocationFsxLustreResult> |
createLocationFsxLustreAsync(CreateLocationFsxLustreRequest createLocationFsxLustreRequest,
AsyncHandler<CreateLocationFsxLustreRequest,CreateLocationFsxLustreResult> asyncHandler)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
Future<CreateLocationFsxOntapResult> |
createLocationFsxOntapAsync(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
|
Future<CreateLocationFsxOntapResult> |
createLocationFsxOntapAsync(CreateLocationFsxOntapRequest createLocationFsxOntapRequest,
AsyncHandler<CreateLocationFsxOntapRequest,CreateLocationFsxOntapResult> asyncHandler)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
|
Future<CreateLocationFsxOpenZfsResult> |
createLocationFsxOpenZfsAsync(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
Future<CreateLocationFsxOpenZfsResult> |
createLocationFsxOpenZfsAsync(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest,
AsyncHandler<CreateLocationFsxOpenZfsRequest,CreateLocationFsxOpenZfsResult> asyncHandler)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
Future<CreateLocationFsxWindowsResult> |
createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
Future<CreateLocationFsxWindowsResult> |
createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest,
AsyncHandler<CreateLocationFsxWindowsRequest,CreateLocationFsxWindowsResult> asyncHandler)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
Future<CreateLocationHdfsResult> |
createLocationHdfsAsync(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
Future<CreateLocationHdfsResult> |
createLocationHdfsAsync(CreateLocationHdfsRequest createLocationHdfsRequest,
AsyncHandler<CreateLocationHdfsRequest,CreateLocationHdfsResult> asyncHandler)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
Future<CreateLocationNfsResult> |
createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
|
Future<CreateLocationNfsResult> |
createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest,
AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
|
Future<CreateLocationObjectStorageResult> |
createLocationObjectStorageAsync(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
Future<CreateLocationObjectStorageResult> |
createLocationObjectStorageAsync(CreateLocationObjectStorageRequest createLocationObjectStorageRequest,
AsyncHandler<CreateLocationObjectStorageRequest,CreateLocationObjectStorageResult> asyncHandler)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
Future<CreateLocationS3Result> |
createLocationS3Async(CreateLocationS3Request createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.
|
Future<CreateLocationS3Result> |
createLocationS3Async(CreateLocationS3Request createLocationS3Request,
AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)
Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.
|
Future<CreateLocationSmbResult> |
createLocationSmbAsync(CreateLocationSmbRequest createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.
|
Future<CreateLocationSmbResult> |
createLocationSmbAsync(CreateLocationSmbRequest createLocationSmbRequest,
AsyncHandler<CreateLocationSmbRequest,CreateLocationSmbResult> asyncHandler)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.
|
Future<CreateTaskResult> |
createTaskAsync(CreateTaskRequest createTaskRequest)
Configures a task, which defines where and how DataSync transfers your data.
|
Future<CreateTaskResult> |
createTaskAsync(CreateTaskRequest createTaskRequest,
AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)
Configures a task, which defines where and how DataSync transfers your data.
|
Future<DeleteAgentResult> |
deleteAgentAsync(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
|
Future<DeleteAgentResult> |
deleteAgentAsync(DeleteAgentRequest deleteAgentRequest,
AsyncHandler<DeleteAgentRequest,DeleteAgentResult> asyncHandler)
Deletes an agent.
|
Future<DeleteLocationResult> |
deleteLocationAsync(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
|
Future<DeleteLocationResult> |
deleteLocationAsync(DeleteLocationRequest deleteLocationRequest,
AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)
Deletes the configuration of a location used by DataSync.
|
Future<DeleteTaskResult> |
deleteTaskAsync(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync task.
|
Future<DeleteTaskResult> |
deleteTaskAsync(DeleteTaskRequest deleteTaskRequest,
AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)
Deletes an DataSync task.
|
Future<DescribeAgentResult> |
describeAgentAsync(DescribeAgentRequest describeAgentRequest)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
|
Future<DescribeAgentResult> |
describeAgentAsync(DescribeAgentRequest describeAgentRequest,
AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
|
Future<DescribeLocationEfsResult> |
describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
Future<DescribeLocationEfsResult> |
describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest,
AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
Future<DescribeLocationFsxLustreResult> |
describeLocationFsxLustreAsync(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
Future<DescribeLocationFsxLustreResult> |
describeLocationFsxLustreAsync(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest,
AsyncHandler<DescribeLocationFsxLustreRequest,DescribeLocationFsxLustreResult> asyncHandler)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
Future<DescribeLocationFsxOntapResult> |
describeLocationFsxOntapAsync(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
Future<DescribeLocationFsxOntapResult> |
describeLocationFsxOntapAsync(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest,
AsyncHandler<DescribeLocationFsxOntapRequest,DescribeLocationFsxOntapResult> asyncHandler)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
Future<DescribeLocationFsxOpenZfsResult> |
describeLocationFsxOpenZfsAsync(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
Future<DescribeLocationFsxOpenZfsResult> |
describeLocationFsxOpenZfsAsync(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest,
AsyncHandler<DescribeLocationFsxOpenZfsRequest,DescribeLocationFsxOpenZfsResult> asyncHandler)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
Future<DescribeLocationFsxWindowsResult> |
describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
Future<DescribeLocationFsxWindowsResult> |
describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest,
AsyncHandler<DescribeLocationFsxWindowsRequest,DescribeLocationFsxWindowsResult> asyncHandler)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
Future<DescribeLocationHdfsResult> |
describeLocationHdfsAsync(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
Future<DescribeLocationHdfsResult> |
describeLocationHdfsAsync(DescribeLocationHdfsRequest describeLocationHdfsRequest,
AsyncHandler<DescribeLocationHdfsRequest,DescribeLocationHdfsResult> asyncHandler)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
Future<DescribeLocationNfsResult> |
describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about an NFS location.
|
Future<DescribeLocationNfsResult> |
describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest,
AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)
Returns metadata, such as the path information, about an NFS location.
|
Future<DescribeLocationObjectStorageResult> |
describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
|
Future<DescribeLocationObjectStorageResult> |
describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest,
AsyncHandler<DescribeLocationObjectStorageRequest,DescribeLocationObjectStorageResult> asyncHandler)
Returns metadata about your DataSync location for an object storage system.
|
Future<DescribeLocationS3Result> |
describeLocationS3Async(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
Future<DescribeLocationS3Result> |
describeLocationS3Async(DescribeLocationS3Request describeLocationS3Request,
AsyncHandler<DescribeLocationS3Request,DescribeLocationS3Result> asyncHandler)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
Future<DescribeLocationSmbResult> |
describeLocationSmbAsync(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
|
Future<DescribeLocationSmbResult> |
describeLocationSmbAsync(DescribeLocationSmbRequest describeLocationSmbRequest,
AsyncHandler<DescribeLocationSmbRequest,DescribeLocationSmbResult> asyncHandler)
Returns metadata, such as the path and user information about an SMB location.
|
Future<DescribeTaskResult> |
describeTaskAsync(DescribeTaskRequest describeTaskRequest)
Returns metadata about a task.
|
Future<DescribeTaskResult> |
describeTaskAsync(DescribeTaskRequest describeTaskRequest,
AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)
Returns metadata about a task.
|
Future<DescribeTaskExecutionResult> |
describeTaskExecutionAsync(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
|
Future<DescribeTaskExecutionResult> |
describeTaskExecutionAsync(DescribeTaskExecutionRequest describeTaskExecutionRequest,
AsyncHandler<DescribeTaskExecutionRequest,DescribeTaskExecutionResult> asyncHandler)
Returns detailed metadata about a task that is being executed.
|
Future<ListAgentsResult> |
listAgentsAsync(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.
|
Future<ListAgentsResult> |
listAgentsAsync(ListAgentsRequest listAgentsRequest,
AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
Future<ListLocationsResult> |
listLocationsAsync(ListLocationsRequest listLocationsRequest)
Returns a list of source and destination locations.
|
Future<ListLocationsResult> |
listLocationsAsync(ListLocationsRequest listLocationsRequest,
AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)
Returns a list of source and destination locations.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
Future<ListTagsForResourceResult> |
listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns all the tags associated with an Amazon Web Services resource.
|
Future<ListTaskExecutionsResult> |
listTaskExecutionsAsync(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
Future<ListTaskExecutionsResult> |
listTaskExecutionsAsync(ListTaskExecutionsRequest listTaskExecutionsRequest,
AsyncHandler<ListTaskExecutionsRequest,ListTaskExecutionsResult> asyncHandler)
Returns a list of executed tasks.
|
Future<ListTasksResult> |
listTasksAsync(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
|
Future<ListTasksResult> |
listTasksAsync(ListTasksRequest listTasksRequest,
AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
Returns a list of the DataSync tasks you created.
|
Future<StartTaskExecutionResult> |
startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest)
Starts an DataSync task.
|
Future<StartTaskExecutionResult> |
startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest,
AsyncHandler<StartTaskExecutionRequest,StartTaskExecutionResult> asyncHandler)
Starts an DataSync task.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest)
Applies a tag to an Amazon Web Services resource.
|
Future<TagResourceResult> |
tagResourceAsync(TagResourceRequest tagResourceRequest,
AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Applies a tag to an Amazon Web Services resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
Future<UntagResourceResult> |
untagResourceAsync(UntagResourceRequest untagResourceRequest,
AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from an Amazon Web Services resource.
|
Future<UpdateAgentResult> |
updateAgentAsync(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
|
Future<UpdateAgentResult> |
updateAgentAsync(UpdateAgentRequest updateAgentRequest,
AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
Updates the name of an agent.
|
Future<UpdateLocationHdfsResult> |
updateLocationHdfsAsync(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
Future<UpdateLocationHdfsResult> |
updateLocationHdfsAsync(UpdateLocationHdfsRequest updateLocationHdfsRequest,
AsyncHandler<UpdateLocationHdfsRequest,UpdateLocationHdfsResult> asyncHandler)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
Future<UpdateLocationNfsResult> |
updateLocationNfsAsync(UpdateLocationNfsRequest updateLocationNfsRequest)
Updates some of the parameters of a previously created location for Network File System (NFS) access.
|
Future<UpdateLocationNfsResult> |
updateLocationNfsAsync(UpdateLocationNfsRequest updateLocationNfsRequest,
AsyncHandler<UpdateLocationNfsRequest,UpdateLocationNfsResult> asyncHandler)
Updates some of the parameters of a previously created location for Network File System (NFS) access.
|
Future<UpdateLocationObjectStorageResult> |
updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
Future<UpdateLocationObjectStorageResult> |
updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest,
AsyncHandler<UpdateLocationObjectStorageRequest,UpdateLocationObjectStorageResult> asyncHandler)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
Future<UpdateLocationSmbResult> |
updateLocationSmbAsync(UpdateLocationSmbRequest updateLocationSmbRequest)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
Future<UpdateLocationSmbResult> |
updateLocationSmbAsync(UpdateLocationSmbRequest updateLocationSmbRequest,
AsyncHandler<UpdateLocationSmbRequest,UpdateLocationSmbResult> asyncHandler)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
Future<UpdateTaskResult> |
updateTaskAsync(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
|
Future<UpdateTaskResult> |
updateTaskAsync(UpdateTaskRequest updateTaskRequest,
AsyncHandler<UpdateTaskRequest,UpdateTaskResult> asyncHandler)
Updates the metadata associated with a task.
|
Future<UpdateTaskExecutionResult> |
updateTaskExecutionAsync(UpdateTaskExecutionRequest updateTaskExecutionRequest)
Updates execution of a task.
|
Future<UpdateTaskExecutionResult> |
updateTaskExecutionAsync(UpdateTaskExecutionRequest updateTaskExecutionRequest,
AsyncHandler<UpdateTaskExecutionRequest,UpdateTaskExecutionResult> asyncHandler)
Updates execution of a task.
|
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, shutdown, startTaskExecution, tagResource, untagResource, updateAgent, updateLocationHdfs, updateLocationNfs, updateLocationObjectStorage, updateLocationSmb, updateTask, updateTaskExecution
Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(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.
cancelTaskExecutionRequest
- CancelTaskExecutionRequestFuture<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest, AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)
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.
cancelTaskExecutionRequest
- 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.Future<CreateAgentResult> createAgentAsync(CreateAgentRequest createAgentRequest)
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.
createAgentRequest
- CreateAgentRequestFuture<CreateAgentResult> createAgentAsync(CreateAgentRequest createAgentRequest, AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
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.
createAgentRequest
- 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.Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest)
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.
createLocationEfsRequest
- CreateLocationEfsRequestFuture<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest, AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)
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.
createLocationEfsRequest
- 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.Future<CreateLocationFsxLustreResult> createLocationFsxLustreAsync(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreRequest
- Future<CreateLocationFsxLustreResult> createLocationFsxLustreAsync(CreateLocationFsxLustreRequest createLocationFsxLustreRequest, AsyncHandler<CreateLocationFsxLustreRequest,CreateLocationFsxLustreResult> asyncHandler)
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreRequest
- 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.Future<CreateLocationFsxOntapResult> createLocationFsxOntapAsync(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
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.
createLocationFsxOntapRequest
- Future<CreateLocationFsxOntapResult> createLocationFsxOntapAsync(CreateLocationFsxOntapRequest createLocationFsxOntapRequest, AsyncHandler<CreateLocationFsxOntapRequest,CreateLocationFsxOntapResult> asyncHandler)
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.
createLocationFsxOntapRequest
- 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.Future<CreateLocationFsxOpenZfsResult> createLocationFsxOpenZfsAsync(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
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.
createLocationFsxOpenZfsRequest
- Future<CreateLocationFsxOpenZfsResult> createLocationFsxOpenZfsAsync(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest, AsyncHandler<CreateLocationFsxOpenZfsRequest,CreateLocationFsxOpenZfsResult> asyncHandler)
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.
createLocationFsxOpenZfsRequest
- 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.Future<CreateLocationFsxWindowsResult> createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsRequest
- Future<CreateLocationFsxWindowsResult> createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest, AsyncHandler<CreateLocationFsxWindowsRequest,CreateLocationFsxWindowsResult> asyncHandler)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsRequest
- 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.Future<CreateLocationHdfsResult> createLocationHdfsAsync(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsRequest
- Future<CreateLocationHdfsResult> createLocationHdfsAsync(CreateLocationHdfsRequest createLocationHdfsRequest, AsyncHandler<CreateLocationHdfsRequest,CreateLocationHdfsResult> asyncHandler)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsRequest
- 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.Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsRequest
- CreateLocationNfsRequestFuture<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest, AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsRequest
- 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.Future<CreateLocationObjectStorageResult> createLocationObjectStorageAsync(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
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.
createLocationObjectStorageRequest
- CreateLocationObjectStorageRequestFuture<CreateLocationObjectStorageResult> createLocationObjectStorageAsync(CreateLocationObjectStorageRequest createLocationObjectStorageRequest, AsyncHandler<CreateLocationObjectStorageRequest,CreateLocationObjectStorageResult> asyncHandler)
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.
createLocationObjectStorageRequest
- 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.Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer. For more information, see Create an Amazon S3 location.
createLocationS3Request
- CreateLocationS3RequestFuture<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request createLocationS3Request, AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)
Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer. For more information, see Create an Amazon S3 location.
createLocationS3Request
- 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.Future<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.
createLocationSmbRequest
- CreateLocationSmbRequestFuture<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest createLocationSmbRequest, AsyncHandler<CreateLocationSmbRequest,CreateLocationSmbResult> asyncHandler)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.
createLocationSmbRequest
- 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.Future<CreateTaskResult> createTaskAsync(CreateTaskRequest createTaskRequest)
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).
createTaskRequest
- CreateTaskRequestFuture<CreateTaskResult> createTaskAsync(CreateTaskRequest createTaskRequest, AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)
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).
createTaskRequest
- 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.Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest deleteAgentRequest)
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.
deleteAgentRequest
- DeleteAgentRequestFuture<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest deleteAgentRequest, AsyncHandler<DeleteAgentRequest,DeleteAgentResult> asyncHandler)
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.
deleteAgentRequest
- 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.Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
deleteLocationRequest
- DeleteLocationFuture<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest deleteLocationRequest, AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)
Deletes the configuration of a location used by DataSync.
deleteLocationRequest
- 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.Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync task.
deleteTaskRequest
- DeleteTaskFuture<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest deleteTaskRequest, AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)
Deletes an DataSync task.
deleteTaskRequest
- 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.Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest describeAgentRequest)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
describeAgentRequest
- DescribeAgentFuture<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest describeAgentRequest, AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
describeAgentRequest
- 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.Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsRequest
- DescribeLocationEfsRequestFuture<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest, AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsRequest
- 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.Future<DescribeLocationFsxLustreResult> describeLocationFsxLustreAsync(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreRequest
- Future<DescribeLocationFsxLustreResult> describeLocationFsxLustreAsync(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest, AsyncHandler<DescribeLocationFsxLustreRequest,DescribeLocationFsxLustreResult> asyncHandler)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreRequest
- 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.Future<DescribeLocationFsxOntapResult> describeLocationFsxOntapAsync(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
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
.
describeLocationFsxOntapRequest
- Future<DescribeLocationFsxOntapResult> describeLocationFsxOntapAsync(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest, AsyncHandler<DescribeLocationFsxOntapRequest,DescribeLocationFsxOntapResult> asyncHandler)
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
.
describeLocationFsxOntapRequest
- 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.Future<DescribeLocationFsxOpenZfsResult> describeLocationFsxOpenZfsAsync(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
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.
describeLocationFsxOpenZfsRequest
- Future<DescribeLocationFsxOpenZfsResult> describeLocationFsxOpenZfsAsync(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest, AsyncHandler<DescribeLocationFsxOpenZfsRequest,DescribeLocationFsxOpenZfsResult> asyncHandler)
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.
describeLocationFsxOpenZfsRequest
- 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.Future<DescribeLocationFsxWindowsResult> describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsRequest
- Future<DescribeLocationFsxWindowsResult> describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest, AsyncHandler<DescribeLocationFsxWindowsRequest,DescribeLocationFsxWindowsResult> asyncHandler)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsRequest
- 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.Future<DescribeLocationHdfsResult> describeLocationHdfsAsync(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsRequest
- Future<DescribeLocationHdfsResult> describeLocationHdfsAsync(DescribeLocationHdfsRequest describeLocationHdfsRequest, AsyncHandler<DescribeLocationHdfsRequest,DescribeLocationHdfsResult> asyncHandler)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsRequest
- 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.Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about an NFS location.
describeLocationNfsRequest
- DescribeLocationNfsRequestFuture<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest, AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)
Returns metadata, such as the path information, about an NFS location.
describeLocationNfsRequest
- 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.Future<DescribeLocationObjectStorageResult> describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageRequest
- DescribeLocationObjectStorageRequestFuture<DescribeLocationObjectStorageResult> describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest, AsyncHandler<DescribeLocationObjectStorageRequest,DescribeLocationObjectStorageResult> asyncHandler)
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageRequest
- 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.Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Request
- DescribeLocationS3RequestFuture<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request describeLocationS3Request, AsyncHandler<DescribeLocationS3Request,DescribeLocationS3Result> asyncHandler)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Request
- 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.Future<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbRequest
- DescribeLocationSmbRequestFuture<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest describeLocationSmbRequest, AsyncHandler<DescribeLocationSmbRequest,DescribeLocationSmbResult> asyncHandler)
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbRequest
- 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.Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest describeTaskRequest)
Returns metadata about a task.
describeTaskRequest
- DescribeTaskRequestFuture<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest describeTaskRequest, AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)
Returns metadata about a task.
describeTaskRequest
- 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.Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
describeTaskExecutionRequest
- DescribeTaskExecutionRequestFuture<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest describeTaskExecutionRequest, AsyncHandler<DescribeTaskExecutionRequest,DescribeTaskExecutionResult> asyncHandler)
Returns detailed metadata about a task that is being executed.
describeTaskExecutionRequest
- 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.Future<ListAgentsResult> listAgentsAsync(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.
listAgentsRequest
- ListAgentsRequestFuture<ListAgentsResult> listAgentsAsync(ListAgentsRequest listAgentsRequest, AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
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.
listAgentsRequest
- 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.Future<ListLocationsResult> listLocationsAsync(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.
listLocationsRequest
- ListLocationsRequestFuture<ListLocationsResult> listLocationsAsync(ListLocationsRequest listLocationsRequest, AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)
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.
listLocationsRequest
- 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
listTagsForResourceRequest
- ListTagsForResourceRequestFuture<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Returns all the tags associated with an Amazon Web Services resource.
listTagsForResourceRequest
- 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.Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
listTaskExecutionsRequest
- ListTaskExecutionsFuture<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest listTaskExecutionsRequest, AsyncHandler<ListTaskExecutionsRequest,ListTaskExecutionsResult> asyncHandler)
Returns a list of executed tasks.
listTaskExecutionsRequest
- 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.Future<ListTasksResult> listTasksAsync(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
listTasksRequest
- ListTasksRequestFuture<ListTasksResult> listTasksAsync(ListTasksRequest listTasksRequest, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
Returns a list of the DataSync tasks you created.
listTasksRequest
- 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.Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest)
Starts an DataSync 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.
startTaskExecutionRequest
- StartTaskExecutionRequestFuture<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest, AsyncHandler<StartTaskExecutionRequest,StartTaskExecutionResult> asyncHandler)
Starts an DataSync 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.
startTaskExecutionRequest
- 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.Future<TagResourceResult> tagResourceAsync(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.
tagResourceRequest
- TagResourceRequestFuture<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest
- 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.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest
- UntagResourceRequestFuture<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from an Amazon Web Services resource.
untagResourceRequest
- 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.Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
updateAgentRequest
- UpdateAgentRequestFuture<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest updateAgentRequest, AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
Updates the name of an agent.
updateAgentRequest
- 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.Future<UpdateLocationHdfsResult> updateLocationHdfsAsync(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsRequest
- Future<UpdateLocationHdfsResult> updateLocationHdfsAsync(UpdateLocationHdfsRequest updateLocationHdfsRequest, AsyncHandler<UpdateLocationHdfsRequest,UpdateLocationHdfsResult> asyncHandler)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsRequest
- 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.Future<UpdateLocationNfsResult> updateLocationNfsAsync(UpdateLocationNfsRequest updateLocationNfsRequest)
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.
updateLocationNfsRequest
- Future<UpdateLocationNfsResult> updateLocationNfsAsync(UpdateLocationNfsRequest updateLocationNfsRequest, AsyncHandler<UpdateLocationNfsRequest,UpdateLocationNfsResult> asyncHandler)
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.
updateLocationNfsRequest
- 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.Future<UpdateLocationObjectStorageResult> updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
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.
updateLocationObjectStorageRequest
- Future<UpdateLocationObjectStorageResult> updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest, AsyncHandler<UpdateLocationObjectStorageRequest,UpdateLocationObjectStorageResult> asyncHandler)
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.
updateLocationObjectStorageRequest
- 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.Future<UpdateLocationSmbResult> updateLocationSmbAsync(UpdateLocationSmbRequest updateLocationSmbRequest)
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.
updateLocationSmbRequest
- Future<UpdateLocationSmbResult> updateLocationSmbAsync(UpdateLocationSmbRequest updateLocationSmbRequest, AsyncHandler<UpdateLocationSmbRequest,UpdateLocationSmbResult> asyncHandler)
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.
updateLocationSmbRequest
- 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.Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
updateTaskRequest
- UpdateTaskResponseFuture<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest updateTaskRequest, AsyncHandler<UpdateTaskRequest,UpdateTaskResult> asyncHandler)
Updates the metadata associated with a task.
updateTaskRequest
- 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.Future<UpdateTaskExecutionResult> updateTaskExecutionAsync(UpdateTaskExecutionRequest updateTaskExecutionRequest)
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
.
updateTaskExecutionRequest
- Future<UpdateTaskExecutionResult> updateTaskExecutionAsync(UpdateTaskExecutionRequest updateTaskExecutionRequest, AsyncHandler<UpdateTaskExecutionRequest,UpdateTaskExecutionResult> asyncHandler)
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
.
updateTaskExecutionRequest
- 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.