AWSDataSyncAsync (AWS SDK for Java

All Superinterfaces:

AWSDataSync

All Known Implementing Classes:

AbstractAWSDataSyncAsync, AWSDataSyncAsyncClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDataSyncAsync
extends AWSDataSync
```
Interface for accessing DataSync asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an 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.

AWS DataSync
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.

Field Summary
- Fields inherited from interface com.amazonaws.services.datasync.AWSDataSync
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<CancelTaskExecutionResult>`	`cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest)` Cancels execution of a task.
`Future<CancelTaskExecutionResult>`	`cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest, AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)` Cancels execution of a task.
`Future<CreateAgentResult>`	`createAgentAsync(CreateAgentRequest createAgentRequest)` Activates an AWS DataSync agent that you have deployed on your host.
`Future<CreateAgentResult>`	`createAgentAsync(CreateAgentRequest createAgentRequest, AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)` Activates an AWS DataSync agent that you have deployed on your host.
`Future<CreateLocationEfsResult>`	`createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest)` Creates an endpoint for an Amazon EFS file system.
`Future<CreateLocationEfsResult>`	`createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest, AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)` Creates an endpoint for an Amazon EFS file system.
`Future<CreateLocationNfsResult>`	`createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest)` Creates an endpoint for a Network File System (NFS) file system.
`Future<CreateLocationNfsResult>`	`createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest, AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)` Creates an endpoint for a Network File System (NFS) file system.
`Future<CreateLocationS3Result>`	`createLocationS3Async(CreateLocationS3Request createLocationS3Request)` Creates an endpoint for an Amazon S3 bucket.
`Future<CreateLocationS3Result>`	`createLocationS3Async(CreateLocationS3Request createLocationS3Request, AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)` Creates an endpoint for an Amazon S3 bucket.
`Future<CreateTaskResult>`	`createTaskAsync(CreateTaskRequest createTaskRequest)` Creates a task.
`Future<CreateTaskResult>`	`createTaskAsync(CreateTaskRequest createTaskRequest, AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)` Creates a task.
`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 AWS DataSync.
`Future<DeleteLocationResult>`	`deleteLocationAsync(DeleteLocationRequest deleteLocationRequest, AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)` Deletes the configuration of a location used by AWS DataSync.
`Future<DeleteTaskResult>`	`deleteTaskAsync(DeleteTaskRequest deleteTaskRequest)` Deletes a task.
`Future<DeleteTaskResult>`	`deleteTaskAsync(DeleteTaskRequest deleteTaskRequest, AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)` Deletes a task.
`Future<DescribeAgentResult>`	`describeAgentAsync(DescribeAgentRequest describeAgentRequest)` Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.
`Future<DescribeAgentResult>`	`describeAgentAsync(DescribeAgentRequest describeAgentRequest, AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)` Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.
`Future<DescribeLocationEfsResult>`	`describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest)` Returns metadata, such as the path information about an Amazon EFS location.
`Future<DescribeLocationEfsResult>`	`describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest, AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)` Returns metadata, such as the path information about an Amazon EFS location.
`Future<DescribeLocationNfsResult>`	`describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest)` Returns metadata, such as the path information, about a NFS location.
`Future<DescribeLocationNfsResult>`	`describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest, AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)` Returns metadata, such as the path information, about a NFS location.
`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<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 agents owned by an AWS account in the AWS Region specified in the request.
`Future<ListAgentsResult>`	`listAgentsAsync(ListAgentsRequest listAgentsRequest, AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`Future<ListLocationsResult>`	`listLocationsAsync(ListLocationsRequest listLocationsRequest)` Returns a lists of source and destination locations.
`Future<ListLocationsResult>`	`listLocationsAsync(ListLocationsRequest listLocationsRequest, AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)` Returns a lists of source and destination locations.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)` Returns all the tags associated with a specified resources.
`Future<ListTagsForResourceResult>`	`listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)` Returns all the tags associated with a specified resources.
`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 all the tasks.
`Future<ListTasksResult>`	`listTasksAsync(ListTasksRequest listTasksRequest, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)` Returns a list of all the tasks.
`Future<StartTaskExecutionResult>`	`startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest)` Starts a specific invocation of a task.
`Future<StartTaskExecutionResult>`	`startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest, AsyncHandler<StartTaskExecutionRequest,StartTaskExecutionResult> asyncHandler)` Starts a specific invocation of a task.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest tagResourceRequest)` Applies a key-value pair to an AWS resource.
`Future<TagResourceResult>`	`tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)` Applies a key-value pair to an AWS resource.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest untagResourceRequest)` Removes a tag from an AWS resource.
`Future<UntagResourceResult>`	`untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)` Removes a tag from an AWS 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<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.

Methods inherited from interface com.amazonaws.services.datasync.AWSDataSync
cancelTaskExecution, createAgent, createLocationEfs, createLocationNfs, createLocationS3, createTask, deleteAgent, deleteLocation, deleteTask, describeAgent, describeLocationEfs, describeLocationNfs, describeLocationS3, describeTask, describeTaskExecution, getCachedResponseMetadata, listAgents, listLocations, listTagsForResource, listTaskExecutions, listTasks, shutdown, startTaskExecution, tagResource, untagResource, updateAgent, updateTask

- Method Detail
  - cancelTaskExecutionAsync
```
Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest)
```
    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.
    
    Parameters:
    
    cancelTaskExecutionRequest - CancelTaskExecutionRequest
    
    Returns:
    
    A Java Future containing the result of the CancelTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelTaskExecutionAsync
```
Future<CancelTaskExecutionResult> cancelTaskExecutionAsync(CancelTaskExecutionRequest cancelTaskExecutionRequest,
                                                           AsyncHandler<CancelTaskExecutionRequest,CancelTaskExecutionResult> asyncHandler)
