@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSDataSync
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDataSync
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
CancelTaskExecutionResult |
cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Cancels execution of a task.
|
CreateAgentResult |
createAgent(CreateAgentRequest createAgentRequest)
Activates an AWS DataSync agent that you have deployed on your host.
|
CreateLocationEfsResult |
createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system.
|
CreateLocationNfsResult |
createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Defines a file system on a Network File System (NFS) server that can be read from or written to
|
CreateLocationS3Result |
createLocationS3(CreateLocationS3Request createLocationS3Request)
Creates an endpoint for an Amazon S3 bucket.
|
CreateLocationSmbResult |
createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
Defines a file system on an Server Message Block (SMB) server that can be read from or written to.
|
CreateTaskResult |
createTask(CreateTaskRequest createTaskRequest)
Creates a task.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
|
DeleteLocationResult |
deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by AWS 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, such as the path information about an Amazon EFS location.
|
DescribeLocationNfsResult |
describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about a NFS location.
|
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 a 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 AWS account in the AWS Region specified in the request.
|
ListLocationsResult |
listLocations(ListLocationsRequest listLocationsRequest)
Returns a lists of source and destination locations.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
|
ListTaskExecutionsResult |
listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
ListTasksResult |
listTasks(ListTasksRequest listTasksRequest)
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 startTaskExecutionRequest)
Starts a specific invocation of a task.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Applies a key-value pair to an AWS resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
|
UpdateTaskResult |
updateTask(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
|
static final String ENDPOINT_PREFIX
CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
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.
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.CreateAgentResult createAgent(CreateAgentRequest createAgentRequest)
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.
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.CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system.
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.CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Defines a file system on a Network File System (NFS) server that can be read from or written to
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.CreateLocationS3Result createLocationS3(CreateLocationS3Request createLocationS3Request)
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 https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide.
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.CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
Defines a file system on an Server Message Block (SMB) server that can be read from or written to.
createLocationSmbRequest
- CreateLocationSmbRequestInvalidRequestException
- 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.CreateTaskResult createTask(CreateTaskRequest createTaskRequest)
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.
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.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 AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
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.DeleteLocationResult deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by AWS DataSync.
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.DeleteTaskResult deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes a task.
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.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.
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.DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata, such as the path information about an Amazon EFS location.
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.DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Returns metadata, such as the path information, about a NFS location.
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.DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
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.DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about a SMB location.
describeLocationSmbRequest
- DescribeLocationSmbRequestInvalidRequestException
- 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.DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest)
Returns metadata about a task.
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.DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Returns detailed metadata about a task that is being executed.
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.ListAgentsResult listAgents(ListAgentsRequest listAgentsRequest)
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.
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.ListLocationsResult listLocations(ListLocationsRequest listLocationsRequest)
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.
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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with a specified resources.
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.ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
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.ListTasksResult listTasks(ListTasksRequest listTasksRequest)
Returns a list of all the tasks.
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.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 AWS DataSync User Guide.
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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Applies a key-value pair to an AWS resource.
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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes a tag from an AWS resource.
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.UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
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.UpdateTaskResult updateTask(UpdateTaskRequest updateTaskRequest)
Updates the metadata associated with a task.
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.void shutdown()
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 a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.