AbstractAWSDataSync (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.datasync.AbstractAWSDataSync

All Implemented Interfaces:

AWSDataSync

Direct Known Subclasses:

AbstractAWSDataSyncAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSDataSync
extends Object
implements AWSDataSync
```
Abstract implementation of AWSDataSync. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddStorageSystemResult`	`addStorageSystem(AddStorageSystemRequest request)` Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
`CancelTaskExecutionResult`	`cancelTaskExecution(CancelTaskExecutionRequest request)` Stops an DataSync task execution that's in progress.
`CreateAgentResult`	`createAgent(CreateAgentRequest request)` Activates an DataSync agent that you have deployed in your storage environment.
`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 that DataSync can access for a transfer.
`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)` A location is an endpoint for an Amazon S3 bucket.
`CreateLocationSmbResult`	`createLocationSmb(CreateLocationSmbRequest request)` Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.
`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 an DataSync task.
`DescribeAgentResult`	`describeAgent(DescribeAgentRequest request)` Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
`DescribeDiscoveryJobResult`	`describeDiscoveryJob(DescribeDiscoveryJobRequest request)` Returns information about a DataSync discovery job.
`DescribeLocationEfsResult`	`describeLocationEfs(DescribeLocationEfsRequest request)` Returns metadata about your DataSync location for an Amazon EFS file system.
`DescribeLocationFsxLustreResult`	`describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)` Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
`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)` Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
`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.
`DescribeStorageSystemResult`	`describeStorageSystem(DescribeStorageSystemRequest request)` Returns information about an on-premises storage system that you're using with DataSync Discovery.
`DescribeStorageSystemResourceMetricsResult`	`describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest request)` Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
`DescribeStorageSystemResourcesResult`	`describeStorageSystemResources(DescribeStorageSystemResourcesRequest request)` Returns information that DataSync Discovery collects about resources in your on-premises storage system.
`DescribeTaskResult`	`describeTask(DescribeTaskRequest request)` Returns metadata about a task.
`DescribeTaskExecutionResult`	`describeTaskExecution(DescribeTaskExecutionRequest request)` Returns detailed metadata about a task that is being executed.
`GenerateRecommendationsResult`	`generateRecommendations(GenerateRecommendationsRequest request)` Creates recommendations about where to migrate your data to in Amazon Web Services.
`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 DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
`ListDiscoveryJobsResult`	`listDiscoveryJobs(ListDiscoveryJobsRequest request)` Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
`ListLocationsResult`	`listLocations(ListLocationsRequest request)` Returns a list of source and destination locations.
`ListStorageSystemsResult`	`listStorageSystems(ListStorageSystemsRequest request)` Lists the on-premises storage systems that you're using with DataSync Discovery.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns all the tags associated with an Amazon Web Services resource.
`ListTaskExecutionsResult`	`listTaskExecutions(ListTaskExecutionsRequest request)` Returns a list of executed tasks.
`ListTasksResult`	`listTasks(ListTasksRequest request)` Returns a list of the DataSync tasks you created.
`RemoveStorageSystemResult`	`removeStorageSystem(RemoveStorageSystemRequest request)` Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartDiscoveryJobResult`	`startDiscoveryJob(StartDiscoveryJobRequest request)` Runs a DataSync discovery job on your on-premises storage system.
`StartTaskExecutionResult`	`startTaskExecution(StartTaskExecutionRequest request)` Starts an DataSync task.
`StopDiscoveryJobResult`	`stopDiscoveryJob(StopDiscoveryJobRequest request)` Stops a running DataSync discovery job.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Applies a tag to an Amazon Web Services resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes tags from an Amazon Web Services resource.
`UpdateAgentResult`	`updateAgent(UpdateAgentRequest request)` Updates the name of an agent.
`UpdateDiscoveryJobResult`	`updateDiscoveryJob(UpdateDiscoveryJobRequest request)` Edits a DataSync discovery job configuration.
`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 parameters of an existing object storage location that DataSync accesses for a transfer.
`UpdateLocationSmbResult`	`updateLocationSmb(UpdateLocationSmbRequest request)` Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.
`UpdateStorageSystemResult`	`updateStorageSystem(UpdateStorageSystemRequest request)` Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
`UpdateTaskResult`	`updateTask(UpdateTaskRequest request)` Updates the metadata associated with a task.
`UpdateTaskExecutionResult`	`updateTaskExecution(UpdateTaskExecutionRequest request)` Modifies a running DataSync task.

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

