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

AWS DataSync

AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).

This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.

Link to this section Summary

Functions

Activates an AWS DataSync agent that you have deployed on your host.

Creates an endpoint for an Amazon EFS file system.

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

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

Creates an endpoint for a self-managed object storage bucket.

Creates an endpoint for an Amazon S3 bucket.

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

Deletes the configuration of a location used by AWS DataSync.

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.

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

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

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

Returns metadata about a self-managed object storage server location.

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 agents owned by an AWS account in the AWS Region specified in the request.

Returns a list of source and destination locations.

Returns all the tags associated with a specified resource.

Returns a list of executed tasks.

Returns a list of all the tasks.

Starts a specific invocation of a task.

Applies a key-value pair to an AWS resource.

Removes a tag from an AWS resource.

Updates the name of an agent.

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

Updates some of the parameters of a previously created location for self-managed object storage server access.

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

Cancels execution of a task.

When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.

Link to this function

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

View Source

Activates an AWS DataSync agent that you have deployed on your host.

The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS 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 AWS 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.

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_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 a self-managed object storage bucket.

For more information about self-managed object storage locations, 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.

For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli in the AWS DataSync User Guide.

Link to this function

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

View Source

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

Link to this function

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

View Source

Creates a task.

A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.

When you create a task that transfers data between AWS services in different AWS Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.

You can transfer data between commercial AWS Regions except for China, or between AWS GovCloud (US-East and US-West) Regions.

When you use DataSync to copy files or objects between AWS Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.

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

Link to this function

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

View Source

Deletes a task.

Link to this function

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

View Source

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.

To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

Link to this function

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

View Source

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

Link to this function

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

View Source

Returns metadata, such as the path information about an Amazon FSx for Windows File Server 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 a self-managed object storage server location.

For more information about self-managed object storage locations, see Creating a location for object storage.

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 agents owned by an AWS account in the AWS Region specified in the request.

The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.

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 a specified 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 all the tasks.

Link to this function

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

View Source

Starts a specific invocation of a task.

A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZINGPREPARING
TRANSFERRINGVERIFYINGSUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.

Link to this function

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

View Source

Applies a key-value pair to an AWS resource.

Link to this function

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

View Source

Removes a tag from an AWS resource.

Link to this function

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

View Source

Updates the name of an agent.

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 of the parameters of a previously created location for self-managed object storage server access.

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