NAME

Paws::Datasync - Perl Interface to AWS AWS DataSync

SYNOPSIS

use Paws;

my $obj = Paws->service('Datasync');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09

METHODS

CancelTaskExecution

TaskExecutionArn => Str

Each argument is described in detail in: Paws::Datasync::CancelTaskExecution

Returns: a Paws::Datasync::CancelTaskExecutionResponse instance

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.

CreateAgent

ActivationKey => Str
[AgentName => Str]
[SecurityGroupArns => ArrayRef[Str|Undef]]
[SubnetArns => ArrayRef[Str|Undef]]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]
[VpcEndpointId => Str]

Each argument is described in detail in: Paws::Datasync::CreateAgent

Returns: a Paws::Datasync::CreateAgentResponse instance

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.

CreateLocationEfs

Ec2Config => Paws::Datasync::Ec2Config
EfsFilesystemArn => Str
[Subdirectory => Str]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateLocationEfs

Returns: a Paws::Datasync::CreateLocationEfsResponse instance

Creates an endpoint for an Amazon EFS file system.

CreateLocationFsxWindows

FsxFilesystemArn => Str
Password => Str
SecurityGroupArns => ArrayRef[Str|Undef]
User => Str
[Domain => Str]
[Subdirectory => Str]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateLocationFsxWindows

Returns: a Paws::Datasync::CreateLocationFsxWindowsResponse instance

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

CreateLocationNfs

OnPremConfig => Paws::Datasync::OnPremConfig
ServerHostname => Str
Subdirectory => Str
[MountOptions => Paws::Datasync::NfsMountOptions]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateLocationNfs

Returns: a Paws::Datasync::CreateLocationNfsResponse instance

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

CreateLocationObjectStorage

AgentArns => ArrayRef[Str|Undef]
BucketName => Str
ServerHostname => Str
[AccessKey => Str]
[SecretKey => Str]
[ServerPort => Int]
[ServerProtocol => Str]
[Subdirectory => Str]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateLocationObjectStorage

Returns: a Paws::Datasync::CreateLocationObjectStorageResponse instance

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 (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

CreateLocationS3

S3BucketArn => Str
S3Config => Paws::Datasync::S3Config
[AgentArns => ArrayRef[Str|Undef]]
[S3StorageClass => Str]
[Subdirectory => Str]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateLocationS3

Returns: a Paws::Datasync::CreateLocationS3Response instance

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.

CreateLocationSmb

AgentArns => ArrayRef[Str|Undef]
Password => Str
ServerHostname => Str
Subdirectory => Str
User => Str
[Domain => Str]
[MountOptions => Paws::Datasync::SmbMountOptions]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateLocationSmb

Returns: a Paws::Datasync::CreateLocationSmbResponse instance

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

CreateTask

DestinationLocationArn => Str
SourceLocationArn => Str
[CloudWatchLogGroupArn => Str]
[Excludes => ArrayRef[Paws::Datasync::FilterRule]]
[Name => Str]
[Options => Paws::Datasync::Options]
[Schedule => Paws::Datasync::TaskSchedule]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

Each argument is described in detail in: Paws::Datasync::CreateTask

Returns: a Paws::Datasync::CreateTaskResponse instance

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 (http://aws.amazon.com/ec2/pricing/on-demand/#Data_Transfer).

DeleteAgent

AgentArn => Str

Each argument is described in detail in: Paws::Datasync::DeleteAgent

Returns: a Paws::Datasync::DeleteAgentResponse instance

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.

DeleteLocation

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DeleteLocation

Returns: a Paws::Datasync::DeleteLocationResponse instance

Deletes the configuration of a location used by AWS DataSync.

DeleteTask

TaskArn => Str

Each argument is described in detail in: Paws::Datasync::DeleteTask

Returns: a Paws::Datasync::DeleteTaskResponse instance

Deletes a task.

DescribeAgent

AgentArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeAgent

Returns: a Paws::Datasync::DescribeAgentResponse instance

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.

DescribeLocationEfs

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeLocationEfs

Returns: a Paws::Datasync::DescribeLocationEfsResponse instance

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

DescribeLocationFsxWindows

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeLocationFsxWindows

Returns: a Paws::Datasync::DescribeLocationFsxWindowsResponse instance

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

DescribeLocationNfs

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeLocationNfs

Returns: a Paws::Datasync::DescribeLocationNfsResponse instance

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

DescribeLocationObjectStorage

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeLocationObjectStorage

Returns: a Paws::Datasync::DescribeLocationObjectStorageResponse instance

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 (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

DescribeLocationS3

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeLocationS3

Returns: a Paws::Datasync::DescribeLocationS3Response instance

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

DescribeLocationSmb

LocationArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeLocationSmb

Returns: a Paws::Datasync::DescribeLocationSmbResponse instance

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

DescribeTask

TaskArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeTask

Returns: a Paws::Datasync::DescribeTaskResponse instance

Returns metadata about a task.

DescribeTaskExecution

TaskExecutionArn => Str

Each argument is described in detail in: Paws::Datasync::DescribeTaskExecution

Returns: a Paws::Datasync::DescribeTaskExecutionResponse instance

Returns detailed metadata about a task that is being executed.

ListAgents

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Datasync::ListAgents

Returns: a Paws::Datasync::ListAgentsResponse instance

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.

ListLocations

[Filters => ArrayRef[Paws::Datasync::LocationFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Datasync::ListLocations

Returns: a Paws::Datasync::ListLocationsResponse instance

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.

ListTagsForResource

ResourceArn => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Datasync::ListTagsForResource

Returns: a Paws::Datasync::ListTagsForResourceResponse instance

Returns all the tags associated with a specified resource.

ListTaskExecutions

[MaxResults => Int]
[NextToken => Str]
[TaskArn => Str]

Each argument is described in detail in: Paws::Datasync::ListTaskExecutions

Returns: a Paws::Datasync::ListTaskExecutionsResponse instance

Returns a list of executed tasks.

ListTasks

[Filters => ArrayRef[Paws::Datasync::TaskFilter]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Datasync::ListTasks

Returns: a Paws::Datasync::ListTasksResponse instance

Returns a list of all the tasks.

StartTaskExecution

TaskArn => Str
[Includes => ArrayRef[Paws::Datasync::FilterRule]]
[OverrideOptions => Paws::Datasync::Options]

Each argument is described in detail in: Paws::Datasync::StartTaskExecution

Returns: a Paws::Datasync::StartTaskExecutionResponse instance

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: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

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

TagResource

ResourceArn => Str
Tags => ArrayRef[Paws::Datasync::TagListEntry]

Each argument is described in detail in: Paws::Datasync::TagResource

Returns: a Paws::Datasync::TagResourceResponse instance

Applies a key-value pair to an AWS resource.

UntagResource

Keys => ArrayRef[Str|Undef]
ResourceArn => Str

Each argument is described in detail in: Paws::Datasync::UntagResource

Returns: a Paws::Datasync::UntagResourceResponse instance

Removes a tag from an AWS resource.

UpdateAgent

AgentArn => Str
[Name => Str]

Each argument is described in detail in: Paws::Datasync::UpdateAgent

Returns: a Paws::Datasync::UpdateAgentResponse instance

Updates the name of an agent.

UpdateLocationNfs

LocationArn => Str
[MountOptions => Paws::Datasync::NfsMountOptions]
[OnPremConfig => Paws::Datasync::OnPremConfig]
[Subdirectory => Str]

Each argument is described in detail in: Paws::Datasync::UpdateLocationNfs

Returns: a Paws::Datasync::UpdateLocationNfsResponse instance

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 (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html).

UpdateLocationObjectStorage

LocationArn => Str
[AccessKey => Str]
[AgentArns => ArrayRef[Str|Undef]]
[SecretKey => Str]
[ServerPort => Int]
[ServerProtocol => Str]
[Subdirectory => Str]

Each argument is described in detail in: Paws::Datasync::UpdateLocationObjectStorage

Returns: a Paws::Datasync::UpdateLocationObjectStorageResponse instance

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 (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

UpdateLocationSmb

LocationArn => Str
[AgentArns => ArrayRef[Str|Undef]]
[Domain => Str]
[MountOptions => Paws::Datasync::SmbMountOptions]
[Password => Str]
[Subdirectory => Str]
[User => Str]

Each argument is described in detail in: Paws::Datasync::UpdateLocationSmb

Returns: a Paws::Datasync::UpdateLocationSmbResponse instance

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 (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html).

UpdateTask

TaskArn => Str
[CloudWatchLogGroupArn => Str]
[Excludes => ArrayRef[Paws::Datasync::FilterRule]]
[Name => Str]
[Options => Paws::Datasync::Options]
[Schedule => Paws::Datasync::TaskSchedule]

Each argument is described in detail in: Paws::Datasync::UpdateTask

Returns: a Paws::Datasync::UpdateTaskResponse instance

Updates the metadata associated with a task.

UpdateTaskExecution

Options => Paws::Datasync::Options
TaskExecutionArn => Str

Each argument is described in detail in: Paws::Datasync::UpdateTaskExecution

Returns: a Paws::Datasync::UpdateTaskExecutionResponse instance

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 (https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling).

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results