```
    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.
    
    Parameters:
    
    cancelTaskExecutionRequest - CancelTaskExecutionRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CancelTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgentAsync
```
Future<CreateAgentResult> createAgentAsync(CreateAgentRequest createAgentRequest)
```
    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 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.
    
    For more information, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-agents.html#activating-agent" (Activating an Agent) in the AWS DataSync User Guide.
    
    Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
    
    Parameters:
    
    createAgentRequest - CreateAgentRequest
    
    Returns:
    
    A Java Future containing the result of the CreateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgentAsync
```
Future<CreateAgentResult> createAgentAsync(CreateAgentRequest createAgentRequest,
                                           AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
```
    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 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.
    
    For more information, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-agents.html#activating-agent" (Activating an Agent) in the AWS DataSync User Guide.
    
    Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
    
    Parameters:
    
    createAgentRequest - CreateAgentRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationEfsAsync
```
Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest)
```
    Creates an endpoint for an Amazon EFS file system.
    
    Parameters:
    
    createLocationEfsRequest - CreateLocationEfsRequest
    
    Returns:
    
    A Java Future containing the result of the CreateLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationEfsAsync
```
Future<CreateLocationEfsResult> createLocationEfsAsync(CreateLocationEfsRequest createLocationEfsRequest,
                                                       AsyncHandler<CreateLocationEfsRequest,CreateLocationEfsResult> asyncHandler)
```
    Creates an endpoint for an Amazon EFS file system.
    
    Parameters:
    
    createLocationEfsRequest - CreateLocationEfsRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationNfsAsync
```
Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest)
```
    Creates an endpoint for a Network File System (NFS) file system.
    
    Parameters:
    
    createLocationNfsRequest - CreateLocationNfsRequest
    
    Returns:
    
    A Java Future containing the result of the CreateLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationNfsAsync
```
Future<CreateLocationNfsResult> createLocationNfsAsync(CreateLocationNfsRequest createLocationNfsRequest,
                                                       AsyncHandler<CreateLocationNfsRequest,CreateLocationNfsResult> asyncHandler)
```
    Creates an endpoint for a Network File System (NFS) file system.
    
    Parameters:
    
    createLocationNfsRequest - CreateLocationNfsRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationS3Async
```
Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request createLocationS3Request)
```
    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" (Configuring Amazon S3 Location Settings) in the AWS DataSync User Guide.
    
    Parameters:
    
    createLocationS3Request - CreateLocationS3Request
    
    Returns:
    
    A Java Future containing the result of the CreateLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationS3Async
```
Future<CreateLocationS3Result> createLocationS3Async(CreateLocationS3Request createLocationS3Request,
                                                     AsyncHandler<CreateLocationS3Request,CreateLocationS3Result> asyncHandler)
