String taskExecutionArn
The Amazon Resource Name (ARN) of the task execution to cancel.
String activationKey
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.
String agentName
The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.
List<E> tags
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: + - = . _ : / @.
String vpcEndpointId
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.
List<E> subnetArns
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.
List<E> securityGroupArns
The ARNs of the security groups used to protect your data transfer task subnets. See SecurityGroupArns.
String agentArn
The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents
for your account and Amazon Web Services Region.
String subdirectory
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).
String efsFilesystemArn
Specifies the ARN for the Amazon EFS file system.
Ec2Config ec2Config
Specifies the subnet and security groups DataSync uses to access your Amazon EFS file system.
List<E> tags
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.
String accessPointArn
Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system.
String fileSystemAccessRoleArn
Specifies an Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
String inTransitEncryption
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 using
FileSystemAccessRoleArn, you must set this parameter to TLS1_2.
String locationArn
The Amazon Resource Name (ARN) of the Amazon EFS file system location that you create.
String fsxFilesystemArn
The Amazon Resource Name (ARN) for the FSx for Lustre file system.
List<E> securityGroupArns
The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.
String subdirectory
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.
List<E> tags
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.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's created.
FsxProtocol protocol
List<E> securityGroupArns
Specifies the Amazon EC2 security groups that provide access to your file system's preferred subnet.
The security groups must allow outbound traffic on the following ports (depending on the protocol you use):
Network File System (NFS): TCP ports 111, 635, and 2049
Server Message Block (SMB): TCP port 445
Your file system's security groups must also allow inbound traffic on the same ports.
String storageVirtualMachineArn
Specifies the ARN of the storage virtual machine (SVM) on your file system where you're copying data to or from.
String subdirectory
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.
List<E> tags
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.
String locationArn
Specifies the ARN of the FSx for ONTAP file system location that you create.
String fsxFilesystemArn
The Amazon Resource Name (ARN) of the FSx for OpenZFS file system.
FsxProtocol protocol
The type of protocol that DataSync uses to access your file system.
List<E> securityGroupArns
The ARNs of the security groups that are used to configure the FSx for OpenZFS file system.
String subdirectory
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).
List<E> tags
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.
String locationArn
The ARN of the FSx for OpenZFS file system location that you created.
String subdirectory
Specifies a mount path for your file system using forward slashes. This is where DataSync reads or writes data (depending on if this is a source or destination location).
String fsxFilesystemArn
Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
List<E> securityGroupArns
Specifies the ARNs of the security groups that provide access to your file system's preferred subnet.
If you choose a security group that doesn't allow connections from within itself, do one of the following:
Configure the security group to allow it to communicate within itself.
Choose a different security group that can communicate with the mount target's security group.
List<E> tags
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.
String user
Specifies the user who has the permissions to access files and folders in the file system.
For information about choosing a user name that ensures sufficient permissions to files, folders, and metadata, see user.
String domain
Specifies the name of the Windows domain that the FSx for Windows File Server belongs to.
String password
Specifies the password of the user who has the permissions to access files and folders in the file system.
String locationArn
The ARN of the FSx for Windows File Server file system location you created.
String subdirectory
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 /.
List<E> nameNodes
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.
Integer blockSize
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).
Integer replicationFactor
The number of DataNodes to replicate the data to when writing to the HDFS cluster. By default, data is replicated to three DataNodes.
String kmsKeyProviderUri
The URI of the HDFS cluster's Key Management Server (KMS).
QopConfiguration qopConfiguration
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 and DataTransferProtection
default to PRIVACY. If you set RpcProtection or DataTransferProtection,
the other parameter assumes the same value.
String authenticationType
The type of authentication used to determine the identity of the user.
String simpleUser
The user name used to identify the client on the host operating system.
If SIMPLE is specified for AuthenticationType, this parameter is required.
String kerberosPrincipal
The Kerberos principal with access to the files and folders on the HDFS cluster.
If KERBEROS is specified for AuthenticationType, this parameter is required.
ByteBuffer kerberosKeytab
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 for AuthenticationType, this parameter is required.
ByteBuffer kerberosKrb5Conf
The krb5.conf file that contains the Kerberos configuration information. You can load the
krb5.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 for AuthenticationType, this parameter is required.
List<E> agentArns
The Amazon Resource Names (ARNs) of the agents that are used to connect to the HDFS cluster.
List<E> tags
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.
String locationArn
The ARN of the source HDFS cluster location that's created.
String subdirectory
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.
String serverHostname
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.
OnPremConfig onPremConfig
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.
NfsMountOptions mountOptions
The NFS mount options that DataSync can use to mount your NFS share.
List<E> tags
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.
String locationArn
The Amazon Resource Name (ARN) of the source NFS file system location that is created.
String serverHostname
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.
Integer serverPort
Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).
String serverProtocol
Specifies the protocol that your object storage server uses to communicate.
String subdirectory
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.
String bucketName
Specifies the name of the object storage bucket involved in the transfer.
String accessKey
Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.
String secretKey
Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.
List<E> agentArns
Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can securely connect with your location.
List<E> tags
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.
String locationArn
Specifies the ARN of the object storage system location that you create.
String subdirectory
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.
String s3BucketArn
The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services Outpost, this must be an access point ARN.
String s3StorageClass
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.
S3Config s3Config
List<E> agentArns
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.
List<E> tags
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.
String locationArn
The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.
String subdirectory
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.
String serverHostname
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.
String user
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.
String domain
The name of the Windows domain that the SMB server belongs to.
String password
The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.
List<E> agentArns
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
SmbMountOptions mountOptions
The mount options used by DataSync to access the SMB server.
List<E> tags
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.
String locationArn
The Amazon Resource Name (ARN) of the source SMB file system location that is created.
String sourceLocationArn
The Amazon Resource Name (ARN) of the source location for the task.
String destinationLocationArn
The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's location.
String cloudWatchLogGroupArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.
String name
The name of a task. This value is a text reference that is used to identify the task in the console.
Options options
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.
List<E> excludes
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".
TaskSchedule schedule
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.
List<E> tags
The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.
List<E> includes
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".
String taskArn
The Amazon Resource Name (ARN) of the task.
String agentArn
The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list
of agents for your account and Amazon Web Services Region.
String locationArn
The Amazon Resource Name (ARN) of the location to delete.
String taskArn
The Amazon Resource Name (ARN) of the task to delete.
String agentArn
The Amazon Resource Name (ARN) of the agent to describe.
String agentArn
The Amazon Resource Name (ARN) of the agent.
String name
The name of the agent.
String status
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.
Date lastConnectionTime
The time that the agent last connected to DataSync.
Date creationTime
The time that the agent was activated (that is, created in your account).
String endpointType
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.
PrivateLinkConfig privateLinkConfig
The subnet and the security group that DataSync used to access a VPC endpoint.
String locationArn
The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.
String locationArn
The ARN of the Amazon EFS file system location.
String locationUri
The URL of the Amazon EFS file system location.
Ec2Config ec2Config
Date creationTime
The time that the location was created.
String accessPointArn
The ARN of the access point that DataSync uses to access the Amazon EFS file system.
String fileSystemAccessRoleArn
The Identity and Access Management (IAM) role that DataSync assumes when mounting the Amazon EFS file system.
String inTransitEncryption
Describes whether DataSync uses Transport Layer Security (TLS) encryption when copying data to or from the Amazon EFS file system.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.
String locationUri
The URI of the FSx for Lustre location that was described.
List<E> securityGroupArns
The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.
Date creationTime
The time that the FSx for Lustre location was created.
String locationArn
Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.
Date creationTime
The time that the location was created.
String locationArn
The ARN of the FSx for ONTAP file system location.
String locationUri
The uniform resource identifier (URI) of the FSx for ONTAP file system location.
FsxProtocol protocol
List<E> securityGroupArns
The security groups that DataSync uses to access your FSx for ONTAP file system.
String storageVirtualMachineArn
The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.
String fsxFilesystemArn
The ARN of the FSx for ONTAP file system.
String locationArn
The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe.
String locationArn
The ARN of the FSx for OpenZFS location that was described.
String locationUri
The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.
Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder
List<E> securityGroupArns
The ARNs of the security groups that are configured for the FSx for OpenZFS file system.
FsxProtocol protocol
The type of protocol that DataSync uses to access your file system.
Date creationTime
The time that the FSx for OpenZFS location was created.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.
String locationArn
The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.
String locationUri
The URL of the FSx for Windows File Server location that was described.
List<E> securityGroupArns
The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.
Date creationTime
The time that the FSx for Windows File Server location was created.
String user
The user who has the permissions to access files and folders in the FSx for Windows File Server file system.
String domain
The name of the Windows domain that the FSx for Windows File Server belongs to.
String locationArn
The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
String locationArn
The ARN of the HDFS cluster location.
String locationUri
The URI of the HDFS cluster location.
List<E> nameNodes
The NameNode that manage the HDFS namespace.
Integer blockSize
The size of the data blocks to write into the HDFS cluster.
Integer replicationFactor
The number of DataNodes to replicate the data to when writing to the HDFS cluster.
String kmsKeyProviderUri
The URI of the HDFS cluster's Key Management Server (KMS).
QopConfiguration qopConfiguration
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.
String authenticationType
The type of authentication used to determine the identity of the user.
String simpleUser
The user name used to identify the client on the host operating system. This parameter is used if the
AuthenticationType is defined as SIMPLE.
String kerberosPrincipal
The Kerberos principal with access to the files and folders on the HDFS cluster. This parameter is used if the
AuthenticationType is defined as KERBEROS.
List<E> agentArns
The ARNs of the agents that are used to connect to the HDFS cluster.
Date creationTime
The time that the HDFS location was created.
String locationArn
The Amazon Resource Name (ARN) of the NFS location to describe.
String locationArn
The Amazon Resource Name (ARN) of the NFS location that was described.
String locationUri
The URL of the source NFS location that was described.
OnPremConfig onPremConfig
NfsMountOptions mountOptions
The NFS mount options that DataSync used to mount your NFS share.
Date creationTime
The time that the NFS location was created.
String locationArn
The Amazon Resource Name (ARN) of the object storage system location that you want information about.
String locationArn
The ARN of the object storage system location.
String locationUri
The URL of the object storage system location.
String accessKey
The access key (for example, a user name) required to authenticate with the object storage server.
Integer serverPort
The port that your object storage server accepts inbound network traffic on (for example, port 443).
String serverProtocol
The protocol that your object storage server uses to communicate.
List<E> agentArns
The ARNs of the DataSync agents that can securely connect with your location.
Date creationTime
The time that the location was created.
String locationArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.
String locationArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.
String locationUri
The URL of the Amazon S3 location that was described.
String s3StorageClass
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.
S3Config s3Config
List<E> agentArns
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.
Date creationTime
The time that the Amazon S3 bucket location was created.
String locationArn
The Amazon Resource Name (ARN) of the SMB location to describe.
String locationArn
The Amazon Resource Name (ARN) of the SMB location that was described.
String locationUri
The URL of the source SMB location that was described.
List<E> agentArns
The Amazon Resource Name (ARN) of the source SMB file system location that is created.
String user
The user who can mount the share, has the permissions to access files and folders in the SMB share.
String domain
The name of the Windows domain that the SMB server belongs to.
SmbMountOptions mountOptions
The mount options that are available for DataSync to use to access an SMB location.
Date creationTime
The time that the SMB location was created.
String taskExecutionArn
The Amazon Resource Name (ARN) of the task that is being executed.
String taskExecutionArn
The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is
hierarchical and includes TaskArn for the task that was executed.
For example, a TaskExecution value with the ARN
arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
String status
The status of the task execution.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
Options options
List<E> excludes
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"
List<E> includes
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"
Date startTime
The time that the task execution was started.
Long estimatedFilesToTransfer
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.
Long estimatedBytesToTransfer
The estimated physical number of bytes that is to be transferred over the network.
Long filesTransferred
The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.
If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This
value can also be greater than EstimatedFilesTransferred in some cases. This element is
implementation-specific for some location types, so don't use it as an indicator for a correct file number or to
monitor your task execution.
Long bytesWritten
The number of logical bytes written to the destination Amazon Web Services storage resource.
Long bytesTransferred
The physical number of bytes transferred over the network.
TaskExecutionResultDetail result
The result of the task execution.
String taskArn
The Amazon Resource Name (ARN) of the task to describe.
String taskArn
The Amazon Resource Name (ARN) of the task that was described.
String status
The status of the task that was described.
For detailed information about task execution statuses, see Understanding Task Statuses in the DataSync User Guide.
String name
The name of the task that was described.
String currentTaskExecutionArn
The Amazon Resource Name (ARN) of the task execution that is syncing files.
String sourceLocationArn
The Amazon Resource Name (ARN) of the source file system's location.
String destinationLocationArn
The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's location.
String cloudWatchLogGroupArn
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.
List<E> sourceNetworkInterfaceArns
The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs) that were created for your subnet.
List<E> destinationNetworkInterfaceArns
The Amazon Resource Names (ARNs) of the destination elastic network interfaces (ENIs) that were created for your subnet.
Options options
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.
List<E> excludes
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".
TaskSchedule schedule
The schedule used to periodically transfer files from a source to a destination location.
String errorCode
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
String errorDetail
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
Date creationTime
The time that the task was created.
List<E> includes
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".
String subnetArn
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.
List<E> securityGroupArns
Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.
FsxProtocolNfs nFS
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).
FsxProtocolSmb sMB
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.
NfsMountOptions mountOptions
String domain
Specifies the fully qualified domain name (FQDN) of the Microsoft Active Directory that your storage virtual machine (SVM) belongs to.
SmbMountOptions mountOptions
String password
Specifies the password of a user who has permission to access your SVM.
String user
Specifies a user name that can mount the location and access the files, folders, and metadata that you need in the SVM.
If you provide a user in your Active Directory, note the following:
If you're using Directory Service for Microsoft Active Directory, the user must be a member of the Amazon Web Services Delegated FSx Administrators group.
If you're using a self-managed Active Directory, the user must be a member of either the Domain Admins group or a custom group that you specified for file system administration when you created your file system.
Make sure that the user has the permissions it needs to copy the data you want:
SE_TCB_NAME: Required to set object ownership and file metadata. With this privilege, you also can
copy NTFS discretionary access lists (DACLs).
SE_SECURITY_NAME: May be needed to copy NTFS system access control lists (SACLs). This operation
specifically requires the Windows privilege, which is granted to members of the Domain Admins group. If you
configure your task to copy SACLs, make sure that the user has the required privileges. For information about
copying SACLs, see Ownership and permissions-related options.
String hostname
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.
Integer port
The port that the NameNode uses to listen to client requests.
String errorCode
Integer maxResults
The maximum number of locations to return.
String nextToken
An opaque string that indicates the position at which to begin the next list of locations.
List<E> filters
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 use ListLocations with filter name
LocationType S3 and Operator Equals.
Integer maxResults
The maximum number of tasks to return.
String nextToken
An opaque string that indicates the position at which to begin the next list of tasks.
List<E> filters
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 use ListTasks with filter name
LocationId and Operator Equals with the ARN for the location.
String name
The name of the filter being used. Each API call supports a list of filters that are available for it (for
example, LocationType for ListLocations).
List<E> values
The values that you want to filter for. For example, you might want to display only Amazon S3 locations.
String operator
The operator that is used to compare filter values (for example, Equals or Contains).
String locationArn
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.
String locationUri
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 or s3).
GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is
us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket.
An example for NFS is a valid IPv4 address or a 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.
String version
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.
String verifyMode
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.
String overwriteMode
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.
String atime
A file metadata value that shows the last time a file was accessed (that is, when the file was read or written
to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original
Atime attribute on all source files (that is, the version before the PREPARING phase).
However, Atime's behavior is not fully standard across platforms, so DataSync can only do this on a
best-effort basis.
Default value: BEST_EFFORT
BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
NONE: Ignore Atime.
If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE
.
If Atime is set to NONE, Mtime must also be NONE.
String mtime
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 original Mtime (recommended)
NONE: Ignore Mtime.
If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT
.
If Mtime is set to NONE, Atime must also be set to NONE.
String uid
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.
String gid
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.
String preserveDeletedFiles
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.
String preserveDevices
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.
String posixPermissions
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.
Long bytesPerSecond
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).
String taskQueueing
A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED
, the tasks will be queued. The default is ENABLED.
If you use the same agent to run multiple tasks, you can enable the tasks to run in series. For more information, see Queueing task executions.
String logLevel
A value that determines the type of logs that DataSync publishes to a log stream in the Amazon CloudWatch log
group that you provide. For more information about providing a log group for DataSync, see CloudWatchLogGroupArn. If set to OFF, no logs are published. BASIC publishes logs
on errors for individual files transferred, and TRANSFER publishes logs for every file or object
that is transferred and integrity checked.
String transferMode
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.
String securityDescriptorCopyFlags
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.
String objectTags
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
String vpcEndpointId
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.
String privateLinkEndpoint
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.
List<E> subnetArns
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.
List<E> securityGroupArns
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.
String rpcProtection
The RPC protection setting configured on the HDFS cluster. This setting corresponds to your
hadoop.rpc.protection setting in your core-site.xml file on your Hadoop cluster.
String dataTransferProtection
The data transfer protection setting configured on the HDFS cluster. This setting corresponds to your
dfs.data.transfer.protection setting in the hdfs-site.xml file on your Hadoop cluster.
String bucketAccessRoleArn
The ARN of the IAM role for accessing the S3 bucket.
String version
Specifies the SMB version that you want DataSync to use when mounting your SMB share. If you don't specify a
version, DataSync defaults to AUTOMATIC and chooses a version based on negotiation with the SMB
server.
String taskArn
The Amazon Resource Name (ARN) of the task to start.
Options overrideOptions
List<E> includes
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".
List<E> excludes
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".
String taskExecutionArn
The Amazon Resource Name (ARN) of the specific task execution that was started.
Long prepareDuration
The total time in milliseconds that DataSync spent in the PREPARING phase.
String prepareStatus
The status of the PREPARING phase.
Long totalDuration
The total time in milliseconds that DataSync took to transfer the file from the source to the destination location.
Long transferDuration
The total time in milliseconds that DataSync spent in the TRANSFERRING phase.
String transferStatus
The status of the TRANSFERRING phase.
Long verifyDuration
The total time in milliseconds that DataSync spent in the VERIFYING phase.
String verifyStatus
The status of the VERIFYING phase.
String errorCode
Errors that DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.
String errorDetail
Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.
String name
The name of the filter being used. Each API call supports a list of filters that are available for it. For
example, LocationId for ListTasks.
List<E> values
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.
String operator
The operator that is used to compare filter values (for example, Equals or Contains).
String scheduleExpression
A cron expression that specifies when DataSync initiates a scheduled transfer from a source to a destination location.
String locationArn
The Amazon Resource Name (ARN) of the source HDFS cluster location.
String subdirectory
A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.
List<E> nameNodes
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.
Integer blockSize
The size of the data blocks to write into the HDFS cluster.
Integer replicationFactor
The number of DataNodes to replicate the data to when writing to the HDFS cluster.
String kmsKeyProviderUri
The URI of the HDFS cluster's Key Management Server (KMS).
QopConfiguration qopConfiguration
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.
String authenticationType
The type of authentication used to determine the identity of the user.
String simpleUser
The user name used to identify the client on the host operating system.
String kerberosPrincipal
The Kerberos principal with access to the files and folders on the HDFS cluster.
ByteBuffer kerberosKeytab
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.
ByteBuffer kerberosKrb5Conf
The krb5.conf file that contains the Kerberos configuration information. You can load the
krb5.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.
List<E> agentArns
The ARNs of the agents that are used to connect to the HDFS cluster.
String locationArn
The Amazon Resource Name (ARN) of the NFS location to update.
String subdirectory
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.
OnPremConfig onPremConfig
NfsMountOptions mountOptions
String locationArn
The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.
Integer serverPort
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.
String serverProtocol
The protocol that the object storage server uses to communicate. Valid values are HTTP or
HTTPS.
String subdirectory
The subdirectory in the self-managed object storage server that is used to read data from.
String accessKey
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 and
SecretKey to provide the user name and password, respectively.
String secretKey
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 and
SecretKey to provide the user name and password, respectively.
List<E> agentArns
The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.
String locationArn
The Amazon Resource Name (ARN) of the SMB location to update.
String subdirectory
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.
String user
The user who can mount the share has the permissions to access files and folders in the SMB share.
String domain
The name of the Windows domain that the SMB server belongs to.
String password
The password of the user who can mount the share has the permissions to access files and folders in the SMB share.
List<E> agentArns
The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
SmbMountOptions mountOptions
String taskArn
The Amazon Resource Name (ARN) of the resource name of the task to update.
Options options
List<E> excludes
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".
TaskSchedule schedule
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.
String name
The name of the task to update.
String cloudWatchLogGroupArn
The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log group.
List<E> includes
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".
Copyright © 2022. All rights reserved.