@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSDataSync
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSDataSync
instead.
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 .
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddStorageSystemResult |
addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
collect information about.
|
CancelTaskExecutionResult |
cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
Stops an DataSync task execution that's in progress.
|
CreateAgentResult |
createAgent(CreateAgentRequest createAgentRequest)
Activates an DataSync agent that you've deployed in your storage environment.
|
CreateLocationAzureBlobResult |
createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)
Creates an endpoint for a Microsoft Azure Blob Storage container that DataSync can use as a transfer source or
destination.
|
CreateLocationEfsResult |
createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
|
CreateLocationFsxLustreResult |
createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
|
CreateLocationFsxOntapResult |
createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
|
CreateLocationFsxOpenZfsResult |
createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.
|
CreateLocationFsxWindowsResult |
createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
|
CreateLocationHdfsResult |
createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
|
CreateLocationNfsResult |
createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
Creates an endpoint for a Network File System (NFS) file server that DataSync can use for a data transfer.
|
CreateLocationObjectStorageResult |
createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
Creates an endpoint for an object storage system that DataSync can access for a transfer.
|
CreateLocationS3Result |
createLocationS3(CreateLocationS3Request createLocationS3Request)
A location is an endpoint for an Amazon S3 bucket.
|
CreateLocationSmbResult |
createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
Creates an endpoint for a Server Message Block (SMB) file server that DataSync can use for a data transfer.
|
CreateTaskResult |
createTask(CreateTaskRequest createTaskRequest)
Configures a transfer task, which defines where and how DataSync moves your data.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
|
DeleteLocationResult |
deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
|
DeleteTaskResult |
deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync transfer task.
|
DescribeAgentResult |
describeAgent(DescribeAgentRequest describeAgentRequest)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
|
DescribeDiscoveryJobResult |
describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
|
DescribeLocationAzureBlobResult |
describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
|
DescribeLocationEfsResult |
describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
|
DescribeLocationFsxLustreResult |
describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
|
DescribeLocationFsxOntapResult |
describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
|
DescribeLocationFsxOpenZfsResult |
describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.
|
DescribeLocationFsxWindowsResult |
describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
|
DescribeLocationHdfsResult |
describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS)
location.
|
DescribeLocationNfsResult |
describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is
configured.
|
DescribeLocationObjectStorageResult |
describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
|
DescribeLocationS3Result |
describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
|
DescribeLocationSmbResult |
describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
|
DescribeStorageSystemResult |
describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
|
DescribeStorageSystemResourceMetricsResult |
describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
specific resource in your-premises storage system.
|
DescribeStorageSystemResourcesResult |
describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
|
DescribeTaskResult |
describeTask(DescribeTaskRequest describeTaskRequest)
Provides information about an DataSync transfer task.
|
DescribeTaskExecutionResult |
describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
Provides information about an execution of your DataSync task.
|
GenerateRecommendationsResult |
generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)
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 listAgentsRequest)
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 listDiscoveryJobsRequest)
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 listLocationsRequest)
Returns a list of source and destination locations.
|
ListStorageSystemsResult |
listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
|
ListTaskExecutionsResult |
listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
|
ListTasksResult |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
|
RemoveStorageSystemResult |
removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)
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 startDiscoveryJobRequest)
Runs a DataSync discovery job on your on-premises storage system.
|
StartTaskExecutionResult |
startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
Starts an DataSync transfer task.
|
StopDiscoveryJobResult |
stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)
Stops a running DataSync discovery job.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Applies a tag to an Amazon Web Services resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
|
UpdateDiscoveryJobResult |
updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
|
UpdateLocationAzureBlobResult |
updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with
DataSync.
|
UpdateLocationHdfsResult |
updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
|
UpdateLocationNfsResult |
updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
|
UpdateLocationObjectStorageResult |
updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
|
UpdateLocationSmbResult |
updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system
access.
|
UpdateStorageSystemResult |
updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
|
UpdateTaskResult |
updateTask(UpdateTaskRequest updateTaskRequest)
Updates the configuration of a DataSync transfer task.
|
UpdateTaskExecutionResult |
updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)
Updates the configuration of a running DataSync task execution.
|
static final String ENDPOINT_PREFIX
AddStorageSystemResult addStorageSystem(AddStorageSystemRequest addStorageSystemRequest)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
addStorageSystemRequest
- 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.CancelTaskExecutionResult cancelTaskExecution(CancelTaskExecutionRequest cancelTaskExecutionRequest)
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.
cancelTaskExecutionRequest
- 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.CreateAgentResult createAgent(CreateAgentRequest createAgentRequest)
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.
createAgentRequest
- 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.CreateLocationAzureBlobResult createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest)
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.
createLocationAzureBlobRequest
- 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.CreateLocationEfsResult createLocationEfs(CreateLocationEfsRequest createLocationEfsRequest)
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.
createLocationEfsRequest
- 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.CreateLocationFsxLustreResult createLocationFsxLustre(CreateLocationFsxLustreRequest createLocationFsxLustreRequest)
Creates an endpoint for an Amazon FSx for Lustre file system.
createLocationFsxLustreRequest
- 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.CreateLocationFsxOntapResult createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest)
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.
createLocationFsxOntapRequest
- 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.CreateLocationFsxOpenZfsResult createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest)
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.
createLocationFsxOpenZfsRequest
- 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.CreateLocationFsxWindowsResult createLocationFsxWindows(CreateLocationFsxWindowsRequest createLocationFsxWindowsRequest)
Creates an endpoint for an Amazon FSx for Windows File Server file system.
createLocationFsxWindowsRequest
- 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.CreateLocationHdfsResult createLocationHdfs(CreateLocationHdfsRequest createLocationHdfsRequest)
Creates an endpoint for a Hadoop Distributed File System (HDFS).
createLocationHdfsRequest
- 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.CreateLocationNfsResult createLocationNfs(CreateLocationNfsRequest createLocationNfsRequest)
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.
createLocationNfsRequest
- 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.CreateLocationObjectStorageResult createLocationObjectStorage(CreateLocationObjectStorageRequest createLocationObjectStorageRequest)
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.
createLocationObjectStorageRequest
- 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.CreateLocationS3Result createLocationS3(CreateLocationS3Request createLocationS3Request)
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.
createLocationS3Request
- 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.CreateLocationSmbResult createLocationSmb(CreateLocationSmbRequest createLocationSmbRequest)
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.
createLocationSmbRequest
- 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.CreateTaskResult createTask(CreateTaskRequest createTaskRequest)
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.
createTaskRequest
- 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.DeleteAgentResult deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
deleteAgentRequest
- DeleteAgentRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.DeleteLocationResult deleteLocation(DeleteLocationRequest deleteLocationRequest)
Deletes the configuration of a location used by DataSync.
deleteLocationRequest
- DeleteLocationInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.DeleteTaskResult deleteTask(DeleteTaskRequest deleteTaskRequest)
Deletes an DataSync transfer task.
deleteTaskRequest
- DeleteTaskInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.DescribeAgentResult describeAgent(DescribeAgentRequest describeAgentRequest)
Returns metadata about an DataSync agent, such as its name, endpoint type, and status.
describeAgentRequest
- 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.DescribeDiscoveryJobResult describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest)
Returns information about a DataSync discovery job.
describeDiscoveryJobRequest
- 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.DescribeLocationAzureBlobResult describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
describeLocationAzureBlobRequest
- 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.DescribeLocationEfsResult describeLocationEfs(DescribeLocationEfsRequest describeLocationEfsRequest)
Returns metadata about your DataSync location for an Amazon EFS file system.
describeLocationEfsRequest
- 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.DescribeLocationFsxLustreResult describeLocationFsxLustre(DescribeLocationFsxLustreRequest describeLocationFsxLustreRequest)
Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
describeLocationFsxLustreRequest
- 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.DescribeLocationFsxOntapResult describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest)
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
.
describeLocationFsxOntapRequest
- 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.DescribeLocationFsxOpenZfsResult describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest)
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.
describeLocationFsxOpenZfsRequest
- 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.DescribeLocationFsxWindowsResult describeLocationFsxWindows(DescribeLocationFsxWindowsRequest describeLocationFsxWindowsRequest)
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
describeLocationFsxWindowsRequest
- 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.DescribeLocationHdfsResult describeLocationHdfs(DescribeLocationHdfsRequest describeLocationHdfsRequest)
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
describeLocationHdfsRequest
- 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.DescribeLocationNfsResult describeLocationNfs(DescribeLocationNfsRequest describeLocationNfsRequest)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
describeLocationNfsRequest
- 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.DescribeLocationObjectStorageResult describeLocationObjectStorage(DescribeLocationObjectStorageRequest describeLocationObjectStorageRequest)
Returns metadata about your DataSync location for an object storage system.
describeLocationObjectStorageRequest
- 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.DescribeLocationS3Result describeLocationS3(DescribeLocationS3Request describeLocationS3Request)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
describeLocationS3Request
- DescribeLocationS3RequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.DescribeLocationSmbResult describeLocationSmb(DescribeLocationSmbRequest describeLocationSmbRequest)
Returns metadata, such as the path and user information about an SMB location.
describeLocationSmbRequest
- DescribeLocationSmbRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.DescribeStorageSystemResult describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
describeStorageSystemRequest
- 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.DescribeStorageSystemResourceMetricsResult describeStorageSystemResourceMetrics(DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
describeStorageSystemResourceMetricsRequest
- 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.DescribeStorageSystemResourcesResult describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
describeStorageSystemResourcesRequest
- 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.DescribeTaskResult describeTask(DescribeTaskRequest describeTaskRequest)
Provides information about an DataSync transfer task.
describeTaskRequest
- DescribeTaskRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.DescribeTaskExecutionResult describeTaskExecution(DescribeTaskExecutionRequest describeTaskExecutionRequest)
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.
describeTaskExecutionRequest
- 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.GenerateRecommendationsResult generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest)
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.
generateRecommendationsRequest
- 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.ListAgentsResult listAgents(ListAgentsRequest listAgentsRequest)
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.
listAgentsRequest
- 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.ListDiscoveryJobsResult listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest)
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.
listDiscoveryJobsRequest
- 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.ListLocationsResult listLocations(ListLocationsRequest listLocationsRequest)
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.
listLocationsRequest
- 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.ListStorageSystemsResult listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest)
Lists the on-premises storage systems that you're using with DataSync Discovery.
listStorageSystemsRequest
- 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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns all the tags associated with an Amazon Web Services resource.
listTagsForResourceRequest
- 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.ListTaskExecutionsResult listTaskExecutions(ListTaskExecutionsRequest listTaskExecutionsRequest)
Returns a list of executed tasks.
listTaskExecutionsRequest
- ListTaskExecutionsInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.ListTasksResult listTasks(ListTasksRequest listTasksRequest)
Returns a list of the DataSync tasks you created.
listTasksRequest
- 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.RemoveStorageSystemResult removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
removeStorageSystemRequest
- 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.StartDiscoveryJobResult startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest)
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.
startDiscoveryJobRequest
- 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.StartTaskExecutionResult startTaskExecution(StartTaskExecutionRequest startTaskExecutionRequest)
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.
startTaskExecutionRequest
- 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.StopDiscoveryJobResult stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest)
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.
stopDiscoveryJobRequest
- 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.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest
- 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.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an Amazon Web Services resource.
untagResourceRequest
- UntagResourceRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the name of an agent.
updateAgentRequest
- UpdateAgentRequestInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.UpdateDiscoveryJobResult updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest)
Edits a DataSync discovery job configuration.
updateDiscoveryJobRequest
- 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.UpdateLocationAzureBlobResult updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
updateLocationAzureBlobRequest
- 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.UpdateLocationHdfsResult updateLocationHdfs(UpdateLocationHdfsRequest updateLocationHdfsRequest)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
updateLocationHdfsRequest
- 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.UpdateLocationNfsResult updateLocationNfs(UpdateLocationNfsRequest updateLocationNfsRequest)
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.
updateLocationNfsRequest
- 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.UpdateLocationObjectStorageResult updateLocationObjectStorage(UpdateLocationObjectStorageRequest updateLocationObjectStorageRequest)
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.
updateLocationObjectStorageRequest
- 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.UpdateLocationSmbResult updateLocationSmb(UpdateLocationSmbRequest updateLocationSmbRequest)
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.
updateLocationSmbRequest
- 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.UpdateStorageSystemResult updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
updateStorageSystemRequest
- 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.UpdateTaskResult updateTask(UpdateTaskRequest updateTaskRequest)
Updates the configuration of a DataSync transfer task.
updateTaskRequest
- UpdateTaskResponseInvalidRequestException
- This exception is thrown when the client submits a malformed request.InternalException
- This exception is thrown when an error occurs in the DataSync service.UpdateTaskExecutionResult updateTaskExecution(UpdateTaskExecutionRequest updateTaskExecutionRequest)
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.
updateTaskExecutionRequest
- 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.