```
    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" (Configuring Amazon S3 Location Settings) in the AWS DataSync User Guide.
    
    Parameters:
    
    createLocationS3Request - CreateLocationS3Request
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTaskAsync
```
Future<CreateTaskResult> createTaskAsync(CreateTaskRequest createTaskRequest)
```
    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.
    
    Parameters:
    
    createTaskRequest - CreateTaskRequest
    
    Returns:
    
    A Java Future containing the result of the CreateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTaskAsync
```
Future<CreateTaskResult> createTaskAsync(CreateTaskRequest createTaskRequest,
                                         AsyncHandler<CreateTaskRequest,CreateTaskResult> asyncHandler)
```
    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.
    
    Parameters:
    
    createTaskRequest - CreateTaskRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the CreateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgentAsync
```
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 AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
    
    Parameters:
    
    deleteAgentRequest - DeleteAgentRequest
    
    Returns:
    
    A Java Future containing the result of the DeleteAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgentAsync
```
Future<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 AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
    
    Parameters:
    
    deleteAgentRequest - DeleteAgentRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLocationAsync
```
Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest deleteLocationRequest)
```
    Deletes the configuration of a location used by AWS DataSync.
    
    Parameters:
    
    deleteLocationRequest - DeleteLocation
    
    Returns:
    
    A Java Future containing the result of the DeleteLocation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLocationAsync
```
Future<DeleteLocationResult> deleteLocationAsync(DeleteLocationRequest deleteLocationRequest,
                                                 AsyncHandler<DeleteLocationRequest,DeleteLocationResult> asyncHandler)
```
    Deletes the configuration of a location used by AWS DataSync.
    
    Parameters:
    
    deleteLocationRequest - DeleteLocation
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteLocation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTaskAsync
```
Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest deleteTaskRequest)
```
    Deletes a task.
    
    Parameters:
    
    deleteTaskRequest - DeleteTask
    
    Returns:
    
    A Java Future containing the result of the DeleteTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTaskAsync
```
Future<DeleteTaskResult> deleteTaskAsync(DeleteTaskRequest deleteTaskRequest,
                                         AsyncHandler<DeleteTaskRequest,DeleteTaskResult> asyncHandler)
```
    Deletes a task.
    
    Parameters:
    
    deleteTaskRequest - DeleteTask
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DeleteTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAgentAsync
```
Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest describeAgentRequest)
```
    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.
    
    Parameters:
    
    describeAgentRequest - DescribeAgent
    
    Returns:
    
    A Java Future containing the result of the DescribeAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAgentAsync
```
Future<DescribeAgentResult> describeAgentAsync(DescribeAgentRequest describeAgentRequest,
                                               AsyncHandler<DescribeAgentRequest,DescribeAgentResult> asyncHandler)
```
    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.
    
    Parameters:
    
    describeAgentRequest - DescribeAgent
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfsAsync
```
Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest)
```
    Returns metadata, such as the path information about an Amazon EFS location.
    
    Parameters:
    
    describeLocationEfsRequest - DescribeLocationEfsRequest
    
    Returns:
    
    A Java Future containing the result of the DescribeLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfsAsync
```
Future<DescribeLocationEfsResult> describeLocationEfsAsync(DescribeLocationEfsRequest describeLocationEfsRequest,
                                                           AsyncHandler<DescribeLocationEfsRequest,DescribeLocationEfsResult> asyncHandler)
```
    Returns metadata, such as the path information about an Amazon EFS location.
    
    Parameters:
    
    describeLocationEfsRequest - DescribeLocationEfsRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfsAsync
```
Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest)
```
    Returns metadata, such as the path information, about a NFS location.
    
    Parameters:
    
    describeLocationNfsRequest - DescribeLocationNfsRequest
    
    Returns:
    
    A Java Future containing the result of the DescribeLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfsAsync
```
Future<DescribeLocationNfsResult> describeLocationNfsAsync(DescribeLocationNfsRequest describeLocationNfsRequest,
                                                           AsyncHandler<DescribeLocationNfsRequest,DescribeLocationNfsResult> asyncHandler)
