View Source aws_datasync (aws v1.0.4)
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: https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html .Summary
Functions
Stops an DataSync task execution that's in progress.
Activates an DataSync agent that you've deployed in your storage environment.
Creates a transfer location for a Microsoft Azure Blob Storage container.
Creates a transfer location for an Amazon EFS file system.
Creates a transfer location for an Amazon FSx for Lustre file system.
Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.
Creates a transfer location for an Amazon FSx for OpenZFS file system.
Creates a transfer location for an Amazon FSx for Windows File Server file system.
Creates a transfer location for a Hadoop Distributed File System (HDFS).
Creates a transfer location for a Network File System (NFS) file server.
Creates a transfer location for an object storage system.
Creates a transfer location for an Amazon S3 bucket.
Creates a transfer location for a Server Message Block (SMB) file server.
Configures a transfer task, which defines where and how DataSync moves your data.
Removes an DataSync agent resource from your Amazon Web Services account.
Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.
Provides information about an execution of your DataSync task.
Creates recommendations about where to migrate your data to in Amazon Web Services.
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
Returns a list of source and destination locations.
Runs a DataSync discovery job on your on-premises storage system.
Starts an DataSync transfer task.
Stops a running DataSync discovery job.
Applies a tag to an Amazon Web Services resource.
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
Updates some parameters of an existing object storage location that DataSync accesses for a transfer.
Updates the configuration of a running DataSync task execution.
Functions
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.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:
Agent requirements: https://docs.aws.amazon.com/datasync/latest/userguide/agent-requirements.html
Create an agent: https://docs.aws.amazon.com/datasync/latest/userguide/configure-agent.html
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: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access and works with access tiers: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers and blob types: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types. You also need a DataSync agent: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent that can connect to your container.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access.
Request parameters related toSMB
aren't supported with the CreateLocationFsxOpenZfs
operation.
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: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs.
If you're copying data to or from an Snowcone device, you can also useCreateLocationNfs
to create your transfer location. For more information, see Configuring transfers with Snowcone: https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html.
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: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites for DataSync to work with object storage systems.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:
Storage class considerations with Amazon S3 locations: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes
Evaluating S3 request costs when using DataSync: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests
For more information, see Configuring transfers with Amazon S3: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests and the DataSync pricing page: http://aws.amazon.com/datasync/pricing/ before you begin.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: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html.Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, theDescribeLocationFsxOntap
operation doesn't actually return a Password
.
Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.
Response elements related toSMB
aren't supported with the DescribeLocationFsxOpenZfs
operation.
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.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: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html operation.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: https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html 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: https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html.
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.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: https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html operation.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: https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-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: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests and the DataSync pricing page: http://aws.amazon.com/datasync/pricing/ before you begin.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: https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html operation.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.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html.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: https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html.Updates the configuration of a running DataSync task execution.
Currently, the onlyOption
that you can modify with UpdateTaskExecution
is BytesPerSecond: https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond
, which throttles bandwidth for a running or queued task execution.