(constructor)

[configuration]

Constructs a new instance of the <code>DataSyncClient</code> class

config

The resolved configuration of DataSyncClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-datasync!DataSyncClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

DataSyncClient

<fullname>DataSync</fullname> 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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html">DataSync User Guide</a> .

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html">Do I need a DataSync agent?</a>

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access">how DataSync accesses Azure Blob Storage</a> and works with <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers">access tiers</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types">blob types</a>. You also need a <a href="https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent">DataSync agent</a> 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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access">accesses Amazon EFS file systems</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access">accesses FSx for Lustre file systems</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access">accesses FSx for ONTAP file systems</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access">accesses FSx for OpenZFS file systems</a>. <note> Request parameters related to <code>SMB</code> aren't supported with the <code>CreateLocationFsxOpenZfs</code> operation. </note>

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access">accesses FSx for Windows File Server file systems</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs">accesses HDFS clusters</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs">accesses NFS file servers</a>. <note> If you're copying data to or from an Snowcone device, you can also use <code>CreateLocationNfs</code> to create your transfer location. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html">Configuring transfers with Snowcone</a>. </note>

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites">prerequisites</a> 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. <important> Before you begin, make sure that you read the following topics: <ul> <li> <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes">Storage class considerations with Amazon S3 locations</a> </li> <li> <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">Evaluating S3 request costs when using DataSync</a> </li> </ul> </important> For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html">Configuring transfers with Amazon S3</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb">accesses SMB file servers</a>.

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). <important> If you're planning to transfer data to or from an Amazon S3 location, review <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how DataSync can affect your S3 request charges</a> and the <a href="http://aws.amazon.com/datasync/pricing/">DataSync pricing page</a> before you begin. </important>

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html">activate a new agent</a>.

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. <note> If your location uses SMB, the <code>DescribeLocationFsxOntap</code> operation doesn't actually return a <code>Password</code>. </note>

DescribeLocationFsxOpenZfsCommand

Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. <note> Response elements related to <code>SMB</code> aren't supported with the <code>DescribeLocationFsxOpenZfs</code> operation. </note>

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. <note> Some <code>DescribeTaskExecution</code> response elements are only relevant to a specific task mode. For information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences">Understanding task mode differences</a> and <a href="https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html">Understanding data transfer performance counters</a>. </note>

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html">Recommendations provided by DataSync Discovery</a>. Once generated, you can view your recommendations by using the <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html">DescribeStorageSystemResources</a> 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. <code>ListAgents</code> 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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html">CreateAgent</a> and then immediately run <code>ListAgents</code>, 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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html">DescribeAgent</a>.

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html">AddStorageSystem</a> 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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses">Task execution statuses</a>. <important> If you're planning to transfer data to or from an Amazon S3 location, review <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests">how DataSync can affect your S3 request charges</a> and the <a href="http://aws.amazon.com/datasync/pricing/">DataSync pricing page</a> before you begin. </important>

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 <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html">GenerateRecommendations</a> 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 some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

UpdateLocationHdfsCommand

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

UpdateLocationNfsCommand

Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync. For more information, see <a href="https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html">Configuring transfers to or from an NFS file server</a>.

UpdateLocationObjectStorageCommand

Updates some parameters of an existing DataSync location for an object storage system.

UpdateLocationSmbCommand

Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.

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. <note> Currently, the only <code>Option</code> that you can modify with <code>UpdateTaskExecution</code> is <code> <a href="https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond">BytesPerSecond</a> </code>, which throttles bandwidth for a running or queued task execution. </note>