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 are 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]
[Tags => ArrayRef[Paws::Datasync::TagListEntry]]

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

For more information, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-agents.html#activating-agent" (Activating an Agent) in the AWS DataSync User Guide.

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.

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

Creates an endpoint for a Network File System (NFS) file system.

CreateLocationS3

S3BucketArn => Str
S3Config => Paws::Datasync::S3Config
[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 AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.

For more information, see "https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location" (Configuring Amazon S3 Location Settings) in the AWS DataSync User Guide.

CreateTask

DestinationLocationArn => Str
SourceLocationArn => Str
[CloudWatchLogGroupArn => Str]
[Excludes => ArrayRef[Paws::Datasync::FilterRule]]
[Name => Str]
[Options => Paws::Datasync::Options]
[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 is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.

If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.

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.

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 a NFS location.

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.

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

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

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

Returns: a Paws::Datasync::ListLocationsResponse instance

Returns a lists 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 resources.

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

[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 Task Execution in "https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-works.html#terminology" (Components and Terminology) 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.

UpdateTask

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

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

Returns: a Paws::Datasync::UpdateTaskResponse instance

Updates the metadata associated with a task.

PAGINATORS

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

ListAllAgents(sub { },[MaxResults => Int, NextToken => Str])

ListAllAgents([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Agents, passing the object as the first parameter, and the string 'Agents' as the second parameter 

If not, it will return a a Paws::Datasync::ListAgentsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllLocations(sub { },[MaxResults => Int, NextToken => Str])

ListAllLocations([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Locations, passing the object as the first parameter, and the string 'Locations' as the second parameter 

If not, it will return a a Paws::Datasync::ListLocationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTagsForResource(sub { },ResourceArn => Str, [MaxResults => Int, NextToken => Str])

ListAllTagsForResource(ResourceArn => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Tags, passing the object as the first parameter, and the string 'Tags' as the second parameter 

If not, it will return a a Paws::Datasync::ListTagsForResourceResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTaskExecutions(sub { },[MaxResults => Int, NextToken => Str, TaskArn => Str])

ListAllTaskExecutions([MaxResults => Int, NextToken => Str, TaskArn => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - TaskExecutions, passing the object as the first parameter, and the string 'TaskExecutions' as the second parameter 

If not, it will return a a Paws::Datasync::ListTaskExecutionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTasks(sub { },[MaxResults => Int, NextToken => Str])

ListAllTasks([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - Tasks, passing the object as the first parameter, and the string 'Tasks' as the second parameter 

If not, it will return a a Paws::Datasync::ListTasksResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues