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 DataSync agent that you have deployed on your host.
- CreateLocationEfs ( array $params = [] )
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer.
- CreateLocationFsxLustre ( array $params = [] )
Creates an endpoint for an Amazon FSx for Lustre file system.
- CreateLocationFsxOntap ( array $params = [] )
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer.
- CreateLocationFsxOpenZfs ( array $params = [] )
Creates an endpoint for an Amazon FSx for OpenZFS file system.
- CreateLocationFsxWindows ( array $params = [] )
Creates an endpoint for an Amazon FSx for Windows File Server file system.
- CreateLocationHdfs ( array $params = [] )
Creates an endpoint for a Hadoop Distributed File System (HDFS).
- 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 an object storage system that DataSync can access for a transfer.
- 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 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 about your DataSync location for an Amazon EFS file system.
- DescribeLocationFsxLustre ( array $params = [] )
Returns metadata about an Amazon FSx for Lustre location, such as information about its path.
- DescribeLocationFsxOntap ( array $params = [] )
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
- DescribeLocationFsxOpenZfs ( array $params = [] )
Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
- DescribeLocationFsxWindows ( array $params = [] )
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
- DescribeLocationHdfs ( array $params = [] )
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
- DescribeLocationNfs ( array $params = [] )
Returns metadata, such as the path information, about an NFS location.
- DescribeLocationObjectStorage ( array $params = [] )
Returns metadata about your DataSync location for an object storage system.
- 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 Amazon Web Services account in the Amazon Web Services 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 Amazon Web Services resource.
- UntagResource ( array $params = [] )
Removes a tag from an Amazon Web Services resource.
- UpdateAgent ( array $params = [] )
Updates the name of an agent.
- UpdateLocationHdfs ( array $params = [] )
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
- UpdateLocationNfs ( array $params = [] )
Updates some of the parameters of a previously created location for Network File System (NFS) access.
- UpdateLocationObjectStorage ( array $params = [] )
Updates some of the parameters of a previously created location for self-managed object storage server access.
- UpdateLocationSmb ( array $params = [] )
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access.
- UpdateTask ( array $params = [] )
Updates the metadata associated with a task.
- UpdateTaskExecution ( array $params = [] )
Updates execution of 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 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, 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateAgent
$result = $client->createAgent
([/* ... */]); $promise = $client->createAgentAsync
([/* ... */]);
Activates an 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 Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services 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 Amazon Web Services 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 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 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 SecurityGroupArns.
- 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
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationEfs
$result = $client->createLocationEfs
([/* ... */]); $promise = $client->createLocationEfsAsync
([/* ... */]);
Creates an endpoint for an Amazon EFS file system that DataSync can access for a transfer. For more information, see Creating a location for Amazon EFS.
Parameter Syntax
$result = $client->createLocationEfs([ 'AccessPointArn' => '<string>', 'Ec2Config' => [ // REQUIRED 'SecurityGroupArns' => ['<string>', ...], // REQUIRED 'SubnetArn' => '<string>', // REQUIRED ], 'EfsFilesystemArn' => '<string>', // REQUIRED 'FileSystemAccessRoleArn' => '<string>', 'InTransitEncryption' => 'NONE|TLS1_2', 'Subdirectory' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- AccessPointArn
-
- Type: string
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
- Ec2Config
-
- Required: Yes
- Type: Ec2Config structure
Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
- EfsFilesystemArn
-
- Required: Yes
- Type: string
Specifies the ARN for the Amazon EFS file system.
- FileSystemAccessRoleArn
-
- Type: string
Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
- InTransitEncryption
-
- Type: string
Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it copies data to or from the Amazon EFS file system.
If you specify an access point using
AccessPointArn
or an IAM role usingFileSystemAccessRoleArn
, you must set this parameter toTLS1_2
. - Subdirectory
-
- Type: string
Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data (depending on if this is a source or destination location). By default, DataSync uses the root directory, but you can also include subdirectories.
You must specify a value with forward slashes (for example,
/path/to/folder
). - Tags
-
- Type: Array of TagListEntry structures
Specifies 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationFsxLustre
$result = $client->createLocationFsxLustre
([/* ... */]); $promise = $client->createLocationFsxLustreAsync
([/* ... */]);
Creates an endpoint for an Amazon FSx for Lustre file system.
Parameter Syntax
$result = $client->createLocationFsxLustre([ 'FsxFilesystemArn' => '<string>', // REQUIRED 'SecurityGroupArns' => ['<string>', ...], // REQUIRED 'Subdirectory' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- FsxFilesystemArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the FSx for Lustre file system.
- SecurityGroupArns
-
- Required: Yes
- Type: Array of strings
The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.
- Subdirectory
-
- Type: string
A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
- 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationFsxOntap
$result = $client->createLocationFsxOntap
([/* ... */]); $promise = $client->createLocationFsxOntapAsync
([/* ... */]);
Creates an endpoint for an Amazon FSx for NetApp ONTAP file system that DataSync can access for a transfer. For more information, see Creating a location for FSx for ONTAP.
Parameter Syntax
$result = $client->createLocationFsxOntap([ 'Protocol' => [ // REQUIRED 'NFS' => [ 'MountOptions' => [ 'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1', ], ], 'SMB' => [ 'Domain' => '<string>', 'MountOptions' => [ 'Version' => 'AUTOMATIC|SMB2|SMB3', ], 'Password' => '<string>', // REQUIRED 'User' => '<string>', // REQUIRED ], ], 'SecurityGroupArns' => ['<string>', ...], // REQUIRED 'StorageVirtualMachineArn' => '<string>', // REQUIRED 'Subdirectory' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- Protocol
-
- Required: Yes
- Type: FsxProtocol structure
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
- SecurityGroupArns
-
- Required: Yes
- Type: Array of strings
Specifies the security groups that DataSync can use to access your FSx for ONTAP file system. You must configure the security groups to allow outbound traffic on the following ports (depending on the protocol that you're using):
-
Network File System (NFS): TCP port 2049
-
Server Message Block (SMB): TCP port 445
Your file system's security groups must also allow inbound traffic on the same port.
- StorageVirtualMachineArn
-
- Required: Yes
- Type: string
Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.
- Subdirectory
-
- Type: string
Specifies the junction path (also known as a mount point) in the SVM volume where you're copying data to or from (for example,
/vol1
).Don't specify a junction path in the SVM's root volume. For more information, see Managing FSx for ONTAP storage virtual machines in the Amazon FSx for NetApp ONTAP User Guide.
- Tags
-
- Type: Array of TagListEntry structures
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources. We recommend creating at least a name tag for your location.
Result Syntax
[ 'LocationArn' => '<string>', ]
Result Details
Members
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationFsxOpenZfs
$result = $client->createLocationFsxOpenZfs
([/* ... */]); $promise = $client->createLocationFsxOpenZfsAsync
([/* ... */]);
Creates an endpoint for an Amazon FSx for OpenZFS file system.
Parameter Syntax
$result = $client->createLocationFsxOpenZfs([ 'FsxFilesystemArn' => '<string>', // REQUIRED 'Protocol' => [ // REQUIRED 'NFS' => [ 'MountOptions' => [ 'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1', ], ], 'SMB' => [ 'Domain' => '<string>', 'MountOptions' => [ 'Version' => 'AUTOMATIC|SMB2|SMB3', ], 'Password' => '<string>', // REQUIRED 'User' => '<string>', // REQUIRED ], ], 'SecurityGroupArns' => ['<string>', ...], // REQUIRED 'Subdirectory' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- FsxFilesystemArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
- Protocol
-
- Required: Yes
- Type: FsxProtocol structure
The type of protocol that DataSync uses to access your file system.
- SecurityGroupArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
- Subdirectory
-
- Type: string
A subdirectory in the location's path that must begin with
/fsx
. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location). - 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationFsxWindows
$result = $client->createLocationFsxWindows
([/* ... */]); $promise = $client->createLocationFsxWindowsAsync
([/* ... */]);
Creates an endpoint for an Amazon FSx for Windows File Server 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 File Server belongs to.
- FsxFilesystemArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the FSx for Windows File Server 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 Server file system.
- SecurityGroupArns
-
- Required: Yes
- Type: Array of strings
The ARNs of the security groups that are used to configure the FSx for Windows File Server file system.
- Subdirectory
-
- Type: string
A subdirectory in the location's path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.
- 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.
- User
-
- Required: Yes
- Type: string
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
Result Syntax
[ 'LocationArn' => '<string>', ]
Result Details
Members
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationHdfs
$result = $client->createLocationHdfs
([/* ... */]); $promise = $client->createLocationHdfsAsync
([/* ... */]);
Creates an endpoint for a Hadoop Distributed File System (HDFS).
Parameter Syntax
$result = $client->createLocationHdfs([ 'AgentArns' => ['<string>', ...], // REQUIRED 'AuthenticationType' => 'SIMPLE|KERBEROS', // REQUIRED 'BlockSize' => <integer>, 'KerberosKeytab' => <string || resource || Psr\Http\Message\StreamInterface>, 'KerberosKrb5Conf' => <string || resource || Psr\Http\Message\StreamInterface>, 'KerberosPrincipal' => '<string>', 'KmsKeyProviderUri' => '<string>', 'NameNodes' => [ // REQUIRED [ 'Hostname' => '<string>', // REQUIRED 'Port' => <integer>, // REQUIRED ], // ... ], 'QopConfiguration' => [ 'DataTransferProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY', 'RpcProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY', ], 'ReplicationFactor' => <integer>, 'SimpleUser' => '<string>', 'Subdirectory' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- AgentArns
-
- Required: Yes
- Type: Array of strings
The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
- AuthenticationType
-
- Required: Yes
- Type: string
The type of authentication used to determine the identity of the user.
- BlockSize
-
- Type: int
The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB).
- KerberosKeytab
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you're using the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
If
KERBEROS
is specified forAuthenticationType
, this parameter is required. - KerberosKrb5Conf
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The
krb5.conf
file that contains the Kerberos configuration information. You can load thekrb5.conf
file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text.If
KERBEROS
is specified forAuthenticationType
, this parameter is required. - KerberosPrincipal
-
- Type: string
The Kerberos principal with access to the files and folders on the HDFS cluster.
If
KERBEROS
is specified forAuthenticationType
, this parameter is required. - KmsKeyProviderUri
-
- Type: string
The URI of the HDFS cluster's Key Management Server (KMS).
- NameNodes
-
- Required: Yes
- Type: Array of HdfsNameNode structures
The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.
- QopConfiguration
-
- Type: QopConfiguration structure
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster. If
QopConfiguration
isn't specified,RpcProtection
andDataTransferProtection
default toPRIVACY
. If you setRpcProtection
orDataTransferProtection
, the other parameter assumes the same value. - ReplicationFactor
-
- Type: int
The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.
- SimpleUser
-
- Type: string
The user name used to identify the client on the host operating system.
If
SIMPLE
is specified forAuthenticationType
, this parameter is required. - Subdirectory
-
- Type: string
A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster. If the subdirectory isn't specified, it will default to
/
. - 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
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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 Snowcone device, see NFS Server on 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 hostname to mount the NFS server in a network.
If you are copying data to or from your Snowcone device, see NFS Server on 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 Snowcone device, see NFS Server on 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
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationObjectStorage
$result = $client->createLocationObjectStorage
([/* ... */]); $promise = $client->createLocationObjectStorageAsync
([/* ... */]);
Creates an endpoint for an object storage system that DataSync can access for a transfer. For more information, see Creating a location for object storage.
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
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
- AgentArns
-
- Required: Yes
- Type: Array of strings
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
- BucketName
-
- Required: Yes
- Type: string
Specifies the name of the object storage bucket involved in the transfer.
- SecretKey
-
- Type: string
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
- ServerHostname
-
- Required: Yes
- Type: string
Specifies the domain name or IP address of the object storage server. A DataSync agent uses this hostname to mount the object storage server in a network.
- ServerPort
-
- Type: int
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
- ServerProtocol
-
- Type: string
Specifies the protocol that your object storage server uses to communicate.
- Subdirectory
-
- Type: string
Specifies the object prefix for your object storage server. If this is a source location, DataSync only copies objects with this prefix. If this is a destination location, DataSync writes all objects with this prefix.
- Tags
-
- Type: Array of TagListEntry structures
Specifies the key-value pair that represents a tag that you want to add to the resource. Tags can help you manage, filter, and search for your resources. We recommend creating a name tag for your location.
Result Syntax
[ 'LocationArn' => '<string>', ]
Result Details
Members
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateLocationS3
$result = $client->createLocationS3
([/* ... */]); $promise = $client->createLocationS3Async
([/* ... */]);
Creates an endpoint for an Amazon S3 bucket.
For more information, see Create an Amazon S3 location in the DataSync User Guide.
Parameter Syntax
$result = $client->createLocationS3([ 'AgentArns' => ['<string>', ...], 'S3BucketArn' => '<string>', // REQUIRED 'S3Config' => [ // REQUIRED 'BucketAccessRoleArn' => '<string>', // REQUIRED ], 'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS', 'Subdirectory' => '<string>', 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- AgentArns
-
- Type: Array of strings
If you're using DataSync on an Amazon Web Services Outpost, specify the Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.
- S3BucketArn
-
- Required: Yes
- Type: string
The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.
- S3Config
-
- Required: Yes
- Type: S3Config structure
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.
For detailed information about using such a role, see Creating a Location for Amazon S3 in the 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 buckets in Amazon Web Services Regions, the storage class defaults to Standard. For buckets on Outposts, the storage class defaults to Amazon Web Services S3 Outposts.
For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
- 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
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see the User setting for SMB locations.
Result Syntax
[ 'LocationArn' => '<string>', ]
Result Details
Members
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
CreateTask
$result = $client->createTask
([/* ... */]); $promise = $client->createTaskAsync
([/* ... */]);
Creates a task.
A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.
When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.
You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.
When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing.
Parameter Syntax
$result = $client->createTask([ 'CloudWatchLogGroupArn' => '<string>', 'DestinationLocationArn' => '<string>', // REQUIRED 'Excludes' => [ [ 'FilterType' => 'SIMPLE_PATTERN', 'Value' => '<string>', ], // ... ], 'Includes' => [ [ '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', 'ObjectTags' => 'PRESERVE|NONE', 'OverwriteMode' => 'ALWAYS|NEVER', 'PosixPermissions' => 'NONE|PRESERVE', 'PreserveDeletedFiles' => 'PRESERVE|REMOVE', 'PreserveDevices' => 'NONE|PRESERVE', 'SecurityDescriptorCopyFlags' => 'NONE|OWNER_DACL|OWNER_DACL_SACL', '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 Amazon Web Services 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"
. - Includes
-
- Type: Array of FilterRule structures
A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. 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 StartTaskExecution 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 Scheduling your task.
- 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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 Amazon Web Services 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
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DeleteLocation
$result = $client->deleteLocation
([/* ... */]); $promise = $client->deleteLocationAsync
([/* ... */]);
Deletes the configuration of a location used by DataSync.
Parameter Syntax
$result = $client->deleteLocation([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
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 DataSync.
- 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationEfs
$result = $client->describeLocationEfs
([/* ... */]); $promise = $client->describeLocationEfsAsync
([/* ... */]);
Returns metadata about your DataSync location for an Amazon EFS file system.
Parameter Syntax
$result = $client->describeLocationEfs([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'AccessPointArn' => '<string>', 'CreationTime' => <DateTime>, 'Ec2Config' => [ 'SecurityGroupArns' => ['<string>', ...], 'SubnetArn' => '<string>', ], 'FileSystemAccessRoleArn' => '<string>', 'InTransitEncryption' => 'NONE|TLS1_2', 'LocationArn' => '<string>', 'LocationUri' => '<string>', ]
Result Details
Members
- AccessPointArn
-
- Type: string
The ARN of the access point that DataSync uses to access the Amazon EFS file system.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the location was created.
- Ec2Config
-
- Type: Ec2Config structure
The subnet and security groups that DataSync uses to access your Amazon EFS file system.
- FileSystemAccessRoleArn
-
- Type: string
The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
- InTransitEncryption
-
- Type: string
Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.
- LocationArn
-
- Type: string
The ARN of the Amazon EFS file system location.
- LocationUri
-
- Type: string
The URL of the Amazon EFS file system location.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationFsxLustre
$result = $client->describeLocationFsxLustre
([/* ... */]); $promise = $client->describeLocationFsxLustreAsync
([/* ... */]);
Returns metadata about an Amazon FSx for Lustre location, such as information about its path.
Parameter Syntax
$result = $client->describeLocationFsxLustre([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'CreationTime' => <DateTime>, 'LocationArn' => '<string>', 'LocationUri' => '<string>', 'SecurityGroupArns' => ['<string>', ...], ]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the FSx for Lustre location was created.
- LocationArn
-
- Type: string
The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.
- LocationUri
-
- Type: string
The URI of the FSx for Lustre 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 Lustre file system.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationFsxOntap
$result = $client->describeLocationFsxOntap
([/* ... */]); $promise = $client->describeLocationFsxOntapAsync
([/* ... */]);
Provides details about how an DataSync location for an Amazon FSx for NetApp ONTAP file system is configured.
Parameter Syntax
$result = $client->describeLocationFsxOntap([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'CreationTime' => <DateTime>, 'FsxFilesystemArn' => '<string>', 'LocationArn' => '<string>', 'LocationUri' => '<string>', 'Protocol' => [ 'NFS' => [ 'MountOptions' => [ 'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1', ], ], 'SMB' => [ 'Domain' => '<string>', 'MountOptions' => [ 'Version' => 'AUTOMATIC|SMB2|SMB3', ], 'Password' => '<string>', 'User' => '<string>', ], ], 'SecurityGroupArns' => ['<string>', ...], 'StorageVirtualMachineArn' => '<string>', ]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the location was created.
- FsxFilesystemArn
-
- Type: string
The ARN of the FSx for ONTAP file system.
- LocationArn
-
- Type: string
The ARN of the FSx for ONTAP file system location.
- LocationUri
-
- Type: string
The uniform resource identifier (URI) of the FSx for ONTAP file system location.
- Protocol
-
- Type: FsxProtocol structure
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
- SecurityGroupArns
-
- Type: Array of strings
The security groups that DataSync uses to access your FSx for ONTAP file system.
- StorageVirtualMachineArn
-
- Type: string
The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationFsxOpenZfs
$result = $client->describeLocationFsxOpenZfs
([/* ... */]); $promise = $client->describeLocationFsxOpenZfsAsync
([/* ... */]);
Returns metadata about an Amazon FSx for OpenZFS location, such as information about its path.
Parameter Syntax
$result = $client->describeLocationFsxOpenZfs([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'CreationTime' => <DateTime>, 'LocationArn' => '<string>', 'LocationUri' => '<string>', 'Protocol' => [ 'NFS' => [ 'MountOptions' => [ 'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1', ], ], 'SMB' => [ 'Domain' => '<string>', 'MountOptions' => [ 'Version' => 'AUTOMATIC|SMB2|SMB3', ], 'Password' => '<string>', 'User' => '<string>', ], ], 'SecurityGroupArns' => ['<string>', ...], ]
Result Details
Members
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the FSx for OpenZFS location was created.
- LocationArn
-
- Type: string
The ARN of the FSx for OpenZFS location that was described.
- LocationUri
-
- Type: string
The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.
Example:
fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder
- Protocol
-
- Type: FsxProtocol structure
The type of protocol that DataSync uses to access your file system.
- SecurityGroupArns
-
- Type: Array of strings
The ARNs of the security groups that are configured for the FSx for OpenZFS file system.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationFsxWindows
$result = $client->describeLocationFsxWindows
([/* ... */]); $promise = $client->describeLocationFsxWindowsAsync
([/* ... */]);
Returns metadata about an Amazon FSx for Windows File Server location, such as information about its path.
Parameter Syntax
$result = $client->describeLocationFsxWindows([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
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 File Server location was created.
- Domain
-
- Type: string
The name of the Windows domain that the FSx for Windows File Server belongs to.
- LocationArn
-
- Type: string
The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.
- LocationUri
-
- Type: string
The URL of the FSx for Windows File Server 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 Server file system.
- User
-
- Type: string
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationHdfs
$result = $client->describeLocationHdfs
([/* ... */]); $promise = $client->describeLocationHdfsAsync
([/* ... */]);
Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.
Parameter Syntax
$result = $client->describeLocationHdfs([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'AgentArns' => ['<string>', ...], 'AuthenticationType' => 'SIMPLE|KERBEROS', 'BlockSize' => <integer>, 'CreationTime' => <DateTime>, 'KerberosPrincipal' => '<string>', 'KmsKeyProviderUri' => '<string>', 'LocationArn' => '<string>', 'LocationUri' => '<string>', 'NameNodes' => [ [ 'Hostname' => '<string>', 'Port' => <integer>, ], // ... ], 'QopConfiguration' => [ 'DataTransferProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY', 'RpcProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY', ], 'ReplicationFactor' => <integer>, 'SimpleUser' => '<string>', ]
Result Details
Members
- AgentArns
-
- Type: Array of strings
The ARNs of the agents that are used to connect to the HDFS cluster.
- AuthenticationType
-
- Type: string
The type of authentication used to determine the identity of the user.
- BlockSize
-
- Type: int
The size of the data blocks to write into the HDFS cluster.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the HDFS location was created.
- KerberosPrincipal
-
- Type: string
The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the
AuthenticationType
is defined asKERBEROS
. - KmsKeyProviderUri
-
- Type: string
The URI of the HDFS cluster's Key Management Server (KMS).
- LocationArn
-
- Type: string
The ARN of the HDFS cluster location.
- LocationUri
-
- Type: string
The URI of the HDFS cluster location.
- NameNodes
-
- Type: Array of HdfsNameNode structures
The NameNode that manage the HDFS namespace.
- QopConfiguration
-
- Type: QopConfiguration structure
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the Hadoop Distributed File System (HDFS) cluster.
- ReplicationFactor
-
- Type: int
The number of DataNodes to replicate the data to when writing to the HDFS cluster.
- SimpleUser
-
- Type: string
The user name used to identify the client on the host operating system. This parameter is used if the
AuthenticationType
is defined asSIMPLE
.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
DescribeLocationObjectStorage
$result = $client->describeLocationObjectStorage
([/* ... */]); $promise = $client->describeLocationObjectStorageAsync
([/* ... */]);
Returns metadata about your DataSync location for an object storage system.
Parameter Syntax
$result = $client->describeLocationObjectStorage([ 'LocationArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'AccessKey' => '<string>', 'AgentArns' => ['<string>', ...], 'CreationTime' => <DateTime>, 'LocationArn' => '<string>', 'LocationUri' => '<string>', 'ServerPort' => <integer>, 'ServerProtocol' => 'HTTPS|HTTP', ]
Result Details
Members
- AccessKey
-
- Type: string
The access key (for example, a user name) required to authenticate with the object storage server.
- AgentArns
-
- Type: Array of strings
The ARNs of the DataSync agents that can securely connect with your location.
- CreationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the location was created.
- LocationArn
-
- Type: string
The ARN of the object storage system location.
- LocationUri
-
- Type: string
The URL of the object storage system location.
- ServerPort
-
- Type: int
The port that your object storage server accepts inbound network traffic on (for example, port 443).
- ServerProtocol
-
- Type: string
The protocol that your object storage server uses to communicate.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
Result Syntax
[ 'AgentArns' => ['<string>', ...], 'CreationTime' => <DateTime>, 'LocationArn' => '<string>', 'LocationUri' => '<string>', 'S3Config' => [ 'BucketAccessRoleArn' => '<string>', ], 'S3StorageClass' => 'STANDARD|STANDARD_IA|ONEZONE_IA|INTELLIGENT_TIERING|GLACIER|DEEP_ARCHIVE|OUTPOSTS', ]
Result Details
Members
- AgentArns
-
- Type: Array of strings
If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.
- 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 or access point.
- LocationUri
-
- Type: string
The URL of the Amazon S3 location that was described.
- S3Config
-
- Type: S3Config structure
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.
For detailed information about using such a role, see Creating a Location for Amazon S3 in the 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. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
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 SMB 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
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>', 'DestinationNetworkInterfaceArns' => ['<string>', ...], 'ErrorCode' => '<string>', 'ErrorDetail' => '<string>', 'Excludes' => [ [ 'FilterType' => 'SIMPLE_PATTERN', 'Value' => '<string>', ], // ... ], 'Includes' => [ [ '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', 'ObjectTags' => 'PRESERVE|NONE', 'OverwriteMode' => 'ALWAYS|NEVER', 'PosixPermissions' => 'NONE|PRESERVE', 'PreserveDeletedFiles' => 'PRESERVE|REMOVE', 'PreserveDevices' => 'NONE|PRESERVE', 'SecurityDescriptorCopyFlags' => 'NONE|OWNER_DACL|OWNER_DACL_SACL', '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 Amazon Web Services storage resource's location.
- DestinationNetworkInterfaceArns
-
- Type: Array of strings
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.
- ErrorCode
-
- Type: string
Errors that 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
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"
. - Includes
-
- Type: Array of FilterRule structures
A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example,
"/folder1|/folder2
". - 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 StartTaskExecution 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 Names (ARNs) of the source elastic network interfaces (ENIs) that were 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 DataSync User Guide.
- TaskArn
-
- Type: string
The Amazon Resource Name (ARN) of the task that was described.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
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', 'ObjectTags' => 'PRESERVE|NONE', 'OverwriteMode' => 'ALWAYS|NEVER', 'PosixPermissions' => 'NONE|PRESERVE', 'PreserveDeletedFiles' => 'PRESERVE|REMOVE', 'PreserveDevices' => 'NONE|PRESERVE', 'SecurityDescriptorCopyFlags' => 'NONE|OWNER_DACL|OWNER_DACL_SACL', '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 Amazon Web Services 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
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"
- 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 thanEstimatedFilesTransferred
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 DataSync User Guide.
- TaskExecutionArn
-
- Type: string
The Amazon Resource Name (ARN) of the task execution that was described.
TaskExecutionArn
is hierarchical and includesTaskArn
for the task that was executed.For example, a
TaskExecution
value with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARNarn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
ListAgents
$result = $client->listAgents
([/* ... */]); $promise = $client->listAgentsAsync
([/* ... */]);
Returns a list of agents owned by an Amazon Web Services account in the Amazon Web Services 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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([ 'Filters' => [ [ 'Name' => 'LocationUri|LocationType|CreationTime', // REQUIRED 'Operator' => 'Equals|NotEquals|In|LessThanOrEqual|LessThan|GreaterThanOrEqual|GreaterThan|Contains|NotContains|BeginsWith', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of LocationFilter structures
You can use API filters to narrow down the list of resources returned by
ListLocations
. For example, to retrieve all tasks on a specific source location, you can useListLocations
with filter nameLocationType S3
andOperator Equals
. - 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
ListTasks
$result = $client->listTasks
([/* ... */]); $promise = $client->listTasksAsync
([/* ... */]);
Returns a list of all the tasks.
Parameter Syntax
$result = $client->listTasks([ 'Filters' => [ [ 'Name' => 'LocationId|CreationTime', // REQUIRED 'Operator' => 'Equals|NotEquals|In|LessThanOrEqual|LessThan|GreaterThanOrEqual|GreaterThan|Contains|NotContains|BeginsWith', // REQUIRED 'Values' => ['<string>', ...], // REQUIRED ], // ... ], 'MaxResults' => <integer>, 'NextToken' => '<string>', ]);
Parameter Details
Members
- Filters
-
- Type: Array of TaskFilter structures
You can use API filters to narrow down the list of resources returned by
ListTasks
. For example, to retrieve all tasks on a specific source location, you can useListTasks
with filter nameLocationId
andOperator Equals
with the ARN for the location. - 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
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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 DataSync User Guide.
Parameter Syntax
$result = $client->startTaskExecution([ 'Excludes' => [ [ 'FilterType' => 'SIMPLE_PATTERN', 'Value' => '<string>', ], // ... ], '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', 'ObjectTags' => 'PRESERVE|NONE', 'OverwriteMode' => 'ALWAYS|NEVER', 'PosixPermissions' => 'NONE|PRESERVE', 'PreserveDeletedFiles' => 'PRESERVE|REMOVE', 'PreserveDevices' => 'NONE|PRESERVE', 'SecurityDescriptorCopyFlags' => 'NONE|OWNER_DACL|OWNER_DACL_SACL', '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
- Excludes
-
- Type: Array of FilterRule structures
A list of filter rules that determines which files to exclude from a task. The list contains a single filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for example,
"/folder1|/folder2"
. - 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
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. - TaskArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the task to start.
Result Syntax
[ 'TaskExecutionArn' => '<string>', ]
Result Details
Members
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Applies a key-value pair to an Amazon Web Services 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
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes a tag from an Amazon Web Services resource.
Parameter Syntax
$result = $client->untagResource([ 'Keys' => ['<string>', ...], // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
UpdateLocationHdfs
$result = $client->updateLocationHdfs
([/* ... */]); $promise = $client->updateLocationHdfsAsync
([/* ... */]);
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
Parameter Syntax
$result = $client->updateLocationHdfs([ 'AgentArns' => ['<string>', ...], 'AuthenticationType' => 'SIMPLE|KERBEROS', 'BlockSize' => <integer>, 'KerberosKeytab' => <string || resource || Psr\Http\Message\StreamInterface>, 'KerberosKrb5Conf' => <string || resource || Psr\Http\Message\StreamInterface>, 'KerberosPrincipal' => '<string>', 'KmsKeyProviderUri' => '<string>', 'LocationArn' => '<string>', // REQUIRED 'NameNodes' => [ [ 'Hostname' => '<string>', // REQUIRED 'Port' => <integer>, // REQUIRED ], // ... ], 'QopConfiguration' => [ 'DataTransferProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY', 'RpcProtection' => 'DISABLED|AUTHENTICATION|INTEGRITY|PRIVACY', ], 'ReplicationFactor' => <integer>, 'SimpleUser' => '<string>', 'Subdirectory' => '<string>', ]);
Parameter Details
Members
- AgentArns
-
- Type: Array of strings
The ARNs of the agents that are used to connect to the HDFS cluster.
- AuthenticationType
-
- Type: string
The type of authentication used to determine the identity of the user.
- BlockSize
-
- Type: int
The size of the data blocks to write into the HDFS cluster.
- KerberosKeytab
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The Kerberos key table (keytab) that contains mappings between the defined Kerberos principal and the encrypted keys. You can load the keytab from a file by providing the file's address. If you use the CLI, it performs base64 encoding for you. Otherwise, provide the base64-encoded text.
- KerberosKrb5Conf
-
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
The
krb5.conf
file that contains the Kerberos configuration information. You can load thekrb5.conf
file by providing the file's address. If you're using the CLI, it performs the base64 encoding for you. Otherwise, provide the base64-encoded text. - KerberosPrincipal
-
- Type: string
The Kerberos principal with access to the files and folders on the HDFS cluster.
- KmsKeyProviderUri
-
- Type: string
The URI of the HDFS cluster's Key Management Server (KMS).
- LocationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the source HDFS cluster location.
- NameNodes
-
- Type: Array of HdfsNameNode structures
The NameNode that manages the HDFS namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes. You can use only one NameNode.
- QopConfiguration
-
- Type: QopConfiguration structure
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
- ReplicationFactor
-
- Type: int
The number of DataNodes to replicate the data to when writing to the HDFS cluster.
- SimpleUser
-
- Type: string
The user name used to identify the client on the host operating system.
- Subdirectory
-
- Type: string
A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
UpdateLocationNfs
$result = $client->updateLocationNfs
([/* ... */]); $promise = $client->updateLocationNfsAsync
([/* ... */]);
Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS.
Parameter Syntax
$result = $client->updateLocationNfs([ 'LocationArn' => '<string>', // REQUIRED 'MountOptions' => [ 'Version' => 'AUTOMATIC|NFS3|NFS4_0|NFS4_1', ], 'OnPremConfig' => [ 'AgentArns' => ['<string>', ...], // REQUIRED ], 'Subdirectory' => '<string>', ]);
Parameter Details
Members
- LocationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the NFS location to update.
- MountOptions
-
- Type: NfsMountOptions structure
Specifies how DataSync can access a location using the NFS protocol.
- OnPremConfig
-
- Type: OnPremConfig structure
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
- Subdirectory
-
- 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 that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with
no_root_squash
, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option 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 Snowcone device, see NFS Server on 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.
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
UpdateLocationObjectStorage
$result = $client->updateLocationObjectStorage
([/* ... */]); $promise = $client->updateLocationObjectStorageAsync
([/* ... */]);
Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.
Parameter Syntax
$result = $client->updateLocationObjectStorage([ 'AccessKey' => '<string>', 'AgentArns' => ['<string>', ...], 'LocationArn' => '<string>', // REQUIRED 'SecretKey' => '<string>', 'ServerPort' => <integer>, 'ServerProtocol' => 'HTTPS|HTTP', 'Subdirectory' => '<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. If your object storage requires a user name and password to authenticate, use
AccessKey
andSecretKey
to provide the user name and password, respectively. - AgentArns
-
- Type: Array of strings
The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
- LocationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.
- SecretKey
-
- Type: string
Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use
AccessKey
andSecretKey
to provide the user name and password, respectively. - 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
orHTTPS
. - Subdirectory
-
- Type: string
The subdirectory in the self-managed object storage server that is used to read data from.
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
UpdateLocationSmb
$result = $client->updateLocationSmb
([/* ... */]); $promise = $client->updateLocationSmbAsync
([/* ... */]);
Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB.
Parameter Syntax
$result = $client->updateLocationSmb([ 'AgentArns' => ['<string>', ...], 'Domain' => '<string>', 'LocationArn' => '<string>', // REQUIRED 'MountOptions' => [ 'Version' => 'AUTOMATIC|SMB2|SMB3', ], 'Password' => '<string>', 'Subdirectory' => '<string>', 'User' => '<string>', ]);
Parameter Details
Members
- AgentArns
-
- 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.
- LocationArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the SMB location to update.
- MountOptions
-
- Type: SmbMountOptions structure
Specifies how DataSync can access a location using the SMB protocol.
- Password
-
- Type: string
The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
- Subdirectory
-
- 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 that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:
-
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.
-
Use credentials of a member of the Backup Operators group to mount the share.
Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.
- User
-
- Type: string
The user who can mount the share has the permissions to access files and folders in the SMB share.
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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>', ], // ... ], 'Includes' => [ [ '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', 'ObjectTags' => 'PRESERVE|NONE', 'OverwriteMode' => 'ALWAYS|NEVER', 'PosixPermissions' => 'NONE|PRESERVE', 'PreserveDeletedFiles' => 'PRESERVE|REMOVE', 'PreserveDevices' => 'NONE|PRESERVE', 'SecurityDescriptorCopyFlags' => 'NONE|OWNER_DACL|OWNER_DACL_SACL', '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 Amazon CloudWatch log group.
- 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"
. - Includes
-
- Type: Array of FilterRule structures
A list of filter rules that determines which files to include when running a task. The pattern contains a single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a pipe), for example,
"/folder1|/folder2"
. - 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
Options
value to StartTaskExecution. - 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 Scheduling your task.
- TaskArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource name of the task to update.
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the DataSync service.
UpdateTaskExecution
$result = $client->updateTaskExecution
([/* ... */]); $promise = $client->updateTaskExecutionAsync
([/* ... */]);
Updates execution of a task.
You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution.
The only Option
that can be modified by UpdateTaskExecution
is BytesPerSecond
.
Parameter Syntax
$result = $client->updateTaskExecution([ 'Options' => [ // REQUIRED 'Atime' => 'NONE|BEST_EFFORT', 'BytesPerSecond' => <integer>, 'Gid' => 'NONE|INT_VALUE|NAME|BOTH', 'LogLevel' => 'OFF|BASIC|TRANSFER', 'Mtime' => 'NONE|PRESERVE', 'ObjectTags' => 'PRESERVE|NONE', 'OverwriteMode' => 'ALWAYS|NEVER', 'PosixPermissions' => 'NONE|PRESERVE', 'PreserveDeletedFiles' => 'PRESERVE|REMOVE', 'PreserveDevices' => 'NONE|PRESERVE', 'SecurityDescriptorCopyFlags' => 'NONE|OWNER_DACL|OWNER_DACL_SACL', 'TaskQueueing' => 'ENABLED|DISABLED', 'TransferMode' => 'CHANGED|ALL', 'Uid' => 'NONE|INT_VALUE|NAME|BOTH', 'VerifyMode' => 'POINT_IN_TIME_CONSISTENT|ONLY_FILES_TRANSFERRED|NONE', ], 'TaskExecutionArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Options
-
- Required: Yes
- 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. - TaskExecutionArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the specific task execution that is being updated.
Result Syntax
[]
Result Details
Errors
-
This exception is thrown when the client submits a malformed request.
-
This exception is thrown when an error occurs in the 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
Ec2Config
Description
The subnet and security groups that DataSync uses to access your Amazon EFS file system.
Members
- SecurityGroupArns
-
- Required: Yes
- Type: Array of strings
Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.
- SubnetArn
-
- Required: Yes
- Type: string
Specifies the ARN of a subnet where DataSync creates the network interfaces for managing traffic during your transfer.
The subnet must be located:
-
In the same virtual private cloud (VPC) as the Amazon EFS file system.
-
In the same Availability Zone as at least one mount target for the Amazon EFS file system.
You don't need to specify a subnet that includes a file system mount target.
FilterRule
Description
Specifies which files, folders, and objects to include or exclude when transferring files from source to destination.
Members
FsxProtocol
Description
Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.
Members
- NFS
-
- Type: FsxProtocolNfs structure
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your FSx for OpenZFS file system or FSx for ONTAP file system's storage virtual machine (SVM).
- SMB
-
- Type: FsxProtocolSmb structure
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
FsxProtocolNfs
Description
Specifies the Network File System (NFS) protocol configuration that DataSync uses to access your Amazon FSx for OpenZFS or Amazon FSx for NetApp ONTAP file system.
Members
- MountOptions
-
- Type: NfsMountOptions structure
Specifies how DataSync can access a location using the NFS protocol.
FsxProtocolSmb
Description
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your Amazon FSx for NetApp ONTAP file system. For more information, see Accessing FSx for ONTAP file systems.
Members
- Domain
-
- Type: string
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
- MountOptions
-
- Type: SmbMountOptions structure
Specifies how DataSync can access a location using the SMB protocol.
- Password
-
- Required: Yes
- Type: string
Specifies the password of a user who has permission to access your SVM.
- User
-
- Required: Yes
- Type: string
Specifies a user who has permission to access your SVM.
HdfsNameNode
Description
The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.
Members
- Hostname
-
- Required: Yes
- Type: string
The hostname of the NameNode in the HDFS cluster. This value is the IP address or Domain Name Service (DNS) name of the NameNode. An agent that's installed on-premises uses this hostname to communicate with the NameNode in the network.
- Port
-
- Required: Yes
- Type: int
The port that the NameNode uses to listen to client requests.
InternalException
Description
This exception is thrown when an error occurs in the DataSync service.
Members
InvalidRequestException
Description
This exception is thrown when the client submits a malformed request.
Members
LocationFilter
Description
You can use API filters to narrow down the list of resources returned by ListLocations
. For example, to retrieve all your Amazon S3 locations, you can use ListLocations
with filter name LocationType S3
and Operator Equals
.
Members
- Name
-
- Required: Yes
- Type: string
The name of the filter being used. Each API call supports a list of filters that are available for it (for example,
LocationType
forListLocations
). - Operator
-
- Required: Yes
- Type: string
The operator that is used to compare filter values (for example,
Equals
orContains
). For more about API filtering operators, see API filters for ListTasks and ListLocations. - Values
-
- Required: Yes
- Type: Array of strings
The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
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 URIs 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 (for example,
nfs
ors3
).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 hostname that is 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
Specifies how DataSync can access a location using the NFS protocol.
Members
- Version
-
- Type: string
Specifies the NFS version that you want DataSync to use when mounting your NFS share. If the server refuses to use the version specified, the task fails.
You can specify the following options:
-
AUTOMATIC
(default): DataSync chooses NFS version 4.1. -
NFS3
: Stateless protocol version that allows for asynchronous writes on the server. -
NFSv4_0
: Stateful, firewall-friendly protocol version that supports delegations and pseudo file systems. -
NFSv4_1
: Stateful protocol version that supports sessions, directory delegations, and parallel data processing. NFS version 4.1 also includes all features available in version 4.0.
DataSync currently only supports NFS version 3 with Amazon FSx for NetApp ONTAP locations.
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
Atime
toBEST_EFFORT
, DataSync attempts to preserve the originalAtime
attribute on all source files (that is, the version before thePREPARING
phase). However,Atime
's behavior is not fully standard across platforms, so DataSync can only do this on a best-effort basis.Default value:
BEST_EFFORT
BEST_EFFORT
: Attempt to preserve the per-fileAtime
value (recommended).NONE
: IgnoreAtime
.If
Atime
is set toBEST_EFFORT
,Mtime
must be set toPRESERVE
.If
Atime
is set toNONE
,Mtime
must also beNONE
. - BytesPerSecond
-
- Type: long (int|float)
A value that limits the bandwidth used by DataSync. For example, if you want DataSync to use a maximum of 1 MB, set this value to
1048576
(=1024*1024
). - Gid
-
- Type: string
The POSIX group ID (GID) of the file's owners.
For more information, see Metadata copied by DataSync.
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, andTRANSFER
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. This option is required for cases when you need to run the same task more than one time.Default Value:
PRESERVE
PRESERVE
: Preserve originalMtime
(recommended)NONE
: IgnoreMtime
.If
Mtime
is set toPRESERVE
,Atime
must be set toBEST_EFFORT
.If
Mtime
is set toNONE
,Atime
must also be set toNONE
. - ObjectTags
-
- Type: string
Specifies whether object tags are maintained when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the
NONE
value.Default Value:
PRESERVE
- 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 Considerations when working with Amazon S3 storage classes in DataSync in the 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.
For more information, see Metadata copied by DataSync.
Default value:
PRESERVE
PRESERVE
: Preserve POSIX-style permissions (recommended).NONE
: Ignore permissions.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 Considerations when working with Amazon S3 storage classes in DataSync in the 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 DataSync should preserve the metadata of block and character devices in the source file system, and re-create the files with that device name and metadata on the destination. DataSync does not copy the contents of such devices, only the name and metadata.
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. - SecurityDescriptorCopyFlags
-
- Type: string
A value that determines which components of the SMB security descriptor are copied from source to destination objects.
This value is only used for transfers between SMB and Amazon FSx for Windows File Server locations, or between two Amazon FSx for Windows File Server locations. For more information about how DataSync handles metadata, see How DataSync Handles Metadata and Special Files.
Default value:
OWNER_DACL
OWNER_DACL
: For each copied object, DataSync copies the following metadata:-
Object owner.
-
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
When choosing this option, DataSync does NOT copy the NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
OWNER_DACL_SACL
: For each copied object, DataSync copies the following metadata:-
Object owner.
-
NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.
-
NTFS system access control lists (SACLs), which are used by administrators to log attempts to access a secured object.
Copying SACLs requires granting additional permissions to the Windows user that DataSync uses to access your SMB location. For information about choosing a user that ensures sufficient permissions to files, folders, and metadata, see user.
NONE
: None of the SMB security descriptor components are copied. Destination objects are owned by the user that was provided for accessing the destination location. DACLs and SACLs are set based on the destination server’s configuration. - 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 isENABLED
.If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
- TransferMode
-
- Type: string
A value that determines whether DataSync transfers only the data and metadata that differ between the source and the destination location, or whether DataSync transfers all the content from the source, without comparing to the destination location.
CHANGED
: DataSync copies only data or metadata that is new or different content from the source location to the destination location.ALL
: DataSync copies all source location content to the destination, without comparing to existing content on the destination. - Uid
-
- Type: string
The POSIX user ID (UID) of the file's owner.
For more information, see Metadata copied by DataSync.
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 Configure task settings.
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 Flexible Retrieval 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.
QopConfiguration
Description
The Quality of Protection (QOP) configuration specifies the Remote Procedure Call (RPC) and data transfer privacy settings configured on the Hadoop Distributed File System (HDFS) cluster.
Members
- DataTransferProtection
-
- Type: string
The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your
dfs.data.transfer.protection
setting in thehdfs-site.xml
file on your Hadoop cluster. - RpcProtection
-
- Type: string
The RPC protection setting configured on the HDFS cluster. This setting corresponds to your
hadoop.rpc.protection
setting in yourcore-site.xml
file on your Hadoop cluster.
S3Config
Description
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role used to access an Amazon S3 bucket.
For detailed information about using such a role, see Creating a Location for Amazon S3 in the DataSync User Guide.
Members
SmbMountOptions
Description
Specifies how DataSync can access a location using the SMB protocol.
Members
TagListEntry
Description
Represents a single entry in a list of Amazon Web Services 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 the 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 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 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 DataSync took to transfer the file from the source to the destination location.
- TransferDuration
-
- Type: long (int|float)
The total time in milliseconds that 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 DataSync spent in the VERIFYING phase.
- VerifyStatus
-
- Type: string
The status of the VERIFYING phase.
TaskFilter
Description
You can use API filters to narrow down the list of resources returned by ListTasks
. For example, to retrieve all tasks on a source location, you can use ListTasks
with filter name LocationId
and Operator Equals
with the ARN for the location.
Members
- Name
-
- Required: Yes
- Type: string
The name of the filter being used. Each API call supports a list of filters that are available for it. For example,
LocationId
forListTasks
. - Operator
-
- Required: Yes
- Type: string
The operator that is used to compare filter values (for example,
Equals
orContains
). For more about API filtering operators, see API filters for ListTasks and ListLocations. - Values
-
- Required: Yes
- Type: Array of strings
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
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
TaskSchedule
Description
Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules.