AWSDataSyncClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.datasync.AWSDataSyncClient

All Implemented Interfaces:

AWSDataSync

Direct Known Subclasses:

AWSDataSyncAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSDataSyncClient
extends AmazonWebServiceClient
implements AWSDataSync
```
Client for accessing DataSync. All service calls made using this client are blocking, and will not return until the service call completes.
DataSync
DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).

This API interface reference for DataSync contains documentation for a programming interface that you can use to manage DataSync.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AWSDataSyncClientBuilder`	`builder()`
`CancelTaskExecutionResult`	`cancelTaskExecution(CancelTaskExecutionRequest request)` Cancels execution of a task.
`CreateAgentResult`	`createAgent(CreateAgentRequest request)` Activates an DataSync agent that you have deployed on your host.
`CreateLocationEfsResult`	`createLocationEfs(CreateLocationEfsRequest request)` Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
`CreateLocationFsxLustreResult`	`createLocationFsxLustre(CreateLocationFsxLustreRequest request)` Creates an endpoint for an Amazon FSx for Lustre file system.
`CreateLocationFsxOntapResult`	`createLocationFsxOntap(CreateLocationFsxOntapRequest request)` Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
`CreateLocationFsxOpenZfsResult`	`createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest request)` Creates an endpoint for an Amazon FSx for OpenZFS file system.
`CreateLocationFsxWindowsResult`	`createLocationFsxWindows(CreateLocationFsxWindowsRequest request)` Creates an endpoint for an Amazon FSx for Windows File Server file system.
`CreateLocationHdfsResult`	`createLocationHdfs(CreateLocationHdfsRequest request)` Creates an endpoint for a Hadoop Distributed File System (HDFS).
`CreateLocationNfsResult`	`createLocationNfs(CreateLocationNfsRequest request)` Defines a file system on a Network File System (NFS) server that can be read from or written to.
`CreateLocationObjectStorageResult`	`createLocationObjectStorage(CreateLocationObjectStorageRequest request)` Creates an endpoint for an object storage system that DataSync can access for a transfer.
`CreateLocationS3Result`	`createLocationS3(CreateLocationS3Request request)` Creates an endpoint for an Amazon S3 bucket.
`CreateLocationSmbResult`	`createLocationSmb(CreateLocationSmbRequest request)` Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
`CreateTaskResult`	`createTask(CreateTaskRequest request)` Configures a task, which defines where and how DataSync transfers your data.
`DeleteAgentResult`	`deleteAgent(DeleteAgentRequest request)` Deletes an agent.
`DeleteLocationResult`	`deleteLocation(DeleteLocationRequest request)` Deletes the configuration of a location used by DataSync.
`DeleteTaskResult`	`deleteTask(DeleteTaskRequest request)` Deletes a task.
`DescribeAgentResult`	`describeAgent(DescribeAgentRequest request)` 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 request)` Returns metadata about your DataSync location for an Amazon EFS file system.
`DescribeLocationFsxLustreResult`	`describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)` Returns metadata about an Amazon FSx for Lustre location, such as information about its path.
`DescribeLocationFsxOntapResult`	`describeLocationFsxOntap(DescribeLocationFsxOntapRequest request)` Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
`DescribeLocationFsxOpenZfsResult`	`describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest request)` Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
`DescribeLocationFsxWindowsResult`	`describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)` Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
`DescribeLocationHdfsResult`	`describeLocationHdfs(DescribeLocationHdfsRequest request)` Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
`DescribeLocationNfsResult`	`describeLocationNfs(DescribeLocationNfsRequest request)` Returns metadata, such as the path information, about an NFS location.
`DescribeLocationObjectStorageResult`	`describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)` Returns metadata about your DataSync location for an object storage system.
`DescribeLocationS3Result`	`describeLocationS3(DescribeLocationS3Request request)` Returns metadata, such as bucket name, about an Amazon S3 bucket location.
`DescribeLocationSmbResult`	`describeLocationSmb(DescribeLocationSmbRequest request)` Returns metadata, such as the path and user information about an SMB location.
`DescribeTaskResult`	`describeTask(DescribeTaskRequest request)` Returns metadata about a task.
`DescribeTaskExecutionResult`	`describeTaskExecution(DescribeTaskExecutionRequest request)` 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 request)` Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request.
`ListLocationsResult`	`listLocations(ListLocationsRequest request)` Returns a list of source and destination locations.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns all the tags associated with a specified resource.
`ListTaskExecutionsResult`	`listTaskExecutions(ListTaskExecutionsRequest request)` Returns a list of executed tasks.
`ListTasksResult`	`listTasks(ListTasksRequest request)` Returns a list of the DataSync tasks you created.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartTaskExecutionResult`	`startTaskExecution(StartTaskExecutionRequest request)` Starts a specific invocation of a task.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies a key-value pair to an Amazon Web Services resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from an Amazon Web Services resource.
`UpdateAgentResult`	`updateAgent(UpdateAgentRequest request)` Updates the name of an agent.
`UpdateLocationHdfsResult`	`updateLocationHdfs(UpdateLocationHdfsRequest request)` Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
`UpdateLocationNfsResult`	`updateLocationNfs(UpdateLocationNfsRequest request)` Updates some of the parameters of a previously created location for Network File System (NFS) access.
`UpdateLocationObjectStorageResult`	`updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)` Updates some of the parameters of a previously created location for self-managed object storage server access.
`UpdateLocationSmbResult`	`updateLocationSmb(UpdateLocationSmbRequest request)` Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.
`UpdateTaskResult`	`updateTask(UpdateTaskRequest request)` Updates the metadata associated with a task.
`UpdateTaskExecutionResult`	`updateTaskExecution(UpdateTaskExecutionRequest request)` Updates execution of a task.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSDataSyncClientBuilder builder()
```
  - cancelTaskExecution
```
public CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest request)
```
    Cancels execution of a task.
    
    When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.
    
    Specified by:
    
    cancelTaskExecution in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
public CreateAgentResult createAgent(CreateAgentRequest request)
```
    Activates an DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
    
    You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.
    
    You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
    
    Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
    
    Specified by:
    
    createAgent in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationEfs
```
public CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest request)
```
    Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
    
    Specified by:
    
    createLocationEfs in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxLustre
```
public CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest request)
```
    Creates an endpoint for an Amazon FSx for Lustre file system.
    
    Specified by:
    
    createLocationFsxLustre in interface AWSDataSync
    
    Parameters:
    
    createLocationFsxLustreRequest -
    
    Returns:
    
    Result of the CreateLocationFsxLustre operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxOntap
```
public CreateLocationFsxOntapResult createLocationFsxOntap(CreateLocationFsxOntapRequest request)
```
    Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
    
    Specified by:
    
    createLocationFsxOntap in interface AWSDataSync
    
    Parameters:
    
    createLocationFsxOntapRequest -
    
    Returns:
    
    Result of the CreateLocationFsxOntap operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxOpenZfs
```
public CreateLocationFsxOpenZfsResult createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest request)
```
    Creates an endpoint for an Amazon FSx for OpenZFS file system.
    
    Specified by:
    
    createLocationFsxOpenZfs in interface AWSDataSync
    
    Parameters:
    
    createLocationFsxOpenZfsRequest -
    
    Returns:
    
    Result of the CreateLocationFsxOpenZfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxWindows
```
public CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest request)
```
    Creates an endpoint for an Amazon FSx for Windows File Server file system.
    
    Specified by:
    
    createLocationFsxWindows in interface AWSDataSync
    
    Parameters:
    
    createLocationFsxWindowsRequest -
    
    Returns:
    
    Result of the CreateLocationFsxWindows operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationHdfs
```
public CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest request)
```
    Creates an endpoint for a Hadoop Distributed File System (HDFS).
    
    Specified by:
    
    createLocationHdfs in interface AWSDataSync
    
    Parameters:
    
    createLocationHdfsRequest -
    
    Returns:
    
    Result of the CreateLocationHdfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationNfs
```
public CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest request)
```
    Defines a file system on a Network File System (NFS) server that can be read from or written to.
    
    Specified by:
    
    createLocationNfs in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationObjectStorage
```
public CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest request)
```
    Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
    
    Specified by:
    
    createLocationObjectStorage in interface AWSDataSync
    
    Parameters:
    
    createLocationObjectStorageRequest - CreateLocationObjectStorageRequest
    
    Returns:
    
    Result of the CreateLocationObjectStorage operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationS3
```
public CreateLocationS3Result createLocationS3(CreateLocationS3Request request)
```
    Creates an endpoint for an Amazon S3 bucket.
    
    For more information, see Create an Amazon S3 location in the DataSync User Guide.
    
    Specified by:
    
    createLocationS3 in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createLocationSmb
```
public CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest request)
```
    Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
    
    Specified by:
    
    createLocationSmb in interface AWSDataSync
    
    Parameters:
    
    createLocationSmbRequest - CreateLocationSmbRequest
    
    Returns:
    
    Result of the CreateLocationSmb operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - createTask
```
public CreateTaskResult createTask(CreateTaskRequest request)
```
    Configures a task, which defines where and how DataSync transfers your data.
    
    A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
    
    When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync.
    
    For more information, see the following topics:
    - Working with DataSync locations
    - Configure DataSync task settings
    Specified by:
    
    createTask in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
```
    Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
    
    Specified by:
    
    deleteAgent in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - deleteLocation