- Method Detail
  - addStorageSystem
```
public AddStorageSystemResult addStorageSystem(AddStorageSystemRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
    
    Specified by:
    
    addStorageSystem in interface AWSDataSync
    
    Returns:
    
    Result of the AddStorageSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelTaskExecution
```
public CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest request)
```
    Description copied from interface: AWSDataSync
    
    Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.
    
    However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.
    
    Specified by:
    
    cancelTaskExecution in interface AWSDataSync
    
    Parameters:
    
    request - CancelTaskExecutionRequest
    
    Returns:
    
    Result of the CancelTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
public CreateAgentResult createAgent(CreateAgentRequest request)
```
    Description copied from interface: AWSDataSync
    
    Activates an DataSync agent that you have deployed in your storage environment. 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:
    
    request - CreateAgentRequest
    
    Returns:
    
    Result of the CreateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationEfs
```
public CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    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:
    
    request - CreateLocationEfsRequest
    
    Returns:
    
    Result of the CreateLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxLustre
```
public CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an endpoint for an Amazon FSx for Lustre file system.
    
    Specified by:
    
    createLocationFsxLustre in interface AWSDataSync
    
    Returns:
    
    Result of the CreateLocationFsxLustre operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxOntap
```
public CreateLocationFsxOntapResult createLocationFsxOntap(CreateLocationFsxOntapRequest request)
```
    Description copied from interface: AWSDataSync
    
    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
    
    Returns:
    
    Result of the CreateLocationFsxOntap operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxOpenZfs
```
public CreateLocationFsxOpenZfsResult createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
    
    Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.
    
    Specified by:
    
    createLocationFsxOpenZfs in interface AWSDataSync
    
    Returns:
    
    Result of the CreateLocationFsxOpenZfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationFsxWindows
```
public CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an endpoint for an Amazon FSx for Windows File Server file system.
    
    Specified by:
    
    createLocationFsxWindows in interface AWSDataSync
    
    Returns:
    
    Result of the CreateLocationFsxWindows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationHdfs
```
public CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an endpoint for a Hadoop Distributed File System (HDFS).
    
    Specified by:
    
    createLocationHdfs in interface AWSDataSync
    
    Returns:
    
    Result of the CreateLocationHdfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationNfs
```
public CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    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:
    
    request - CreateLocationNfsRequest
    
    Returns:
    
    Result of the CreateLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationObjectStorage
```
public CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest request)
```
    Description copied from interface: AWSDataSync
    
    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:
    
    request - CreateLocationObjectStorageRequest
    
    Returns:
    
    Result of the CreateLocationObjectStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationS3
```
public CreateLocationS3Result createLocationS3(CreateLocationS3Request request)
```
    Description copied from interface: AWSDataSync
    A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.
    Before you create your location, make sure that you read the following sections:
    
    Storage class considerations with Amazon S3 locations
    
    Evaluating S3 request costs when using DataSync
    For more information, see Creating an Amazon S3 location.
    Specified by:
    
    createLocationS3 in interface AWSDataSync
    
    Parameters:
    
    request - CreateLocationS3Request
    
    Returns:
    
    Result of the CreateLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationSmb
```
public CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer. For more information, see Creating an SMB location.
    
    Specified by:
    
    createLocationSmb in interface AWSDataSync
    
    Parameters:
    
    request - CreateLocationSmbRequest
    
    Returns:
    
    Result of the CreateLocationSmb operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTask
```
public CreateTaskResult createTask(CreateTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    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).
    
    If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
    
    Specified by:
    
    createTask in interface AWSDataSync
    
    Parameters:
    
    request - CreateTaskRequest
    
    Returns:
    
    Result of the CreateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
