@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSDataSyncClient extends AmazonWebServiceClient implements AWSDataSync
DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
AddStorageSystemResult |
addStorageSystem(AddStorageSystemRequest request)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
collect information about.
|
static AWSDataSyncClientBuilder |
builder() |
CancelTaskExecutionResult |
cancelTaskExecution(CancelTaskExecutionRequest request)
Stops an DataSync task execution that's in progress.
|
CreateAgentResult |
createAgent(CreateAgentRequest request)
Activates an DataSync agent that you've deployed in your storage environment.
|
CreateLocationAzureBlobResult |
createLocationAzureBlob(CreateLocationAzureBlobRequest request)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or
destination.
|
CreateLocationEfsResult |
createLocationEfs(CreateLocationEfsRequest request)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
CreateLocationFsxLustreResult |
createLocationFsxLustre(CreateLocationFsxLustreRequest request)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
CreateLocationFsxOntapResult |
createLocationFsxOntap(CreateLocationFsxOntapRequest request)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
|
CreateLocationFsxOpenZfsResult |
createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest request)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
CreateLocationFsxWindowsResult |
createLocationFsxWindows(CreateLocationFsxWindowsRequest request)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
CreateLocationHdfsResult |
createLocationHdfs(CreateLocationHdfsRequest request)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
CreateLocationNfsResult |
createLocationNfs(CreateLocationNfsRequest request)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
|
CreateLocationObjectStorageResult |
createLocationObjectStorage(CreateLocationObjectStorageRequest request)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
CreateLocationS3Result |
createLocationS3(CreateLocationS3Request request)
A location is an endpoint for an Amazon S3 bucket.
|
CreateLocationSmbResult |
createLocationSmb(CreateLocationSmbRequest request)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
|
CreateTaskResult |
createTask(CreateTaskRequest request)
Configures a transfer task, which defines where and how DataSync moves your data.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest request)
Deletes an agent.
|
DeleteLocationResult |
deleteLocation(DeleteLocationRequest request)
Deletes the configuration of a location used by DataSync.
|
DeleteTaskResult |
deleteTask(DeleteTaskRequest request)
Deletes an DataSync transfer task.
|
DescribeAgentResult |
describeAgent(DescribeAgentRequest request)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
|
DescribeDiscoveryJobResult |
describeDiscoveryJob(DescribeDiscoveryJobRequest request)
Returns information about a DataSync discovery job.
|
DescribeLocationAzureBlobResult |
describeLocationAzureBlob(DescribeLocationAzureBlobRequest request)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
|
DescribeLocationEfsResult |
describeLocationEfs(DescribeLocationEfsRequest request)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
DescribeLocationFsxLustreResult |
describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
DescribeLocationFsxOntapResult |
describeLocationFsxOntap(DescribeLocationFsxOntapRequest request)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
DescribeLocationFsxOpenZfsResult |
describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest request)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
DescribeLocationFsxWindowsResult |
describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
DescribeLocationHdfsResult |
describeLocationHdfs(DescribeLocationHdfsRequest request)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
DescribeLocationNfsResult |
describeLocationNfs(DescribeLocationNfsRequest request)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is
configured.
|
DescribeLocationObjectStorageResult |
describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)
Returns metadata about your DataSync location for an object storage system.
|
DescribeLocationS3Result |
describeLocationS3(DescribeLocationS3Request request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
DescribeLocationSmbResult |
describeLocationSmb(DescribeLocationSmbRequest request)
Returns metadata, such as the path and user information about an SMB location.
|
DescribeStorageSystemResult |
describeStorageSystem(DescribeStorageSystemRequest request)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
|
DescribeStorageSystemResourceMetricsResult |
describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest request)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
DescribeStorageSystemResourcesResult |
describeStorageSystemResources(DescribeStorageSystemResourcesRequest request)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
DescribeTaskResult |
describeTask(DescribeTaskRequest request)
Provides information about an DataSync transfer task.
|
DescribeTaskExecutionResult |
describeTaskExecution(DescribeTaskExecutionRequest request)
Provides information about an execution of your DataSync task.
|
GenerateRecommendationsResult |
generateRecommendations(GenerateRecommendationsRequest request)
Creates recommendations about where to migrate your data to in Amazon Web Services.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAgentsResult |
listAgents(ListAgentsRequest request)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region
specified in the request.
|
ListDiscoveryJobsResult |
listDiscoveryJobs(ListDiscoveryJobsRequest request)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account
where you're using DataSync Discovery.
|
ListLocationsResult |
listLocations(ListLocationsRequest request)
Returns a list of source and destination locations.
|
ListStorageSystemsResult |
listStorageSystems(ListStorageSystemsRequest request)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags associated with an Amazon Web Services resource.
|
ListTaskExecutionsResult |
listTaskExecutions(ListTaskExecutionsRequest request)
Returns a list of executed tasks.
|
ListTasksResult |
listTasks(ListTasksRequest request)
Returns a list of the DataSync tasks you created.
|
RemoveStorageSystemResult |
removeStorageSystem(RemoveStorageSystemRequest request)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs,
collected data, and recommendations.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartDiscoveryJobResult |
startDiscoveryJob(StartDiscoveryJobRequest request)
Runs a DataSync discovery job on your on-premises storage system.
|
StartTaskExecutionResult |
startTaskExecution(StartTaskExecutionRequest request)
Starts an DataSync transfer task.
|
StopDiscoveryJobResult |
stopDiscoveryJob(StopDiscoveryJobRequest request)
Stops a running DataSync discovery job.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Applies a tag to an Amazon Web Services resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from an Amazon Web Services resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest request)
Updates the name of an agent.
|
UpdateDiscoveryJobResult |
updateDiscoveryJob(UpdateDiscoveryJobRequest request)
Edits a DataSync discovery job configuration.
|
UpdateLocationAzureBlobResult |
updateLocationAzureBlob(UpdateLocationAzureBlobRequest request)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with
DataSync.
|
UpdateLocationHdfsResult |
updateLocationHdfs(UpdateLocationHdfsRequest request)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
UpdateLocationNfsResult |
updateLocationNfs(UpdateLocationNfsRequest request)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
|
UpdateLocationObjectStorageResult |
updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
UpdateLocationSmbResult |
updateLocationSmb(UpdateLocationSmbRequest request)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
UpdateStorageSystemResult |
updateStorageSystem(UpdateStorageSystemRequest request)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
|
UpdateTaskResult |
updateTask(UpdateTaskRequest request)
Updates the configuration of a DataSync transfer task.
|
UpdateTaskExecutionResult |
updateTaskExecution(UpdateTaskExecutionRequest request)
Updates the configuration of a running DataSync task execution.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetpublic static AWSDataSyncClientBuilder builder()
public AddStorageSystemResult addStorageSystem(AddStorageSystemRequest request)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
addStorageSystem in interface AWSDataSyncaddStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest request)
Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.
However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.
cancelTaskExecution in interface AWSDataSynccancelTaskExecutionRequest - CancelTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateAgentResult createAgent(CreateAgentRequest request)
Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see the following topics to learn more:
If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
createAgent in interface AWSDataSynccreateAgentRequest - CreateAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationAzureBlobResult createLocationAzureBlob(CreateLocationAzureBlobRequest request)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or destination.
Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
createLocationAzureBlob in interface AWSDataSynccreateLocationAzureBlobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest request)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
createLocationEfs in interface AWSDataSynccreateLocationEfsRequest - CreateLocationEfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest request)
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustre in interface AWSDataSynccreateLocationFsxLustreRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationFsxOntapResult createLocationFsxOntap(CreateLocationFsxOntapRequest request)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
createLocationFsxOntap in interface AWSDataSynccreateLocationFsxOntapRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationFsxOpenZfsResult createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest request)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for OpenZFS.
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs
operation.
createLocationFsxOpenZfs in interface AWSDataSynccreateLocationFsxOpenZfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest request)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindows in interface AWSDataSynccreateLocationFsxWindowsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest request)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfs in interface AWSDataSynccreateLocationHdfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest request)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
For more information, see Configuring transfers to or from an NFS file server.
If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create
your transfer location. For more information, see Configuring transfers with
Snowcone.
createLocationNfs in interface AWSDataSynccreateLocationNfsRequest - CreateLocationNfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest request)
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
createLocationObjectStorage in interface AWSDataSynccreateLocationObjectStorageRequest - CreateLocationObjectStorageRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationS3Result createLocationS3(CreateLocationS3Request request)
A location is an endpoint for an Amazon S3 bucket. DataSync can use the location as a source or destination for copying data.
Before you create your location, make sure that you read the following sections:
For more information, see Creating an Amazon S3 location.
createLocationS3 in interface AWSDataSynccreateLocationS3Request - CreateLocationS3RequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest request)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
Before you begin, make sure that you understand how DataSync accesses an SMB file server.
createLocationSmb in interface AWSDataSynccreateLocationSmbRequest - CreateLocationSmbRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public CreateTaskResult createTask(CreateTaskRequest request)
Configures a transfer task, which defines where and how DataSync moves your data.
A task includes a source location, destination location, and the options for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
createTask in interface AWSDataSynccreateTaskRequest - CreateTaskRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgent in interface AWSDataSyncdeleteAgentRequest - DeleteAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DeleteLocationResult deleteLocation(DeleteLocationRequest request)
Deletes the configuration of a location used by DataSync.
deleteLocation in interface AWSDataSyncdeleteLocationRequest - DeleteLocationInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DeleteTaskResult deleteTask(DeleteTaskRequest request)
Deletes an DataSync transfer task.
deleteTask in interface AWSDataSyncdeleteTaskRequest - DeleteTaskInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeAgentResult describeAgent(DescribeAgentRequest request)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
describeAgent in interface AWSDataSyncdescribeAgentRequest - DescribeAgentInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeDiscoveryJobResult describeDiscoveryJob(DescribeDiscoveryJobRequest request)
Returns information about a DataSync discovery job.
describeDiscoveryJob in interface AWSDataSyncdescribeDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationAzureBlobResult describeLocationAzureBlob(DescribeLocationAzureBlobRequest request)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
describeLocationAzureBlob in interface AWSDataSyncdescribeLocationAzureBlobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest request)
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfs in interface AWSDataSyncdescribeLocationEfsRequest - DescribeLocationEfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest request)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustre in interface AWSDataSyncdescribeLocationFsxLustreRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationFsxOntapResult describeLocationFsxOntap(DescribeLocationFsxOntapRequest request)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a
Password.
describeLocationFsxOntap in interface AWSDataSyncdescribeLocationFsxOntapRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationFsxOpenZfsResult describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest request)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs
operation.
describeLocationFsxOpenZfs in interface AWSDataSyncdescribeLocationFsxOpenZfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest request)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindows in interface AWSDataSyncdescribeLocationFsxWindowsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest request)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfs in interface AWSDataSyncdescribeLocationHdfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest request)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
describeLocationNfs in interface AWSDataSyncdescribeLocationNfsRequest - DescribeLocationNfsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest request)
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorage in interface AWSDataSyncdescribeLocationObjectStorageRequest - DescribeLocationObjectStorageRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3 in interface AWSDataSyncdescribeLocationS3Request - DescribeLocationS3RequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest request)
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmb in interface AWSDataSyncdescribeLocationSmbRequest - DescribeLocationSmbRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeStorageSystemResult describeStorageSystem(DescribeStorageSystemRequest request)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
describeStorageSystem in interface AWSDataSyncdescribeStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeStorageSystemResourceMetricsResult describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest request)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
describeStorageSystemResourceMetrics in interface AWSDataSyncdescribeStorageSystemResourceMetricsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeStorageSystemResourcesResult describeStorageSystemResources(DescribeStorageSystemResourcesRequest request)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
describeStorageSystemResources in interface AWSDataSyncdescribeStorageSystemResourcesRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeTaskResult describeTask(DescribeTaskRequest request)
Provides information about an DataSync transfer task.
describeTask in interface AWSDataSyncdescribeTaskRequest - DescribeTaskRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest request)
Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.
describeTaskExecution in interface AWSDataSyncdescribeTaskExecutionRequest - DescribeTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public GenerateRecommendationsResult generateRecommendations(GenerateRecommendationsRequest request)
Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
generateRecommendations in interface AWSDataSyncgenerateRecommendationsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListAgentsResult listAgents(ListAgentsRequest request)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.
ListAgents is eventually consistent. This means the result of running the operation might not
reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgent and then
immediately run ListAgents, that agent might not show up in the list right away. In situations like
this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
listAgents in interface AWSDataSynclistAgentsRequest - ListAgentsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListDiscoveryJobsResult listDiscoveryJobs(ListDiscoveryJobsRequest request)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
listDiscoveryJobs in interface AWSDataSynclistDiscoveryJobsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListLocationsResult listLocations(ListLocationsRequest request)
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.
listLocations in interface AWSDataSynclistLocationsRequest - ListLocationsRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListStorageSystemsResult listStorageSystems(ListStorageSystemsRequest request)
Lists the on-premises storage systems that you're using with DataSync Discovery.
listStorageSystems in interface AWSDataSynclistStorageSystemsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Returns all the tags associated with an Amazon Web Services resource.
listTagsForResource in interface AWSDataSynclistTagsForResourceRequest - ListTagsForResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest request)
Returns a list of executed tasks.
listTaskExecutions in interface AWSDataSynclistTaskExecutionsRequest - ListTaskExecutionsInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ListTasksResult listTasks(ListTasksRequest request)
Returns a list of the DataSync tasks you created.
listTasks in interface AWSDataSynclistTasksRequest - ListTasksRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public RemoveStorageSystemResult removeStorageSystem(RemoveStorageSystemRequest request)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
removeStorageSystem in interface AWSDataSyncremoveStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public StartDiscoveryJobResult startDiscoveryJob(StartDiscoveryJobRequest request)
Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystem operation.
startDiscoveryJob in interface AWSDataSyncstartDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest request)
Starts an DataSync transfer task. For each task, you can only run one task execution at a time.
There are several phases to a task execution. For more information, see Task execution statuses.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing page before you begin.
startTaskExecution in interface AWSDataSyncstartTaskExecutionRequest - StartTaskExecutionRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public StopDiscoveryJobResult stopDiscoveryJob(StopDiscoveryJobRequest request)
Stops a running DataSync discovery job.
You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendations operation.
stopDiscoveryJob in interface AWSDataSyncstopDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public TagResourceResult tagResource(TagResourceRequest request)
Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.
These include DataSync resources, such as locations, tasks, and task executions.
tagResource in interface AWSDataSynctagResourceRequest - TagResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes tags from an Amazon Web Services resource.
untagResource in interface AWSDataSyncuntagResourceRequest - UntagResourceRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateAgentResult updateAgent(UpdateAgentRequest request)
Updates the name of an agent.
updateAgent in interface AWSDataSyncupdateAgentRequest - UpdateAgentRequestInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateDiscoveryJobResult updateDiscoveryJob(UpdateDiscoveryJobRequest request)
Edits a DataSync discovery job configuration.
updateDiscoveryJob in interface AWSDataSyncupdateDiscoveryJobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateLocationAzureBlobResult updateLocationAzureBlob(UpdateLocationAzureBlobRequest request)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
updateLocationAzureBlob in interface AWSDataSyncupdateLocationAzureBlobRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest request)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfs in interface AWSDataSyncupdateLocationHdfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest request)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
For more information, see Configuring transfers to or from an NFS file server.
updateLocationNfs in interface AWSDataSyncupdateLocationNfsRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest request)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer. For information about creating a self-managed object storage location, see Creating a location for object storage.
updateLocationObjectStorage in interface AWSDataSyncupdateLocationObjectStorageRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest request)
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.
updateLocationSmb in interface AWSDataSyncupdateLocationSmbRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateStorageSystemResult updateStorageSystem(UpdateStorageSystemRequest request)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
updateStorageSystem in interface AWSDataSyncupdateStorageSystemRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateTaskResult updateTask(UpdateTaskRequest request)
Updates the configuration of a DataSync transfer task.
updateTask in interface AWSDataSyncupdateTaskRequest - UpdateTaskResponseInvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest request)
Updates the configuration of a running DataSync task execution.
Currently, the only Option that you can modify with UpdateTaskExecution is
BytesPerSecond
, which throttles bandwidth for a running or queued task execution.
updateTaskExecution in interface AWSDataSyncupdateTaskExecutionRequest - InvalidRequestException - This exception is thrown when the client submits a malformed request.InternalException - This exception is thrown when an error occurs in the DataSync service.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AWSDataSyncrequest - The originally executed requestpublic void shutdown()
AmazonWebServiceClientshutdown in interface AWSDataSyncshutdown in class AmazonWebServiceClient