AbstractAWSDataSync (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.datasync.AbstractAWSDataSync

All Implemented Interfaces:

AWSDataSync

Direct Known Subclasses:

AbstractAWSDataSyncAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSDataSync
extends Object
implements AWSDataSync
```
Abstract implementation of AWSDataSync. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.datasync.AWSDataSync
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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)` Defines a file system on a Network File System (NFS) server that can be read from or written to
`CreateLocationS3Result`	`createLocationS3(CreateLocationS3Request request)` Creates an endpoint for an Amazon S3 bucket.
`CreateLocationSmbResult`	`createLocationSmb(CreateLocationSmbRequest request)` Defines a file system on an 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 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.
`DescribeLocationSmbResult`	`describeLocationSmb(DescribeLocationSmbRequest request)` Returns metadata, such as the path and user information about a 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 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.
`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 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - cancelTaskExecution
```
public CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    cancelTaskExecution in interface AWSDataSync
    
    Parameters:
    
    request - CancelTaskExecutionRequest
    
    Returns:
    
    Result of the CancelTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
public CreateAgentResult createAgent(CreateAgentRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    createAgent in interface AWSDataSync
    
    Parameters:
    
    request - CreateAgentRequest
    
    Returns:
    
    Result of the CreateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationEfs
```
public CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Creates an endpoint for an Amazon EFS file system.
    
    Specified by:
    
    createLocationEfs in interface AWSDataSync
    
    Parameters:
    
    request - CreateLocationEfsRequest
    
    Returns:
    
    Result of the CreateLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationNfs
```
public CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Defines a file system on a Network File System (NFS) server that can be read from or written to
    
    Specified by:
    
    createLocationNfs in interface AWSDataSync
    
    Parameters:
    
    request - CreateLocationNfsRequest
    
    Returns:
    
    Result of the CreateLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationS3
```
public CreateLocationS3Result createLocationS3(CreateLocationS3Request request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    createLocationS3 in interface AWSDataSync
    
    Parameters:
    
    request - CreateLocationS3Request
    
    Returns:
    
    Result of the CreateLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createLocationSmb
```
public CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest request)
```
    Description copied from interface: AWSDataSync
    
    Defines a file system on an Server Message Block (SMB) server that can be read from or written to
    
    Specified by:
    
    createLocationSmb in interface AWSDataSync
    
    Parameters:
    
    request - CreateLocationSmbRequest
    
    Returns:
    
    Result of the CreateLocationSmb operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTask
```
public CreateTaskResult createTask(CreateTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    createTask in interface AWSDataSync
    
    Parameters:
    
    request - CreateTaskRequest
    
    Returns:
    
    Result of the CreateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
```
    Description copied from interface: 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 AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
    
    Specified by:
    
    deleteAgent in interface AWSDataSync
    
    Parameters:
    
    request - DeleteAgentRequest
    
    Returns:
    
    Result of the DeleteAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteLocation
```
public DeleteLocationResult deleteLocation(DeleteLocationRequest request)
```
    Description copied from interface: AWSDataSync
    
    Deletes the configuration of a location used by AWS DataSync.
    
    Specified by:
    
    deleteLocation in interface AWSDataSync
    
    Parameters:
    
    request - DeleteLocation
    
    Returns:
    
    Result of the DeleteLocation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
public DeleteTaskResult deleteTask(DeleteTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    Deletes a task.
    
    Specified by:
    
    deleteTask in interface AWSDataSync
    
    Parameters:
    
    request - DeleteTask
    
    Returns:
    
    Result of the DeleteTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
public DescribeAgentResult describeAgent(DescribeAgentRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    describeAgent in interface AWSDataSync
    
    Parameters:
    
    request - DescribeAgent
    
    Returns:
    
    Result of the DescribeAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfs
```
public DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as the path information about an Amazon EFS location.
    
    Specified by:
    
    describeLocationEfs in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationEfsRequest
    
    Returns:
    
    Result of the DescribeLocationEfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfs
```
public DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as the path information, about a NFS location.
    
    Specified by:
    
    describeLocationNfs in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationNfsRequest
    
    Returns:
    
    Result of the DescribeLocationNfs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3
```
public DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    Specified by:
    
    describeLocationS3 in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationS3Request
    
    Returns:
    
    Result of the DescribeLocationS3 operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLocationSmb
```
public DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata, such as the path and user information about a SMB location.
    
    Specified by:
    
    describeLocationSmb in interface AWSDataSync
    
    Parameters:
    
    request - DescribeLocationSmbRequest
    
    Returns:
    
    Result of the DescribeLocationSmb operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
public DescribeTaskResult describeTask(DescribeTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns metadata about a task.
    
    Specified by:
    
    describeTask in interface AWSDataSync
    
    Parameters:
    
    request - DescribeTaskRequest
    
    Returns:
    
    Result of the DescribeTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
public DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns detailed metadata about a task that is being executed.
    
    Specified by:
    
    describeTaskExecution in interface AWSDataSync
    
    Parameters:
    
    request - DescribeTaskExecutionRequest
    
    Returns:
    
    Result of the DescribeTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
public ListAgentsResult listAgents(ListAgentsRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    listAgents in interface AWSDataSync
    
    Parameters:
    
    request - ListAgentsRequest
    
    Returns:
    
    Result of the ListAgents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listLocations
```
public ListLocationsResult listLocations(ListLocationsRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    listLocations in interface AWSDataSync
    
    Parameters:
    
    request - ListLocationsRequest
    
    Returns:
    
    Result of the ListLocations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns all the tags associated with a specified resources.
    
    Specified by:
    
    listTagsForResource in interface AWSDataSync
    
    Parameters:
    
    request - ListTagsForResourceRequest
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutions
```
public ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns a list of executed tasks.
    
    Specified by:
    
    listTaskExecutions in interface AWSDataSync
    
    Parameters:
    
    request - ListTaskExecutions
    
    Returns:
    
    Result of the ListTaskExecutions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
public ListTasksResult listTasks(ListTasksRequest request)
```
    Description copied from interface: AWSDataSync
    
    Returns a list of all the tasks.
    
    Specified by:
    
    listTasks in interface AWSDataSync
    
    Parameters:
    
    request - ListTasksRequest
    
    Returns:
    
    Result of the ListTasks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startTaskExecution
```
public StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest request)
```
    Description copied from interface: 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 AWS DataSync User Guide.
    
    Specified by:
    
    startTaskExecution in interface AWSDataSync
    
    Parameters:
    
    request - StartTaskExecutionRequest
    
    Returns:
    
    Result of the StartTaskExecution operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSDataSync
    
    Applies a key-value pair to an AWS resource.
    
    Specified by:
    
    tagResource in interface AWSDataSync
    
    Parameters:
    
    request - TagResourceRequest
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSDataSync
    
    Removes a tag from an AWS resource.
    
    Specified by:
    
    untagResource in interface AWSDataSync
    
    Parameters:
    
    request - UntagResourceRequest
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
public UpdateAgentResult updateAgent(UpdateAgentRequest request)
```
    Description copied from interface: AWSDataSync
    
    Updates the name of an agent.
    
    Specified by:
    
    updateAgent in interface AWSDataSync
    
    Parameters:
    
    request - UpdateAgentRequest
    
    Returns:
    
    Result of the UpdateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTask
```
public UpdateTaskResult updateTask(UpdateTaskRequest request)
```
    Description copied from interface: AWSDataSync
    
    Updates the metadata associated with a task.
    
    Specified by:
    
    updateTask in interface AWSDataSync
    
    Parameters:
    
    request - UpdateTaskResponse
    
    Returns:
    
    Result of the UpdateTask operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    shutdown in interface AWSDataSync
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSDataSync
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSDataSync
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAWSDataSync

Field Summary

Fields inherited from interface com.amazonaws.services.datasync.AWSDataSync

Method Summary

Methods inherited from class java.lang.Object

Method Detail

cancelTaskExecution

createAgent

createLocationEfs

createLocationNfs

createLocationS3

createLocationSmb

createTask

deleteAgent

deleteLocation

deleteTask

describeAgent

describeLocationEfs

describeLocationNfs

describeLocationS3

describeLocationSmb

describeTask

describeTaskExecution

listAgents

listLocations

listTagsForResource

listTaskExecutions

listTasks

startTaskExecution

tagResource

untagResource

updateAgent

updateTask

shutdown

getCachedResponseMetadata