AWSDataSync (AWS SDK for Java

All Known Subinterfaces:

AWSDataSyncAsync

All Known Implementing Classes:

AbstractAWSDataSync, AbstractAWSDataSyncAsync, AWSDataSyncAsyncClient, AWSDataSyncClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDataSync
```
Interface for accessing DataSync.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSDataSync instead.

DataSync
DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.

This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .

Field Summary

Fields
Modifier and Type Field and Description

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

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AddStorageSystemResult`	`addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)` Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
`CancelTaskExecutionResult`	`cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)` Stops an DataSync task execution that's in progress.
`CreateAgentResult`	`createAgent(CreateAgentRequest createAgentRequest)` Activates an DataSync agent that you've deployed in your storage environment.
`CreateLocationAzureBlobResult`	`createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)` Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.
`CreateLocationEfsResult`	`createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)` Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
`CreateLocationFsxLustreResult`	`createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)` Creates an endpoint for an Amazon FSx for Lustre file system.
`CreateLocationFsxOntapResult`	`createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)` Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.
`CreateLocationFsxOpenZfsResult`	`createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)` Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
`CreateLocationFsxWindowsResult`	`createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)` Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.
`CreateLocationHdfsResult`	`createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)` Creates an endpoint for a Hadoop Distributed File System (HDFS).
`CreateLocationNfsResult`	`createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)` Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
`CreateLocationObjectStorageResult`	`createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)` Creates an endpoint for an object storage system that DataSync can access for a transfer.
`CreateLocationS3Result`	`createLocationS3(CreateLocationS3Request createLocationS3Request)` A location is an endpoint for an Amazon S3 bucket.
`CreateLocationSmbResult`	`createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)` Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
`CreateTaskResult`	`createTask(CreateTaskRequest createTaskRequest)` Configures a transfer task, which defines where and how DataSync moves your data.
`DeleteAgentResult`	`deleteAgent(DeleteAgentRequest deleteAgentRequest)` Removes an DataSync agent resource from your Amazon Web Services account.
`DeleteLocationResult`	`deleteLocation(DeleteLocationRequest deleteLocationRequest)` Deletes the configuration of a location used by DataSync.
`DeleteTaskResult`	`deleteTask(DeleteTaskRequest deleteTaskRequest)` Deletes an DataSync transfer task.
`DescribeAgentResult`	`describeAgent(DescribeAgentRequest describeAgentRequest)` Returns information about an DataSync agent, such as its name, service endpoint type, and status.
`DescribeDiscoveryJobResult`	`describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)` Returns information about a DataSync discovery job.
`DescribeLocationAzureBlobResult`	`describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)` Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
`DescribeLocationEfsResult`	`describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)` Returns metadata about your DataSync location for an Amazon EFS file system.
`DescribeLocationFsxLustreResult`	`describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)` Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
`DescribeLocationFsxOntapResult`	`describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)` Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
`DescribeLocationFsxOpenZfsResult`	`describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)` Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
`DescribeLocationFsxWindowsResult`	`describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)` Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
`DescribeLocationHdfsResult`	`describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)` Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
`DescribeLocationNfsResult`	`describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)` Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
`DescribeLocationObjectStorageResult`	`describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)` Returns metadata about your DataSync location for an object storage system.
`DescribeLocationS3Result`	`describeLocationS3(DescribeLocationS3Request describeLocationS3Request)` Returns metadata, such as bucket name, about an Amazon S3 bucket location.
`DescribeLocationSmbResult`	`describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)` Returns metadata, such as the path and user information about an SMB location.
`DescribeStorageSystemResult`	`describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)` Returns information about an on-premises storage system that you're using with DataSync Discovery.
`DescribeStorageSystemResourceMetricsResult`	`describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)` Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
`DescribeStorageSystemResourcesResult`	`describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)` Returns information that DataSync Discovery collects about resources in your on-premises storage system.
`DescribeTaskResult`	`describeTask(DescribeTaskRequest describeTaskRequest)` Provides information about an DataSync transfer task.
`DescribeTaskExecutionResult`	`describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)` Provides information about an execution of your DataSync task.
`GenerateRecommendationsResult`	`generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)` 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 listAgentsRequest)` 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 listDiscoveryJobsRequest)` 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 listLocationsRequest)` Returns a list of source and destination locations.
`ListStorageSystemsResult`	`listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)` Lists the on-premises storage systems that you're using with DataSync Discovery.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns all the tags associated with an Amazon Web Services resource.
`ListTaskExecutionsResult`	`listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)` Returns a list of executed tasks.
`ListTasksResult`	`listTasks(ListTasksRequest listTasksRequest)` Returns a list of the DataSync tasks you created.
`RemoveStorageSystemResult`	`removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)` 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 startDiscoveryJobRequest)` Runs a DataSync discovery job on your on-premises storage system.
`StartTaskExecutionResult`	`startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)` Starts an DataSync transfer task.
`StopDiscoveryJobResult`	`stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)` Stops a running DataSync discovery job.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Applies a tag to an Amazon Web Services resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes tags from an Amazon Web Services resource.
`UpdateAgentResult`	`updateAgent(UpdateAgentRequest updateAgentRequest)` Updates the name of an DataSync agent.
`UpdateDiscoveryJobResult`	`updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)` Edits a DataSync discovery job configuration.
`UpdateLocationAzureBlobResult`	`updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)` Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
`UpdateLocationHdfsResult`	`updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)` Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
`UpdateLocationNfsResult`	`updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)` Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
`UpdateLocationObjectStorageResult`	`updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)` Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
`UpdateLocationSmbResult`	`updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)` Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
`UpdateStorageSystemResult`	`updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)` Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
`UpdateTaskResult`	`updateTask(UpdateTaskRequest updateTaskRequest)` Updates the configuration of a DataSync transfer task.
`UpdateTaskExecutionResult`	`updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)` Updates the configuration of a running DataSync task execution.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - addStorageSystem
```
AddStorageSystemResult addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)
```
    Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
    
    Parameters:
    
    addStorageSystemRequest -
    
    Returns:
    
    Result of the AddStorageSystem 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
  - cancelTaskExecution
```
CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
```
    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.
    
    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
```
CreateAgentResult createAgent(CreateAgentRequest createAgentRequest)
```
    Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
    
    If you haven't deployed an agent yet, see the following topics to learn more:
    - Agent requirements
    - Create an agent
    If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
    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
  - createLocationAzureBlob
```
CreateLocationAzureBlobResult createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)
```
    Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.
    
    Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
    
    Parameters:
    
    createLocationAzureBlobRequest -
    
    Returns:
    
    Result of the CreateLocationAzureBlob 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
```
CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
```
    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.
    
    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
```
CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
```
    Creates an endpoint for an Amazon FSx for Lustre file system.
    
    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
```
CreateLocationFsxOntapResult createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
```
    Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can use for a data transfer.
    
    Before you begin, make sure that you understand how DataSync accesses an FSx for ONTAP file system.
    
    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
```
CreateLocationFsxOpenZfsResult createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
```
    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.
    
    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
```
CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
```
    Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data transfer.
    
    Before you begin, make sure that you understand how DataSync accesses an FSx for Windows File Server.
    
    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
```
CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)
```
    Creates an endpoint for a Hadoop Distributed File System (HDFS).
    
    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
```
CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
```
    Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
    
    For more information, see Configuring transfers to or from an NFS file server.
    
    If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.
    
    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
```
CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
```
    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.
    
    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
```
CreateLocationS3Result createLocationS3(CreateLocationS3Request createLocationS3Request)
```
    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.
    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
```
CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
```
    Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
    
    Before you begin, make sure that you understand how DataSync accesses an SMB file server.
    
    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
```
CreateTaskResult createTask(CreateTaskRequest createTaskRequest)
```
    Configures a transfer task, which defines where and how DataSync moves your data.
    
    A task includes a source location, destination location, and the options 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.
    
    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
