com.amazonaws.services.datasync.AWSDataSync Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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 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 .
*
*/
@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";
/**
*
* Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to
* collect information about.
*
*
* @param addStorageSystemRequest
* @return Result of the AddStorageSystem 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.AddStorageSystem
* @see AWS API
* Documentation
*/
AddStorageSystemResult addStorageSystem(AddStorageSystemRequest addStorageSystemRequest);
/**
*
* 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.
*
*
* @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'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:
*
*
* -
*
*
* -
*
* Create an agent
*
*
*
*
*
* If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
*
*
*
* @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 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.
*
*
* @param createLocationAzureBlobRequest
* @return Result of the CreateLocationAzureBlob 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.CreateLocationAzureBlob
* @see AWS API Documentation
*/
CreateLocationAzureBlobResult createLocationAzureBlob(CreateLocationAzureBlobRequest createLocationAzureBlobRequest);
/**
*
* 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.
*
*
* @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 NetApp ONTAP file system that DataSync can use for a data transfer.
*
*
* Before you begin, make sure that you understand how DataSync accesses an FSx for ONTAP file system.
*
*
* @param createLocationFsxOntapRequest
* @return Result of the CreateLocationFsxOntap 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.CreateLocationFsxOntap
* @see AWS API Documentation
*/
CreateLocationFsxOntapResult createLocationFsxOntap(CreateLocationFsxOntapRequest createLocationFsxOntapRequest);
/**
*
* 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.
*
*
*
* @param createLocationFsxOpenZfsRequest
* @return Result of the CreateLocationFsxOpenZfs 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.CreateLocationFsxOpenZfs
* @see AWS API Documentation
*/
CreateLocationFsxOpenZfsResult createLocationFsxOpenZfs(CreateLocationFsxOpenZfsRequest createLocationFsxOpenZfsRequest);
/**
*
* Creates an endpoint for an Amazon FSx for Windows File Server file system that DataSync can use for a data
* transfer.
*
*
* Before you begin, make sure that you understand how DataSync accesses an FSx for Windows File Server.
*
*
* @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);
/**
*
* 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.
*
*
*
* @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 an object storage system that DataSync can access for a transfer. For more information,
* 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);
/**
*
* 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.
*
*
* @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);
/**
*
* 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.
*
*
* @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);
/**
*
* 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.
*
*
*
* @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);
/**
*
* Removes an DataSync agent resource from your Amazon Web Services account.
*
*
* Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or
* Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your
* storage environment or reuse it to activate a new agent.
*
*
* @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 an DataSync transfer 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 information about an DataSync agent, such as its name, service endpoint type, and status.
*
*
* @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 information about a DataSync discovery job.
*
*
* @param describeDiscoveryJobRequest
* @return Result of the DescribeDiscoveryJob 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.DescribeDiscoveryJob
* @see AWS
* API Documentation
*/
DescribeDiscoveryJobResult describeDiscoveryJob(DescribeDiscoveryJobRequest describeDiscoveryJobRequest);
/**
*
* Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
*
*
* @param describeLocationAzureBlobRequest
* @return Result of the DescribeLocationAzureBlob 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.DescribeLocationAzureBlob
* @see AWS API Documentation
*/
DescribeLocationAzureBlobResult describeLocationAzureBlob(DescribeLocationAzureBlobRequest describeLocationAzureBlobRequest);
/**
*
* Returns metadata about your DataSync location for an Amazon EFS file system.
*
*
* @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);
/**
*
* Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.
*
*
* @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);
/**
*
* 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.
*
*
*
* @param describeLocationFsxOntapRequest
* @return Result of the DescribeLocationFsxOntap 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.DescribeLocationFsxOntap
* @see AWS API Documentation
*/
DescribeLocationFsxOntapResult describeLocationFsxOntap(DescribeLocationFsxOntapRequest describeLocationFsxOntapRequest);
/**
*
* 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.
*
*
*
* @param describeLocationFsxOpenZfsRequest
* @return Result of the DescribeLocationFsxOpenZfs 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.DescribeLocationFsxOpenZfs
* @see AWS API Documentation
*/
DescribeLocationFsxOpenZfsResult describeLocationFsxOpenZfs(DescribeLocationFsxOpenZfsRequest describeLocationFsxOpenZfsRequest);
/**
*
* Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
*
*
* @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);
/**
*
* Provides details about how an DataSync transfer location for a Network File System (NFS) file server is
* configured.
*
*
* @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 your DataSync location for an object storage system.
*
*
* @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 information about an on-premises storage system that you're using with DataSync Discovery.
*
*
* @param describeStorageSystemRequest
* @return Result of the DescribeStorageSystem 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.DescribeStorageSystem
* @see AWS
* API Documentation
*/
DescribeStorageSystemResult describeStorageSystem(DescribeStorageSystemRequest describeStorageSystemRequest);
/**
*
* Returns information, including performance data and capacity usage, which DataSync Discovery collects about a
* specific resource in your-premises storage system.
*
*
* @param describeStorageSystemResourceMetricsRequest
* @return Result of the DescribeStorageSystemResourceMetrics 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.DescribeStorageSystemResourceMetrics
* @see AWS API Documentation
*/
DescribeStorageSystemResourceMetricsResult describeStorageSystemResourceMetrics(
DescribeStorageSystemResourceMetricsRequest describeStorageSystemResourceMetricsRequest);
/**
*
* Returns information that DataSync Discovery collects about resources in your on-premises storage system.
*
*
* @param describeStorageSystemResourcesRequest
* @return Result of the DescribeStorageSystemResources 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.DescribeStorageSystemResources
* @see AWS API Documentation
*/
DescribeStorageSystemResourcesResult describeStorageSystemResources(DescribeStorageSystemResourcesRequest describeStorageSystemResourcesRequest);
/**
*
* Provides information about an DataSync transfer 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);
/**
*
* 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.
*
*
* @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);
/**
*
* 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.
*
*
* @param generateRecommendationsRequest
* @return Result of the GenerateRecommendations 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.GenerateRecommendations
* @see AWS API Documentation
*/
GenerateRecommendationsResult generateRecommendations(GenerateRecommendationsRequest generateRecommendationsRequest);
/**
*
* 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.
*
*
* @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);
/**
*
* 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.
*
*
* @param listDiscoveryJobsRequest
* @return Result of the ListDiscoveryJobs 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.ListDiscoveryJobs
* @see AWS API
* Documentation
*/
ListDiscoveryJobsResult listDiscoveryJobs(ListDiscoveryJobsRequest listDiscoveryJobsRequest);
/**
*
* 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);
/**
*
* Lists the on-premises storage systems that you're using with DataSync Discovery.
*
*
* @param listStorageSystemsRequest
* @return Result of the ListStorageSystems 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.ListStorageSystems
* @see AWS
* API Documentation
*/
ListStorageSystemsResult listStorageSystems(ListStorageSystemsRequest listStorageSystemsRequest);
/**
*
* Returns all the tags associated with an Amazon Web Services 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 the DataSync tasks you created.
*
*
* @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);
/**
*
* Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs,
* collected data, and recommendations.
*
*
* @param removeStorageSystemRequest
* @return Result of the RemoveStorageSystem 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.RemoveStorageSystem
* @see AWS
* API Documentation
*/
RemoveStorageSystemResult removeStorageSystem(RemoveStorageSystemRequest removeStorageSystemRequest);
/**
*
* 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.
*
*
* @param startDiscoveryJobRequest
* @return Result of the StartDiscoveryJob 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.StartDiscoveryJob
* @see AWS API
* Documentation
*/
StartDiscoveryJobResult startDiscoveryJob(StartDiscoveryJobRequest startDiscoveryJobRequest);
/**
*
* 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.
*
*
*
* @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);
/**
*
* 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.
*
*
* @param stopDiscoveryJobRequest
* @return Result of the StopDiscoveryJob 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.StopDiscoveryJob
* @see AWS API
* Documentation
*/
StopDiscoveryJobResult stopDiscoveryJob(StopDiscoveryJobRequest stopDiscoveryJobRequest);
/**
*
* 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.
*
*
* @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 tags 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 DataSync 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);
/**
*
* Edits a DataSync discovery job configuration.
*
*
* @param updateDiscoveryJobRequest
* @return Result of the UpdateDiscoveryJob 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.UpdateDiscoveryJob
* @see AWS
* API Documentation
*/
UpdateDiscoveryJobResult updateDiscoveryJob(UpdateDiscoveryJobRequest updateDiscoveryJobRequest);
/**
*
* Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with
* DataSync.
*
*
* @param updateLocationAzureBlobRequest
* @return Result of the UpdateLocationAzureBlob 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.UpdateLocationAzureBlob
* @see AWS API Documentation
*/
UpdateLocationAzureBlobResult updateLocationAzureBlob(UpdateLocationAzureBlobRequest updateLocationAzureBlobRequest);
/**
*
* 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);
/**
*
* 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.
*
*
* @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 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.
*
*
* @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 Server Message Block (SMB) file server location that you can use for DataSync
* transfers.
*
*
* @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);
/**
*
* Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
*
*
* @param updateStorageSystemRequest
* @return Result of the UpdateStorageSystem 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.UpdateStorageSystem
* @see AWS
* API Documentation
*/
UpdateStorageSystemResult updateStorageSystem(UpdateStorageSystemRequest updateStorageSystemRequest);
/**
*
* Updates the configuration of a DataSync transfer 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 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.
*
*
*
* @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);
}