@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 Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).
This API interface reference for DataSync contains documentation for a programming interface that you can use to manage DataSync.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, cancelTaskExecution, createAgent, createLocationEfs, createLocationFsxWindows, createLocationHdfs, createLocationNfs, createLocationObjectStorage, createLocationS3, createLocationSmb, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationFsxWindows, describeLocationHdfs, describeLocationNfs, describeLocationObjectStorage, describeLocationS3, describeLocationSmb, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, startTaskExecution, tagResource, untagResource, updateAgent, updateLocationHdfs, updateLocationNfs, updateLocationObjectStorage, updateLocationSmb, updateTask, updateTaskExecutionaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelTaskExecution, createAgent, createLocationEfs, createLocationFsxWindows, createLocationHdfs, createLocationNfs, createLocationObjectStorage, createLocationS3, createLocationSmb, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationFsxWindows, describeLocationHdfs, describeLocationNfs, describeLocationObjectStorage, describeLocationS3, describeLocationSmb, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, startTaskExecution, tagResource, untagResource, updateAgent, updateLocationHdfs, updateLocationNfs, updateLocationObjectStorage, updateLocationSmb, updateTask, updateTaskExecutionpublic static AWSDataSyncAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest request)
AWSDataSyncAsyncCancels execution of a task.
When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.
cancelTaskExecutionAsync in interface AWSDataSyncAsyncrequest - CancelTaskExecutionRequestpublic Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest request, AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)
AWSDataSyncAsyncCancels execution of a task.
When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.
cancelTaskExecutionAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncActivates an DataSync agent that you have deployed on your host. 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 AWSDataSyncAsyncrequest - CreateAgentRequestpublic Future<CreateAgentResult> createAgentAsync(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
AWSDataSyncAsyncActivates an DataSync agent that you have deployed on your host. 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 AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncCreates an endpoint for an Amazon EFS file system.
createLocationEfsAsync in interface AWSDataSyncAsyncrequest - CreateLocationEfsRequestpublic Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest request, AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)
AWSDataSyncAsyncCreates an endpoint for an Amazon EFS file system.
createLocationEfsAsync in interface AWSDataSyncAsyncrequest - 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<CreateLocationFsxWindowsResult> createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest request)
AWSDataSyncAsyncCreates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsAsync in interface AWSDataSyncAsyncpublic Future<CreateLocationFsxWindowsResult> createLocationFsxWindowsAsync(CreateLocationFsxWindowsRequest request, AsyncHandler<CreateLocationFsxWindowsRequest,CreateLocationFsxWindowsResult> asyncHandler)
AWSDataSyncAsyncCreates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsAsync in interface AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncCreates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsAsync in interface AWSDataSyncAsyncpublic Future<CreateLocationHdfsResult> createLocationHdfsAsync(CreateLocationHdfsRequest request, AsyncHandler<CreateLocationHdfsRequest,CreateLocationHdfsResult> asyncHandler)
AWSDataSyncAsyncCreates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsAsync in interface AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncDefines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsAsync in interface AWSDataSyncAsyncrequest - CreateLocationNfsRequestpublic Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest request, AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)
AWSDataSyncAsyncDefines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfsAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncCreates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage.
createLocationObjectStorageAsync in interface AWSDataSyncAsyncrequest - CreateLocationObjectStorageRequestpublic Future<CreateLocationObjectStorageResult> createLocationObjectStorageAsync(CreateLocationObjectStorageRequest request, AsyncHandler<CreateLocationObjectStorageRequest,CreateLocationObjectStorageResult> asyncHandler)
AWSDataSyncAsyncCreates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage.
createLocationObjectStorageAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncCreates an endpoint for an Amazon S3 bucket.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
createLocationS3Async in interface AWSDataSyncAsyncrequest - CreateLocationS3Requestpublic Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request request, AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)
AWSDataSyncAsyncCreates an endpoint for an Amazon S3 bucket.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
createLocationS3Async in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncDefines a file system on a Server Message Block (SMB) server that can be read from or written to.
createLocationSmbAsync in interface AWSDataSyncAsyncrequest - CreateLocationSmbRequestpublic Future<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest request, AsyncHandler<CreateLocationSmbRequest,CreateLocationSmbResult> asyncHandler)
AWSDataSyncAsyncDefines a file system on a Server Message Block (SMB) server that can be read from or written to.
createLocationSmbAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncCreates a task.
A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.
You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.
When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
createTaskAsync in interface AWSDataSyncAsyncrequest - CreateTaskRequestpublic Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request, AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)
AWSDataSyncAsyncCreates a task.
A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.
You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.
When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
createTaskAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncDeletes 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 AWSDataSyncAsyncrequest - DeleteAgentRequestpublic Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResult> asyncHandler)
AWSDataSyncAsyncDeletes 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 AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncDeletes the configuration of a location used by DataSync.
deleteLocationAsync in interface AWSDataSyncAsyncrequest - DeleteLocationpublic Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest request, AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)
AWSDataSyncAsyncDeletes the configuration of a location used by DataSync.
deleteLocationAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncDeletes a task.
deleteTaskAsync in interface AWSDataSyncAsyncrequest - DeleteTaskpublic Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest request, AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)
AWSDataSyncAsyncDeletes a task.
deleteTaskAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns 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 AWSDataSyncAsyncrequest - DescribeAgentpublic Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest request, AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)
AWSDataSyncAsyncReturns 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 AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns metadata, such as the path information about an Amazon EFS location.
describeLocationEfsAsync in interface AWSDataSyncAsyncrequest - DescribeLocationEfsRequestpublic Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest request, AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)
AWSDataSyncAsyncReturns metadata, such as the path information about an Amazon EFS location.
describeLocationEfsAsync in interface AWSDataSyncAsyncrequest - 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<DescribeLocationFsxWindowsResult> describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest request)
AWSDataSyncAsyncReturns metadata, such as the path information about an Amazon FSx for Windows File Server location.
describeLocationFsxWindowsAsync in interface AWSDataSyncAsyncpublic Future<DescribeLocationFsxWindowsResult> describeLocationFsxWindowsAsync(DescribeLocationFsxWindowsRequest request, AsyncHandler<DescribeLocationFsxWindowsRequest,DescribeLocationFsxWindowsResult> asyncHandler)
AWSDataSyncAsyncReturns metadata, such as the path information about an Amazon FSx for Windows File Server location.
describeLocationFsxWindowsAsync in interface AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncReturns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsAsync in interface AWSDataSyncAsyncpublic Future<DescribeLocationHdfsResult> describeLocationHdfsAsync(DescribeLocationHdfsRequest request, AsyncHandler<DescribeLocationHdfsRequest,DescribeLocationHdfsResult> asyncHandler)
AWSDataSyncAsyncReturns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsAsync in interface AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncReturns metadata, such as the path information, about an NFS location.
describeLocationNfsAsync in interface AWSDataSyncAsyncrequest - DescribeLocationNfsRequestpublic Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest request, AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)
AWSDataSyncAsyncReturns metadata, such as the path information, about an NFS location.
describeLocationNfsAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage.
describeLocationObjectStorageAsync in interface AWSDataSyncAsyncrequest - DescribeLocationObjectStorageRequestpublic Future<DescribeLocationObjectStorageResult> describeLocationObjectStorageAsync(DescribeLocationObjectStorageRequest request, AsyncHandler<DescribeLocationObjectStorageRequest,DescribeLocationObjectStorageResult> asyncHandler)
AWSDataSyncAsyncReturns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage.
describeLocationObjectStorageAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Async in interface AWSDataSyncAsyncrequest - DescribeLocationS3Requestpublic Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request request, AsyncHandler<DescribeLocationS3Request,DescribeLocationS3Result> asyncHandler)
AWSDataSyncAsyncReturns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Async in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns metadata, such as the path and user information about an SMB location.
describeLocationSmbAsync in interface AWSDataSyncAsyncrequest - DescribeLocationSmbRequestpublic Future<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest request, AsyncHandler<DescribeLocationSmbRequest,DescribeLocationSmbResult> asyncHandler)
AWSDataSyncAsyncReturns metadata, such as the path and user information about an SMB location.
describeLocationSmbAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns metadata about a task.
describeTaskAsync in interface AWSDataSyncAsyncrequest - DescribeTaskRequestpublic Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request, AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)
AWSDataSyncAsyncReturns metadata about a task.
describeTaskAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns detailed metadata about a task that is being executed.
describeTaskExecutionAsync in interface AWSDataSyncAsyncrequest - DescribeTaskExecutionRequestpublic Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest request, AsyncHandler<DescribeTaskExecutionRequest,DescribeTaskExecutionResult> asyncHandler)
AWSDataSyncAsyncReturns detailed metadata about a task that is being executed.
describeTaskExecutionAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns 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 AWSDataSyncAsyncrequest - ListAgentsRequestpublic Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
AWSDataSyncAsyncReturns 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 AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns 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 AWSDataSyncAsyncrequest - ListLocationsRequestpublic Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest request, AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)
AWSDataSyncAsyncReturns 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 AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns all the tags associated with a specified resource.
listTagsForResourceAsync in interface AWSDataSyncAsyncrequest - ListTagsForResourceRequestpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSDataSyncAsyncReturns all the tags associated with a specified resource.
listTagsForResourceAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns a list of executed tasks.
listTaskExecutionsAsync in interface AWSDataSyncAsyncrequest - ListTaskExecutionspublic Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest request, AsyncHandler<ListTaskExecutionsRequest,ListTaskExecutionsResult> asyncHandler)
AWSDataSyncAsyncReturns a list of executed tasks.
listTaskExecutionsAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncReturns a list of all the tasks.
listTasksAsync in interface AWSDataSyncAsyncrequest - ListTasksRequestpublic Future<ListTasksResult> listTasksAsync(ListTasksRequest request, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
AWSDataSyncAsyncReturns a list of all the tasks.
listTasksAsync in interface AWSDataSyncAsyncrequest - 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 AWSDataSyncAsyncrequest - 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 AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncApplies a key-value pair to an Amazon Web Services resource.
tagResourceAsync in interface AWSDataSyncAsyncrequest - TagResourceRequestpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSDataSyncAsyncApplies a key-value pair to an Amazon Web Services resource.
tagResourceAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncRemoves a tag from an Amazon Web Services resource.
untagResourceAsync in interface AWSDataSyncAsyncrequest - UntagResourceRequestpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSDataSyncAsyncRemoves a tag from an Amazon Web Services resource.
untagResourceAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncUpdates the name of an agent.
updateAgentAsync in interface AWSDataSyncAsyncrequest - UpdateAgentRequestpublic Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
AWSDataSyncAsyncUpdates the name of an agent.
updateAgentAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncUpdates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsAsync in interface AWSDataSyncAsyncpublic Future<UpdateLocationHdfsResult> updateLocationHdfsAsync(UpdateLocationHdfsRequest request, AsyncHandler<UpdateLocationHdfsRequest,UpdateLocationHdfsResult> asyncHandler)
AWSDataSyncAsyncUpdates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsAsync in interface AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncUpdates 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 AWSDataSyncAsyncpublic Future<UpdateLocationNfsResult> updateLocationNfsAsync(UpdateLocationNfsRequest request, AsyncHandler<UpdateLocationNfsRequest,UpdateLocationNfsResult> asyncHandler)
AWSDataSyncAsyncUpdates 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 AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncUpdates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.
updateLocationObjectStorageAsync in interface AWSDataSyncAsyncpublic Future<UpdateLocationObjectStorageResult> updateLocationObjectStorageAsync(UpdateLocationObjectStorageRequest request, AsyncHandler<UpdateLocationObjectStorageRequest,UpdateLocationObjectStorageResult> asyncHandler)
AWSDataSyncAsyncUpdates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.
updateLocationObjectStorageAsync in interface AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncUpdates 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 AWSDataSyncAsyncpublic Future<UpdateLocationSmbResult> updateLocationSmbAsync(UpdateLocationSmbRequest request, AsyncHandler<UpdateLocationSmbRequest,UpdateLocationSmbResult> asyncHandler)
AWSDataSyncAsyncUpdates 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 AWSDataSyncAsyncasyncHandler - 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)
AWSDataSyncAsyncUpdates the metadata associated with a task.
updateTaskAsync in interface AWSDataSyncAsyncrequest - UpdateTaskResponsepublic Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest request, AsyncHandler<UpdateTaskRequest,UpdateTaskResult> asyncHandler)
AWSDataSyncAsyncUpdates the metadata associated with a task.
updateTaskAsync in interface AWSDataSyncAsyncrequest - 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)
AWSDataSyncAsyncUpdates 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 AWSDataSyncAsyncpublic Future<UpdateTaskExecutionResult> updateTaskExecutionAsync(UpdateTaskExecutionRequest request, AsyncHandler<UpdateTaskExecutionRequest,UpdateTaskExecutionResult> asyncHandler)
AWSDataSyncAsyncUpdates 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 AWSDataSyncAsyncasyncHandler - 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 AWSDataSyncshutdown in class AWSDataSyncClient