@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSDataSync extends Object implements AWSDataSync
AWSDataSync
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CancelTaskExecutionResult |
cancelTaskExecution(CancelTaskExecutionRequest request)
Cancels execution of a task.
|
CreateAgentResult |
createAgent(CreateAgentRequest request)
Activates an DataSync agent that you have deployed on your host.
|
CreateLocationEfsResult |
createLocationEfs(CreateLocationEfsRequest request)
Creates an endpoint for an Amazon EFS file system.
|
CreateLocationFsxLustreResult |
createLocationFsxLustre(CreateLocationFsxLustreRequest request)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
CreateLocationFsxWindowsResult |
createLocationFsxWindows(CreateLocationFsxWindowsRequest request)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
CreateLocationHdfsResult |
createLocationHdfs(CreateLocationHdfsRequest request)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
CreateLocationNfsResult |
createLocationNfs(CreateLocationNfsRequest request)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
|
CreateLocationObjectStorageResult |
createLocationObjectStorage(CreateLocationObjectStorageRequest request)
Creates an endpoint for a self-managed object storage bucket.
|
CreateLocationS3Result |
createLocationS3(CreateLocationS3Request request)
Creates an endpoint for an Amazon S3 bucket.
|
CreateLocationSmbResult |
createLocationSmb(CreateLocationSmbRequest request)
Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
|
CreateTaskResult |
createTask(CreateTaskRequest request)
Creates a task.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest request)
Deletes an agent.
|
DeleteLocationResult |
deleteLocation(DeleteLocationRequest request)
Deletes the configuration of a location used by DataSync.
|
DeleteTaskResult |
deleteTask(DeleteTaskRequest request)
Deletes a task.
|
DescribeAgentResult |
describeAgent(DescribeAgentRequest request)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running
or not) for an agent.
|
DescribeLocationEfsResult |
describeLocationEfs(DescribeLocationEfsRequest request)
Returns metadata, such as the path information about an Amazon EFS location.
|
DescribeLocationFsxLustreResult |
describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)
Returns metadata, such as the path information about an Amazon FSx for Lustre location.
|
DescribeLocationFsxWindowsResult |
describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)
Returns metadata, such as the path information about an Amazon FSx for Windows File Server location.
|
DescribeLocationHdfsResult |
describeLocationHdfs(DescribeLocationHdfsRequest request)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
DescribeLocationNfsResult |
describeLocationNfs(DescribeLocationNfsRequest request)
Returns metadata, such as the path information, about an NFS location.
|
DescribeLocationObjectStorageResult |
describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)
Returns metadata about a self-managed object storage server location.
|
DescribeLocationS3Result |
describeLocationS3(DescribeLocationS3Request request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
DescribeLocationSmbResult |
describeLocationSmb(DescribeLocationSmbRequest request)
Returns metadata, such as the path and user information about an SMB location.
|
DescribeTaskResult |
describeTask(DescribeTaskRequest request)
Returns metadata about a task.
|
DescribeTaskExecutionResult |
describeTaskExecution(DescribeTaskExecutionRequest request)
Returns detailed metadata about a task that is being executed.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAgentsResult |
listAgents(ListAgentsRequest request)
Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in
the request.
|
ListLocationsResult |
listLocations(ListLocationsRequest request)
Returns a list of source and destination locations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags associated with a specified resource.
|
ListTaskExecutionsResult |
listTaskExecutions(ListTaskExecutionsRequest request)
Returns a list of executed tasks.
|
ListTasksResult |
listTasks(ListTasksRequest request)
Returns a list of all the tasks.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartTaskExecutionResult |
startTaskExecution(StartTaskExecutionRequest request)
Starts a specific invocation of a task.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies a key-value pair to an Amazon Web Services resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an Amazon Web Services resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest request)
Updates the name of an agent.
|
UpdateLocationHdfsResult |
updateLocationHdfs(UpdateLocationHdfsRequest request)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
UpdateLocationNfsResult |
updateLocationNfs(UpdateLocationNfsRequest request)
Updates some of the parameters of a previously created location for Network File System (NFS) access.
|
UpdateLocationObjectStorageResult |
updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)
Updates some of the parameters of a previously created location for self-managed object storage server access.
|
UpdateLocationSmbResult |
updateLocationSmb(UpdateLocationSmbRequest request)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
UpdateTaskResult |
updateTask(UpdateTaskRequest request)
Updates the metadata associated with a task.
|
UpdateTaskExecutionResult |
updateTaskExecution(UpdateTaskExecutionRequest request)
Updates execution of a task.
|
public CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest request)
AWSDataSync
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.
cancelTaskExecution
in interface AWSDataSync
request
- CancelTaskExecutionRequestpublic CreateAgentResult createAgent(CreateAgentRequest request)
AWSDataSync
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.
createAgent
in interface AWSDataSync
request
- CreateAgentRequestpublic CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest request)
AWSDataSync
Creates an endpoint for an Amazon EFS file system.
createLocationEfs
in interface AWSDataSync
request
- CreateLocationEfsRequestpublic CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest request)
AWSDataSync
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustre
in interface AWSDataSync
public CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest request)
AWSDataSync
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindows
in interface AWSDataSync
public CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest request)
AWSDataSync
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfs
in interface AWSDataSync
public CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest request)
AWSDataSync
Defines a file system on a Network File System (NFS) server that can be read from or written to.
createLocationNfs
in interface AWSDataSync
request
- CreateLocationNfsRequestpublic CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest request)
AWSDataSync
Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage.
createLocationObjectStorage
in interface AWSDataSync
request
- CreateLocationObjectStorageRequestpublic CreateLocationS3Result createLocationS3(CreateLocationS3Request request)
AWSDataSync
Creates an endpoint for an Amazon S3 bucket.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
createLocationS3
in interface AWSDataSync
request
- CreateLocationS3Requestpublic CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest request)
AWSDataSync
Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
createLocationSmb
in interface AWSDataSync
request
- CreateLocationSmbRequestpublic CreateTaskResult createTask(CreateTaskRequest request)
AWSDataSync
Creates a task.
A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.
You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.
When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
createTask
in interface AWSDataSync
request
- CreateTaskRequestpublic DeleteAgentResult deleteAgent(DeleteAgentRequest request)
AWSDataSync
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgent
in interface AWSDataSync
request
- DeleteAgentRequestpublic DeleteLocationResult deleteLocation(DeleteLocationRequest request)
AWSDataSync
Deletes the configuration of a location used by DataSync.
deleteLocation
in interface AWSDataSync
request
- DeleteLocationpublic DeleteTaskResult deleteTask(DeleteTaskRequest request)
AWSDataSync
Deletes a task.
deleteTask
in interface AWSDataSync
request
- DeleteTaskpublic DescribeAgentResult describeAgent(DescribeAgentRequest request)
AWSDataSync
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.
describeAgent
in interface AWSDataSync
request
- DescribeAgentpublic DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest request)
AWSDataSync
Returns metadata, such as the path information about an Amazon EFS location.
describeLocationEfs
in interface AWSDataSync
request
- DescribeLocationEfsRequestpublic DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)
AWSDataSync
Returns metadata, such as the path information about an Amazon FSx for Lustre location.
describeLocationFsxLustre
in interface AWSDataSync
public DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)
AWSDataSync
Returns metadata, such as the path information about an Amazon FSx for Windows File Server location.
describeLocationFsxWindows
in interface AWSDataSync
public DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest request)
AWSDataSync
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfs
in interface AWSDataSync
public DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest request)
AWSDataSync
Returns metadata, such as the path information, about an NFS location.
describeLocationNfs
in interface AWSDataSync
request
- DescribeLocationNfsRequestpublic DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)
AWSDataSync
Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage.
describeLocationObjectStorage
in interface AWSDataSync
request
- DescribeLocationObjectStorageRequestpublic DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request request)
AWSDataSync
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3
in interface AWSDataSync
request
- DescribeLocationS3Requestpublic DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest request)
AWSDataSync
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmb
in interface AWSDataSync
request
- DescribeLocationSmbRequestpublic DescribeTaskResult describeTask(DescribeTaskRequest request)
AWSDataSync
Returns metadata about a task.
describeTask
in interface AWSDataSync
request
- DescribeTaskRequestpublic DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest request)
AWSDataSync
Returns detailed metadata about a task that is being executed.
describeTaskExecution
in interface AWSDataSync
request
- DescribeTaskExecutionRequestpublic ListAgentsResult listAgents(ListAgentsRequest request)
AWSDataSync
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.
listAgents
in interface AWSDataSync
request
- ListAgentsRequestpublic ListLocationsResult listLocations(ListLocationsRequest request)
AWSDataSync
Returns a list of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
listLocations
in interface AWSDataSync
request
- ListLocationsRequestpublic ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSDataSync
Returns all the tags associated with a specified resource.
listTagsForResource
in interface AWSDataSync
request
- ListTagsForResourceRequestpublic ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest request)
AWSDataSync
Returns a list of executed tasks.
listTaskExecutions
in interface AWSDataSync
request
- ListTaskExecutionspublic ListTasksResult listTasks(ListTasksRequest request)
AWSDataSync
Returns a list of all the tasks.
listTasks
in interface AWSDataSync
request
- ListTasksRequestpublic StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest request)
AWSDataSync
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.
startTaskExecution
in interface AWSDataSync
request
- StartTaskExecutionRequestpublic TagResourceResult tagResource(TagResourceRequest request)
AWSDataSync
Applies a key-value pair to an Amazon Web Services resource.
tagResource
in interface AWSDataSync
request
- TagResourceRequestpublic UntagResourceResult untagResource(UntagResourceRequest request)
AWSDataSync
Removes a tag from an Amazon Web Services resource.
untagResource
in interface AWSDataSync
request
- UntagResourceRequestpublic UpdateAgentResult updateAgent(UpdateAgentRequest request)
AWSDataSync
Updates the name of an agent.
updateAgent
in interface AWSDataSync
request
- UpdateAgentRequestpublic UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest request)
AWSDataSync
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfs
in interface AWSDataSync
public UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest request)
AWSDataSync
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
updateLocationNfs
in interface AWSDataSync
public UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)
AWSDataSync
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.
updateLocationObjectStorage
in interface AWSDataSync
public UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest request)
AWSDataSync
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
updateLocationSmb
in interface AWSDataSync
public UpdateTaskResult updateTask(UpdateTaskRequest request)
AWSDataSync
Updates the metadata associated with a task.
updateTask
in interface AWSDataSync
request
- UpdateTaskResponsepublic UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest request)
AWSDataSync
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
.
updateTaskExecution
in interface AWSDataSync
public void shutdown()
AWSDataSync
shutdown
in interface AWSDataSync
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSDataSync
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.
getCachedResponseMetadata
in interface AWSDataSync
request
- The originally executed request.