```
DeleteAgentResult deleteAgent(DeleteAgentRequest deleteAgentRequest)
```
    Removes an DataSync agent resource from your Amazon Web Services account.
    
    Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.
    
    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
```
DeleteLocationResult deleteLocation(DeleteLocationRequest deleteLocationRequest)
```
    Deletes the configuration of a location used by DataSync.
    
    Parameters:
    
    deleteLocationRequest - DeleteLocation
    
    Returns:
    
    Result of the DeleteLocation operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
DeleteTaskResult deleteTask(DeleteTaskRequest deleteTaskRequest)
```
    Deletes an DataSync transfer task.
    
    Parameters:
    
    deleteTaskRequest - DeleteTask
    
    Returns:
    
    Result of the DeleteTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
DescribeAgentResult describeAgent(DescribeAgentRequest describeAgentRequest)
```
    Returns information about an DataSync agent, such as its name, service endpoint type, and status.
    
    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
  - describeDiscoveryJob
```
DescribeDiscoveryJobResult describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)
```
    Returns information about a DataSync discovery job.
    
    Parameters:
    
    describeDiscoveryJobRequest -
    
    Returns:
    
    Result of the DescribeDiscoveryJob 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
  - describeLocationAzureBlob
```
DescribeLocationAzureBlobResult describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)
```
    Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
    
    Parameters:
    
    describeLocationAzureBlobRequest -
    
    Returns:
    
    Result of the DescribeLocationAzureBlob 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
```
DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
```
    Returns metadata about your DataSync location for an Amazon EFS file system.
    
    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
```
DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
```
    Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
    
    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
```
DescribeLocationFsxOntapResult describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
```
    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.
    
    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
```
DescribeLocationFsxOpenZfsResult describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
```
    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.
    
    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
```
DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
```
    Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
    
    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
```
DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)
```
    Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
    
    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
```
DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
```
    Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
    
    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
```
DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
```
    Returns metadata about your DataSync location for an object storage system.
    
    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
```
DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
```
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Parameters:
    
    describeLocationS3Request - DescribeLocationS3Request
    
    Returns:
    
    Result of the DescribeLocationS3 operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationSmb
```
DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
```
    Returns metadata, such as the path and user information about an SMB location.
    
    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
  - describeStorageSystem
```
DescribeStorageSystemResult describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)
```
    Returns information about an on-premises storage system that you're using with DataSync Discovery.
    
    Parameters:
    
    describeStorageSystemRequest -
    
    Returns:
    
    Result of the DescribeStorageSystem 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
  - describeStorageSystemResourceMetrics
```
DescribeStorageSystemResourceMetricsResult describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
```
    Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
    
    Parameters:
    
    describeStorageSystemResourceMetricsRequest -
    
    Returns:
    
    Result of the DescribeStorageSystemResourceMetrics 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
  - describeStorageSystemResources
```
DescribeStorageSystemResourcesResult describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
```
    Returns information that DataSync Discovery collects about resources in your on-premises storage system.
    
    Parameters:
    
    describeStorageSystemResourcesRequest -
    
    Returns:
    
    Result of the DescribeStorageSystemResources 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
```
DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest)
```
    Provides information about an DataSync transfer task.
    
    Parameters:
    
    describeTaskRequest - DescribeTaskRequest
    
    Returns:
    
    Result of the DescribeTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
```
    Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.
    
    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
  - generateRecommendations
```
GenerateRecommendationsResult generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)
```
    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.
    
    Parameters:
    
    generateRecommendationsRequest -
    
    Returns:
    
    Result of the GenerateRecommendations 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
```
ListAgentsResult listAgents(ListAgentsRequest listAgentsRequest)
```
    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.
    
    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
  - listDiscoveryJobs
```
ListDiscoveryJobsResult listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
```
    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.
    
    Parameters:
    
    listDiscoveryJobsRequest -
    
    Returns:
    
    Result of the ListDiscoveryJobs 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
```
ListLocationsResult listLocations(ListLocationsRequest listLocationsRequest)
```
    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.
    
    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
  - listStorageSystems
```
ListStorageSystemsResult listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)
```
    Lists the on-premises storage systems that you're using with DataSync Discovery.
    
    Parameters:
    
    listStorageSystemsRequest -
    
    Returns:
    
    Result of the ListStorageSystems 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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns all the tags associated with an Amazon Web Services resource.
    
    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
```
ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
```
    Returns a list of executed tasks.
    
    Parameters:
    
    listTaskExecutionsRequest - ListTaskExecutions
    
    Returns:
    
    Result of the ListTaskExecutions operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
ListTasksResult listTasks(ListTasksRequest listTasksRequest)
```
    Returns a list of the DataSync tasks you created.
    
    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
  - removeStorageSystem
