@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSDataSyncClient extends AmazonWebServiceClient implements AWSDataSync
AWS 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 AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
static AWSDataSyncClientBuilder |
builder() |
CancelTaskExecutionResult |
cancelTaskExecution(CancelTaskExecutionRequest request)
Cancels execution of a task.
|
CreateAgentResult |
createAgent(CreateAgentRequest request)
Activates an AWS DataSync agent that you have deployed on your host.
|
CreateLocationEfsResult |
createLocationEfs(CreateLocationEfsRequest request)
Creates an endpoint for an Amazon EFS file system.
|
CreateLocationNfsResult |
createLocationNfs(CreateLocationNfsRequest request)
Creates an endpoint for a Network File System (NFS) file system.
|
CreateLocationS3Result |
createLocationS3(CreateLocationS3Request request)
Creates an endpoint for an Amazon S3 bucket.
|
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 AWS 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.
|
DescribeLocationNfsResult |
describeLocationNfs(DescribeLocationNfsRequest request)
Returns metadata, such as the path information, about a NFS location.
|
DescribeLocationS3Result |
describeLocationS3(DescribeLocationS3Request request)
Returns metadata, such as bucket name, about an Amazon S3 bucket 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 AWS account in the AWS Region specified in the request.
|
ListLocationsResult |
listLocations(ListLocationsRequest request)
Returns a lists of source and destination locations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags associated with a specified resources.
|
ListTaskExecutionsResult |
listTaskExecutions(ListTaskExecutionsRequest request)
Returns a list of executed tasks.
|
ListTasksResult |
listTasks(ListTasksRequest request)
Returns a list of all the tasks.
|
StartTaskExecutionResult |
startTaskExecution(StartTaskExecutionRequest request)
Starts a specific invocation of a task.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies a key-value pair to an AWS resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an AWS resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest request)
Updates the name of an agent.
|
UpdateTaskResult |
updateTask(UpdateTaskRequest request)
Updates the metadata associated with a task.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
shutdown
public static AWSDataSyncClientBuilder builder()
public CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest request)
Cancels execution of a task.
When you cancel a task execution, the transfer of some files are 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, AWS DataSync successfully complete the transfer when you start the next task execution.
cancelTaskExecution
in interface AWSDataSync
cancelTaskExecutionRequest
- CancelTaskExecutionRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public CreateAgentResult createAgent(CreateAgentRequest request)
Activates an AWS 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 AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS 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 AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
createAgent
in interface AWSDataSync
createAgentRequest
- CreateAgentRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest request)
Creates an endpoint for an Amazon EFS file system.
createLocationEfs
in interface AWSDataSync
createLocationEfsRequest
- CreateLocationEfsRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest request)
Creates an endpoint for a Network File System (NFS) file system.
createLocationNfs
in interface AWSDataSync
createLocationNfsRequest
- CreateLocationNfsRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public CreateLocationS3Result createLocationS3(CreateLocationS3Request request)
Creates an endpoint for an Amazon S3 bucket.
For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.
For more information, see Configuring Amazon S3 Location Settings in the AWS DataSync User Guide.
createLocationS3
in interface AWSDataSync
createLocationS3Request
- CreateLocationS3RequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public CreateTaskResult createTask(CreateTaskRequest request)
Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.
When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.
createTask
in interface AWSDataSync
createTaskRequest
- CreateTaskRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgent
in interface AWSDataSync
deleteAgentRequest
- DeleteAgentRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DeleteLocationResult deleteLocation(DeleteLocationRequest request)
Deletes the configuration of a location used by AWS DataSync.
deleteLocation
in interface AWSDataSync
deleteLocationRequest
- DeleteLocationInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DeleteTaskResult deleteTask(DeleteTaskRequest request)
Deletes a task.
deleteTask
in interface AWSDataSync
deleteTaskRequest
- DeleteTaskInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DescribeAgentResult describeAgent(DescribeAgentRequest request)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
describeAgent
in interface AWSDataSync
describeAgentRequest
- DescribeAgentInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest request)
Returns metadata, such as the path information about an Amazon EFS location.
describeLocationEfs
in interface AWSDataSync
describeLocationEfsRequest
- DescribeLocationEfsRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest request)
Returns metadata, such as the path information, about a NFS location.
describeLocationNfs
in interface AWSDataSync
describeLocationNfsRequest
- DescribeLocationNfsRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3
in interface AWSDataSync
describeLocationS3Request
- DescribeLocationS3RequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DescribeTaskResult describeTask(DescribeTaskRequest request)
Returns metadata about a task.
describeTask
in interface AWSDataSync
describeTaskRequest
- DescribeTaskRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest request)
Returns detailed metadata about a task that is being executed.
describeTaskExecution
in interface AWSDataSync
describeTaskExecutionRequest
- DescribeTaskExecutionRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public ListAgentsResult listAgents(ListAgentsRequest request)
Returns a list of agents owned by an AWS account in the AWS 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
listAgentsRequest
- ListAgentsRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public ListLocationsResult listLocations(ListLocationsRequest request)
Returns a lists 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
listLocationsRequest
- ListLocationsRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags associated with a specified resources.
listTagsForResource
in interface AWSDataSync
listTagsForResourceRequest
- ListTagsForResourceRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest request)
Returns a list of executed tasks.
listTaskExecutions
in interface AWSDataSync
listTaskExecutionsRequest
- ListTaskExecutionsInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public ListTasksResult listTasks(ListTasksRequest request)
Returns a list of all the tasks.
listTasks
in interface AWSDataSync
listTasksRequest
- ListTasksRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest request)
Starts a specific invocation of a task. A TaskExecution
value represents an individual run of a
task. Each task can have at most one TaskExecution
at a time.
TaskExecution
has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
VERIFYING | SUCCESS/FAILURE.
For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.
startTaskExecution
in interface AWSDataSync
startTaskExecutionRequest
- StartTaskExecutionRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public TagResourceResult tagResource(TagResourceRequest request)
Applies a key-value pair to an AWS resource.
tagResource
in interface AWSDataSync
tagResourceRequest
- TagResourceRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from an AWS resource.
untagResource
in interface AWSDataSync
untagResourceRequest
- UntagResourceRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public UpdateAgentResult updateAgent(UpdateAgentRequest request)
Updates the name of an agent.
updateAgent
in interface AWSDataSync
updateAgentRequest
- UpdateAgentRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public UpdateTaskResult updateTask(UpdateTaskRequest request)
Updates the metadata associated with a task.
updateTask
in interface AWSDataSync
updateTaskRequest
- UpdateTaskResponseInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the AWS DataSync service.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSDataSync
request
- The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.