```
    Returns metadata, such as the path information, about a NFS location.
    
    Parameters:
    
    describeLocationNfsRequest - DescribeLocationNfsRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3Async
```
Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request describeLocationS3Request)
```
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Parameters:
    
    describeLocationS3Request - DescribeLocationS3Request
    
    Returns:
    
    A Java Future containing the result of the DescribeLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3Async
```
Future<DescribeLocationS3Result> describeLocationS3Async(DescribeLocationS3Request describeLocationS3Request,
                                                         AsyncHandler<DescribeLocationS3Request,DescribeLocationS3Result> asyncHandler)
```
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Parameters:
    
    describeLocationS3Request - DescribeLocationS3Request
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskAsync
```
Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest describeTaskRequest)
```
    Returns metadata about a task.
    
    Parameters:
    
    describeTaskRequest - DescribeTaskRequest
    
    Returns:
    
    A Java Future containing the result of the DescribeTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskAsync
```
Future<DescribeTaskResult> describeTaskAsync(DescribeTaskRequest describeTaskRequest,
                                             AsyncHandler<DescribeTaskRequest,DescribeTaskResult> asyncHandler)
```
    Returns metadata about a task.
    
    Parameters:
    
    describeTaskRequest - DescribeTaskRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecutionAsync
```
Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest describeTaskExecutionRequest)
```
    Returns detailed metadata about a task that is being executed.
    
    Parameters:
    
    describeTaskExecutionRequest - DescribeTaskExecutionRequest
    
    Returns:
    
    A Java Future containing the result of the DescribeTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecutionAsync
```
Future<DescribeTaskExecutionResult> describeTaskExecutionAsync(DescribeTaskExecutionRequest describeTaskExecutionRequest,
                                                               AsyncHandler<DescribeTaskExecutionRequest,DescribeTaskExecutionResult> asyncHandler)
```
    Returns detailed metadata about a task that is being executed.
    
    Parameters:
    
    describeTaskExecutionRequest - DescribeTaskExecutionRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the DescribeTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgentsAsync
```
Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest listAgentsRequest)
```
    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.
    
    Parameters:
    
    listAgentsRequest - ListAgentsRequest
    
    Returns:
    
    A Java Future containing the result of the ListAgents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgentsAsync
```
Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest listAgentsRequest,
                                         AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
```
    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.
    
    Parameters:
    
    listAgentsRequest - ListAgentsRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListAgents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLocationsAsync
```
Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest listLocationsRequest)
```
    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.
    
    Parameters:
    
    listLocationsRequest - ListLocationsRequest
    
    Returns:
    
    A Java Future containing the result of the ListLocations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLocationsAsync
```
Future<ListLocationsResult> listLocationsAsync(ListLocationsRequest listLocationsRequest,
                                               AsyncHandler<ListLocationsRequest,ListLocationsResult> asyncHandler)
```
    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.
    
    Parameters:
    
    listLocationsRequest - ListLocationsRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListLocations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns all the tags associated with a specified resources.
    
    Parameters:
    
    listTagsForResourceRequest - ListTagsForResourceRequest
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourceAsync
```
Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
                                                           AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
```
    Returns all the tags associated with a specified resources.
    
    Parameters:
    
    listTagsForResourceRequest - ListTagsForResourceRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutionsAsync
```
Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest listTaskExecutionsRequest)
```
    Returns a list of executed tasks.
    
    Parameters:
    
    listTaskExecutionsRequest - ListTaskExecutions
    
    Returns:
    
    A Java Future containing the result of the ListTaskExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutionsAsync
```
Future<ListTaskExecutionsResult> listTaskExecutionsAsync(ListTaskExecutionsRequest listTaskExecutionsRequest,
                                                         AsyncHandler<ListTaskExecutionsRequest,ListTaskExecutionsResult> asyncHandler)