```
RemoveStorageSystemResult removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)
```
    Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
    
    Parameters:
    
    removeStorageSystemRequest -
    
    Returns:
    
    Result of the RemoveStorageSystem 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
  - startDiscoveryJob
```
StartDiscoveryJobResult startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest)
```
    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.
    
    Parameters:
    
    startDiscoveryJobRequest -
    
    Returns:
    
    Result of the StartDiscoveryJob 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
```
StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
```
    Starts an DataSync transfer 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.
    
    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
  - stopDiscoveryJob
```
StopDiscoveryJobResult stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)
```
    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.
    
    Parameters:
    
    stopDiscoveryJobRequest -
    
    Returns:
    
    Result of the StopDiscoveryJob 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
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    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.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes tags from an Amazon Web Services resource.
    
    Parameters:
    
    untagResourceRequest - UntagResourceRequest
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest)
```
    Updates the name of an DataSync agent.
    
    Parameters:
    
    updateAgentRequest - UpdateAgentRequest
    
    Returns:
    
    Result of the UpdateAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateDiscoveryJob
```
UpdateDiscoveryJobResult updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)
```
    Edits a DataSync discovery job configuration.
    
    Parameters:
    
    updateDiscoveryJobRequest -
    
    Returns:
    
    Result of the UpdateDiscoveryJob 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
  - updateLocationAzureBlob
```
UpdateLocationAzureBlobResult updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)
```
    Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
    
    Parameters:
    
    updateLocationAzureBlobRequest -
    
    Returns:
    
    Result of the UpdateLocationAzureBlob 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
```
UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)
```
    Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
    
    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
```
UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)
```
    Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
    
    For more information, see Configuring transfers to or from an NFS file server.
    
    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
```
UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
```
    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.
    
    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
```
UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)
```
    Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
    
    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
  - updateStorageSystem
```
UpdateStorageSystemResult updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)
```
    Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
    
    Parameters:
    
    updateStorageSystemRequest -
    
    Returns:
    
    Result of the UpdateStorageSystem 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
```
UpdateTaskResult updateTask(UpdateTaskRequest updateTaskRequest)
```
    Updates the configuration of a DataSync transfer task.
    
    Parameters:
    
    updateTaskRequest - UpdateTaskResponse
    
    Returns:
    
    Result of the UpdateTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    InternalException - This exception is thrown when an error occurs in the DataSync service.
    
    See Also:
    
    AWS API Documentation
  - updateTaskExecution
```
UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)
```
    Updates the configuration of a running DataSync task execution.
    
    Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond , which throttles bandwidth for a running or queued task execution.
    
    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
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.639

Interface AWSDataSync

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

addStorageSystem

cancelTaskExecution

createAgent

createLocationAzureBlob

createLocationEfs

createLocationFsxLustre

createLocationFsxOntap

createLocationFsxOpenZfs

createLocationFsxWindows

createLocationHdfs

createLocationNfs

createLocationObjectStorage

createLocationS3

createLocationSmb

createTask

deleteAgent

deleteLocation

deleteTask

describeAgent

describeDiscoveryJob

describeLocationAzureBlob

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

updateLocationAzureBlob

updateLocationHdfs

updateLocationNfs

updateLocationObjectStorage

updateLocationSmb

updateStorageSystem

updateTask

updateTaskExecution

shutdown

getCachedResponseMetadata