aws-elixir

View Source AWS.DataSync (aws-elixir 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

*.

Link to this section Summary

Functions

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

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

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

Stops an DataSync task execution that's in progress.

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

Activates an DataSync agent that you deploy in your storage environment.

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

Creates a transfer location for a Microsoft Azure Blob Storage container.

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

Creates a transfer location for an Amazon EFS file system.

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

Creates a transfer location for an Amazon FSx for Lustre file system.

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

Creates a transfer location for an Amazon FSx for NetApp ONTAP file system.

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

Creates a transfer location for an Amazon FSx for OpenZFS file system.

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

Creates a transfer location for an Amazon FSx for Windows File Server file system.

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

Creates a transfer location for a Hadoop Distributed File System (HDFS).

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

Creates a transfer location for a Network File System (NFS) file server.

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

Creates a transfer location for an object storage system.

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

Creates a transfer location for an Amazon S3 bucket.

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

Creates a transfer location for a Server Message Block (SMB) file server.

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

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

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

Removes an DataSync agent resource from your Amazon Web Services account.

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

Deletes a transfer location resource from DataSync.

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

Deletes a transfer task resource from DataSync.

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

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

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

Returns information about a DataSync discovery job.

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

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

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

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

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

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

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

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

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

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

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

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

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

Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

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

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

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

Provides details about how an DataSync transfer location for an object storage system is configured.

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

Provides details about how an DataSync transfer location for an S3 bucket is configured.

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

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

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

Returns information about an on-premises storage system that you're using with DataSync Discovery.

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

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

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

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

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

Provides information about a task, which defines where and how DataSync transfers your data.

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

Provides information about an execution of your DataSync task.

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

Creates recommendations about where to migrate your data to in Amazon Web Services.

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

Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.

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

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.

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

Returns a list of source and destination locations.

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

Lists the on-premises storage systems that you're using with DataSync Discovery.

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

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

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

Returns a list of executions for an DataSync transfer task.

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

Returns a list of the DataSync tasks you created.

metadata()
remove_storage_system(client, input, options \\ [])

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

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

Runs a DataSync discovery job on your on-premises storage system.

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

Starts an DataSync transfer task.

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

Stops a running DataSync discovery job.

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

Applies a tag to an Amazon Web Services resource.

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

Removes tags from an Amazon Web Services resource.

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

Updates the name of an DataSync agent.

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

Edits a DataSync discovery job configuration.

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

Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

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

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

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

Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.

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

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

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

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

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

Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

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

Updates the configuration of a task, which defines where and how DataSync transfers your data.

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

Updates the configuration of a running DataSync task execution.

Link to this section Functions

Link to this function

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

View Source

Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.

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 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?

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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 SMB aren't supported with the CreateLocationFsxOpenZfs operation.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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

Evaluating S3 request costs when using DataSync

For more information, see Configuring transfers with Amazon S3.

Link to this function

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

View Source

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.

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, 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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Deletes a transfer location resource from DataSync.

Link to this function

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

View Source

Deletes a transfer task resource from DataSync.

Link to this function

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

View Source

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

Link to this function

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

View Source

Returns information about a DataSync discovery job.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer 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 transfer 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 transfer 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

Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for an object storage system is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for an S3 bucket is configured.

Link to this function

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

View Source

Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.

Link to this function

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

View Source

Returns information about an on-premises storage system that you're using with DataSync Discovery.

Link to this function

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

View Source

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

Link to this function

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

View Source

Returns information that DataSync Discovery collects about resources in your on-premises storage system.

Link to this function

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

View Source

Provides information about a task, which defines where and how DataSync transfers your data.

Link to this function

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

View Source

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 DescribeTaskExecution response elements are only relevant to a specific task mode. For information, see Understanding task mode differences and Understanding data transfer performance counters.

Link to this function

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

View Source

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.

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_discovery_jobs(client, input, options \\ [])

View Source

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.

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_storage_systems(client, input, options \\ [])

View Source

Lists the on-premises storage systems that you're using with DataSync Discovery.

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 executions for an DataSync transfer task.

Link to this function

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

View Source

Returns a list of the DataSync tasks you created.

Link to this function

metadata()

View Source
Link to this function

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

View Source

Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

Link to this function

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

View Source

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.

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 DataSync agent.

Link to this function

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

View Source

Edits a DataSync discovery job configuration.

Link to this function

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

View Source

Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.

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

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.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.

Link to this function

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

View Source

Updates the configuration of a task, which defines where and how DataSync transfers your data.

Link to this function

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

View Source

Updates the configuration of a running DataSync task execution.

Currently, the only Option 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.