AWS DataSync 2018-11-09
- Client: Aws\DataSync\DataSyncClient
- 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.
- CreateLocationNfs ( array $params = [] )
Creates an endpoint for a Network File System (NFS) file system.
- CreateLocationS3 ( array $params = [] )
Creates an endpoint for an Amazon S3 bucket.
- 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.
- DescribeLocationNfs ( array $params = [] )
Returns metadata, such as the path information, about a NFS location.
- DescribeLocationS3 ( array $params = [] )
Returns metadata, such as bucket name, about an Amazon S3 bucket 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 lists of source and destination locations.
- ListTagsForResource ( array $params = [] )
Returns all the tags associated with a specified resources.
- 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:
Operations
CancelTaskExecution
$result = $client->cancelTaskExecution([/* ... */]); $promise = $client->cancelTaskExecutionAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->cancelTaskExecution([
'TaskExecutionArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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 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 Activating a Sync 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.
Parameter Syntax
$result = $client->createAgent([
'ActivationKey' => '<string>', // REQUIRED
'AgentName' => '<string>',
'Tags' => [
[
'Key' => '<string>',
'Value' => '<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 a Sync 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.
- Tags
-
- Type: Array of TagListEntry structures
The key-value pair that represents the tag 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: + - = . _ : / @.
Result Syntax
[
'AgentArn' => '<string>',
]
Result Details
Members
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- Ec2Config
-
- Required: Yes
- Type: Ec2Config structure
The subnet and security group that the Amazon EFS file system uses.
- EfsFilesystemArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the Amazon EFS file system.
- Subdirectory
-
- Required: Yes
- 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.
- 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
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
CreateLocationNfs
$result = $client->createLocationNfs([/* ... */]); $promise = $client->createLocationNfsAsync([/* ... */]);
Creates an endpoint for a Network File System (NFS) file system.
Parameter Syntax
$result = $client->createLocationNfs([
'OnPremConfig' => [ // REQUIRED
'AgentArns' => ['<string>', ...], // REQUIRED
],
'ServerHostname' => '<string>', // REQUIRED
'Subdirectory' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- 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.
- 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.
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 sync 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. For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Centos 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
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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 Configuring Amazon S3 Location Settings in the AWS DataSync User Guide.
Parameter Syntax
$result = $client->createLocationS3([
'S3BucketArn' => '<string>', // REQUIRED
'S3Config' => [ // REQUIRED
'BucketAccessRoleArn' => '<string>', // REQUIRED
],
'Subdirectory' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'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 Components and Terminology in the AWS DataSync User Guide.
- Subdirectory
-
- Required: Yes
- 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
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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 default OverrideOptions that you use to control the behavior of a task. If you don't specify default values for Options when you create a task, AWS DataSync populates them with safe service defaults.
When you initially create a task, it enters the INITIALIZING status and then the CREATING status. In CREATING status, AWS DataSync attempts to mount the source Network File System (NFS) location. The task transitions to the AVAILABLE status without waiting for the destination location to mount. Instead, AWS DataSync mounts a destination before every task execution and then unmounts it after every 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
'Name' => '<string>',
'Options' => [
'Atime' => 'NONE|BEST_EFFORT',
'BytesPerSecond' => <integer>,
'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
'Mtime' => 'NONE|PRESERVE',
'PosixPermissions' => 'NONE|BEST_EFFORT|PRESERVE',
'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
'PreserveDevices' => 'NONE|PRESERVE',
'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|NONE',
],
'SourceLocationArn' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>',
'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. For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.
For more information about how to useCloudWatchLogs with DataSync, see Monitoring Your Task.
- DestinationLocationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of an AWS storage resource's location.
- 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
OverrideOptionsbefore starting a the task execution. For more information, see the operation. - 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
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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.
After you delete an agent, you can't reactivate it and you longer pay software charges for it.
Parameter Syntax
$result = $client->deleteAgent([
'AgentArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
DeleteTask
$result = $client->deleteTask([/* ... */]); $promise = $client->deleteTaskAsync([/* ... */]);
Deletes a task.
Parameter Syntax
$result = $client->deleteTask([
'TaskArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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
Result Syntax
[
'AgentArn' => '<string>',
'CreationTime' => <DateTime>,
'LastConnectionTime' => <DateTime>,
'Name' => '<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).
- LastConnectionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the agent was last connected.
- Name
-
- Type: string
The name of the agent.
- 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.
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
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 the target Amazon EFS file system uses. 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.
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.
- 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.
DescribeLocationNfs
$result = $client->describeLocationNfs([/* ... */]); $promise = $client->describeLocationNfsAsync([/* ... */]);
Returns metadata, such as the path information, about a NFS location.
Parameter Syntax
$result = $client->describeLocationNfs([
'LocationArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'CreationTime' => <DateTime>,
'LocationArn' => '<string>',
'LocationUri' => '<string>',
'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.
- 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.
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
Result Syntax
[
'CreationTime' => <DateTime>,
'LocationArn' => '<string>',
'LocationUri' => '<string>',
'S3Config' => [
'BucketAccessRoleArn' => '<string>',
],
]
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 Components and Terminology in the AWS DataSync User Guide.
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
DescribeTask
$result = $client->describeTask([/* ... */]); $promise = $client->describeTaskAsync([/* ... */]);
Returns metadata about a task.
Parameter Syntax
$result = $client->describeTask([
'TaskArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'CloudWatchLogGroupArn' => '<string>',
'CreationTime' => <DateTime>,
'CurrentTaskExecutionArn' => '<string>',
'DestinationLocationArn' => '<string>',
'ErrorCode' => '<string>',
'ErrorDetail' => '<string>',
'Name' => '<string>',
'Options' => [
'Atime' => 'NONE|BEST_EFFORT',
'BytesPerSecond' => <integer>,
'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
'Mtime' => 'NONE|PRESERVE',
'PosixPermissions' => 'NONE|BEST_EFFORT|PRESERVE',
'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
'PreserveDevices' => 'NONE|PRESERVE',
'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|NONE',
],
'SourceLocationArn' => '<string>',
'Status' => 'AVAILABLE|CREATING|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.
- 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.
- 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
OverrideOptionsvalue to operation. - SourceLocationArn
-
- Type: string
The Amazon Resource Name (ARN) of the source file system's location.
- Status
-
- Type: string
The status of the task that was described. For detailed information about sync statuses, see Understanding Sync Task Statuses.
- 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.
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
Result Syntax
[
'BytesTransferred' => <integer>,
'BytesWritten' => <integer>,
'EstimatedBytesToTransfer' => <integer>,
'EstimatedFilesToTransfer' => <integer>,
'FilesTransferred' => <integer>,
'Options' => [
'Atime' => 'NONE|BEST_EFFORT',
'BytesPerSecond' => <integer>,
'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
'Mtime' => 'NONE|PRESERVE',
'PosixPermissions' => 'NONE|BEST_EFFORT|PRESERVE',
'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
'PreserveDevices' => 'NONE|PRESERVE',
'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|NONE',
],
'Result' => [
'ErrorCode' => '<string>',
'ErrorDetail' => '<string>',
'PrepareDuration' => <integer>,
'PrepareStatus' => 'PENDING|SUCCESS|ERROR',
'TransferDuration' => <integer>,
'TransferStatus' => 'PENDING|SUCCESS|ERROR',
'VerifyDuration' => <integer>,
'VerifyStatus' => 'PENDING|SUCCESS|ERROR',
],
'StartTime' => <DateTime>,
'Status' => '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.
- 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 thanEstimatedFilesTransferredin 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. - 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
Optionsvalue 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. For detailed information about sync statuses, see Understanding Sync Task Statuses.
- TaskExecutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the task execution that was described.
TaskExecutionArnis hierarchical and includesTaskArnfor the task that was executed.For example, a
TaskExecutionvalue with the ARNarn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019bexecuted the task with the ARNarn:aws:sync:us-east-1:209870788375:task/task-0208075f79cedf4a2.
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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
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.
ListLocations
$result = $client->listLocations([/* ... */]); $promise = $client->listLocationsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listLocations([
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
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.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns all the tags associated with a specified resources.
Parameter Syntax
$result = $client->listTagsForResource([
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
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.
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
Result Syntax
[
'NextToken' => '<string>',
'TaskExecutions' => [
[
'Status' => '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.
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
Result Syntax
[
'NextToken' => '<string>',
'Tasks' => [
[
'Name' => '<string>',
'Status' => 'AVAILABLE|CREATING|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.
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 Task Execution in Components and Terminology in the AWS DataSync User Guide.
Parameter Syntax
$result = $client->startTaskExecution([
'OverrideOptions' => [
'Atime' => 'NONE|BEST_EFFORT',
'BytesPerSecond' => <integer>,
'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
'Mtime' => 'NONE|PRESERVE',
'PosixPermissions' => 'NONE|BEST_EFFORT|PRESERVE',
'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
'PreserveDevices' => 'NONE|PRESERVE',
'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|NONE',
],
'TaskArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- OverrideOptions
-
- 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
Optionsvalue to StartTaskExecution. - TaskArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the task to start.
Result Syntax
[
'TaskExecutionArn' => '<string>',
]
Result Details
Members
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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>',
'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
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
UpdateTask
$result = $client->updateTask([/* ... */]); $promise = $client->updateTaskAsync([/* ... */]);
Updates the metadata associated with a task.
Parameter Syntax
$result = $client->updateTask([
'Name' => '<string>',
'Options' => [
'Atime' => 'NONE|BEST_EFFORT',
'BytesPerSecond' => <integer>,
'Gid' => 'NONE|INT_VALUE|NAME|BOTH',
'Mtime' => 'NONE|PRESERVE',
'PosixPermissions' => 'NONE|BEST_EFFORT|PRESERVE',
'PreserveDeletedFiles' => 'PRESERVE|REMOVE',
'PreserveDevices' => 'NONE|PRESERVE',
'Uid' => 'NONE|INT_VALUE|NAME|BOTH',
'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|NONE',
],
'TaskArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- Name
-
- Type: string
The name of the task to update.
- 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
Optionsvalue to StartTaskExecution. - TaskArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource name of the task to update.
Result Syntax
[]
Result Details
Errors
-
InvalidRequestException:
This exception is thrown when the client submits a malformed request.
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
Ec2Config
Description
The subnet and the security group that the target Amazon EFS file system uses. 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.
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.
Members
InvalidRequestException
Description
This exception is thrown when the client submits a malformed request.
Members
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.
LocationUrireturns 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 asmyBucket. 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.
OnPremConfig
Description
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
Members
Options
Description
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.
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
Atimeto BEST_EFFORT, DataSync attempts to preserve the originalAtimeattribute 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
Atimevalue (recommended).NONE: Ignore
Atime.If
Atimeis set to BEST_EFFORT,Mtimemust be set to PRESERVE.If
Atimeis set to NONE,Mtimemust 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.
- 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
Mtimeis set to PRESERVE,Atimemust be set to BEST_EFFORT.If
Mtimeis set to NONE,Atimemust also be set to NONE. - 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.
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.
- 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.
Default value: POINT_IN_TIME_CONSISTENT.
POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
NONE: Skip verification.
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 Components and Terminology 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.
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
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
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.
- 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.
