AWSDataSync (AWS SDK for Java

All Known Subinterfaces:

AWSDataSyncAsync

All Known Implementing Classes:

AbstractAWSDataSync, AbstractAWSDataSyncAsync, AWSDataSyncAsyncClient, AWSDataSyncClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDataSync
```
Interface for accessing DataSync.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSDataSync 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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CancelTaskExecutionResult`	`cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)` Cancels execution of a task.
`CreateAgentResult`	`createAgent(CreateAgentRequest createAgentRequest)` Activates an AWS DataSync agent that you have deployed on your host.
`CreateLocationEfsResult`	`createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)` Creates an endpoint for an Amazon EFS file system.
`CreateLocationNfsResult`	`createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)` Creates an endpoint for a Network File System (NFS) file system.
`CreateLocationS3Result`	`createLocationS3(CreateLocationS3Request createLocationS3Request)` Creates an endpoint for an Amazon S3 bucket.
`CreateTaskResult`	`createTask(CreateTaskRequest createTaskRequest)` Creates a task.
`DeleteAgentResult`	`deleteAgent(DeleteAgentRequest deleteAgentRequest)` Deletes an agent.
`DeleteLocationResult`	`deleteLocation(DeleteLocationRequest deleteLocationRequest)` Deletes the configuration of a location used by AWS DataSync.
`DeleteTaskResult`	`deleteTask(DeleteTaskRequest deleteTaskRequest)` Deletes a task.
`DescribeAgentResult`	`describeAgent(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.
`DescribeLocationEfsResult`	`describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)` Returns metadata, such as the path information about an Amazon EFS location.
`DescribeLocationNfsResult`	`describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)` Returns metadata, such as the path information, about a NFS location.
`DescribeLocationS3Result`	`describeLocationS3(DescribeLocationS3Request describeLocationS3Request)` Returns metadata, such as bucket name, about an Amazon S3 bucket location.
`DescribeTaskResult`	`describeTask(DescribeTaskRequest describeTaskRequest)` Returns metadata about a task.
`DescribeTaskExecutionResult`	`describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)` Returns detailed metadata about a task that is being executed.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListAgentsResult`	`listAgents(ListAgentsRequest listAgentsRequest)` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`ListLocationsResult`	`listLocations(ListLocationsRequest listLocationsRequest)` Returns a lists of source and destination locations.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns all the tags associated with a specified resources.
`ListTaskExecutionsResult`	`listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)` Returns a list of executed tasks.
`ListTasksResult`	`listTasks(ListTasksRequest listTasksRequest)` Returns a list of all the tasks.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartTaskExecutionResult`	`startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)` Starts a specific invocation of a task.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Applies a key-value pair to an AWS resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from an AWS resource.
`UpdateAgentResult`	`updateAgent(UpdateAgentRequest updateAgentRequest)` Updates the name of an agent.
`UpdateTaskResult`	`updateTask(UpdateTaskRequest updateTaskRequest)` Updates the metadata associated with a task.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - cancelTaskExecution
```
CancelTaskExecutionResult cancelTaskExecution(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:
    
    Result of the CancelTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
CreateAgentResult createAgent(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 Activating a Sync 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:
    
    Result of the CreateAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - createLocationEfs
```
CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
```
    Creates an endpoint for an Amazon EFS file system.
    
    Parameters:
    
    createLocationEfsRequest - CreateLocationEfsRequest
    
    Returns:
    
    Result of the CreateLocationEfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - createLocationNfs
```
CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
```
    Creates an endpoint for a Network File System (NFS) file system.
    
    Parameters:
    
    createLocationNfsRequest - CreateLocationNfsRequest
    
    Returns:
    
    Result of the CreateLocationNfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - createLocationS3
```
CreateLocationS3Result createLocationS3(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 Configuring Amazon S3 Location Settings in the AWS DataSync User Guide.
    
    Parameters:
    
    createLocationS3Request - CreateLocationS3Request
    
    Returns:
    
    Result of the CreateLocationS3 operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - createTask
```
CreateTaskResult createTask(CreateTaskRequest createTaskRequest)
```
    Creates a task. A task is a set of two locations (source and destination) and a set of default OverrideOptions that you use to control the behavior of a task. If you don't specify default values for Options when you create a task, AWS DataSync populates them with safe service defaults.
    
    When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every 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:
    
    Result of the CreateTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
DeleteAgentResult deleteAgent(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.
    
    After you delete an agent, you can't reactivate it and you longer pay software charges for it.
    
    Parameters:
    
    deleteAgentRequest - DeleteAgentRequest
    
    Returns:
    
    Result of the DeleteAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - deleteLocation
```
DeleteLocationResult deleteLocation(DeleteLocationRequest deleteLocationRequest)
```
    Deletes the configuration of a location used by AWS DataSync.
    
    Parameters:
    
    deleteLocationRequest - DeleteLocation
    
    Returns:
    
    Result of the DeleteLocation operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
DeleteTaskResult deleteTask(DeleteTaskRequest deleteTaskRequest)
```
    Deletes a task.
    
    Parameters:
    
    deleteTaskRequest - DeleteTask
    
    Returns:
    
    Result of the DeleteTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
DescribeAgentResult describeAgent(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:
    
    Result of the DescribeAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfs
```
DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
```
    Returns metadata, such as the path information about an Amazon EFS location.
    
    Parameters:
    
    describeLocationEfsRequest - DescribeLocationEfsRequest
    
    Returns:
    
    Result of the DescribeLocationEfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfs
```
DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
```
    Returns metadata, such as the path information, about a NFS location.
    
    Parameters:
    
    describeLocationNfsRequest - DescribeLocationNfsRequest
    
    Returns:
    
    Result of the DescribeLocationNfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3
```
DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
```
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Parameters:
    
    describeLocationS3Request - DescribeLocationS3Request
    
    Returns:
    
    Result of the DescribeLocationS3 operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest)
```
    Returns metadata about a task.
    
    Parameters:
    
    describeTaskRequest - DescribeTaskRequest
    
    Returns:
    
    Result of the DescribeTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
```
    Returns detailed metadata about a task that is being executed.
    
    Parameters:
    
    describeTaskExecutionRequest - DescribeTaskExecutionRequest
    
    Returns:
    
    Result of the DescribeTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
ListAgentsResult listAgents(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:
    
    Result of the ListAgents operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listLocations
```
ListLocationsResult listLocations(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:
    
    Result of the ListLocations operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns all the tags associated with a specified resources.
    
    Parameters:
    
    listTagsForResourceRequest - ListTagsForResourceRequest
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutions
```
ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
```
    Returns a list of executed tasks.
    
    Parameters:
    
    listTaskExecutionsRequest - ListTaskExecutions
    
    Returns:
    
    Result of the ListTaskExecutions operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
ListTasksResult listTasks(ListTasksRequest listTasksRequest)
```
    Returns a list of all the tasks.
    
    Parameters:
    
    listTasksRequest - ListTasksRequest
    
    Returns:
    
    Result of the ListTasks operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - startTaskExecution
```
StartTaskExecutionResult startTaskExecution(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 Components and Terminology in the AWS DataSync User Guide.
    
    Parameters:
    
    startTaskExecutionRequest - StartTaskExecutionRequest
    
    Returns:
    
    Result of the StartTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Applies a key-value pair to an AWS resource.
    
    Parameters:
    
    tagResourceRequest - TagResourceRequest
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from an AWS resource.
    
    Parameters:
    
    untagResourceRequest - UntagResourceRequest
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest)
```
    Updates the name of an agent.
    
    Parameters:
    
    updateAgentRequest - UpdateAgentRequest
    
    Returns:
    
    Result of the UpdateAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - updateTask
```
UpdateTaskResult updateTask(UpdateTaskRequest updateTaskRequest)
```
    Updates the metadata associated with a task.
    
    Parameters:
    
    updateTaskRequest - UpdateTaskResponse
    
    Returns:
    
    Result of the UpdateTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSDataSync

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

cancelTaskExecution

createAgent

createLocationEfs

createLocationNfs

createLocationS3

createTask

deleteAgent

deleteLocation

deleteTask

describeAgent

describeLocationEfs

describeLocationNfs

describeLocationS3

describeTask

describeTaskExecution

listAgents

listLocations

listTagsForResource

listTaskExecutions

listTasks

startTaskExecution

tagResource

untagResource

updateAgent

updateTask

shutdown

getCachedResponseMetadata