com.amazonaws.services.datasync

Interface AWSDataSync

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 a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
CancelTaskExecutionResult	cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest) Cancels execution of a task.
CreateAgentResult	createAgent(CreateAgentRequest createAgentRequest) Activates an DataSync agent that you have deployed on your host.
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 access for a transfer.
CreateLocationFsxOpenZfsResult	createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest) Creates an endpoint for an Amazon FSx for OpenZFS file system.
CreateLocationFsxWindowsResult	createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest) Creates an endpoint for an Amazon FSx for Windows File Server file system.
CreateLocationHdfsResult	createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest) Creates an endpoint for a Hadoop Distributed File System (HDFS).
CreateLocationNfsResult	createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest) Defines a file system on a Network File System (NFS) server that can be read from or written to.
CreateLocationObjectStorageResult	createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest) Creates an endpoint for an object storage system that DataSync can access for a transfer.
CreateLocationS3Result	createLocationS3(CreateLocationS3Request createLocationS3Request) Creates an endpoint for an Amazon S3 bucket.
CreateLocationSmbResult	createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest) Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
CreateTaskResult	createTask(CreateTaskRequest createTaskRequest) Configures a task, which defines where and how DataSync transfers your data.
DeleteAgentResult	deleteAgent(DeleteAgentRequest deleteAgentRequest) Deletes an agent.
DeleteLocationResult	deleteLocation(DeleteLocationRequest deleteLocationRequest) Deletes the configuration of a location used by DataSync.
DeleteTaskResult	deleteTask(DeleteTaskRequest deleteTaskRequest) Deletes a task.
DescribeAgentResult	describeAgent(DescribeAgentRequest describeAgentRequest) Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.
DescribeLocationEfsResult	describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest) Returns metadata about your DataSync location for an Amazon EFS file system.
DescribeLocationFsxLustreResult	describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest) Returns metadata about an Amazon FSx for Lustre location, such as information about its path.
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) Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
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) Returns metadata, such as the path information, about an NFS location.
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.
DescribeTaskResult	describeTask(DescribeTaskRequest describeTaskRequest) Returns metadata about a task.
DescribeTaskExecutionResult	describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest) Returns detailed metadata about a task that is being executed.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListAgentsResult	listAgents(ListAgentsRequest listAgentsRequest) Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request.
ListLocationsResult	listLocations(ListLocationsRequest listLocationsRequest) Returns a list of source and destination locations.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns all the tags associated with a specified resource.
ListTaskExecutionsResult	listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest) Returns a list of executed tasks.
ListTasksResult	listTasks(ListTasksRequest listTasksRequest) Returns a list of the DataSync tasks you created.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartTaskExecutionResult	startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest) Starts a specific invocation of a task.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Applies a key-value pair to an Amazon Web Services resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes a tag from an Amazon Web Services resource.
UpdateAgentResult	updateAgent(UpdateAgentRequest updateAgentRequest) Updates the name of an agent.
UpdateLocationHdfsResult	updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest) Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
UpdateLocationNfsResult	updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest) Updates some of the parameters of a previously created location for Network File System (NFS) access.
UpdateLocationObjectStorageResult	updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest) Updates some of the parameters of a previously created location for self-managed object storage server access.
UpdateLocationSmbResult	updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest) Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.
UpdateTaskResult	updateTask(UpdateTaskRequest updateTaskRequest) Updates the metadata associated with a task.
UpdateTaskExecutionResult	updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest) Updates execution of a task.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelTaskExecution

CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)

Cancels execution of a task.

When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully complete the transfer when you start the next task execution.

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 have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

Parameters:

createAgentRequest - CreateAgentRequest

Returns:

Result of the CreateAgent operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

createLocationEfs

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 access for a transfer. For more information, see Creating a location for FSx for ONTAP.

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.

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.

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)

Defines a file system on a Network File System (NFS) server that can be read from or written to.

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)

Creates an endpoint for an Amazon S3 bucket.

For more information, see Create an Amazon S3 location in the DataSync User Guide.

Parameters:

createLocationS3Request - CreateLocationS3Request

Returns:

Result of the CreateLocationS3 operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

createLocationSmb

CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

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 task, which defines where and how DataSync transfers your data.

A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of your locations must reside in the Region where you're using DataSync.

For more information, see the following topics:

• Working with DataSync locations

• Configure DataSync task settings

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)

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.

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 a task.

Parameters:

deleteTaskRequest - DeleteTask

Returns:

Result of the DeleteTask operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

describeAgent

DescribeAgentResult describeAgent(DescribeAgentRequest describeAgentRequest)

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

Parameters:

describeAgentRequest - DescribeAgent

Returns:

Result of the DescribeAgent operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

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)

Returns metadata about an Amazon FSx for Lustre location, such as information about its path.

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.

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)

Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.

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)

Returns metadata, such as the path information, about an NFS location.

Parameters:

describeLocationNfsRequest - DescribeLocationNfsRequest

Returns:

Result of the DescribeLocationNfs operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

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

describeTask

DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest)

Returns metadata about a task.

Parameters:

describeTaskRequest - DescribeTaskRequest

Returns:

Result of the DescribeTask operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

describeTaskExecution

DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)

Returns detailed metadata about a task that is being executed.

Parameters:

describeTaskExecutionRequest - DescribeTaskExecutionRequest

Returns:

Result of the DescribeTaskExecution operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

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 agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.

Parameters:

listAgentsRequest - ListAgentsRequest

Returns:

Result of the ListAgents operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

listLocations

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

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns all the tags associated with a specified 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

startTaskExecution

StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)

Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the DataSync User Guide.

Parameters:

startTaskExecutionRequest - StartTaskExecutionRequest

Returns:

Result of the StartTaskExecution operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

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 key-value pair to an Amazon Web Services resource.

Parameters:

tagResourceRequest - TagResourceRequest

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes a tag 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 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

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)

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.

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 of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.

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 previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.

Parameters:

updateLocationSmbRequest -

Returns:

Result of the UpdateLocationSmb operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

updateTask

UpdateTaskResult updateTask(UpdateTaskRequest updateTaskRequest)

Updates the metadata associated with a task.

Parameters:

updateTaskRequest - UpdateTaskResponse

Returns:

Result of the UpdateTask operation returned by the service.

Throws:

InvalidRequestException - This exception is thrown when the client submits a malformed request.

InternalException - This exception is thrown when an error occurs in the DataSync service.

See Also:

AWS API Documentation

updateTaskExecution

UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)

Updates execution of a task.

You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.

The only Option that can be modified by UpdateTaskExecution is BytesPerSecond .

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.