DataSyncClient (AWS SDK for Java

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient
```
@Generated(value="software.amazon.awssdk:codegen")
public interface DataSyncClient
extends SdkClient
```
Service client for accessing DataSync. This can be created using the static builder() method. AWS DataSync
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.

Field Summary

Fields
Modifier and Type Field and Description

static String SERVICE_NAME

Fields
Modifier and Type	Field and Description
`static String`	`SERVICE_NAME`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static DataSyncClientBuilder`	`builder()` Create a builder that can be used to configure and create a `DataSyncClient`.
`default CancelTaskExecutionResponse`	`cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)` Cancels execution of a task.
`default CancelTaskExecutionResponse`	`cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)` Cancels execution of a task.
`static DataSyncClient`	`create()` Create a `DataSyncClient` with the region loaded from the `DefaultAwsRegionProviderChain` and credentials loaded from the `DefaultCredentialsProvider`.
`default CreateAgentResponse`	`createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)` Activates an AWS DataSync agent that you have deployed on your host.
`default CreateAgentResponse`	`createAgent(CreateAgentRequest createAgentRequest)` Activates an AWS DataSync agent that you have deployed on your host.
`default CreateLocationEfsResponse`	`createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)` Creates an endpoint for an Amazon EFS file system.
`default CreateLocationEfsResponse`	`createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)` Creates an endpoint for an Amazon EFS file system.
`default CreateLocationNfsResponse`	`createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)` Creates an endpoint for a Network File System (NFS) file system.
`default CreateLocationNfsResponse`	`createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)` Creates an endpoint for a Network File System (NFS) file system.
`default CreateLocationS3Response`	`createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)` Creates an endpoint for an Amazon S3 bucket.
`default CreateLocationS3Response`	`createLocationS3(CreateLocationS3Request createLocationS3Request)` Creates an endpoint for an Amazon S3 bucket.
`default CreateTaskResponse`	`createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)` Creates a task.
`default CreateTaskResponse`	`createTask(CreateTaskRequest createTaskRequest)` Creates a task.
`default DeleteAgentResponse`	`deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)` Deletes an agent.
`default DeleteAgentResponse`	`deleteAgent(DeleteAgentRequest deleteAgentRequest)` Deletes an agent.
`default DeleteLocationResponse`	`deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)` Deletes the configuration of a location used by AWS DataSync.
`default DeleteLocationResponse`	`deleteLocation(DeleteLocationRequest deleteLocationRequest)` Deletes the configuration of a location used by AWS DataSync.
`default DeleteTaskResponse`	`deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)` Deletes a task.
`default DeleteTaskResponse`	`deleteTask(DeleteTaskRequest deleteTaskRequest)` Deletes a task.
`default DescribeAgentResponse`	`describeAgent(Consumer<DescribeAgentRequest.Builder> 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.
`default DescribeAgentResponse`	`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.
`default DescribeLocationEfsResponse`	`describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)` Returns metadata, such as the path information about an Amazon EFS location.
`default DescribeLocationEfsResponse`	`describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)` Returns metadata, such as the path information about an Amazon EFS location.
`default DescribeLocationNfsResponse`	`describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)` Returns metadata, such as the path information, about a NFS location.
`default DescribeLocationNfsResponse`	`describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)` Returns metadata, such as the path information, about a NFS location.
`default DescribeLocationS3Response`	`describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)` Returns metadata, such as bucket name, about an Amazon S3 bucket location.
`default DescribeLocationS3Response`	`describeLocationS3(DescribeLocationS3Request describeLocationS3Request)` Returns metadata, such as bucket name, about an Amazon S3 bucket location.
`default DescribeTaskResponse`	`describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)` Returns metadata about a task.
`default DescribeTaskResponse`	`describeTask(DescribeTaskRequest describeTaskRequest)` Returns metadata about a task.
`default DescribeTaskExecutionResponse`	`describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)` Returns detailed metadata about a task that is being executed.
`default DescribeTaskExecutionResponse`	`describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)` Returns detailed metadata about a task that is being executed.
`default ListAgentsResponse`	`listAgents()` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`default ListAgentsResponse`	`listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`default ListAgentsResponse`	`listAgents(ListAgentsRequest listAgentsRequest)` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`default ListAgentsIterable`	`listAgentsPaginator()` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`default ListAgentsIterable`	`listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`default ListAgentsIterable`	`listAgentsPaginator(ListAgentsRequest listAgentsRequest)` Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
`default ListLocationsResponse`	`listLocations()` Returns a lists of source and destination locations.
`default ListLocationsResponse`	`listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)` Returns a lists of source and destination locations.
`default ListLocationsResponse`	`listLocations(ListLocationsRequest listLocationsRequest)` Returns a lists of source and destination locations.
`default ListLocationsIterable`	`listLocationsPaginator()` Returns a lists of source and destination locations.
`default ListLocationsIterable`	`listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)` Returns a lists of source and destination locations.
`default ListLocationsIterable`	`listLocationsPaginator(ListLocationsRequest listLocationsRequest)` Returns a lists of source and destination locations.
`default ListTagsForResourceResponse`	`listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)` Returns all the tags associated with a specified resources.
`default ListTagsForResourceResponse`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns all the tags associated with a specified resources.
`default ListTagsForResourceIterable`	`listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)` Returns all the tags associated with a specified resources.
`default ListTagsForResourceIterable`	`listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)` Returns all the tags associated with a specified resources.
`default ListTaskExecutionsResponse`	`listTaskExecutions()` Returns a list of executed tasks.
`default ListTaskExecutionsResponse`	`listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)` Returns a list of executed tasks.
`default ListTaskExecutionsResponse`	`listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)` Returns a list of executed tasks.
`default ListTaskExecutionsIterable`	`listTaskExecutionsPaginator()` Returns a list of executed tasks.
`default ListTaskExecutionsIterable`	`listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)` Returns a list of executed tasks.
`default ListTaskExecutionsIterable`	`listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)` Returns a list of executed tasks.
`default ListTasksResponse`	`listTasks()` Returns a list of all the tasks.
`default ListTasksResponse`	`listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)` Returns a list of all the tasks.
`default ListTasksResponse`	`listTasks(ListTasksRequest listTasksRequest)` Returns a list of all the tasks.
`default ListTasksIterable`	`listTasksPaginator()` Returns a list of all the tasks.
`default ListTasksIterable`	`listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)` Returns a list of all the tasks.
`default ListTasksIterable`	`listTasksPaginator(ListTasksRequest listTasksRequest)` Returns a list of all the tasks.
`static ServiceMetadata`	`serviceMetadata()`
`default StartTaskExecutionResponse`	`startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)` Starts a specific invocation of a task.
`default StartTaskExecutionResponse`	`startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)` Starts a specific invocation of a task.
`default TagResourceResponse`	`tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)` Applies a key-value pair to an AWS resource.
`default TagResourceResponse`	`tagResource(TagResourceRequest tagResourceRequest)` Applies a key-value pair to an AWS resource.
`default UntagResourceResponse`	`untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)` Removes a tag from an AWS resource.
`default UntagResourceResponse`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from an AWS resource.
`default UpdateAgentResponse`	`updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)` Updates the name of an agent.
`default UpdateAgentResponse`	`updateAgent(UpdateAgentRequest updateAgentRequest)` Updates the name of an agent.
`default UpdateTaskResponse`	`updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)` Updates the metadata associated with a task.
`default UpdateTaskResponse`	`updateTask(UpdateTaskRequest updateTaskRequest)` Updates the metadata associated with a task.

Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
static DataSyncClient create()
```
    Create a DataSyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
  - builder
