com.amazonaws.services.datasync.AWSDataSync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datasync Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.datasync;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.datasync.model.*;
/**
* Interface for accessing DataSync.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.datasync.AbstractAWSDataSync} instead.
*
*
* DataSync
*
* 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 DataSync contains documentation for a programming interface that you can use to
* manage DataSync.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSDataSync {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "datasync";
/**
*
* Cancels execution of a task.
*
*
* When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that
* are transferred to the destination might be incomplete or inconsistent with the source files. However, if you
* start a new task execution on the same task and you allow the task execution to complete, file content on the
* destination is complete and consistent. This applies to other unexpected failures that interrupt a task
* execution. In all of these cases, DataSync successfully complete the transfer when you start the next task
* execution.
*
*
* @param cancelTaskExecutionRequest
* CancelTaskExecutionRequest
* @return Result of the CancelTaskExecution operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CancelTaskExecution
* @see AWS
* API Documentation
*/
CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest);
/**
*
* Activates an DataSync agent that you have deployed on your host. The activation process associates your agent
* with your account. In the activation process, you specify information such as the Amazon Web Services Region that
* you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target
* locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.
*
*
* You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you
* can run tasks without going over the public internet.
*
*
* You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status
* AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents
* must be AVAILABLE for the task to run.
*
*
* Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures
* minimal interruption to your tasks.
*
*
*
* @param createAgentRequest
* CreateAgentRequest
* @return Result of the CreateAgent operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateAgent
* @see AWS API
* Documentation
*/
CreateAgentResult createAgent(CreateAgentRequest createAgentRequest);
/**
*
* Creates an endpoint for an Amazon EFS file system.
*
*
* @param createLocationEfsRequest
* CreateLocationEfsRequest
* @return Result of the CreateLocationEfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationEfs
* @see AWS API
* Documentation
*/
CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest);
/**
*
* Creates an endpoint for an Amazon FSx for Lustre file system.
*
*
* @param createLocationFsxLustreRequest
* @return Result of the CreateLocationFsxLustre operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationFsxLustre
* @see AWS API Documentation
*/
CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest);
/**
*
* Creates an endpoint for an Amazon FSx for Windows File Server file system.
*
*
* @param createLocationFsxWindowsRequest
* @return Result of the CreateLocationFsxWindows operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationFsxWindows
* @see AWS API Documentation
*/
CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest);
/**
*
* Creates an endpoint for a Hadoop Distributed File System (HDFS).
*
*
* @param createLocationHdfsRequest
* @return Result of the CreateLocationHdfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationHdfs
* @see AWS
* API Documentation
*/
CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest);
/**
*
* Defines a file system on a Network File System (NFS) server that can be read from or written to.
*
*
* @param createLocationNfsRequest
* CreateLocationNfsRequest
* @return Result of the CreateLocationNfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationNfs
* @see AWS API
* Documentation
*/
CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest);
/**
*
* Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object
* storage locations, see Creating a location for
* object storage.
*
*
* @param createLocationObjectStorageRequest
* CreateLocationObjectStorageRequest
* @return Result of the CreateLocationObjectStorage operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationObjectStorage
* @see AWS API Documentation
*/
CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest);
/**
*
* Creates an endpoint for an Amazon S3 bucket.
*
*
* For more information, see Create an Amazon S3 location in the DataSync User Guide.
*
*
* @param createLocationS3Request
* CreateLocationS3Request
* @return Result of the CreateLocationS3 operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationS3
* @see AWS API
* Documentation
*/
CreateLocationS3Result createLocationS3(CreateLocationS3Request createLocationS3Request);
/**
*
* Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
*
*
* @param createLocationSmbRequest
* CreateLocationSmbRequest
* @return Result of the CreateLocationSmb operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateLocationSmb
* @see AWS API
* Documentation
*/
CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest);
/**
*
* Creates a task.
*
*
* A task includes a source location and a destination location, and a configuration that specifies how data is
* transferred. A task always transfers data from the source location to the destination location. The configuration
* specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data
* transfer.
*
*
* When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services
* Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The
* other location must be specified in a different Region.
*
*
* You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web
* Services GovCloud (US) Regions.
*
*
*
* When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer
* between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more
* information, see Data Transfer pricing.
*
*
*
* @param createTaskRequest
* CreateTaskRequest
* @return Result of the CreateTask operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.CreateTask
* @see AWS API
* Documentation
*/
CreateTaskResult createTask(CreateTaskRequest createTaskRequest);
/**
*
* Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your
* request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete
* the agent virtual machine (VM) from your on-premises environment.
*
*
* @param deleteAgentRequest
* DeleteAgentRequest
* @return Result of the DeleteAgent operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DeleteAgent
* @see AWS API
* Documentation
*/
DeleteAgentResult deleteAgent(DeleteAgentRequest deleteAgentRequest);
/**
*
* Deletes the configuration of a location used by DataSync.
*
*
* @param deleteLocationRequest
* DeleteLocation
* @return Result of the DeleteLocation operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DeleteLocation
* @see AWS API
* Documentation
*/
DeleteLocationResult deleteLocation(DeleteLocationRequest deleteLocationRequest);
/**
*
* Deletes a task.
*
*
* @param deleteTaskRequest
* DeleteTask
* @return Result of the DeleteTask operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DeleteTask
* @see AWS API
* Documentation
*/
DeleteTaskResult deleteTask(DeleteTaskRequest deleteTaskRequest);
/**
*
* 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.
*
*
* @param describeAgentRequest
* DescribeAgent
* @return Result of the DescribeAgent operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeAgent
* @see AWS API
* Documentation
*/
DescribeAgentResult describeAgent(DescribeAgentRequest describeAgentRequest);
/**
*
* Returns metadata, such as the path information about an Amazon EFS location.
*
*
* @param describeLocationEfsRequest
* DescribeLocationEfsRequest
* @return Result of the DescribeLocationEfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationEfs
* @see AWS
* API Documentation
*/
DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest);
/**
*
* Returns metadata, such as the path information about an Amazon FSx for Lustre location.
*
*
* @param describeLocationFsxLustreRequest
* @return Result of the DescribeLocationFsxLustre operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationFsxLustre
* @see AWS API Documentation
*/
DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest);
/**
*
* Returns metadata, such as the path information about an Amazon FSx for Windows File Server location.
*
*
* @param describeLocationFsxWindowsRequest
* @return Result of the DescribeLocationFsxWindows operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationFsxWindows
* @see AWS API Documentation
*/
DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest);
/**
*
* Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
* location.
*
*
* @param describeLocationHdfsRequest
* @return Result of the DescribeLocationHdfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationHdfs
* @see AWS
* API Documentation
*/
DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest);
/**
*
* Returns metadata, such as the path information, about an NFS location.
*
*
* @param describeLocationNfsRequest
* DescribeLocationNfsRequest
* @return Result of the DescribeLocationNfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationNfs
* @see AWS
* API Documentation
*/
DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest);
/**
*
* Returns metadata about a self-managed object storage server location. For more information about self-managed
* object storage locations, see Creating a location for
* object storage.
*
*
* @param describeLocationObjectStorageRequest
* DescribeLocationObjectStorageRequest
* @return Result of the DescribeLocationObjectStorage operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationObjectStorage
* @see AWS API Documentation
*/
DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest);
/**
*
* Returns metadata, such as bucket name, about an Amazon S3 bucket location.
*
*
* @param describeLocationS3Request
* DescribeLocationS3Request
* @return Result of the DescribeLocationS3 operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationS3
* @see AWS
* API Documentation
*/
DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request describeLocationS3Request);
/**
*
* Returns metadata, such as the path and user information about an SMB location.
*
*
* @param describeLocationSmbRequest
* DescribeLocationSmbRequest
* @return Result of the DescribeLocationSmb operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeLocationSmb
* @see AWS
* API Documentation
*/
DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest);
/**
*
* Returns metadata about a task.
*
*
* @param describeTaskRequest
* DescribeTaskRequest
* @return Result of the DescribeTask operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeTask
* @see AWS API
* Documentation
*/
DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest);
/**
*
* Returns detailed metadata about a task that is being executed.
*
*
* @param describeTaskExecutionRequest
* DescribeTaskExecutionRequest
* @return Result of the DescribeTaskExecution operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.DescribeTaskExecution
* @see AWS
* API Documentation
*/
DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest);
/**
*
* Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services Region specified in
* the request. The returned list is ordered by agent Amazon Resource Name (ARN).
*
*
* By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you
* to optionally reduce the number of agents returned in a response.
*
*
* If you have more agents than are returned in a response (that is, the response returns only a truncated list of
* your agents), the response contains a marker that you can specify in your next request to fetch the next page of
* agents.
*
*
* @param listAgentsRequest
* ListAgentsRequest
* @return Result of the ListAgents operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.ListAgents
* @see AWS API
* Documentation
*/
ListAgentsResult listAgents(ListAgentsRequest listAgentsRequest);
/**
*
* Returns a list of source and destination locations.
*
*
* If you have more locations than are returned in a response (that is, the response returns only a truncated list
* of your agents), the response contains a token that you can specify in your next request to fetch the next page
* of locations.
*
*
* @param listLocationsRequest
* ListLocationsRequest
* @return Result of the ListLocations operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.ListLocations
* @see AWS API
* Documentation
*/
ListLocationsResult listLocations(ListLocationsRequest listLocationsRequest);
/**
*
* Returns all the tags associated with a specified resource.
*
*
* @param listTagsForResourceRequest
* ListTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Returns a list of executed tasks.
*
*
* @param listTaskExecutionsRequest
* ListTaskExecutions
* @return Result of the ListTaskExecutions operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.ListTaskExecutions
* @see AWS
* API Documentation
*/
ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest);
/**
*
* Returns a list of all the tasks.
*
*
* @param listTasksRequest
* ListTasksRequest
* @return Result of the ListTasks operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.ListTasks
* @see AWS API
* Documentation
*/
ListTasksResult listTasks(ListTasksRequest listTasksRequest);
/**
*
* Starts a specific invocation of a task. A TaskExecution value represents an individual run of a
* task. Each task can have at most one TaskExecution at a time.
*
*
* TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING |
* VERIFYING | SUCCESS/FAILURE.
*
*
* For detailed information, see the Task Execution section in the Components and Terminology topic in the
* DataSync User Guide.
*
*
* @param startTaskExecutionRequest
* StartTaskExecutionRequest
* @return Result of the StartTaskExecution operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.StartTaskExecution
* @see AWS
* API Documentation
*/
StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest);
/**
*
* Applies a key-value pair to an Amazon Web Services resource.
*
*
* @param tagResourceRequest
* TagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes a tag from an Amazon Web Services resource.
*
*
* @param untagResourceRequest
* UntagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the name of an agent.
*
*
* @param updateAgentRequest
* UpdateAgentRequest
* @return Result of the UpdateAgent operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateAgent
* @see AWS API
* Documentation
*/
UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest);
/**
*
* Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
*
*
* @param updateLocationHdfsRequest
* @return Result of the UpdateLocationHdfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateLocationHdfs
* @see AWS
* API Documentation
*/
UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest);
/**
*
* Updates some of the parameters of a previously created location for Network File System (NFS) access. For
* information about creating an NFS location, see Creating a location for
* NFS.
*
*
* @param updateLocationNfsRequest
* @return Result of the UpdateLocationNfs operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateLocationNfs
* @see AWS API
* Documentation
*/
UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest);
/**
*
* Updates some of the parameters of a previously created location for self-managed object storage server access.
* For information about creating a self-managed object storage location, see Creating a location for
* object storage.
*
*
* @param updateLocationObjectStorageRequest
* @return Result of the UpdateLocationObjectStorage operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateLocationObjectStorage
* @see AWS API Documentation
*/
UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest);
/**
*
* Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
* access. For information about creating an SMB location, see Creating a location for
* SMB.
*
*
* @param updateLocationSmbRequest
* @return Result of the UpdateLocationSmb operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateLocationSmb
* @see AWS API
* Documentation
*/
UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest);
/**
*
* Updates the metadata associated with a task.
*
*
* @param updateTaskRequest
* UpdateTaskResponse
* @return Result of the UpdateTask operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateTask
* @see AWS API
* Documentation
*/
UpdateTaskResult updateTask(UpdateTaskRequest updateTaskRequest);
/**
*
* Updates execution of a task.
*
*
* You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.
*
*
*
* The only Option that can be modified by UpdateTaskExecution is
* BytesPerSecond
* .
*
*
*
* @param updateTaskExecutionRequest
* @return Result of the UpdateTaskExecution operation returned by the service.
* @throws InvalidRequestException
* This exception is thrown when the client submits a malformed request.
* @throws InternalException
* This exception is thrown when an error occurs in the DataSync service.
* @sample AWSDataSync.UpdateTaskExecution
* @see AWS
* API Documentation
*/
UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}