```
    Description copied from interface: AWSDataSync
    
    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:
    
    request - DeleteAgentRequest
    
    Returns:
    
    Result of the DeleteAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLocation
```
public DeleteLocationResult deleteLocation(DeleteLocationRequest request)
```
    Description copied from interface: AWSDataSync
    
    Deletes the configuration of a location used by DataSync.
    
    Specified by:
    
    deleteLocation in interface AWSDataSync
    
    Parameters:
    
    request - DeleteLocation
    
    Returns:
    
    Result of the DeleteLocation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
public DeleteTaskResult deleteTask(DeleteTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    Deletes an DataSync task.
    
    Specified by:
    
    deleteTask in interface AWSDataSync
    
    Parameters:
    
    request - DeleteTask
    
    Returns:
    
    Result of the DeleteTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
public DescribeAgentResult describeAgent(DescribeAgentRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
    
    Specified by:
    
    describeAgent in interface AWSDataSync
    
    Parameters:
    
    request - DescribeAgent
    
    Returns:
    
    Result of the DescribeAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDiscoveryJob
```
public DescribeDiscoveryJobResult describeDiscoveryJob(DescribeDiscoveryJobRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns information about a DataSync discovery job.
    
    Specified by:
    
    describeDiscoveryJob in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeDiscoveryJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfs
```
public DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata about your DataSync location for an Amazon EFS file system.
    
    Specified by:
    
    describeLocationEfs in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationEfsRequest
    
    Returns:
    
    Result of the DescribeLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxLustre
```
public DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)
```
    Description copied from interface: AWSDataSync
    
    Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
    
    Specified by:
    
    describeLocationFsxLustre in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeLocationFsxLustre operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxOntap
```
public DescribeLocationFsxOntapResult describeLocationFsxOntap(DescribeLocationFsxOntapRequest request)
```
    Description copied from interface: AWSDataSync
    
    Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
    
    If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password.
    
    Specified by:
    
    describeLocationFsxOntap in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeLocationFsxOntap operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxOpenZfs
```
public DescribeLocationFsxOpenZfsResult describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
    
    Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.
    
    Specified by:
    
    describeLocationFsxOpenZfs in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeLocationFsxOpenZfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationFsxWindows
```
public DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
    
    Specified by:
    
    describeLocationFsxWindows in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeLocationFsxWindows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationHdfs
```
public DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
    
    Specified by:
    
    describeLocationHdfs in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeLocationHdfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfs
```
public DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as the path information, about an NFS location.
    
    Specified by:
    
    describeLocationNfs in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationNfsRequest
    
    Returns:
    
    Result of the DescribeLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationObjectStorage
```
public DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata about your DataSync location for an object storage system.
    
    Specified by:
    
    describeLocationObjectStorage in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationObjectStorageRequest
    
    Returns:
    
    Result of the DescribeLocationObjectStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3
```
public DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Specified by:
    
    describeLocationS3 in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationS3Request
    
    Returns:
    
    Result of the DescribeLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationSmb
```
public DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as the path and user information about an SMB location.
    
    Specified by:
    
    describeLocationSmb in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationSmbRequest
    
    Returns:
    
    Result of the DescribeLocationSmb operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStorageSystem
```
public DescribeStorageSystemResult describeStorageSystem(DescribeStorageSystemRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns information about an on-premises storage system that you're using with DataSync Discovery.
    
    Specified by:
    
    describeStorageSystem in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeStorageSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStorageSystemResourceMetrics
```
public DescribeStorageSystemResourceMetricsResult describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
    
    Specified by:
    
    describeStorageSystemResourceMetrics in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeStorageSystemResourceMetrics operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStorageSystemResources
```
public DescribeStorageSystemResourcesResult describeStorageSystemResources(DescribeStorageSystemResourcesRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns information that DataSync Discovery collects about resources in your on-premises storage system.
    
    Specified by:
    
    describeStorageSystemResources in interface AWSDataSync
    
    Returns:
    
    Result of the DescribeStorageSystemResources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
public DescribeTaskResult describeTask(DescribeTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata about a task.
    
    Specified by:
    
    describeTask in interface AWSDataSync
    
    Parameters:
    
    request - DescribeTaskRequest
    
    Returns:
    
    Result of the DescribeTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
public DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns detailed metadata about a task that is being executed.
    
    Specified by:
    
    describeTaskExecution in interface AWSDataSync
    
    Parameters:
    
    request - DescribeTaskExecutionRequest
    
    Returns:
    
    Result of the DescribeTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - generateRecommendations
```
public GenerateRecommendationsResult generateRecommendations(GenerateRecommendationsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.
    
    Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
    
    If your discovery job completes successfully, you don't need to use this operation. DataSync Discovery generates the recommendations for you automatically.
    
    Specified by:
    
    generateRecommendations in interface AWSDataSync
    
    Returns:
    
    Result of the GenerateRecommendations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
public ListAgentsResult listAgents(ListAgentsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
    
    With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.
    
    ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then immediately run ListAgents, that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
    
    Specified by:
    
    listAgents in interface AWSDataSync
    
    Parameters:
    
    request - ListAgentsRequest
    
    Returns:
    
    Result of the ListAgents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDiscoveryJobs
```
public ListDiscoveryJobsResult listDiscoveryJobs(ListDiscoveryJobsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
    
    Specified by:
    
    listDiscoveryJobs in interface AWSDataSync
    
    Returns:
    
    Result of the ListDiscoveryJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLocations
```
public ListLocationsResult listLocations(ListLocationsRequest request)
```
    Description copied from interface: AWSDataSync
    
    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:
    
    request - ListLocationsRequest
    
    Returns:
    
    Result of the ListLocations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listStorageSystems
```
public ListStorageSystemsResult listStorageSystems(ListStorageSystemsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Lists the on-premises storage systems that you're using with DataSync Discovery.
    
    Specified by:
    
    listStorageSystems in interface AWSDataSync
    
    Returns:
    
    Result of the ListStorageSystems operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns all the tags associated with an Amazon Web Services resource.
    
    Specified by:
    
    listTagsForResource in interface AWSDataSync
    
    Parameters:
    
    request - ListTagsForResourceRequest
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutions
```
public ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns a list of executed tasks.
    
    Specified by:
    
    listTaskExecutions in interface AWSDataSync
    
    Parameters:
    
    request - ListTaskExecutions
    
    Returns:
    
    Result of the ListTaskExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
public ListTasksResult listTasks(ListTasksRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns a list of the DataSync tasks you created.
    
    Specified by:
    
    listTasks in interface AWSDataSync
    
    Parameters:
    
    request - ListTasksRequest
    
    Returns:
    
    Result of the ListTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeStorageSystem
```
public RemoveStorageSystemResult removeStorageSystem(RemoveStorageSystemRequest request)
```
    Description copied from interface: AWSDataSync
    
    Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
    
    Specified by:
    
    removeStorageSystem in interface AWSDataSync
    
    Returns:
    
    Result of the RemoveStorageSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDiscoveryJob
```
public StartDiscoveryJobResult startDiscoveryJob(StartDiscoveryJobRequest request)
```
    Description copied from interface: AWSDataSync
    
    Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.
    
    Specified by:
    
    startDiscoveryJob in interface AWSDataSync
    
    Returns:
    
    Result of the StartDiscoveryJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTaskExecution
```
public StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest request)
```
    Description copied from interface: AWSDataSync
    
    Starts an DataSync task. For each task, you can only run one task execution at a time.
    
    There are several phases to a task execution. For more information, see Task execution statuses.
    
    If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
    
    Specified by:
    
    startTaskExecution in interface AWSDataSync
    
    Parameters:
    
    request - StartTaskExecutionRequest
    
    Returns:
    
    Result of the StartTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopDiscoveryJob
```
public StopDiscoveryJobResult stopDiscoveryJob(StopDiscoveryJobRequest request)
```
    Description copied from interface: AWSDataSync
    
    Stops a running DataSync discovery job.
    
    You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.
    
    Specified by:
    
    stopDiscoveryJob in interface AWSDataSync
    
    Returns:
    
    Result of the StopDiscoveryJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSDataSync
    
    Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.
    
    These include DataSync resources, such as locations, tasks, and task executions.
    
    Specified by:
    
    tagResource in interface AWSDataSync
    
    Parameters:
    
    request - TagResourceRequest
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSDataSync
    
    Removes tags from an Amazon Web Services resource.
    
    Specified by:
    
    untagResource in interface AWSDataSync
    
    Parameters:
    
    request - UntagResourceRequest
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
public UpdateAgentResult updateAgent(UpdateAgentRequest request)
```
    Description copied from interface: AWSDataSync
    
    Updates the name of an agent.
    
    Specified by:
    
    updateAgent in interface AWSDataSync
    
    Parameters:
    
    request - UpdateAgentRequest
    
    Returns:
    
    Result of the UpdateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDiscoveryJob
```
public UpdateDiscoveryJobResult updateDiscoveryJob(UpdateDiscoveryJobRequest request)
```
    Description copied from interface: AWSDataSync
    
    Edits a DataSync discovery job configuration.
    
    Specified by:
    
    updateDiscoveryJob in interface AWSDataSync
    
    Returns:
    
    Result of the UpdateDiscoveryJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationHdfs
```
public UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
    
    Specified by:
    
    updateLocationHdfs in interface AWSDataSync
    
    Returns:
    
    Result of the UpdateLocationHdfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationNfs
```
public UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    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
    
    Returns:
    
    Result of the UpdateLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationObjectStorage
```
public UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)
```
    Description copied from interface: AWSDataSync
    
    Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
    
    Specified by:
    
    updateLocationObjectStorage in interface AWSDataSync
    
    Returns:
    
    Result of the UpdateLocationObjectStorage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateLocationSmb
```
public UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest request)
```
    Description copied from interface: AWSDataSync
    
    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
    
    Returns:
    
    Result of the UpdateLocationSmb operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateStorageSystem
```
public UpdateStorageSystemResult updateStorageSystem(UpdateStorageSystemRequest request)
```
    Description copied from interface: AWSDataSync
    
    Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
    
    Specified by:
    
    updateStorageSystem in interface AWSDataSync
    
    Returns:
    
    Result of the UpdateStorageSystem operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTask
```
public UpdateTaskResult updateTask(UpdateTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    Updates the metadata associated with a task.
    
    Specified by:
    
    updateTask in interface AWSDataSync
    
    Parameters:
    
    request - UpdateTaskResponse
    
    Returns:
    
    Result of the UpdateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTaskExecution
```
public UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest request)
```
    Description copied from interface: AWSDataSync
    
    Modifies a running DataSync task.
    
    Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task.
    
    Specified by:
    
    updateTaskExecution in interface AWSDataSync
    
    Returns:
    
    Result of the UpdateTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    shutdown in interface AWSDataSync
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.476

Class AbstractAWSDataSync

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addStorageSystem

cancelTaskExecution

createAgent

createLocationEfs

createLocationFsxLustre

createLocationFsxOntap

createLocationFsxOpenZfs

createLocationFsxWindows

createLocationHdfs

createLocationNfs

createLocationObjectStorage

createLocationS3

createLocationSmb

createTask

deleteAgent

deleteLocation

deleteTask

describeAgent

describeDiscoveryJob

describeLocationEfs

describeLocationFsxLustre

describeLocationFsxOntap

describeLocationFsxOpenZfs

describeLocationFsxWindows

describeLocationHdfs

describeLocationNfs

describeLocationObjectStorage

describeLocationS3

describeLocationSmb

describeStorageSystem

describeStorageSystemResourceMetrics

describeStorageSystemResources

describeTask

describeTaskExecution

generateRecommendations

listAgents

listDiscoveryJobs

listLocations

listStorageSystems

listTagsForResource

listTaskExecutions

listTasks

removeStorageSystem

startDiscoveryJob

startTaskExecution

stopDiscoveryJob

tagResource

untagResource

updateAgent

updateDiscoveryJob

updateLocationHdfs

updateLocationNfs

updateLocationObjectStorage

updateLocationSmb

updateStorageSystem

updateTask

updateTaskExecution

shutdown

getCachedResponseMetadata