View Source AWS.DataSync (aws-elixir v0.13.3)

DataSync

DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Web Services storage services.

You also can use DataSync to transfer data between other cloud providers and Amazon Web Services storage services.

This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide .

Link to this section Summary

Functions

Stops an DataSync task execution that's in progress.

Activates an DataSync agent that you have deployed in your storage environment.

Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.

Creates an endpoint for an Amazon FSx for Lustre file system.

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.

Creates an endpoint for an Amazon FSx for OpenZFS file system that DataSync can access for a transfer.

Creates an endpoint for an Amazon FSx for Windows File Server file system.

Creates an endpoint for a Hadoop Distributed File System (HDFS).

Defines a file system on a Network File System (NFS) server that can be read from or written to.

Creates an endpoint for an object storage system that DataSync can access for a transfer.

Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.

Configures a task, which defines where and how DataSync transfers your data.

Deletes the configuration of a location used by DataSync.

Deletes an DataSync task.

Returns metadata about an DataSync agent, such as its name, endpoint type, and status.

Returns metadata about your DataSync location for an Amazon EFS file system.

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.

Provides details about how an DataSync location for an Amazon FSx for OpenZFS file system is configured.

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

Returns metadata, such as the path information, about an NFS location.

Returns metadata about your DataSync location for an object storage system.

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

Returns metadata, such as the path and user information about an SMB location.

Returns metadata about a task.

Returns detailed metadata about a task that is being executed.

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.

Returns all the tags associated with an Amazon Web Services resource.

Returns a list of executed tasks.

Returns a list of the DataSync tasks you created.

Applies a tag to an Amazon Web Services resource.

Removes tags from an Amazon Web Services resource.

Updates the name of an agent.

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

Updates some of the parameters of a previously created location for Network File System (NFS) access.

Updates some parameters of an existing object storage location that DataSync accesses for a transfer.

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.

Updates the metadata associated with a task.

Link to this section Functions

Link to this function

cancel_task_execution(client, input, options \\ [])

View Source

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.

Link to this function

create_agent(client, input, options \\ [])

View Source

Activates an DataSync agent that you have deployed in your storage environment.

The activation process associates your agent with your account. In the activation process, you specify information such as the Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services Region.

You can activate the agent in a VPC (virtual private cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by Amazon Web Services on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

Link to this function

create_location_efs(client, input, options \\ [])

View Source

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.

Link to this function

create_location_fsx_lustre(client, input, options \\ [])

View Source

Creates an endpoint for an Amazon FSx for Lustre file system.

Link to this function

create_location_fsx_ontap(client, input, options \\ [])

View Source

Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.

For more information, see Creating a location for FSx for ONTAP.

Link to this function

create_location_fsx_open_zfs(client, input, options \\ [])

View Source

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.

Link to this function

create_location_fsx_windows(client, input, options \\ [])

View Source

Creates an endpoint for an Amazon FSx for Windows File Server file system.

Link to this function

create_location_hdfs(client, input, options \\ [])

View Source

Creates an endpoint for a Hadoop Distributed File System (HDFS).

Link to this function

create_location_nfs(client, input, options \\ [])

View Source

Defines a file system on a Network File System (NFS) server that can be read from or written to.

Link to this function

create_location_object_storage(client, input, options \\ [])

View Source

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.

Link to this function

create_location_s3(client, input, options \\ [])

View Source

Creates an endpoint for an Amazon S3 bucket that DataSync can access for a transfer.

For more information, see Create an Amazon S3 location.

Link to this function

create_location_smb(client, input, options \\ [])

View Source

Creates an endpoint for a Server Message Block (SMB) file server that DataSync can access for a transfer.

For more information, see Creating an SMB location.

Link to this function

create_task(client, input, options \\ [])

View Source

Configures a task, which defines where and how DataSync transfers your data.

A task includes a source location, a destination location, and the preferences for how and when you want to transfer your data (such as bandwidth limits, scheduling, among other options).

Link to this function

delete_agent(client, input, options \\ [])

View Source

Deletes an agent.

To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your Amazon Web Services account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

Link to this function

delete_location(client, input, options \\ [])

View Source

Deletes the configuration of a location used by DataSync.

Link to this function

delete_task(client, input, options \\ [])

View Source

Deletes an DataSync task.

Link to this function

describe_agent(client, input, options \\ [])

View Source

Returns metadata about an DataSync agent, such as its name, endpoint type, and status.

Link to this function

describe_location_efs(client, input, options \\ [])

View Source

Returns metadata about your DataSync location for an Amazon EFS file system.

Link to this function

describe_location_fsx_lustre(client, input, options \\ [])

View Source

Provides details about how an DataSync location for an Amazon FSx for Lustre file system is configured.

Link to this function

describe_location_fsx_ontap(client, input, options \\ [])

View Source

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.

Link to this function

describe_location_fsx_open_zfs(client, input, options \\ [])

View Source

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.

Link to this function

describe_location_fsx_windows(client, input, options \\ [])

View Source

Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.

Link to this function

describe_location_hdfs(client, input, options \\ [])

View Source

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

Link to this function

describe_location_nfs(client, input, options \\ [])

View Source

Returns metadata, such as the path information, about an NFS location.

Link to this function

describe_location_object_storage(client, input, options \\ [])

View Source

Returns metadata about your DataSync location for an object storage system.

Link to this function

describe_location_s3(client, input, options \\ [])

View Source

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

Link to this function

describe_location_smb(client, input, options \\ [])

View Source

Returns metadata, such as the path and user information about an SMB location.

Link to this function

describe_task(client, input, options \\ [])

View Source

Returns metadata about a task.

Link to this function

describe_task_execution(client, input, options \\ [])

View Source

Returns detailed metadata about a task that is being executed.

Link to this function

list_agents(client, input, options \\ [])

View Source

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.

Link to this function

list_locations(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Returns all the tags associated with an Amazon Web Services resource.

Link to this function

list_task_executions(client, input, options \\ [])

View Source

Returns a list of executed tasks.

Link to this function

list_tasks(client, input, options \\ [])

View Source

Returns a list of the DataSync tasks you created.

Link to this function

start_task_execution(client, input, options \\ [])

View Source

Starts an DataSync 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.

Link to this function

tag_resource(client, input, options \\ [])

View Source

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.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes tags from an Amazon Web Services resource.

Link to this function

update_agent(client, input, options \\ [])

View Source

Updates the name of an agent.

Link to this function

update_location_hdfs(client, input, options \\ [])

View Source

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

Link to this function

update_location_nfs(client, input, options \\ [])

View Source

Updates some of the parameters of a previously created location for Network File System (NFS) access.

For information about creating an NFS location, see Creating a location for NFS.

Link to this function

update_location_object_storage(client, input, options \\ [])

View Source

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.

Link to this function

update_location_smb(client, input, options \\ [])

View Source

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.

For information about creating an SMB location, see Creating a location for SMB.

Link to this function

update_task(client, input, options \\ [])

View Source

Updates the metadata associated with a task.

Link to this function

update_task_execution(client, input, options \\ [])

View Source

Updates execution of a task.

You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.

The only Option that can be modified by UpdateTaskExecution is [BytesPerSecond](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond).