Amazon Web Services, Inc.

AWS DataSync

DataSync In addition to the Amazon Web Services Management Console and Amazon Web Services Command Line Interface, you can use the DataSync API to configure…

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

DataSync
In addition to the Amazon Web Services Management Console and Amazon Web Services Command Line Interface,
you can use the DataSync API to configure and manage DataSync with the
Amazon Web Services SDKs .
DataSync is an online data movement 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
.

Endpoints 53

  • POSTCancel task execution/#X-Amz-Target=FmrsService.CancelTaskExecutionStops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination…
  • POSTCreate agent/#X-Amz-Target=FmrsService.CreateAgentActivates an DataSync agent that you deploy in your storage environment. The activation process associates the agent with your Amazon Web Services account. If…
  • POSTCreate location azure blob/#X-Amz-Target=FmrsService.CreateLocationAzureBlobCreates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination. You can make…
  • POSTCreate location efs/#X-Amz-Target=FmrsService.CreateLocationEfsCreates 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,…
  • POSTCreate location fsx lustre/#X-Amz-Target=FmrsService.CreateLocationFsxLustreCreates 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…
  • POSTCreate location fsx ontap/#X-Amz-Target=FmrsService.CreateLocationFsxOntapCreates 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.…
  • POSTCreate location fsx open zfs/#X-Amz-Target=FmrsService.CreateLocationFsxOpenZfsCreates 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…
  • POSTCreate location fsx windows/#X-Amz-Target=FmrsService.CreateLocationFsxWindowsCreates 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…
  • POSTCreate location hdfs/#X-Amz-Target=FmrsService.CreateLocationHdfsCreates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.…
  • POSTCreate location nfs/#X-Amz-Target=FmrsService.CreateLocationNfsCreates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.…
  • POSTCreate location object storage/#X-Amz-Target=FmrsService.CreateLocationObjectStorageCreates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data. You can make…
  • POSTCreate location s3/#X-Amz-Target=FmrsService.CreateLocationS3Creates 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…
  • POSTCreate location smb/#X-Amz-Target=FmrsService.CreateLocationSmbCreates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.…
  • POSTCreate task/#X-Amz-Target=FmrsService.CreateTaskConfigures a task , which defines where and how DataSync transfers your data. A task includes a source location, destination location, and transfer options…
  • POSTDelete agent/#X-Amz-Target=FmrsService.DeleteAgentRemoves 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…
  • POSTDelete location/#X-Amz-Target=FmrsService.DeleteLocationDeletes a transfer location resource from DataSync.
  • POSTDelete task/#X-Amz-Target=FmrsService.DeleteTaskDeletes a transfer task resource from DataSync.
  • POSTDescribe agent/#X-Amz-Target=FmrsService.DescribeAgentReturns information about an DataSync agent, such as its name, service endpoint type, and status.
  • POSTDescribe location azure blob/#X-Amz-Target=FmrsService.DescribeLocationAzureBlobProvides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
  • POSTDescribe location efs/#X-Amz-Target=FmrsService.DescribeLocationEfsProvides details about how an DataSync transfer location for an Amazon EFS file system is configured.
  • POSTDescribe location fsx lustre/#X-Amz-Target=FmrsService.DescribeLocationFsxLustreProvides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
  • POSTDescribe location fsx ontap/#X-Amz-Target=FmrsService.DescribeLocationFsxOntapProvides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured. If your location uses SMB, the…
  • POSTDescribe location fsx open zfs/#X-Amz-Target=FmrsService.DescribeLocationFsxOpenZfsProvides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured. Response elements related to SMB aren't…
  • POSTDescribe location fsx windows/#X-Amz-Target=FmrsService.DescribeLocationFsxWindowsProvides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
  • POSTDescribe location hdfs/#X-Amz-Target=FmrsService.DescribeLocationHdfsProvides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
  • POSTDescribe location nfs/#X-Amz-Target=FmrsService.DescribeLocationNfsProvides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
  • POSTDescribe location object storage/#X-Amz-Target=FmrsService.DescribeLocationObjectStorageProvides details about how an DataSync transfer location for an object storage system is configured.
  • POSTDescribe location s3/#X-Amz-Target=FmrsService.DescribeLocationS3Provides details about how an DataSync transfer location for an S3 bucket is configured.
  • POSTDescribe location smb/#X-Amz-Target=FmrsService.DescribeLocationSmbProvides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
  • POSTDescribe task/#X-Amz-Target=FmrsService.DescribeTaskProvides information about a task , which defines where and how DataSync transfers your data.
  • POSTDescribe task execution/#X-Amz-Target=FmrsService.DescribeTaskExecutionProvides 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…
  • POSTList agents/#X-Amz-Target=FmrsService.ListAgentsReturns 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,…
  • POSTList locations/#X-Amz-Target=FmrsService.ListLocationsReturns 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…
  • POSTList tags for resource/#X-Amz-Target=FmrsService.ListTagsForResourceReturns all the tags associated with an Amazon Web Services resource.
  • POSTList task executions/#X-Amz-Target=FmrsService.ListTaskExecutionsReturns a list of executions for an DataSync transfer task.
  • POSTList tasks/#X-Amz-Target=FmrsService.ListTasksReturns a list of the DataSync tasks you created.
  • POSTStart task execution/#X-Amz-Target=FmrsService.StartTaskExecutionStarts 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…
  • POSTTag resource/#X-Amz-Target=FmrsService.TagResourceApplies 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…
  • POSTUntag resource/#X-Amz-Target=FmrsService.UntagResourceRemoves tags from an Amazon Web Services resource.
  • POSTUpdate agent/#X-Amz-Target=FmrsService.UpdateAgentUpdates the name of an DataSync agent.
  • POSTUpdate location azure blob/#X-Amz-Target=FmrsService.UpdateLocationAzureBlobModifies the following configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync. For more information, see…
  • POSTUpdate location efs/#X-Amz-Target=FmrsService.UpdateLocationEfsModifies the following configuration parameters of the Amazon EFS transfer location that you're using with DataSync. For more information, see Configuring…
  • POSTUpdate location fsx lustre/#X-Amz-Target=FmrsService.UpdateLocationFsxLustreModifies the following configuration parameters of the Amazon FSx for Lustre transfer location that you're using with DataSync. For more information, see…
  • POSTUpdate location fsx ontap/#X-Amz-Target=FmrsService.UpdateLocationFsxOntapModifies the following configuration parameters of the Amazon FSx for NetApp ONTAP transfer location that you're using with DataSync. For more information,…
  • POSTUpdate location fsx open zfs/#X-Amz-Target=FmrsService.UpdateLocationFsxOpenZfsModifies the following configuration parameters of the Amazon FSx for OpenZFS transfer location that you're using with DataSync. For more information, see…
  • POSTUpdate location fsx windows/#X-Amz-Target=FmrsService.UpdateLocationFsxWindowsModifies the following configuration parameters of the Amazon FSx for Windows File Server transfer location that you're using with DataSync. For more…
  • POSTUpdate location hdfs/#X-Amz-Target=FmrsService.UpdateLocationHdfsModifies the following configuration parameters of the Hadoop Distributed File System (HDFS) transfer location that you're using with DataSync. For more…
  • POSTUpdate location nfs/#X-Amz-Target=FmrsService.UpdateLocationNfsModifies the following configuration parameters of the Network File System (NFS) transfer location that you're using with DataSync. For more information, see…
  • POSTUpdate location object storage/#X-Amz-Target=FmrsService.UpdateLocationObjectStorageModifies the following configuration parameters of the object storage transfer location that you're using with DataSync. For more information, see Configuring…
  • POSTUpdate location s3/#X-Amz-Target=FmrsService.UpdateLocationS3Modifies the following configuration parameters of the Amazon S3 transfer location that you're using with DataSync. Before you begin, make sure that you read…
  • POSTUpdate location smb/#X-Amz-Target=FmrsService.UpdateLocationSmbModifies the following configuration parameters of the Server Message Block (SMB) transfer location that you're using with DataSync. For more information, see…
  • POSTUpdate task/#X-Amz-Target=FmrsService.UpdateTaskUpdates the configuration of a task , which defines where and how DataSync transfers your data.
  • POSTUpdate task execution/#X-Amz-Target=FmrsService.UpdateTaskExecutionUpdates the configuration of a running DataSync task execution. Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond ,…

API details

Base URL
https://datasync.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
53 operations on 53 pathsPOST 53
Description format
AWS Smithy model, API version 2018-11-09

How to test the AWS DataSync in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS DataSync collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Cancel task execution” (POST /#X-Amz-Target=FmrsService.CancelTaskExecution), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS DataSync?

DataSync In addition to the Amazon Web Services Management Console and Amazon Web Services Command Line Interface, you can use the DataSync API to configure… It is listed under Data & analytics and has 53 endpoints.

Who publishes the AWS DataSync?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS DataSync?

Requests go to https://datasync.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS DataSync?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS DataSync have?

53 operations on 53 paths (53 POST).

Is forking the AWS DataSync free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.