```
public DeleteLocationResult deleteLocation(DeleteLocationRequest request)
```
    Deletes the configuration of a location used by DataSync.
    
    Specified by:
    
    deleteLocation in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
public DeleteTaskResult deleteTask(DeleteTaskRequest request)
```
    Deletes a task.
    
    Specified by:
    
    deleteTask in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
public DescribeAgentResult describeAgent(DescribeAgentRequest request)
```
    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.
    
    Specified by:
    
    describeAgent in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfs
```
public DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest request)
```
    Returns metadata about your DataSync location for an Amazon EFS file system.
    
    Specified by:
    
    describeLocationEfs in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxLustre
```
public DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)
```
    Returns metadata about an Amazon FSx for Lustre location, such as information about its path.
    
    Specified by:
    
    describeLocationFsxLustre in interface AWSDataSync
    
    Parameters:
    
    describeLocationFsxLustreRequest -
    
    Returns:
    
    Result of the DescribeLocationFsxLustre operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxOntap
```
public DescribeLocationFsxOntapResult describeLocationFsxOntap(DescribeLocationFsxOntapRequest request)
```
    Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
    
    Specified by:
    
    describeLocationFsxOntap in interface AWSDataSync
    
    Parameters:
    
    describeLocationFsxOntapRequest -
    
    Returns:
    
    Result of the DescribeLocationFsxOntap operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxOpenZfs
```
public DescribeLocationFsxOpenZfsResult describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest request)
```
    Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
    
    Specified by:
    
    describeLocationFsxOpenZfs in interface AWSDataSync
    
    Parameters:
    
    describeLocationFsxOpenZfsRequest -
    
    Returns:
    
    Result of the DescribeLocationFsxOpenZfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxWindows
```
public DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)
```
    Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
    
    Specified by:
    
    describeLocationFsxWindows in interface AWSDataSync
    
    Parameters:
    
    describeLocationFsxWindowsRequest -
    
    Returns:
    
    Result of the DescribeLocationFsxWindows operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationHdfs
```
public DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest request)
```
    Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
    
    Specified by:
    
    describeLocationHdfs in interface AWSDataSync
    
    Parameters:
    
    describeLocationHdfsRequest -
    
    Returns:
    
    Result of the DescribeLocationHdfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfs
```
public DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest request)
```
    Returns metadata, such as the path information, about an NFS location.
    
    Specified by:
    
    describeLocationNfs in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationObjectStorage
```
public DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)
```
    Returns metadata about your DataSync location for an object storage system.
    
    Specified by:
    
    describeLocationObjectStorage in interface AWSDataSync
    
    Parameters:
    
    describeLocationObjectStorageRequest - DescribeLocationObjectStorageRequest
    
    Returns:
    
    Result of the DescribeLocationObjectStorage operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3
```
public DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request request)
```
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Specified by:
    
    describeLocationS3 in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationSmb
```
public DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest request)
```
    Returns metadata, such as the path and user information about an SMB location.
    
    Specified by:
    
    describeLocationSmb in interface AWSDataSync
    
    Parameters:
    
    describeLocationSmbRequest - DescribeLocationSmbRequest
    
    Returns:
    
    Result of the DescribeLocationSmb operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
public DescribeTaskResult describeTask(DescribeTaskRequest request)
```
    Returns metadata about a task.
    
    Specified by:
    
    describeTask in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
public DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest request)
```
    Returns detailed metadata about a task that is being executed.
    
    Specified by:
    
    describeTaskExecution in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
public ListAgentsResult listAgents(ListAgentsRequest request)
```
    Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
    
    By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
    
    If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
    
    Specified by:
    
    listAgents in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - listLocations
```
public ListLocationsResult listLocations(ListLocationsRequest request)
```
    Returns a list of source and destination locations.
    
    If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
    
    Specified by:
    
    listLocations in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Returns all the tags associated with a specified resource.
    
    Specified by:
    
    listTagsForResource in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutions
```
public ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest request)
```
    Returns a list of executed tasks.
    
    Specified by:
    
    listTaskExecutions in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
public ListTasksResult listTasks(ListTasksRequest request)
```
    Returns a list of the DataSync tasks you created.
    
    Specified by:
    
    listTasks in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - startTaskExecution
```
public StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest request)
```
    Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.
    
    TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.
    
    For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.
    
    Specified by:
    
    startTaskExecution in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Applies a key-value pair to an Amazon Web Services resource.
    
    Specified by:
    
    tagResource in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Removes a tag from an Amazon Web Services resource.
    
    Specified by:
    
    untagResource in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
public UpdateAgentResult updateAgent(UpdateAgentRequest request)
```
    Updates the name of an agent.
    
    Specified by:
    
    updateAgent in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationHdfs
```
public UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest request)
```
    Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
    
    Specified by:
    
    updateLocationHdfs in interface AWSDataSync
    
    Parameters:
    
    updateLocationHdfsRequest -
    
    Returns:
    
    Result of the UpdateLocationHdfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationNfs
```
public UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest request)
```
    Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
    
    Specified by:
    
    updateLocationNfs in interface AWSDataSync
    
    Parameters:
    
    updateLocationNfsRequest -
    
    Returns:
    
    Result of the UpdateLocationNfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationObjectStorage
```
public UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)
```
    Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.
    
    Specified by:
    
    updateLocationObjectStorage in interface AWSDataSync
    
    Parameters:
    
    updateLocationObjectStorageRequest -
    
    Returns:
    
    Result of the UpdateLocationObjectStorage operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationSmb
```
public UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest request)
```
    Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
    
    Specified by:
    
    updateLocationSmb in interface AWSDataSync
    
    Parameters:
    
    updateLocationSmbRequest -
    
    Returns:
    
    Result of the UpdateLocationSmb operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateTask
```
public UpdateTaskResult updateTask(UpdateTaskRequest request)
```
    Updates the metadata associated with a task.
    
    Specified by:
    
    updateTask in interface AWSDataSync
    
    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.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateTaskExecution
```
public UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest request)
```
    Updates execution of a task.
    
    You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.
    
    The only Option that can be modified by UpdateTaskExecution is BytesPerSecond .
    
    Specified by:
    
    updateTaskExecution in interface AWSDataSync
    
    Parameters:
    
    updateTaskExecutionRequest -
    
    Returns:
    
    Result of the UpdateTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSDataSync
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSDataSync
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

Did this page help you?

Class AWSDataSyncClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

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

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

cancelTaskExecution

createAgent

createLocationEfs

createLocationFsxLustre

createLocationFsxOntap

createLocationFsxOpenZfs

createLocationFsxWindows

createLocationHdfs

createLocationNfs

createLocationObjectStorage

createLocationS3

createLocationSmb

createTask

deleteAgent

deleteLocation

deleteTask

describeAgent

describeLocationEfs

describeLocationFsxLustre

describeLocationFsxOntap

describeLocationFsxOpenZfs

describeLocationFsxWindows

describeLocationHdfs

describeLocationNfs

describeLocationObjectStorage

describeLocationS3

describeLocationSmb

describeTask

describeTaskExecution

listAgents

listLocations

listTagsForResource

listTaskExecutions

listTasks

startTaskExecution

tagResource

untagResource

updateAgent

updateLocationHdfs

updateLocationNfs

updateLocationObjectStorage

updateLocationSmb

updateTask

updateTaskExecution

getCachedResponseMetadata

shutdown