- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
DataSyncClient
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 .
Installation
npm install @aws-sdk/client-datasync
yarn add @aws-sdk/client-datasync
pnpm add @aws-sdk/client-datasync
DataSyncClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AddStorageSystemCommand | Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about. |
CancelTaskExecutionCommand | 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. |
CreateAgentCommand | Activates an DataSync agent that you deploy 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 Do I need a DataSync agent? |
CreateLocationAzureBlobCommand | Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location 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. |
CreateLocationEfsCommand | Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems . |
CreateLocationFsxLustreCommand | Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems . |
CreateLocationFsxOntapCommand | Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems . |
CreateLocationFsxOpenZfsCommand | Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems . Request parameters related to |
CreateLocationFsxWindowsCommand | Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems . |
CreateLocationHdfsCommand | Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses HDFS clusters . |
CreateLocationNfsCommand | Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses NFS file servers . |
CreateLocationObjectStorageCommand | Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems. |
CreateLocationS3Command | Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you read the following topics: For more information, see Configuring transfers with Amazon S3 . |
CreateLocationSmbCommand | Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data. Before you begin, make sure that you understand how DataSync accesses SMB file servers . |
CreateTaskCommand | Configures a task, which defines where and how DataSync transfers your data. A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more). 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. |
DeleteAgentCommand | 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 . |
DeleteLocationCommand | Deletes a transfer location resource from DataSync. |
DeleteTaskCommand | Deletes a transfer task resource from DataSync. |
DescribeAgentCommand | Returns information about an DataSync agent, such as its name, service endpoint type, and status. |
DescribeDiscoveryJobCommand | Returns information about a DataSync discovery job. |
DescribeLocationAzureBlobCommand | Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured. |
DescribeLocationEfsCommand | Provides details about how an DataSync transfer location for an Amazon EFS file system is configured. |
DescribeLocationFsxLustreCommand | Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured. |
DescribeLocationFsxOntapCommand | Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured. If your location uses SMB, the |
DescribeLocationFsxOpenZfsCommand | Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to |
DescribeLocationFsxWindowsCommand | Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured. |
DescribeLocationHdfsCommand | Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured. |
DescribeLocationNfsCommand | Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured. |
DescribeLocationObjectStorageCommand | Provides details about how an DataSync transfer location for an object storage system is configured. |
DescribeLocationS3Command | Provides details about how an DataSync transfer location for an S3 bucket is configured. |
DescribeLocationSmbCommand | Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured. |
DescribeStorageSystemCommand | Returns information about an on-premises storage system that you're using with DataSync Discovery. |
DescribeStorageSystemResourceMetricsCommand | Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system. |
DescribeStorageSystemResourcesCommand | Returns information that DataSync Discovery collects about resources in your on-premises storage system. |
DescribeTaskCommand | Provides information about a task, which defines where and how DataSync transfers your data. |
DescribeTaskExecutionCommand | Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing data transfer or check the results of the transfer. Some |
GenerateRecommendationsCommand | 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. |
ListAgentsCommand | 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. |
ListDiscoveryJobsCommand | 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. |
ListLocationsCommand | 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. |
ListStorageSystemsCommand | Lists the on-premises storage systems that you're using with DataSync Discovery. |
ListTagsForResourceCommand | Returns all the tags associated with an Amazon Web Services resource. |
ListTaskExecutionsCommand | Returns a list of executions for an DataSync transfer task. |
ListTasksCommand | Returns a list of the DataSync tasks you created. |
RemoveStorageSystemCommand | Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations. |
StartDiscoveryJobCommand | 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. |
StartTaskExecutionCommand | Starts an DataSync transfer task. For each task, you can only run one task execution at a time. There are several steps 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. |
StopDiscoveryJobCommand | 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. |
TagResourceCommand | 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. |
UntagResourceCommand | Removes tags from an Amazon Web Services resource. |
UpdateAgentCommand | Updates the name of an DataSync agent. |
UpdateDiscoveryJobCommand | Edits a DataSync discovery job configuration. |
UpdateLocationAzureBlobCommand | Modifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Azure Blob Storage . |
UpdateLocationEfsCommand | Modifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with Amazon EFS . |
UpdateLocationFsxLustreCommand | Modifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Lustre . |
UpdateLocationFsxOntapCommand | Modifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for ONTAP . |
UpdateLocationFsxOpenZfsCommand | Modifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for OpenZFS . Request parameters related to |
UpdateLocationFsxWindowsCommand | Modifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with FSx for Windows File Server . |
UpdateLocationHdfsCommand | Modifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an HDFS cluster . |
UpdateLocationNfsCommand | Modifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync. For more information, see Configuring transfers with an NFS file server . |
UpdateLocationObjectStorageCommand | Modifies the following configuration parameters of the object storage transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an object storage system . |
UpdateLocationS3Command | Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync. Before you begin, make sure that you read the following topics: |
UpdateLocationSmbCommand | Modifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync. For more information, see Configuring DataSync transfers with an SMB file server . |
UpdateStorageSystemCommand | Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery. |
UpdateTaskCommand | Updates the configuration of a task, which defines where and how DataSync transfers your data. |
UpdateTaskExecutionCommand | Updates the configuration of a running DataSync task execution. Currently, the only |
DataSyncClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: DataSyncClientConfig