```
static DataSyncClientBuilder builder()
```
    Create a builder that can be used to configure and create a DataSyncClient.
  - cancelTaskExecution
```
default CancelTaskExecutionResponse cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    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.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - cancelTaskExecution
```
default CancelTaskExecutionResponse cancelTaskExecution(Consumer<CancelTaskExecutionRequest.Builder> cancelTaskExecutionRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    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.
    
    This is a convenience which creates an instance of the CancelTaskExecutionRequest.Builder avoiding the need to create one manually via CancelTaskExecutionRequest.builder()
    
    Parameters:
    
    cancelTaskExecutionRequest - A Consumer that will call methods on CancelTaskExecutionRequest.Builder to create a request. CancelTaskExecutionRequest
    
    Returns:
    
    Result of the CancelTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
default CreateAgentResponse createAgent(CreateAgentRequest createAgentRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    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 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. For more information, see Activating a Sync Agent in the AWS DataSync User Guide.
    
    Agents are automatically updated by AWS 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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
default CreateAgentResponse createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    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 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. For more information, see Activating a Sync Agent in the AWS DataSync User Guide.
    
    Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
    
    This is a convenience which creates an instance of the CreateAgentRequest.Builder avoiding the need to create one manually via CreateAgentRequest.builder()
    
    Parameters:
    
    createAgentRequest - A Consumer that will call methods on CreateAgentRequest.Builder to create a request. CreateAgentRequest
    
    Returns:
    
    Result of the CreateAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createLocationEfs
```
default CreateLocationEfsResponse createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
                                             throws InvalidRequestException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    DataSyncException
```
    Creates an endpoint for an Amazon EFS file system.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createLocationEfs
```
default CreateLocationEfsResponse createLocationEfs(Consumer<CreateLocationEfsRequest.Builder> createLocationEfsRequest)
                                             throws InvalidRequestException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    DataSyncException
```
    Creates an endpoint for an Amazon EFS file system.
    
    This is a convenience which creates an instance of the CreateLocationEfsRequest.Builder avoiding the need to create one manually via CreateLocationEfsRequest.builder()
    
    Parameters:
    
    createLocationEfsRequest - A Consumer that will call methods on CreateLocationEfsRequest.Builder to create a request. CreateLocationEfsRequest
    
    Returns:
    
    Result of the CreateLocationEfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createLocationNfs
```
default CreateLocationNfsResponse createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
                                             throws InvalidRequestException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    DataSyncException
```
    Creates an endpoint for a Network File System (NFS) file system.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createLocationNfs
```
default CreateLocationNfsResponse createLocationNfs(Consumer<CreateLocationNfsRequest.Builder> createLocationNfsRequest)
                                             throws InvalidRequestException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    DataSyncException
```
    Creates an endpoint for a Network File System (NFS) file system.
    
    This is a convenience which creates an instance of the CreateLocationNfsRequest.Builder avoiding the need to create one manually via CreateLocationNfsRequest.builder()
    
    Parameters:
    
    createLocationNfsRequest - A Consumer that will call methods on CreateLocationNfsRequest.Builder to create a request. CreateLocationNfsRequest
    
    Returns:
    
    Result of the CreateLocationNfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createLocationS3
```
default CreateLocationS3Response createLocationS3(CreateLocationS3Request createLocationS3Request)
                                           throws InvalidRequestException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  DataSyncException
```
    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.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createLocationS3
```
default CreateLocationS3Response createLocationS3(Consumer<CreateLocationS3Request.Builder> createLocationS3Request)
                                           throws InvalidRequestException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  DataSyncException
```
    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.
    
    This is a convenience which creates an instance of the CreateLocationS3Request.Builder avoiding the need to create one manually via CreateLocationS3Request.builder()
    
    Parameters:
    
    createLocationS3Request - A Consumer that will call methods on CreateLocationS3Request.Builder to create a request. CreateLocationS3Request
    
    Returns:
    
    Result of the CreateLocationS3 operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createTask
```
default CreateTaskResponse createTask(CreateTaskRequest createTaskRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    Creates a task. A task is a set of two locations (source and destination) and a set of default OverrideOptions that you use to control the behavior of a task. If you don't specify default values for Options when you create a task, AWS DataSync populates them with safe service defaults.
    
    When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every 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.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - createTask
```
default CreateTaskResponse createTask(Consumer<CreateTaskRequest.Builder> createTaskRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    Creates a task. A task is a set of two locations (source and destination) and a set of default OverrideOptions that you use to control the behavior of a task. If you don't specify default values for Options when you create a task, AWS DataSync populates them with safe service defaults.
    
    When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every 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.
    
    This is a convenience which creates an instance of the CreateTaskRequest.Builder avoiding the need to create one manually via CreateTaskRequest.builder()
    
    Parameters:
    
    createTaskRequest - A Consumer that will call methods on CreateTaskRequest.Builder to create a request. CreateTaskRequest
    
    Returns:
    
    Result of the CreateTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
default DeleteAgentResponse deleteAgent(DeleteAgentRequest deleteAgentRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    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.
    
    After you delete an agent, you can't reactivate it and you longer pay software charges for it.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
default DeleteAgentResponse deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    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.
    
    After you delete an agent, you can't reactivate it and you longer pay software charges for it.
    
    This is a convenience which creates an instance of the DeleteAgentRequest.Builder avoiding the need to create one manually via DeleteAgentRequest.builder()
    
    Parameters:
    
    deleteAgentRequest - A Consumer that will call methods on DeleteAgentRequest.Builder to create a request. DeleteAgentRequest
    
    Returns:
    
    Result of the DeleteAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteLocation
```
default DeleteLocationResponse deleteLocation(DeleteLocationRequest deleteLocationRequest)
                                       throws InvalidRequestException,
                                              AwsServiceException,
                                              SdkClientException,
                                              DataSyncException
```
    Deletes the configuration of a location used by AWS 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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteLocation
```
default DeleteLocationResponse deleteLocation(Consumer<DeleteLocationRequest.Builder> deleteLocationRequest)
                                       throws InvalidRequestException,
                                              AwsServiceException,
                                              SdkClientException,
                                              DataSyncException
```
    Deletes the configuration of a location used by AWS DataSync.
    
    This is a convenience which creates an instance of the DeleteLocationRequest.Builder avoiding the need to create one manually via DeleteLocationRequest.builder()
    
    Parameters:
    
    deleteLocationRequest - A Consumer that will call methods on DeleteLocationRequest.Builder to create a request. DeleteLocation
    
    Returns:
    
    Result of the DeleteLocation operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
default DeleteTaskResponse deleteTask(DeleteTaskRequest deleteTaskRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - deleteTask
```
default DeleteTaskResponse deleteTask(Consumer<DeleteTaskRequest.Builder> deleteTaskRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    Deletes a task.
    
    This is a convenience which creates an instance of the DeleteTaskRequest.Builder avoiding the need to create one manually via DeleteTaskRequest.builder()
    
    Parameters:
    
    deleteTaskRequest - A Consumer that will call methods on DeleteTaskRequest.Builder to create a request. DeleteTask
    
    Returns:
    
    Result of the DeleteTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
default DescribeAgentResponse describeAgent(DescribeAgentRequest describeAgentRequest)
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeAgent
```
default DescribeAgentResponse describeAgent(Consumer<DescribeAgentRequest.Builder> describeAgentRequest)
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    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.
    
    This is a convenience which creates an instance of the DescribeAgentRequest.Builder avoiding the need to create one manually via DescribeAgentRequest.builder()
    
    Parameters:
    
    describeAgentRequest - A Consumer that will call methods on DescribeAgentRequest.Builder to create a request. DescribeAgent
    
    Returns:
    
    Result of the DescribeAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfs
```
default DescribeLocationEfsResponse describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    Returns metadata, such as the path information about an Amazon EFS location.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeLocationEfs
```
default DescribeLocationEfsResponse describeLocationEfs(Consumer<DescribeLocationEfsRequest.Builder> describeLocationEfsRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    Returns metadata, such as the path information about an Amazon EFS location.
    
    This is a convenience which creates an instance of the DescribeLocationEfsRequest.Builder avoiding the need to create one manually via DescribeLocationEfsRequest.builder()
    
    Parameters:
    
    describeLocationEfsRequest - A Consumer that will call methods on DescribeLocationEfsRequest.Builder to create a request. DescribeLocationEfsRequest
    
    Returns:
    
    Result of the DescribeLocationEfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfs
```
default DescribeLocationNfsResponse describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    Returns metadata, such as the path information, about a 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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeLocationNfs
```
default DescribeLocationNfsResponse describeLocationNfs(Consumer<DescribeLocationNfsRequest.Builder> describeLocationNfsRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    Returns metadata, such as the path information, about a NFS location.
    
    This is a convenience which creates an instance of the DescribeLocationNfsRequest.Builder avoiding the need to create one manually via DescribeLocationNfsRequest.builder()
    
    Parameters:
    
    describeLocationNfsRequest - A Consumer that will call methods on DescribeLocationNfsRequest.Builder to create a request. DescribeLocationNfsRequest
    
    Returns:
    
    Result of the DescribeLocationNfs operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3
```
default DescribeLocationS3Response describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeLocationS3
```
default DescribeLocationS3Response describeLocationS3(Consumer<DescribeLocationS3Request.Builder> describeLocationS3Request)
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    Returns metadata, such as bucket name, about an Amazon S3 bucket location.
    
    This is a convenience which creates an instance of the DescribeLocationS3Request.Builder avoiding the need to create one manually via DescribeLocationS3Request.builder()
    
    Parameters:
    
    describeLocationS3Request - A Consumer that will call methods on DescribeLocationS3Request.Builder to create a request. DescribeLocationS3Request
    
    Returns:
    
    Result of the DescribeLocationS3 operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
default DescribeTaskResponse describeTask(DescribeTaskRequest describeTaskRequest)
                                   throws InvalidRequestException,
                                          AwsServiceException,
                                          SdkClientException,
                                          DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeTask
```
default DescribeTaskResponse describeTask(Consumer<DescribeTaskRequest.Builder> describeTaskRequest)
                                   throws InvalidRequestException,
                                          AwsServiceException,
                                          SdkClientException,
                                          DataSyncException
```
    Returns metadata about a task.
    
    This is a convenience which creates an instance of the DescribeTaskRequest.Builder avoiding the need to create one manually via DescribeTaskRequest.builder()
    
    Parameters:
    
    describeTaskRequest - A Consumer that will call methods on DescribeTaskRequest.Builder to create a request. DescribeTaskRequest
    
    Returns:
    
    Result of the DescribeTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
default DescribeTaskExecutionResponse describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
                                                     throws InvalidRequestException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - describeTaskExecution
```
default DescribeTaskExecutionResponse describeTaskExecution(Consumer<DescribeTaskExecutionRequest.Builder> describeTaskExecutionRequest)
                                                     throws InvalidRequestException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            DataSyncException
```
    Returns detailed metadata about a task that is being executed.
    
    This is a convenience which creates an instance of the DescribeTaskExecutionRequest.Builder avoiding the need to create one manually via DescribeTaskExecutionRequest.builder()
    
    Parameters:
    
    describeTaskExecutionRequest - A Consumer that will call methods on DescribeTaskExecutionRequest.Builder to create a request. DescribeTaskExecutionRequest
    
    Returns:
    
    Result of the DescribeTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
default ListAgentsResponse listAgents()
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    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.
    
    Returns:
    
    Result of the ListAgents operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listAgents(ListAgentsRequest), AWS API Documentation
  - listAgents
```
default ListAgentsResponse listAgents(ListAgentsRequest listAgentsRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    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.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
default ListAgentsResponse listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    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.
    
    This is a convenience which creates an instance of the ListAgentsRequest.Builder avoiding the need to create one manually via ListAgentsRequest.builder()
    
    Parameters:
    
    listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request. ListAgentsRequest
    
    Returns:
    
    Result of the ListAgents operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listAgentsPaginator
```
default ListAgentsIterable listAgentsPaginator()
                                        throws InvalidRequestException,
                                               AwsServiceException,
                                               SdkClientException,
                                               DataSyncException
```
    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.
    
    This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListAgentsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation.
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listAgentsPaginator(ListAgentsRequest), AWS API Documentation
  - listAgentsPaginator
```
default ListAgentsIterable listAgentsPaginator(ListAgentsRequest listAgentsRequest)
                                        throws InvalidRequestException,
                                               AwsServiceException,
                                               SdkClientException,
                                               DataSyncException
```
    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.
    
    This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListAgentsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation.
    Parameters:
    
    listAgentsRequest - ListAgentsRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listAgentsPaginator
```
default ListAgentsIterable listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)
                                        throws InvalidRequestException,
                                               AwsServiceException,
                                               SdkClientException,
                                               DataSyncException
```
    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.
    
    This is a variant of listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListAgentsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listAgents(software.amazon.awssdk.services.datasync.model.ListAgentsRequest) operation.
    
    This is a convenience which creates an instance of the ListAgentsRequest.Builder avoiding the need to create one manually via ListAgentsRequest.builder()
    Parameters:
    
    listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request. ListAgentsRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listLocations
```
default ListLocationsResponse listLocations()
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    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.
    
    Returns:
    
    Result of the ListLocations operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listLocations(ListLocationsRequest), AWS API Documentation
  - listLocations
```
default ListLocationsResponse listLocations(ListLocationsRequest listLocationsRequest)
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    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.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listLocations
```
default ListLocationsResponse listLocations(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    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.
    
    This is a convenience which creates an instance of the ListLocationsRequest.Builder avoiding the need to create one manually via ListLocationsRequest.builder()
    
    Parameters:
    
    listLocationsRequest - A Consumer that will call methods on ListLocationsRequest.Builder to create a request. ListLocationsRequest
    
    Returns:
    
    Result of the ListLocations operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listLocationsPaginator
```
default ListLocationsIterable listLocationsPaginator()
                                              throws InvalidRequestException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     DataSyncException
```
    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.
    
    This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListLocationsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation.
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listLocationsPaginator(ListLocationsRequest), AWS API Documentation
  - listLocationsPaginator
```
default ListLocationsIterable listLocationsPaginator(ListLocationsRequest listLocationsRequest)
                                              throws InvalidRequestException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     DataSyncException
```
    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.
    
    This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListLocationsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation.
    Parameters:
    
    listLocationsRequest - ListLocationsRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listLocationsPaginator
```
default ListLocationsIterable listLocationsPaginator(Consumer<ListLocationsRequest.Builder> listLocationsRequest)
                                              throws InvalidRequestException,
                                                     AwsServiceException,
                                                     SdkClientException,
                                                     DataSyncException
```
    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.
    
    This is a variant of listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListLocationsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListLocationsIterable responses = client.listLocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listLocations(software.amazon.awssdk.services.datasync.model.ListLocationsRequest) operation.
    
    This is a convenience which creates an instance of the ListLocationsRequest.Builder avoiding the need to create one manually via ListLocationsRequest.builder()
    Parameters:
    
    listLocationsRequest - A Consumer that will call methods on ListLocationsRequest.Builder to create a request. ListLocationsRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    Returns all the tags associated with a specified resources.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        DataSyncException
```
    Returns all the tags associated with a specified resources.
    
    This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()
    
    Parameters:
    
    listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. ListTagsForResourceRequest
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourcePaginator
```
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
                                                          throws InvalidRequestException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 DataSyncException
```
    Returns all the tags associated with a specified resources.
    
    This is a variant of listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client
             .listTagsForResourcePaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest) operation.
    Parameters:
    
    listTagsForResourceRequest - ListTagsForResourceRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTagsForResourcePaginator
```
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                          throws InvalidRequestException,
                                                                 AwsServiceException,
                                                                 SdkClientException,
                                                                 DataSyncException
```
    Returns all the tags associated with a specified resources.
    
    This is a variant of listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client
             .listTagsForResourcePaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTagsForResourceResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.datasync.model.ListTagsForResourceRequest) operation.
    
    This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()
    Parameters:
    
    listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. ListTagsForResourceRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutions
```
default ListTaskExecutionsResponse listTaskExecutions()
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    Returns a list of executed tasks.
    
    Returns:
    
    Result of the ListTaskExecutions operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listTaskExecutions(ListTaskExecutionsRequest), AWS API Documentation
  - listTaskExecutions
```
default ListTaskExecutionsResponse listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutions
```
default ListTaskExecutionsResponse listTaskExecutions(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    Returns a list of executed tasks.
    
    This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder avoiding the need to create one manually via ListTaskExecutionsRequest.builder()
    
    Parameters:
    
    listTaskExecutionsRequest - A Consumer that will call methods on ListTaskExecutionsRequest.Builder to create a request. ListTaskExecutions
    
    Returns:
    
    Result of the ListTaskExecutions operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutionsPaginator
```
default ListTaskExecutionsIterable listTaskExecutionsPaginator()
                                                        throws InvalidRequestException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               DataSyncException
```
    Returns a list of executed tasks.
    
    This is a variant of listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client
             .listTaskExecutionsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listTaskExecutionsPaginator(ListTaskExecutionsRequest), AWS API Documentation
  - listTaskExecutionsPaginator
```
default ListTaskExecutionsIterable listTaskExecutionsPaginator(ListTaskExecutionsRequest listTaskExecutionsRequest)
                                                        throws InvalidRequestException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               DataSyncException
```
    Returns a list of executed tasks.
    
    This is a variant of listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client
             .listTaskExecutionsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
    Parameters:
    
    listTaskExecutionsRequest - ListTaskExecutions
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTaskExecutionsPaginator
```
default ListTaskExecutionsIterable listTaskExecutionsPaginator(Consumer<ListTaskExecutionsRequest.Builder> listTaskExecutionsRequest)
                                                        throws InvalidRequestException,
                                                               AwsServiceException,
                                                               SdkClientException,
                                                               DataSyncException
```
    Returns a list of executed tasks.
    
    This is a variant of listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client
             .listTaskExecutionsPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTaskExecutionsResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTaskExecutionsIterable responses = client.listTaskExecutionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTaskExecutions(software.amazon.awssdk.services.datasync.model.ListTaskExecutionsRequest) operation.
    
    This is a convenience which creates an instance of the ListTaskExecutionsRequest.Builder avoiding the need to create one manually via ListTaskExecutionsRequest.builder()
    Parameters:
    
    listTaskExecutionsRequest - A Consumer that will call methods on ListTaskExecutionsRequest.Builder to create a request. ListTaskExecutions
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
default ListTasksResponse listTasks()
                             throws InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    DataSyncException
```
    Returns a list of all the tasks.
    
    Returns:
    
    Result of the ListTasks operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listTasks(ListTasksRequest), AWS API Documentation
  - listTasks
```
default ListTasksResponse listTasks(ListTasksRequest listTasksRequest)
                             throws InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    DataSyncException
```
    Returns a list of all the tasks.
    
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTasks
```
default ListTasksResponse listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
                             throws InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    DataSyncException
```
    Returns a list of all the tasks.
    
    This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to create one manually via ListTasksRequest.builder()
    
    Parameters:
    
    listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request. ListTasksRequest
    
    Returns:
    
    Result of the ListTasks operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTasksPaginator
```
default ListTasksIterable listTasksPaginator()
                                      throws InvalidRequestException,
                                             AwsServiceException,
                                             SdkClientException,
                                             DataSyncException
```
    Returns a list of all the tasks.
    
    This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTasksResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation.
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    listTasksPaginator(ListTasksRequest), AWS API Documentation
  - listTasksPaginator
```
default ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest)
                                      throws InvalidRequestException,
                                             AwsServiceException,
                                             SdkClientException,
                                             DataSyncException
```
    Returns a list of all the tasks.
    
    This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTasksResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation.
    Parameters:
    
    listTasksRequest - ListTasksRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - listTasksPaginator
```
default ListTasksIterable listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
                                      throws InvalidRequestException,
                                             AwsServiceException,
                                             SdkClientException,
                                             DataSyncException
```
    Returns a list of all the tasks.
    
    This is a variant of listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.
    
    When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
    
    The following are few ways to iterate through the response pages:
    1) Using a Stream
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
 responses.stream().forEach(....);
 
 
```
    2) Using For loop
```
 {
     @code
     software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
     for (software.amazon.awssdk.services.datasync.model.ListTasksResponse response : responses) {
         // do something;
     }
 }
 
```
    3) Use iterator directly
```
 
 software.amazon.awssdk.services.datasync.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 
```
    Note: If you prefer to have control on service calls, use the listTasks(software.amazon.awssdk.services.datasync.model.ListTasksRequest) operation.
    
    This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to create one manually via ListTasksRequest.builder()
    Parameters:
    
    listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request. ListTasksRequest
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - startTaskExecution
```
default StartTaskExecutionResponse startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    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 Task Execution in Components and Terminology in the AWS 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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - startTaskExecution
```
default StartTaskExecutionResponse startTaskExecution(Consumer<StartTaskExecutionRequest.Builder> startTaskExecutionRequest)
                                               throws InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      DataSyncException
```
    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 Task Execution in Components and Terminology in the AWS DataSync User Guide.
    
    This is a convenience which creates an instance of the StartTaskExecutionRequest.Builder avoiding the need to create one manually via StartTaskExecutionRequest.builder()
    
    Parameters:
    
    startTaskExecutionRequest - A Consumer that will call methods on StartTaskExecutionRequest.Builder to create a request. StartTaskExecutionRequest
    
    Returns:
    
    Result of the StartTaskExecution operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    Applies a key-value pair to an AWS 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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    Applies a key-value pair to an AWS resource.
    
    This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()
    
    Parameters:
    
    tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. TagResourceRequest
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    Removes a tag from an AWS 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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InvalidRequestException,
                                            AwsServiceException,
                                            SdkClientException,
                                            DataSyncException
```
    Removes a tag from an AWS resource.
    
    This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()
    
    Parameters:
    
    untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. UntagResourceRequest
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
default UpdateAgentResponse updateAgent(UpdateAgentRequest updateAgentRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
default UpdateAgentResponse updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)
                                 throws InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        DataSyncException
```
    Updates the name of an agent.
    
    This is a convenience which creates an instance of the UpdateAgentRequest.Builder avoiding the need to create one manually via UpdateAgentRequest.builder()
    
    Parameters:
    
    updateAgentRequest - A Consumer that will call methods on UpdateAgentRequest.Builder to create a request. UpdateAgentRequest
    
    Returns:
    
    Result of the UpdateAgent operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - updateTask
```
default UpdateTaskResponse updateTask(UpdateTaskRequest updateTaskRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    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.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - updateTask
```
default UpdateTaskResponse updateTask(Consumer<UpdateTaskRequest.Builder> updateTaskRequest)
                               throws InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      DataSyncException
```
    Updates the metadata associated with a task.
    
    This is a convenience which creates an instance of the UpdateTaskRequest.Builder avoiding the need to create one manually via UpdateTaskRequest.builder()
    
    Parameters:
    
    updateTaskRequest - A Consumer that will call methods on UpdateTaskRequest.Builder to create a request. UpdateTaskResponse
    
    Returns:
    
    Result of the UpdateTask operation returned by the service.
    
    Throws:
    
    InvalidRequestException - This exception is thrown when the client submits a malformed request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    DataSyncException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
    
    See Also:
    
    AWS API Documentation
  - serviceMetadata
```
static ServiceMetadata serviceMetadata()
```

Interface DataSyncClient

Field Summary

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkClient

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

Field Detail

SERVICE_NAME

Method Detail

create

builder

cancelTaskExecution

cancelTaskExecution

createAgent

createAgent

createLocationEfs

createLocationEfs

createLocationNfs

createLocationNfs

createLocationS3

createLocationS3

createTask

createTask

deleteAgent

deleteAgent

deleteLocation

deleteLocation

deleteTask

deleteTask

describeAgent

describeAgent

describeLocationEfs

describeLocationEfs

describeLocationNfs

describeLocationNfs

describeLocationS3

describeLocationS3

describeTask

describeTask

describeTaskExecution

describeTaskExecution

listAgents

listAgents

listAgents

listAgentsPaginator

listAgentsPaginator

listAgentsPaginator

listLocations

listLocations

listLocations

listLocationsPaginator

listLocationsPaginator

listLocationsPaginator

listTagsForResource

listTagsForResource

listTagsForResourcePaginator

listTagsForResourcePaginator

listTaskExecutions

listTaskExecutions

listTaskExecutions

listTaskExecutionsPaginator

listTaskExecutionsPaginator

listTaskExecutionsPaginator

listTasks

listTasks

listTasks

listTasksPaginator

listTasksPaginator

listTasksPaginator

startTaskExecution

startTaskExecution

tagResource

tagResource

untagResource

untagResource

updateAgent

updateAgent

updateTask

updateTask

serviceMetadata