AWS SDK for PHP 3.x

Service ID: datasync

Version: 2018-11-09

This page describes the parameters and results for the operations of the AWS DataSync (2018-11-09), and shows how to use the Aws\DataSync\DataSyncClient object to call the described operations. This documentation is specific to the 2018-11-09 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelTaskExecution ( array $params = [] )
Cancels execution of a task.
CreateAgent ( array $params = [] )
Activates an AWS DataSync agent that you have deployed on your host.
CreateLocationEfs ( array $params = [] )
Creates an endpoint for an Amazon EFS file system.
CreateLocationFsxWindows ( array $params = [] )
Creates an endpoint for an Amazon FSx for Windows file system.
CreateLocationNfs ( array $params = [] )
Defines a file system on a Network File System (NFS) server that can be read from or written to.
CreateLocationObjectStorage ( array $params = [] )
Creates an endpoint for a self-managed object storage bucket.
CreateLocationS3 ( array $params = [] )
Creates an endpoint for an Amazon S3 bucket.
CreateLocationSmb ( array $params = [] )
Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
CreateTask ( array $params = [] )
Creates a task.
DeleteAgent ( array $params = [] )
Deletes an agent.
DeleteLocation ( array $params = [] )
Deletes the configuration of a location used by AWS DataSync.
DeleteTask ( array $params = [] )
Deletes a task.
DescribeAgent ( array $params = [] )
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent.
DescribeLocationEfs ( array $params = [] )
Returns metadata, such as the path information about an Amazon EFS location.
DescribeLocationFsxWindows ( array $params = [] )
Returns metadata, such as the path information about an Amazon FSx for Windows location.
DescribeLocationNfs ( array $params = [] )
Returns metadata, such as the path information, about an NFS location.
DescribeLocationObjectStorage ( array $params = [] )
Returns metadata about a self-managed object storage server location.
DescribeLocationS3 ( array $params = [] )
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
DescribeLocationSmb ( array $params = [] )
Returns metadata, such as the path and user information about an SMB location.
DescribeTask ( array $params = [] )
Returns metadata about a task.
DescribeTaskExecution ( array $params = [] )
Returns detailed metadata about a task that is being executed.
ListAgents ( array $params = [] )
Returns a list of agents owned by an AWS account in the AWS Region specified in the request.
ListLocations ( array $params = [] )
Returns a list of source and destination locations.
ListTagsForResource ( array $params = [] )
Returns all the tags associated with a specified resource.
ListTaskExecutions ( array $params = [] )
Returns a list of executed tasks.
ListTasks ( array $params = [] )
Returns a list of all the tasks.
StartTaskExecution ( array $params = [] )
Starts a specific invocation of a task.
TagResource ( array $params = [] )
Applies a key-value pair to an AWS resource.
UntagResource ( array $params = [] )
Removes a tag from an AWS resource.
UpdateAgent ( array $params = [] )
Updates the name of an agent.
UpdateTask ( array $params = [] )
Updates the metadata associated with a task.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAgents
ListLocations
ListTagsForResource
ListTaskExecutions
ListTasks

Operations

CancelTaskExecution

$result = $client->cancelTaskExecution([/* ... */]);
$promise = $client->cancelTaskExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->cancelTaskExecution([
    'TaskExecutionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

TaskExecutionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the task execution to cancel.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateAgent

$result = $client->createAgent([/* ... */]);
$promise = $client->createAgentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createAgent([
    'ActivationKey' => '<string>', // REQUIRED
    'AgentName' => '<string>',
    'SecurityGroupArns' => ['<string>', ...],
    'SubnetArns' => ['<string>', ...],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'VpcEndpointId' => '<string>',
]);

Parameter Details

Members

ActivationKey

Required: Yes
Type: string

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

For more information, see Activating an Agent in the AWS DataSync User Guide.

AgentName

Type: string

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

SecurityGroupArns

Type: Array of strings

The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.

SubnetArns

Type: Array of strings

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

VpcEndpointId

Type: string

The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

Result Syntax

[
    'AgentArn' => '<string>',
]

Result Details

Members

AgentArn

Type: string

The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and AWS Region.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateLocationEfs

$result = $client->createLocationEfs([/* ... */]);
$promise = $client->createLocationEfsAsync([/* ... */]);

Creates an endpoint for an Amazon EFS file system.

Parameter Syntax

$result = $client->createLocationEfs([
    'Ec2Config' => [ // REQUIRED
        'SecurityGroupArns' => ['<string>', ...], // REQUIRED
        'SubnetArn' => '<string>', // REQUIRED
    ],
    'EfsFilesystemArn' => '<string>', // REQUIRED
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

Ec2Config

Required: Yes
Type: Ec2Config structure

The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:

Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.
Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.

For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.

EfsFilesystemArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the Amazon EFS file system.

Subdirectory

Type: string

A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateLocationFsxWindows

$result = $client->createLocationFsxWindows([/* ... */]);
$promise = $client->createLocationFsxWindowsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLocationFsxWindows([
    'Domain' => '<string>',
    'FsxFilesystemArn' => '<string>', // REQUIRED
    'Password' => '<string>', // REQUIRED
    'SecurityGroupArns' => ['<string>', ...], // REQUIRED
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'User' => '<string>', // REQUIRED
]);

Parameter Details

Members

Domain

Type: string

The name of the Windows domain that the FSx for Windows server belongs to.

FsxFilesystemArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) for the FSx for Windows file system.

Password

Required: Yes
Type: string

The password of the user who has the permissions to access files and folders in the FSx for Windows file system.

SecurityGroupArns

Required: Yes
Type: Array of strings

The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.

Subdirectory

Type: string

A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.

Tags

Type: Array of TagListEntry structures

User

Required: Yes
Type: string

The user who has the permissions to access files and folders in the FSx for Windows file system.

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the FSx for Windows file system location that is created.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateLocationNfs

$result = $client->createLocationNfs([/* ... */]);
$promise = $client->createLocationNfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLocationNfs([
    'MountOptions' => [
        'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
    ],
    'OnPremConfig' => [ // REQUIRED
        'AgentArns' => ['<string>', ...], // REQUIRED
    ],
    'ServerHostname' => '<string>', // REQUIRED
    'Subdirectory' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

MountOptions

Type: NfsMountOptions structure

The NFS mount options that DataSync can use to mount your NFS share.

OnPremConfig

Required: Yes
Type: OnPremConfig structure

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

ServerHostname

Required: Yes
Type: string

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Subdirectory

Required: Yes
Type: string

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server. run "showmount -e nfs-server-name" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the source NFS file system location that is created.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateLocationObjectStorage

$result = $client->createLocationObjectStorage([/* ... */]);
$promise = $client->createLocationObjectStorageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLocationObjectStorage([
    'AccessKey' => '<string>',
    'AgentArns' => ['<string>', ...], // REQUIRED
    'BucketName' => '<string>', // REQUIRED
    'SecretKey' => '<string>',
    'ServerHostname' => '<string>', // REQUIRED
    'ServerPort' => <integer>,
    'ServerProtocol' => 'HTTPS|HTTP',
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

AccessKey

Type: string

Optional. The access key is used if credentials are required to access the self-managed object storage server.

AgentArns

Required: Yes
Type: Array of strings

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

BucketName

Required: Yes
Type: string

The bucket on the self-managed object storage server that is used to read data from.

SecretKey

Type: string

Optional. The secret key is used if credentials are required to access the self-managed object storage server.

ServerHostname

Required: Yes
Type: string

The name of the self-managed object storage server. This value is the IP address or Domain Name Service (DNS) name of the object storage server. An agent uses this host name to mount the object storage server in a network.

ServerPort

Type: int

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

ServerProtocol

Type: string

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

Subdirectory

Type: string

The subdirectory in the self-managed object storage server that is used to read data from.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateLocationS3

$result = $client->createLocationS3([/* ... */]);
$promise = $client->createLocationS3Async([/* ... */]);

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 in the AWS DataSync User Guide.

Parameter Syntax

$result = $client->createLocationS3([
    'S3BucketArn' => '<string>', // REQUIRED
    'S3Config' => [ // REQUIRED
        'BucketAccessRoleArn' => '<string>', // REQUIRED
    ],
    'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE',
    'Subdirectory' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

S3BucketArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

S3Config

Required: Yes
Type: S3Config structure

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.

S3StorageClass

Type: string

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage Service Developer Guide. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

Subdirectory

Type: string

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateLocationSmb

$result = $client->createLocationSmb([/* ... */]);
$promise = $client->createLocationSmbAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createLocationSmb([
    'AgentArns' => ['<string>', ...], // REQUIRED
    'Domain' => '<string>',
    'MountOptions' => [
        'Version' => 'AUTOMATIC|SMB2|SMB3',
    ],
    'Password' => '<string>', // REQUIRED
    'ServerHostname' => '<string>', // REQUIRED
    'Subdirectory' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
    'User' => '<string>', // REQUIRED
]);

Parameter Details

Members

AgentArns

Required: Yes
Type: Array of strings

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

Domain

Type: string

The name of the Windows domain that the SMB server belongs to.

MountOptions

Type: SmbMountOptions structure

The mount options used by DataSync to access the SMB server.

Password

Required: Yes
Type: string

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

ServerHostname

Required: Yes
Type: string

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

Subdirectory

Required: Yes
Type: string

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

Subdirectory must be specified with forward slashes. For example, /path/to/folder.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

User

Required: Yes
Type: string

The user who can mount the share, has the permissions to access files and folders in the SMB share.

Result Syntax

[
    'LocationArn' => '<string>',
]

Result Details

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

CreateTask

$result = $client->createTask([/* ... */]);
$promise = $client->createTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createTask([
    'CloudWatchLogGroupArn' => '<string>',
    'DestinationLocationArn' => '<string>', // REQUIRED
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
        'LogLevel' => 'OFF|BASIC|TRANSFER',
        'Mtime' => 'NONE|PRESERVE',
        'OverwriteMode' => 'ALWAYS|NEVER',
        'PosixPermissions' => 'NONE|PRESERVE',
        'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
        'PreserveDevices' => 'NONE|PRESERVE',
        'TaskQueueing' => 'ENABLED|DISABLED',
        'TransferMode' => 'CHANGED|ALL',
        'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
        'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|ONLY_FILES_TRANSFERRED|NONE',
    ],
    'Schedule' => [
        'ScheduleExpression' => '<string>', // REQUIRED
    ],
    'SourceLocationArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

CloudWatchLogGroupArn

Type: string

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

DestinationLocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of an AWS storage resource's location.

Excludes

Type: Array of FilterRule structures

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example, "/folder1|/folder2"

Name

Type: string

The name of a task. This value is a text reference that is used to identify the task in the console.

Options

Type: Options structure

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting the task execution. For more information, see the operation.

Schedule

Type: TaskSchedule structure

Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule should be specified in UTC time. For more information, see task-scheduling.

SourceLocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the source location for the task.

Tags

Type: Array of TagListEntry structures

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

Result Syntax

[
    'TaskArn' => '<string>',
]

Result Details

Members

TaskArn

Type: string

The Amazon Resource Name (ARN) of the task.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DeleteAgent

$result = $client->deleteAgent([/* ... */]);
$promise = $client->deleteAgentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteAgent([
    'AgentArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AgentArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and AWS Region.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DeleteLocation

$result = $client->deleteLocation([/* ... */]);
$promise = $client->deleteLocationAsync([/* ... */]);

Deletes the configuration of a location used by AWS DataSync.

Parameter Syntax

$result = $client->deleteLocation([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the location to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DeleteTask

$result = $client->deleteTask([/* ... */]);
$promise = $client->deleteTaskAsync([/* ... */]);

Deletes a task.

Parameter Syntax

$result = $client->deleteTask([
    'TaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

TaskArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the task to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeAgent

$result = $client->describeAgent([/* ... */]);
$promise = $client->describeAgentAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->describeAgent([
    'AgentArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AgentArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the agent to describe.

Result Syntax

[
    'AgentArn' => '<string>',
    'CreationTime' => <DateTime>,
    'EndpointType' => 'PUBLIC|PRIVATE_LINK|FIPS',
    'LastConnectionTime' => <DateTime>,
    'Name' => '<string>',
    'PrivateLinkConfig' => [
        'PrivateLinkEndpoint' => '<string>',
        'SecurityGroupArns' => ['<string>', ...],
        'SubnetArns' => ['<string>', ...],
        'VpcEndpointId' => '<string>',
    ],
    'Status' => 'ONLINE|OFFLINE',
]

Result Details

Members

AgentArn

Type: string

The Amazon Resource Name (ARN) of the agent.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the agent was activated (that is, created in your account).

EndpointType

Type: string

The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public internet.

LastConnectionTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the agent last connected to DataSyc.

Name

Type: string

The name of the agent.

PrivateLinkConfig

Type: PrivateLinkConfig structure

The subnet and the security group that DataSync used to access a VPC endpoint.

Status

Type: string

The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeLocationEfs

$result = $client->describeLocationEfs([/* ... */]);
$promise = $client->describeLocationEfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationEfs([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the EFS location to describe.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'Ec2Config' => [
        'SecurityGroupArns' => ['<string>', ...],
        'SubnetArn' => '<string>',
    ],
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the EFS location was created.

Ec2Config

Type: Ec2Config structure

The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

LocationArn

Type: string

The Amazon Resource Name (ARN) of the EFS location that was described.

LocationUri

Type: string

The URL of the EFS location that was described.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeLocationFsxWindows

$result = $client->describeLocationFsxWindows([/* ... */]);
$promise = $client->describeLocationFsxWindowsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationFsxWindows([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the FSx for Windows location to describe.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'Domain' => '<string>',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'SecurityGroupArns' => ['<string>', ...],
    'User' => '<string>',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the FSx for Windows location was created.

Domain

Type: string

The name of the Windows domain that the FSx for Windows server belongs to.

LocationArn

Type: string

The Amazon Resource Name (ARN) of the FSx for Windows location that was described.

LocationUri

Type: string

The URL of the FSx for Windows location that was described.

SecurityGroupArns

Type: Array of strings

The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows file system.

User

Type: string

The user who has the permissions to access files and folders in the FSx for Windows file system.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeLocationNfs

$result = $client->describeLocationNfs([/* ... */]);
$promise = $client->describeLocationNfsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationNfs([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the NFS location to describe.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'MountOptions' => [
        'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1',
    ],
    'OnPremConfig' => [
        'AgentArns' => ['<string>', ...],
    ],
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the NFS location was created.

LocationArn

Type: string

The Amazon Resource Name (ARN) of the NFS location that was described.

LocationUri

Type: string

The URL of the source NFS location that was described.

MountOptions

Type: NfsMountOptions structure

The NFS mount options that DataSync used to mount your NFS share.

OnPremConfig

Type: OnPremConfig structure

A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeLocationObjectStorage

$result = $client->describeLocationObjectStorage([/* ... */]);
$promise = $client->describeLocationObjectStorageAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationObjectStorage([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the self-managed object storage server location that was described.

Result Syntax

[
    'AccessKey' => '<string>',
    'AgentArns' => ['<string>', ...],
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'ServerPort' => <integer>,
    'ServerProtocol' => 'HTTPS|HTTP',
]

Result Details

Members

AccessKey

Type: string

Optional. The access key is used if credentials are required to access the self-managed object storage server.

AgentArns

Type: Array of strings

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the self-managed object storage server agent was created.

LocationArn

Type: string

The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.

LocationUri

Type: string

The URL of the source self-managed object storage server location that was described.

ServerPort

Type: int

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).

ServerProtocol

Type: string

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeLocationS3

$result = $client->describeLocationS3([/* ... */]);
$promise = $client->describeLocationS3Async([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationS3([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

Result Syntax

[
    'CreationTime' => <DateTime>,
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'S3Config' => [
        'BucketAccessRoleArn' => '<string>',
    ],
    'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE',
]

Result Details

Members

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the Amazon S3 bucket location was created.

LocationArn

Type: string

The Amazon Resource Name (ARN) of the Amazon S3 bucket location.

LocationUri

Type: string

The URL of the Amazon S3 location that was described.

S3Config

Type: S3Config structure

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.

S3StorageClass

Type: string

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage Service Developer Guide. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeLocationSmb

$result = $client->describeLocationSmb([/* ... */]);
$promise = $client->describeLocationSmbAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeLocationSmb([
    'LocationArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

LocationArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the SMB location to describe.

Result Syntax

[
    'AgentArns' => ['<string>', ...],
    'CreationTime' => <DateTime>,
    'Domain' => '<string>',
    'LocationArn' => '<string>',
    'LocationUri' => '<string>',
    'MountOptions' => [
        'Version' => 'AUTOMATIC|SMB2|SMB3',
    ],
    'User' => '<string>',
]

Result Details

Members

AgentArns

Type: Array of strings

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the SMB location was created.

Domain

Type: string

The name of the Windows domain that the SMB server belongs to.

LocationArn

Type: string

The Amazon Resource Name (ARN) of the SMB location that was described.

LocationUri

Type: string

The URL of the source SBM location that was described.

MountOptions

Type: SmbMountOptions structure

The mount options that are available for DataSync to use to access an SMB location.

User

Type: string

The user who can mount the share, has the permissions to access files and folders in the SMB share.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeTask

$result = $client->describeTask([/* ... */]);
$promise = $client->describeTaskAsync([/* ... */]);

Returns metadata about a task.

Parameter Syntax

$result = $client->describeTask([
    'TaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

TaskArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the task to describe.

Result Syntax

[
    'CloudWatchLogGroupArn' => '<string>',
    'CreationTime' => <DateTime>,
    'CurrentTaskExecutionArn' => '<string>',
    'DestinationLocationArn' => '<string>',
    'DestinationNetworkInterfaceArns' => ['<string>', ...],
    'ErrorCode' => '<string>',
    'ErrorDetail' => '<string>',
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
        'LogLevel' => 'OFF|BASIC|TRANSFER',
        'Mtime' => 'NONE|PRESERVE',
        'OverwriteMode' => 'ALWAYS|NEVER',
        'PosixPermissions' => 'NONE|PRESERVE',
        'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
        'PreserveDevices' => 'NONE|PRESERVE',
        'TaskQueueing' => 'ENABLED|DISABLED',
        'TransferMode' => 'CHANGED|ALL',
        'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
        'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|ONLY_FILES_TRANSFERRED|NONE',
    ],
    'Schedule' => [
        'ScheduleExpression' => '<string>',
    ],
    'SourceLocationArn' => '<string>',
    'SourceNetworkInterfaceArns' => ['<string>', ...],
    'Status' => 'AVAILABLE|CREATING|QUEUED|RUNNING|UNAVAILABLE',
    'TaskArn' => '<string>',
]

Result Details

Members

CloudWatchLogGroupArn

Type: string

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

CreationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the task was created.

CurrentTaskExecutionArn

Type: string

The Amazon Resource Name (ARN) of the task execution that is syncing files.

DestinationLocationArn

Type: string

The Amazon Resource Name (ARN) of the AWS storage resource's location.

DestinationNetworkInterfaceArns

Type: Array of strings

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.

ErrorCode

Type: string

Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

ErrorDetail

Type: string

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

Excludes

Type: Array of FilterRule structures

Name

Type: string

The name of the task that was described.

Options

Type: Options structure

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

Schedule

Type: TaskSchedule structure

The schedule used to periodically transfer files from a source to a destination location.

SourceLocationArn

Type: string

The Amazon Resource Name (ARN) of the source file system's location.

SourceNetworkInterfaceArns

Type: Array of strings

The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.

Status

Type: string

The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

TaskArn

Type: string

The Amazon Resource Name (ARN) of the task that was described.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

DescribeTaskExecution

$result = $client->describeTaskExecution([/* ... */]);
$promise = $client->describeTaskExecutionAsync([/* ... */]);

Returns detailed metadata about a task that is being executed.

Parameter Syntax

$result = $client->describeTaskExecution([
    'TaskExecutionArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

TaskExecutionArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the task that is being executed.

Result Syntax

[
    'BytesTransferred' => <integer>,
    'BytesWritten' => <integer>,
    'EstimatedBytesToTransfer' => <integer>,
    'EstimatedFilesToTransfer' => <integer>,
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'FilesTransferred' => <integer>,
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
        'LogLevel' => 'OFF|BASIC|TRANSFER',
        'Mtime' => 'NONE|PRESERVE',
        'OverwriteMode' => 'ALWAYS|NEVER',
        'PosixPermissions' => 'NONE|PRESERVE',
        'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
        'PreserveDevices' => 'NONE|PRESERVE',
        'TaskQueueing' => 'ENABLED|DISABLED',
        'TransferMode' => 'CHANGED|ALL',
        'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
        'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|ONLY_FILES_TRANSFERRED|NONE',
    ],
    'Result' => [
        'ErrorCode' => '<string>',
        'ErrorDetail' => '<string>',
        'PrepareDuration' => <integer>,
        'PrepareStatus' => 'PENDING|SUCCESS|ERROR',
        'TotalDuration' => <integer>,
        'TransferDuration' => <integer>,
        'TransferStatus' => 'PENDING|SUCCESS|ERROR',
        'VerifyDuration' => <integer>,
        'VerifyStatus' => 'PENDING|SUCCESS|ERROR',
    ],
    'StartTime' => <DateTime>,
    'Status' => 'QUEUED|LAUNCHING|PREPARING|TRANSFERRING|VERIFYING|SUCCESS|ERROR',
    'TaskExecutionArn' => '<string>',
]

Result Details

Members

BytesTransferred

Type: long (int|float)

The physical number of bytes transferred over the network.

BytesWritten

Type: long (int|float)

The number of logical bytes written to the destination AWS storage resource.

EstimatedBytesToTransfer

Type: long (int|float)

The estimated physical number of bytes that is to be transferred over the network.

EstimatedFilesToTransfer

Type: long (int|float)

The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

Excludes

Type: Array of FilterRule structures

FilesTransferred

Type: long (int|float)

The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.

If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

Includes

Type: Array of FilterRule structures

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example: "/folder1|/folder2"

Options

Type: Options structure

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

Result

Type: TaskExecutionResultDetail structure

The result of the task execution.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The time that the task execution was started.

Status

Type: string

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

TaskExecutionArn

Type: string

The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

ListAgents

$result = $client->listAgents([/* ... */]);
$promise = $client->listAgentsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAgents([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of agents to list.

NextToken

Type: string

An opaque string that indicates the position at which to begin the next list of agents.

Result Syntax

[
    'Agents' => [
        [
            'AgentArn' => '<string>',
            'Name' => '<string>',
            'Status' => 'ONLINE|OFFLINE',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Agents

Type: Array of AgentListEntry structures

A list of agents in your account.

NextToken

Type: string

An opaque string that indicates the position at which to begin returning the next list of agents.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

ListLocations

$result = $client->listLocations([/* ... */]);
$promise = $client->listLocationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listLocations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of locations to return.

NextToken

Type: string

An opaque string that indicates the position at which to begin the next list of locations.

Result Syntax

[
    'Locations' => [
        [
            'LocationArn' => '<string>',
            'LocationUri' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Locations

Type: Array of LocationListEntry structures

An array that contains a list of locations.

NextToken

Type: string

An opaque string that indicates the position at which to begin returning the next list of locations.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns all the tags associated with a specified resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of locations to return.

NextToken

Type: string

An opaque string that indicates the position at which to begin the next list of locations.

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource whose tags to list.

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An opaque string that indicates the position at which to begin returning the next list of resource tags.

Tags

Type: Array of TagListEntry structures

Array of resource tags.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

ListTaskExecutions

$result = $client->listTaskExecutions([/* ... */]);
$promise = $client->listTaskExecutionsAsync([/* ... */]);

Returns a list of executed tasks.

Parameter Syntax

$result = $client->listTaskExecutions([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TaskArn' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of executed tasks to list.

NextToken

Type: string

An opaque string that indicates the position at which to begin the next list of the executed tasks.

TaskArn

Type: string

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

Result Syntax

[
    'NextToken' => '<string>',
    'TaskExecutions' => [
        [
            'Status' => 'QUEUED|LAUNCHING|PREPARING|TRANSFERRING|VERIFYING|SUCCESS|ERROR',
            'TaskExecutionArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An opaque string that indicates the position at which to begin returning the next list of executed tasks.

TaskExecutions

Type: Array of TaskExecutionListEntry structures

A list of executed tasks.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

ListTasks

$result = $client->listTasks([/* ... */]);
$promise = $client->listTasksAsync([/* ... */]);

Returns a list of all the tasks.

Parameter Syntax

$result = $client->listTasks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of tasks to return.

NextToken

Type: string

An opaque string that indicates the position at which to begin the next list of tasks.

Result Syntax

[
    'NextToken' => '<string>',
    'Tasks' => [
        [
            'Name' => '<string>',
            'Status' => 'AVAILABLE|CREATING|QUEUED|RUNNING|UNAVAILABLE',
            'TaskArn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

An opaque string that indicates the position at which to begin returning the next list of tasks.

Tasks

Type: Array of TaskListEntry structures

A list of all the tasks that are returned.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

StartTaskExecution

$result = $client->startTaskExecution([/* ... */]);
$promise = $client->startTaskExecutionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startTaskExecution([
    'Includes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'OverrideOptions' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
        'LogLevel' => 'OFF|BASIC|TRANSFER',
        'Mtime' => 'NONE|PRESERVE',
        'OverwriteMode' => 'ALWAYS|NEVER',
        'PosixPermissions' => 'NONE|PRESERVE',
        'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
        'PreserveDevices' => 'NONE|PRESERVE',
        'TaskQueueing' => 'ENABLED|DISABLED',
        'TransferMode' => 'CHANGED|ALL',
        'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
        'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|ONLY_FILES_TRANSFERRED|NONE',
    ],
    'TaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Includes

Type: Array of FilterRule structures

A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe). For example: "/folder1|/folder2"

OverrideOptions

Type: Options structure

TaskArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the task to start.

Result Syntax

[
    'TaskExecutionArn' => '<string>',
]

Result Details

Members

TaskExecutionArn

Type: string

The Amazon Resource Name (ARN) of the specific task execution that was started.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Applies a key-value pair to an AWS resource.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to apply the tag to.

Tags

Required: Yes
Type: Array of TagListEntry structures

The tags to apply.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes a tag from an AWS resource.

Parameter Syntax

$result = $client->untagResource([
    'Keys' => ['<string>', ...], // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Keys

Required: Yes
Type: Array of strings

The keys in the key-value pair in the tag to remove.

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource to remove the tag from.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

UpdateAgent

$result = $client->updateAgent([/* ... */]);
$promise = $client->updateAgentAsync([/* ... */]);

Updates the name of an agent.

Parameter Syntax

$result = $client->updateAgent([
    'AgentArn' => '<string>', // REQUIRED
    'Name' => '<string>',
]);

Parameter Details

Members

AgentArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the agent to update.

Name

Type: string

The name that you want to use to configure the agent.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

UpdateTask

$result = $client->updateTask([/* ... */]);
$promise = $client->updateTaskAsync([/* ... */]);

Updates the metadata associated with a task.

Parameter Syntax

$result = $client->updateTask([
    'CloudWatchLogGroupArn' => '<string>',
    'Excludes' => [
        [
            'FilterType' => 'SIMPLE_PATTERN',
            'Value' => '<string>',
        ],
        // ...
    ],
    'Name' => '<string>',
    'Options' => [
        'Atime' => 'NONE|BEST_EFFORT',
        'BytesPerSecond' => <integer>,
        'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
        'LogLevel' => 'OFF|BASIC|TRANSFER',
        'Mtime' => 'NONE|PRESERVE',
        'OverwriteMode' => 'ALWAYS|NEVER',
        'PosixPermissions' => 'NONE|PRESERVE',
        'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
        'PreserveDevices' => 'NONE|PRESERVE',
        'TaskQueueing' => 'ENABLED|DISABLED',
        'TransferMode' => 'CHANGED|ALL',
        'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
        'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|ONLY_FILES_TRANSFERRED|NONE',
    ],
    'Schedule' => [
        'ScheduleExpression' => '<string>', // REQUIRED
    ],
    'TaskArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

CloudWatchLogGroupArn

Type: string

The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.

Excludes

Type: Array of FilterRule structures

Name

Type: string

The name of the task to update.

Options

Type: Options structure

Schedule

Type: TaskSchedule structure

Specifies a schedule used to periodically transfer files from a source to a destination location. You can configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day or hour you want the task to execute. The time you specify is UTC time. For more information, see task-scheduling.

TaskArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource name of the task to update.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
This exception is thrown when the client submits a malformed request.
InternalException:
This exception is thrown when an error occurs in the AWS DataSync service.

Shapes

AgentListEntry

Description

Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.

Members

AgentArn

Type: string

The Amazon Resource Name (ARN) of the agent.

Name

Type: string

The name of the agent.

Status

Type: string

The status of the agent.

Ec2Config

Description

Members

SecurityGroupArns

Required: Yes
Type: Array of strings

The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.

SubnetArn

Required: Yes
Type: string

The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.

FilterRule

Description

Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

Members

FilterType

Type: string

The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.

Value

Type: string

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2

InternalException

Description

This exception is thrown when an error occurs in the AWS DataSync service.

Members

errorCode

Type: string

message

Type: string

InvalidRequestException

Description

This exception is thrown when the client submits a malformed request.

Members

errorCode

Type: string

message

Type: string

LocationListEntry

Description

Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.

Members

LocationArn

Type: string

The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

LocationUri

Type: string

Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

Format: TYPE://GLOBAL_ID/SUBDIR.

TYPE designates the type of location. Valid values: NFS | EFS | S3.

GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).

SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

NfsMountOptions

Description

Represents the mount options that are available for DataSync to access an NFS location.

Members

Version

Type: string

The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the NFS server.

You can specify the following NFS versions:

NFSv3 - stateless protocol version that allows for asynchronous writes on the server.
NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.
NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.

OnPremConfig

Description

A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

Members

AgentArns

Required: Yes
Type: Array of strings

ARNs)of the agents to use for an NFS location.

Options

Description

Members

Atime

Type: string

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

BytesPerSecond

Type: long (int|float)

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

Gid

Type: string

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

LogLevel

Type: string

A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs on errors for individual files transferred, and TRANSFER publishes logs for every file or object that is transferred and integrity checked.

Mtime

Type: string

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

OverwriteMode

Type: string

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

PosixPermissions

Type: string

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

PreserveDeletedFiles

Type: string

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

PreserveDevices

Type: string

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

TaskQueueing

Type: string

A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.

If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see queue-task-execution.

TransferMode

Type: string

TransferMode has two values: CHANGED and ALL. CHANGED performs an "incremental" or "delta sync", it compares file modification time between source and destination to determine which files need to be transferred. ALL skips destination inventory and transfers all files discovered on the source.

Uid

Type: string

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

VerifyMode

Type: string

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred. For more information, see create-task

Default value: POINT_IN_TIME_CONSISTENT.

ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.

POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at the end of the transfer to verify that source and destination are fully synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier Deep Archive storage classes.

NONE: No additional verification is done at the end of the transfer, but all data transmissions are integrity-checked with checksum verification during the transfer.

PrivateLinkConfig

Description

The VPC endpoint, subnet, and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).

Members

PrivateLinkEndpoint

Type: string

The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public internet.

SecurityGroupArns

Type: Array of strings

The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.

SubnetArns

Type: Array of strings

The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.

VpcEndpointId

Type: string

The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public internet.

S3Config

Description

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.

Members

BucketAccessRoleArn

Required: Yes
Type: string

The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

SmbMountOptions

Description

Represents the mount options that are available for DataSync to access an SMB location.

Members

Version

Type: string

The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the SMB server.

TagListEntry

Description

Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

Members

Key

Required: Yes
Type: string

The key for an AWS resource tag.

Value

Type: string

The value for an AWS resource tag.

TaskExecutionListEntry

Description

Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.

Members

Status

Type: string

The status of a task execution.

TaskExecutionArn

Type: string

The Amazon Resource Name (ARN) of the task that was executed.

TaskExecutionResultDetail

Description

Describes the detailed result of a TaskExecution operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.

Members

ErrorCode

Type: string

Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

ErrorDetail

Type: string

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

PrepareDuration

Type: long (int|float)

The total time in milliseconds that AWS DataSync spent in the PREPARING phase.

PrepareStatus

Type: string

The status of the PREPARING phase.

TotalDuration

Type: long (int|float)

The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.

TransferDuration

Type: long (int|float)

The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.

TransferStatus

Type: string

The status of the TRANSFERRING Phase.

VerifyDuration

Type: long (int|float)

The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.

VerifyStatus

Type: string

The status of the VERIFYING Phase.

TaskListEntry

Description

Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

Members

Name

Type: string

The name of the task.

Status

Type: string

The status of the task.

TaskArn

Type: string

The Amazon Resource Name (ARN) of the task.

TaskSchedule

Description

Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.

Members

ScheduleExpression

Required: Yes
Type: string

A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination location.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS DataSync 2018-11-09

Operation Summary

Paginators

Operations

CancelTaskExecution

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

CreateAgent

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLocationEfs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLocationFsxWindows

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLocationNfs

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLocationObjectStorage

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLocationS3

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateLocationSmb

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateTask

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members