@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.
AWS 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 AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
builder, cancelTaskExecution, createAgent, createLocationEfs, createLocationNfs, createLocationS3, createLocationSmb, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationNfs, describeLocationS3, describeLocationSmb, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, startTaskExecution, tagResource, untagResource, updateAgent, updateTask
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
cancelTaskExecution, createAgent, createLocationEfs, createLocationNfs, createLocationS3, createLocationSmb, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationNfs, describeLocationS3, describeLocationSmb, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, startTaskExecution, tagResource, untagResource, updateAgent, updateTask
public static AWSDataSyncAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest request)
AWSDataSyncAsync
Cancels execution of a task.
When you cancel a task execution, the transfer of some files are 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, AWS DataSync successfully complete the transfer when you start the next task execution.
cancelTaskExecutionAsync
in interface AWSDataSyncAsync
request
- CancelTaskExecutionRequestpublic Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest request, AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
Cancels execution of a task.
When you cancel a task execution, the transfer of some files are 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, AWS DataSync successfully complete the transfer when you start the next task execution.
cancelTaskExecutionAsync
in interface AWSDataSyncAsync
request
- CancelTaskExecutionRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateAgentResult> createAgentAsync(CreateAgentRequest request)
AWSDataSyncAsync
Activates an AWS 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 AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS 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 AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgentAsync
in interface AWSDataSyncAsync
request
- CreateAgentRequestpublic Future<CreateAgentResult> createAgentAsync(CreateAgentRequest request, AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
AWSDataSyncAsync
Activates an AWS 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 AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS 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 AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgentAsync
in interface AWSDataSyncAsync
request
- CreateAgentRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest request)
AWSDataSyncAsync
Creates an endpoint for an Amazon EFS file system.
createLocationEfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationEfsRequestpublic Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest request, AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon EFS file system.
createLocationEfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationEfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest request)
AWSDataSyncAsync
Defines a file system on a Network File System (NFS) server that can be read from or written to
createLocationNfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationNfsRequestpublic Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest request, AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)
AWSDataSyncAsync
Defines a file system on a Network File System (NFS) server that can be read from or written to
createLocationNfsAsync
in interface AWSDataSyncAsync
request
- CreateLocationNfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request request)
AWSDataSyncAsync
Creates an endpoint for an Amazon S3 bucket.
For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.
For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide.
createLocationS3Async
in interface AWSDataSyncAsync
request
- CreateLocationS3Requestpublic Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request request, AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)
AWSDataSyncAsync
Creates an endpoint for an Amazon S3 bucket.
For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.
For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide.
createLocationS3Async
in interface AWSDataSyncAsync
request
- CreateLocationS3RequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest request)
AWSDataSyncAsync
Defines a file system on an Server Message Block (SMB) server that can be read from or written to.
createLocationSmbAsync
in interface AWSDataSyncAsync
request
- CreateLocationSmbRequestpublic Future<CreateLocationSmbResult> createLocationSmbAsync(CreateLocationSmbRequest request, AsyncHandler<CreateLocationSmbRequest,CreateLocationSmbResult> asyncHandler)
AWSDataSyncAsync
Defines a file system on an Server Message Block (SMB) server that can be read from or written to.
createLocationSmbAsync
in interface AWSDataSyncAsync
request
- CreateLocationSmbRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request)
AWSDataSyncAsync
Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.
When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.
createTaskAsync
in interface AWSDataSyncAsync
request
- CreateTaskRequestpublic Future<CreateTaskResult> createTaskAsync(CreateTaskRequest request, AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)
AWSDataSyncAsync
Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.
When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.
createTaskAsync
in interface AWSDataSyncAsync
request
- CreateTaskRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest request)
AWSDataSyncAsync
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgentAsync
in interface AWSDataSyncAsync
request
- DeleteAgentRequestpublic Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest request, AsyncHandler<DeleteAgentRequest,DeleteAgentResult> asyncHandler)
AWSDataSyncAsync
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgentAsync
in interface AWSDataSyncAsync
request
- DeleteAgentRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest request)
AWSDataSyncAsync
Deletes the configuration of a location used by AWS DataSync.
deleteLocationAsync
in interface AWSDataSyncAsync
request
- DeleteLocationpublic Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest request, AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)
AWSDataSyncAsync
Deletes the configuration of a location used by AWS DataSync.
deleteLocationAsync
in interface AWSDataSyncAsync
request
- DeleteLocationasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest request)
AWSDataSyncAsync
Deletes a task.
deleteTaskAsync
in interface AWSDataSyncAsync
request
- DeleteTaskpublic Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest request, AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)
AWSDataSyncAsync
Deletes a task.
deleteTaskAsync
in interface AWSDataSyncAsync
request
- DeleteTaskasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest request)
AWSDataSyncAsync
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
describeAgentAsync
in interface AWSDataSyncAsync
request
- DescribeAgentpublic Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest request, AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)
AWSDataSyncAsync
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
describeAgentAsync
in interface AWSDataSyncAsync
request
- DescribeAgentasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest request)
AWSDataSyncAsync
Returns metadata, such as the path information about an Amazon EFS location.
describeLocationEfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationEfsRequestpublic Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest request, AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as the path information about an Amazon EFS location.
describeLocationEfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationEfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest request)
AWSDataSyncAsync
Returns metadata, such as the path information, about a NFS location.
describeLocationNfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationNfsRequestpublic Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest request, AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as the path information, about a NFS location.
describeLocationNfsAsync
in interface AWSDataSyncAsync
request
- DescribeLocationNfsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request request)
AWSDataSyncAsync
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Async
in interface AWSDataSyncAsync
request
- DescribeLocationS3Requestpublic Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request request, AsyncHandler<DescribeLocationS3Request,DescribeLocationS3Result> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Async
in interface AWSDataSyncAsync
request
- DescribeLocationS3RequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest request)
AWSDataSyncAsync
Returns metadata, such as the path and user information about a SMB location.
describeLocationSmbAsync
in interface AWSDataSyncAsync
request
- DescribeLocationSmbRequestpublic Future<DescribeLocationSmbResult> describeLocationSmbAsync(DescribeLocationSmbRequest request, AsyncHandler<DescribeLocationSmbRequest,DescribeLocationSmbResult> asyncHandler)
AWSDataSyncAsync
Returns metadata, such as the path and user information about a SMB location.
describeLocationSmbAsync
in interface AWSDataSyncAsync
request
- DescribeLocationSmbRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request)
AWSDataSyncAsync
Returns metadata about a task.
describeTaskAsync
in interface AWSDataSyncAsync
request
- DescribeTaskRequestpublic Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest request, AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)
AWSDataSyncAsync
Returns metadata about a task.
describeTaskAsync
in interface AWSDataSyncAsync
request
- DescribeTaskRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest request)
AWSDataSyncAsync
Returns detailed metadata about a task that is being executed.
describeTaskExecutionAsync
in interface AWSDataSyncAsync
request
- DescribeTaskExecutionRequestpublic Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest request, AsyncHandler<DescribeTaskExecutionRequest,DescribeTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
Returns detailed metadata about a task that is being executed.
describeTaskExecutionAsync
in interface AWSDataSyncAsync
request
- DescribeTaskExecutionRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest request)
AWSDataSyncAsync
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
listAgentsAsync
in interface AWSDataSyncAsync
request
- ListAgentsRequestpublic Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest request, AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
AWSDataSyncAsync
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
listAgentsAsync
in interface AWSDataSyncAsync
request
- ListAgentsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest request)
AWSDataSyncAsync
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
listLocationsAsync
in interface AWSDataSyncAsync
request
- ListLocationsRequestpublic Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest request, AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)
AWSDataSyncAsync
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
listLocationsAsync
in interface AWSDataSyncAsync
request
- ListLocationsRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AWSDataSyncAsync
Returns all the tags associated with a specified resources.
listTagsForResourceAsync
in interface AWSDataSyncAsync
request
- ListTagsForResourceRequestpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AWSDataSyncAsync
Returns all the tags associated with a specified resources.
listTagsForResourceAsync
in interface AWSDataSyncAsync
request
- ListTagsForResourceRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest request)
AWSDataSyncAsync
Returns a list of executed tasks.
listTaskExecutionsAsync
in interface AWSDataSyncAsync
request
- ListTaskExecutionspublic Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest request, AsyncHandler<ListTaskExecutionsRequest,ListTaskExecutionsResult> asyncHandler)
AWSDataSyncAsync
Returns a list of executed tasks.
listTaskExecutionsAsync
in interface AWSDataSyncAsync
request
- ListTaskExecutionsasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTasksResult> listTasksAsync(ListTasksRequest request)
AWSDataSyncAsync
Returns a list of all the tasks.
listTasksAsync
in interface AWSDataSyncAsync
request
- ListTasksRequestpublic Future<ListTasksResult> listTasksAsync(ListTasksRequest request, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
AWSDataSyncAsync
Returns a list of all the tasks.
listTasksAsync
in interface AWSDataSyncAsync
request
- ListTasksRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest request)
AWSDataSyncAsync
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.
startTaskExecutionAsync
in interface AWSDataSyncAsync
request
- StartTaskExecutionRequestpublic Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest request, AsyncHandler<StartTaskExecutionRequest,StartTaskExecutionResult> asyncHandler)
AWSDataSyncAsync
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.
startTaskExecutionAsync
in interface AWSDataSyncAsync
request
- StartTaskExecutionRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AWSDataSyncAsync
Applies a key-value pair to an AWS resource.
tagResourceAsync
in interface AWSDataSyncAsync
request
- TagResourceRequestpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AWSDataSyncAsync
Applies a key-value pair to an AWS resource.
tagResourceAsync
in interface AWSDataSyncAsync
request
- TagResourceRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AWSDataSyncAsync
Removes a tag from an AWS resource.
untagResourceAsync
in interface AWSDataSyncAsync
request
- UntagResourceRequestpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AWSDataSyncAsync
Removes a tag from an AWS resource.
untagResourceAsync
in interface AWSDataSyncAsync
request
- UntagResourceRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest request)
AWSDataSyncAsync
Updates the name of an agent.
updateAgentAsync
in interface AWSDataSyncAsync
request
- UpdateAgentRequestpublic Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest request, AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
AWSDataSyncAsync
Updates the name of an agent.
updateAgentAsync
in interface AWSDataSyncAsync
request
- UpdateAgentRequestasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest request)
AWSDataSyncAsync
Updates the metadata associated with a task.
updateTaskAsync
in interface AWSDataSyncAsync
request
- UpdateTaskResponsepublic Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest request, AsyncHandler<UpdateTaskRequest,UpdateTaskResult> asyncHandler)
AWSDataSyncAsync
Updates the metadata associated with a task.
updateTaskAsync
in interface AWSDataSyncAsync
request
- UpdateTaskResponseasyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AWSDataSync
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.