```
    Returns a list of executed tasks.
    
    Parameters:
    
    listTaskExecutionsRequest - ListTaskExecutions
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListTaskExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTasksAsync
```
Future<ListTasksResult> listTasksAsync(ListTasksRequest listTasksRequest)
```
    Returns a list of all the tasks.
    
    Parameters:
    
    listTasksRequest - ListTasksRequest
    
    Returns:
    
    A Java Future containing the result of the ListTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTasksAsync
```
Future<ListTasksResult> listTasksAsync(ListTasksRequest listTasksRequest,
                                       AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
```
    Returns a list of all the tasks.
    
    Parameters:
    
    listTasksRequest - ListTasksRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the ListTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTaskExecutionAsync
```
Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest)
```
    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 Task Execution in "https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-works.html#terminology" (Components and Terminology) in the AWS DataSync User Guide.
    
    Parameters:
    
    startTaskExecutionRequest - StartTaskExecutionRequest
    
    Returns:
    
    A Java Future containing the result of the StartTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTaskExecutionAsync
```
Future<StartTaskExecutionResult> startTaskExecutionAsync(StartTaskExecutionRequest startTaskExecutionRequest,
                                                         AsyncHandler<StartTaskExecutionRequest,StartTaskExecutionResult> asyncHandler)
```
    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 Task Execution in "https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-works.html#terminology" (Components and Terminology) in the AWS DataSync User Guide.
    
    Parameters:
    
    startTaskExecutionRequest - StartTaskExecutionRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the StartTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
```
    Applies a key-value pair to an AWS resource.
    
    Parameters:
    
    tagResourceRequest - TagResourceRequest
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResourceAsync
```
Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest,
                                           AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
```
    Applies a key-value pair to an AWS resource.
    
    Parameters:
    
    tagResourceRequest - TagResourceRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from an AWS resource.
    
    Parameters:
    
    untagResourceRequest - UntagResourceRequest
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResourceAsync
```
Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest,
                                               AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
```
    Removes a tag from an AWS resource.
    
    Parameters:
    
    untagResourceRequest - UntagResourceRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgentAsync
```
Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest updateAgentRequest)
```
    Updates the name of an agent.
    
    Parameters:
    
    updateAgentRequest - UpdateAgentRequest
    
    Returns:
    
    A Java Future containing the result of the UpdateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgentAsync
```
Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest updateAgentRequest,
                                           AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
```
    Updates the name of an agent.
    
    Parameters:
    
    updateAgentRequest - UpdateAgentRequest
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UpdateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTaskAsync
```
Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest updateTaskRequest)
```
    Updates the metadata associated with a task.
    
    Parameters:
    
    updateTaskRequest - UpdateTaskResponse
    
    Returns:
    
    A Java Future containing the result of the UpdateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTaskAsync
```
Future<UpdateTaskResult> updateTaskAsync(UpdateTaskRequest updateTaskRequest,
                                         AsyncHandler<UpdateTaskRequest,UpdateTaskResult> asyncHandler)
```
    Updates the metadata associated with a task.
    
    Parameters:
    
    updateTaskRequest - UpdateTaskResponse
    
    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.
    
    Returns:
    
    A Java Future containing the result of the UpdateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation

Did this page help you?

Interface AWSDataSyncAsync

Field Summary

Fields inherited from interface com.amazonaws.services.datasync.AWSDataSync

Method Summary

Methods inherited from interface com.amazonaws.services.datasync.AWSDataSync

Method Detail

cancelTaskExecutionAsync

cancelTaskExecutionAsync

createAgentAsync

createAgentAsync

createLocationEfsAsync

createLocationEfsAsync

createLocationNfsAsync

createLocationNfsAsync

createLocationS3Async

createLocationS3Async

createTaskAsync

createTaskAsync

deleteAgentAsync

deleteAgentAsync

deleteLocationAsync

deleteLocationAsync

deleteTaskAsync

deleteTaskAsync

describeAgentAsync

describeAgentAsync

describeLocationEfsAsync

describeLocationEfsAsync

describeLocationNfsAsync

describeLocationNfsAsync

describeLocationS3Async

describeLocationS3Async

describeTaskAsync

describeTaskAsync

describeTaskExecutionAsync

describeTaskExecutionAsync

listAgentsAsync

listAgentsAsync

listLocationsAsync

listLocationsAsync

listTagsForResourceAsync

listTagsForResourceAsync

listTaskExecutionsAsync

listTaskExecutionsAsync

listTasksAsync

listTasksAsync

startTaskExecutionAsync

startTaskExecutionAsync

tagResourceAsync

tagResourceAsync

untagResourceAsync

untagResourceAsync

updateAgentAsync

updateAgentAsync

updateTaskAsync

updateTaskAsync