Module Smaws_Client_DataSync.Types

Specifies whether you want DataSync to PRESERVE object tags (default behavior) when transferring between object storage systems. If you want your DataSync task to ignore object tags, specify the NONE value.

Specifies 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 FSx for Windows File Server locations. For more information, see Understanding how DataSync handles file and object metadata.

• OWNER_DACL (default) - For each copied object, DataSync copies the following metadata:

  • The object owner.

  • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

    DataSync won't copy NTFS system access control lists (SACLs) with this option.

• OWNER_DACL_SACL - For each copied object, DataSync copies the following metadata:

  • The object owner.
  • NTFS discretionary access control lists (DACLs), which determine whether to grant access to an object.

  • 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 with the right permissions, see required permissions for SMB, FSx for Windows File Server, or FSx for ONTAP (depending on the type of location in your transfer).

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

Specifies whether DataSync transfers only the data (including metadata) that differs between locations following an initial copy or transfers all data every time you run the task. If you're planning on recurring transfers, you might only want to transfer what's changed since your previous task execution.

• CHANGED (default) - After your initial full transfer, DataSync copies only the data and metadata that differs between the source and destination location.
• ALL - DataSync copies everything in the source to the destination without comparing differences between the locations.

Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see CloudWatchLogGroupArn.

• BASIC - Publishes logs with only basic information (such as transfer errors).
• TRANSFER - Publishes logs for all files or objects that your DataSync task transfers and performs data-integrity checks on.
• OFF - No logs are published.

Specifies whether your transfer tasks should be put into a queue during certain scenarios when running multiple tasks. This is ENABLED by default.

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

Specifies 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 Understanding how DataSync handles file and object metadata.

• PRESERVE (default) - Preserves POSIX-style permissions, which is recommended.
• NONE - Ignores POSIX-style permissions.

DataSync can preserve extant permissions of a source location.

Specifies whether DataSync should preserve the metadata of block and character devices in the source location and recreate the files with that device name and metadata on the destination. DataSync copies only the name and metadata of such devices.

DataSync can't copy the actual contents of these devices because they're nonterminal and don't return an end-of-file (EOF) marker.

• NONE (default) - Ignores special devices (recommended).
• PRESERVE - Preserves character and block device metadata. This option currently isn't supported for Amazon EFS.

Specifies whether files in the destination location that don't exist in the source should be preserved. This option can affect your Amazon S3 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.

• PRESERVE (default) - Ignores such destination files, which is recommended.
• REMOVE - Deletes destination files that aren’t present in the source.

If you set this parameter to REMOVE, you can't set TransferMode to ALL. When you transfer all data, DataSync doesn't scan your destination location and doesn't know what to delete.

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

• INT_VALUE (default) - Preserves the integer value of user ID (UID) and GID, which is recommended.
• NONE - Ignores UID and GID.

For more information, see Understanding how DataSync handles file and object metadata.

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

• INT_VALUE (default) - Preserves the integer value of UID and group ID (GID), which is recommended.
• NONE - Ignores UID and GID.

For more information, see Metadata copied by DataSync.

Specifies whether to preserve metadata indicating the last time that a file was written to before the PREPARING step of your task execution. This option is required when you need to run the a task more than once.

• PRESERVE (default) - Preserves original Mtime, which is recommended.
• NONE - Ignores 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.

Specifies whether to preserve metadata indicating the last time a file was read or written to.

The behavior of Atime isn't fully standard across platforms, so DataSync can only do this on a best-effort basis.

• BEST_EFFORT (default) - DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING steps of the task execution). This option is recommended.
• NONE - Ignores 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.

Specifies whether DataSync should modify or preserve data at the destination location.

• ALWAYS (default) - DataSync modifies data in the destination location when source data (including metadata) has changed.

  If DataSync overwrites objects, you might incur additional charges for certain Amazon S3 storage classes (for example, for retrieval or early deletion). For more information, see Storage class considerations with Amazon S3 transfers.

• NEVER - DataSync doesn't overwrite data in the destination location even if the source data has changed. You can use this option to protect against overwriting changes made to files or objects in the destination.

Specifies if and how DataSync checks the integrity of your data at the end of your transfer.

• ONLY_FILES_TRANSFERRED (recommended) - DataSync calculates the checksum of transferred data (including metadata) at the source location. At the end of the transfer, DataSync then compares this checksum to the checksum calculated on that data at the destination.

  This is the default option for Enhanced mode tasks.

  We recommend this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

• POINT_IN_TIME_CONSISTENT - At the end of the transfer, DataSync checks the entire source and destination to verify that both locations are fully synchronized.

  The is the default option for Basic mode tasks and isn't currently supported with Enhanced mode tasks.

  If you use a manifest, DataSync only scans and verifies what's listed in the manifest.

  You can't use this option when transferring to S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage classes. For more information, see Storage class considerations with Amazon S3 locations.

• NONE - DataSync performs data integrity checks only during your transfer. Unlike other options, there's no additional verification at the end of your transfer.

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

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

Specifies whether to enable or disable your task schedule. Your schedule is enabled by default, but there can be situations where you need to disable it. For example, you might need to pause a recurring transfer to fix an issue with your task or perform maintenance on your storage system.

DataSync might disable your schedule automatically if your task fails repeatedly with the same error. For more information, see TaskScheduleDetails.

Specifies your task schedule by using a cron or rate expression.

Use cron expressions for task schedules that run on a specific time and day. For example, the following cron expression creates a task schedule that runs at 8 AM on the first Wednesday of every month:

cron(0 8 * * 3#1)

Use rate expressions for task schedules that run on a regular interval. For example, the following rate expression creates a task schedule that runs every 12 hours:

rate(12 hours)

For information about cron and rate expression syntax, see the Amazon EventBridge User Guide.

Specifies the object version ID of the manifest that you want DataSync to use. If you don't set this, DataSync uses the latest version of the object.

Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.

Specifies the Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see Providing DataSync access to your manifest.

Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, prefix/my-manifest.csv).

Specifies the S3 bucket where you're hosting your manifest.

Specifies the manifest that you want DataSync to use and where it's hosted.

You must specify this parameter if you're configuring a new manifest on or after February 7, 2024.

If you don't, you'll get a 400 status code and ValidationException error stating that you're missing the IAM role for DataSync to access the S3 bucket where you're hosting your manifest. For more information, see Providing DataSync access to your manifest.

Specifies the file format of your manifest. For more information, see Creating a manifest.

Specifies what DataSync uses the manifest for.

Specifies the Amazon Resource Name (ARN) of the IAM policy that allows DataSync to upload a task report to your S3 bucket. For more information, see Allowing DataSync to upload a task report to an Amazon S3 bucket.

Specifies the ARN of the S3 bucket where DataSync uploads your report.

Specifies a bucket prefix for your report.

Specifies the Amazon S3 bucket where DataSync uploads your task report.

Specifies whether your task report includes errors only or successes and errors.

For example, your report might mostly include only what didn't go well in your transfer (ERRORS_ONLY). At the same time, you want to verify that your task filter is working correctly. In this situation, you can get a list of what files DataSync successfully skipped and if something transferred that you didn't to transfer (SUCCESSES_AND_ERRORS).

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to delete in your destination location. This only applies if you configure your task to delete data in the destination that isn't in the source.

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.

Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.

Customizes the reporting level for aspects of your task report. For example, your report might generally only include errors, but you could specify that you want a list of successes and errors just for the files that DataSync attempted to delete in your destination location.

Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This only applies if you enable versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task execution.

Specifies whether you want your task report to include only what went wrong with your transfer or a list of what succeeded and didn't.

• ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
• SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify, and delete.

Specifies the type of task report that you want:

• SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects, and directories transferred and transfer duration.
• STANDARD: Provides complete details about your task, including a full list of files, objects, and directories that were transferred, skipped, verified, and more.

Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task reports.

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

When using this parameter, your caller identity (the IAM role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a manifest configuration, specify this parameter as empty.

Specifies include filters define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For Enhanced mode tasks, you must use /aws/datasync as your log group name. For example:

arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*

For more information, see Monitoring data transfers with CloudWatch Logs.

Specifies the name of your task.

Specifies a schedule for when you want your task to run. For more information, see Scheduling your task.

Specifies exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

Specifies the ARN of the task that you want to update.

Specifies the Amazon Resource Name (ARN) of the task execution that you're updating.

Specifies the ARN for the customer-managed KMS key that DataSync uses to encrypt the DataSync-managed secret stored for SecretArn. DataSync provides this key to Secrets Manager.

Specifies the ARN for the DataSync-managed Secrets Manager secret that that is used to access a specific storage location. This property is generated by DataSync and is read-only. DataSync encrypts this secret with the KMS key that you specify for KmsKeyArn.

Specifies the ARN for the Identity and Access Management role that DataSync uses to access the secret specified for SecretArn.

Specifies the ARN for an Secrets Manager secret.

By default, DataSync automatically chooses an SMB protocol version based on negotiation with your SMB file server. You also can configure DataSync to use a specific SMB version, but we recommend doing this only if DataSync has trouble negotiating with the SMB file server automatically.

These are the following options for configuring the SMB version:

• AUTOMATIC (default): DataSync and the SMB file server negotiate the highest version of SMB that they mutually support between 2.1 and 3.1.1.

  This is the recommended option. If you instead choose a specific version that your file server doesn't support, you may get an Operation Not Supported error.

• SMB3: Restricts the protocol negotiation to only SMB version 3.0.2.
• SMB2: Restricts the protocol negotiation to only SMB version 2.1.
• SMB2_0: Restricts the protocol negotiation to only SMB version 2.0.

• SMB1: Restricts the protocol negotiation to only SMB version 1.0.

  The SMB1 option isn't available when creating an Amazon FSx for NetApp ONTAP location.

Specifies a Kerberos configuration file (krb5.conf) that defines your Kerberos realm configuration.

The file must be base64 encoded. If you're using the CLI, the encoding is done for you.

Specifies your Kerberos key table (keytab) file, which includes mappings between your Kerberos principal and encryption keys.

To avoid task execution errors, make sure that the Kerberos principal that you use to create the keytab file matches exactly what you specify for KerberosPrincipal.

Specifies a Kerberos prinicpal, which is an identity in your Kerberos realm that has permission to access the files, folders, and file metadata in your SMB file server.

A Kerberos principal might look like HOST/kerberosuser@MYDOMAIN.ORG.

Principal names are case sensitive. Your DataSync task execution will fail if the principal that you specify for this parameter doesn’t exactly match the principal that you use to create the keytab file.

Specifies the IP addresses (IPv4 or IPv6) for the DNS servers that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to KERBEROS.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right SMB file server.

Specifies the authentication protocol that DataSync uses to connect to your SMB file server. DataSync supports NTLM (default) and KERBEROS authentication.

For more information, see Providing DataSync access to SMB file servers.

Specifies the DataSync agent (or agents) that can connect to your SMB file server. You specify an agent by using its Amazon Resource Name (ARN).

Specifies configuration information for a customer-managed secret, such as a Password or KerberosKeytab or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Specifies configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

Specifies the password of the user who can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

Specifies the Windows domain name that your SMB file server belongs to. This parameter applies only if AuthenticationType is set to NTLM.

If you have multiple domains in your environment, configuring this parameter makes sure that DataSync connects to the right file server.

Specifies the user name that can mount your SMB file server and has permission to access the files and folders involved in your transfer. This parameter applies only if AuthenticationType is set to NTLM.

For information about choosing a user with the right level of access for your transfer, see Providing DataSync access to SMB file servers.

Specifies the domain name or IP address (IPv4 or IPv6) of the SMB file server that your DataSync agent connects to.

If you're using Kerberos authentication, you must specify a domain name.

Specifies the name of the share exported by your SMB file server where DataSync will read or write data. You can include a subdirectory in the share path (for example, /path/to/subdirectory). Make sure that other SMB clients in your network can also mount this path.

To copy all data in the specified subdirectory, DataSync must be able to mount the SMB share and access all of its data. For more information, see Providing DataSync access to SMB file servers.

Specifies the ARN of the SMB location that you want to update.

Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

Specifies the storage class that you want your objects to use when Amazon S3 is a transfer destination.

For buckets in Amazon Web Services Regions, the storage class defaults to STANDARD. For buckets on Outposts, the storage class defaults to OUTPOSTS.

For more information, see Storage class considerations with Amazon S3 transfers.

Specifies a prefix in the S3 bucket that DataSync reads from or writes to (depending on whether the bucket is a source or destination location).

DataSync can't transfer objects with a prefix that begins with a slash (/) or includes //, /./, or /../ patterns. For example:

• /photos
• photos//2006/January
• photos/./2006/February
• photos/../2006/March

Specifies the Amazon Resource Name (ARN) of the Amazon S3 transfer location that you're updating.

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

Specifies a certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA). You must specify a single .pem file with a full certificate chain (for example, file:///home/user/.ssh/object_storage_certificates.pem).

The certificate chain might include:

• The object storage system's certificate
• All intermediate certificates (if there are any)
• The root certificate of the signing CA

You can concatenate your certificates into a .pem file (which can be up to 32768 bytes before base64 encoding). The following example cat command creates an object_storage_certificates.pem file that includes three certificates:

cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem

To use this parameter, configure ServerProtocol to HTTPS.

Updating this parameter doesn't interfere with tasks that you have in progress.

(Optional) Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can connect with your object storage system. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

You cannot add or remove agents from a storage location after you initially create it.

Specifies the secret key (for example, a password) if credentials are required to authenticate with the object storage server.

If you provide a secret using SecretKey, but do not provide secret configuration details using CmkSecretConfig or CustomSecretConfig, then DataSync stores the token using your Amazon Web Services account's Secrets Manager secret.

Specifies the access key (for example, a user name) if credentials are required to authenticate with the object storage server.

Specifies the domain name or IP address (IPv4 or IPv6) of the object storage server that your DataSync agent connects to.

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.

Specifies the protocol that your object storage server uses to communicate.

Specifies the port that your object storage server accepts inbound network traffic on (for example, port 443).

Specifies the ARN of the object storage system location that you're updating.

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your NFS file server.

You can specify more than one agent. For more information, see Using multiple DataSync agents.

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.

Specifies the DNS name or IP address (IPv4 or IPv6) of the NFS file server that your DataSync agent connects to.

Specifies the export path in your NFS file server that you want DataSync to mount.

This path (or a subdirectory of the path) is where DataSync transfers data to or from. For information on configuring an export for DataSync, see Accessing NFS file servers.

Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you want to update.

The port that the NameNode uses to listen to client requests.

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.

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.

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.

Specifies configuration information for a customer-managed secret, such as a KerberosKeytab or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Specifies configuration information for a DataSync-managed secret, such as a KerberosKeytab or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

The Amazon Resource Names (ARNs) of the DataSync agents that can connect to your HDFS cluster.

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.

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.

The Kerberos principal with access to the files and folders on the HDFS cluster.

The user name used to identify the client on the host operating system.

The type of authentication used to determine the identity of the user.

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.

The URI of the HDFS cluster's Key Management Server (KMS).

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

The size of the data blocks to write into the HDFS cluster.

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.

A subdirectory in the HDFS cluster. This subdirectory is used to read data from or write data to the HDFS cluster.

The Amazon Resource Name (ARN) of the source HDFS cluster location.

Specifies configuration information for a customer-managed secret, such as a Password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Specifies configuration information for a DataSync-managed secret, such as a Password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

Specifies the password of the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

Specifies the user with the permissions to mount and access the files, folders, and file metadata in your FSx for Windows File Server file system.

For information about choosing a user with the right level of access for your transfer, see required permissions for FSx for Windows File Server locations.

Specifies the name of the Windows domain that your FSx for Windows File Server file system belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right file system.

Specifies a mount path for your file system using forward slashes. DataSync uses this subdirectory to read or write data (depending on whether the file system is a source or destination location).

Specifies the ARN of the FSx for Windows File Server transfer location that you're updating.

Specifies the ARN for an Secrets Manager secret.

Specifies configuration information for a customer-managed Secrets Manager secret where the password for an FSx for ONTAP storage location (using SMB) is stored in plain text, in Secrets Manager. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret. For more information, see Using a secret that you manage.

You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

Specifies configuration information for a DataSync-managed secret, which includes the password that DataSync uses to access a specific FSx for ONTAP storage location (using SMB), with a customer-managed KMS key.

When you include this parameter as part of a CreateLocationFsxOntap request, you provide only the KMS key ARN. DataSync uses this KMS key together with the Password you specify for to create a DataSync-managed secret to store the location access credentials.

Make sure that DataSync has permission to access the KMS key that you specify. For more information, see Using a service-managed secret encrypted with a custom KMS key.

You can use either CmkSecretConfig (with Password) or CustomSecretConfig (without Password) to provide credentials for a CreateLocationFsxOntap request. Do not provide both parameters for the same request.

Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

Do not provide this for a CreateLocation request. ManagedSecretConfig is a ReadOnly property and is only be populated in the DescribeLocation response.

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

Specifies the password of a user who has permission to access your SVM.

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

If you have multiple domains in your environment, configuring this setting makes sure that DataSync connects to the right SVM.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.

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

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

Specifies the Amazon Resource Name (ARN) of the FSx for OpenZFS transfer location that you're updating.

Specifies configuration information for a customer-managed secret, such as a Password or set of credentials that DataSync uses to access a specific transfer location. This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

Specifies configuration information for a DataSync-managed secret, such as a Password or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

Specifies a user that can mount and access the files, folders, and metadata in your SVM.

For information about choosing a user with the right level of access for your transfer, see Using the SMB protocol.

Specifies the password of a user who has permission to access your SVM.

Specifies the name of the Windows domain that your storage virtual machine (SVM) belongs to.

If you have multiple Active Directory domains in your environment, configuring this parameter makes sure that DataSync connects to the right SVM.

Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM).

Specifies a path to the file share in the storage virtual machine (SVM) where you want to transfer data to or from.

You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares). For example, your mount path might be /vol1, /vol1/tree1, or /share1.

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.

Specifies the data transfer protocol that DataSync uses to access your Amazon FSx file system.

Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP transfer location that you're updating.

Specifies a mount path for your FSx for Lustre file system. The path can include subdirectories.

When the location is used as a source, DataSync reads data from the mount path. When the location is used as a destination, DataSync writes data to the mount path. If you don't include this parameter, DataSync uses the file system's root directory (/).

Specifies the Amazon Resource Name (ARN) of the FSx for Lustre transfer location that you're updating.

Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 encryption when it transfers data to or from your 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.

Specifies an Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For information on creating this role, see Creating a DataSync IAM role for Amazon EFS file system access.

Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to mount your Amazon EFS file system.

For more information, see Accessing restricted Amazon EFS file systems.

Specifies a mount path for your Amazon EFS file system. This is where DataSync reads or writes data on your file system (depending on if this is a source or destination location).

By default, DataSync uses the root directory (or access point if you provide one by using AccessPointArn). You can also include subdirectories using forward slashes (for example, /path/to/folder).

Specifies the Amazon Resource Name (ARN) of the Amazon EFS transfer location that you're updating.

Specifies a SAS token that provides permissions to access your Azure Blob Storage.

The token is part of the SAS URI string that comes after the storage resource URI and a question mark. A token looks something like this:

sp=r&st=2023-12-20T14:54:52Z&se=2023-12-20T22:54:52Z&spr=https&sv=2021-06-08&sr=c&sig=aBBKDWQvyuVcTPH9EBp%2FXTI9E%2F%2Fmq171%2BZU178wcwqU%3D

Specifies configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Specifies configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

(Optional) Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect with your Azure Blob Storage container. If you are setting up an agentless cross-cloud transfer, you do not need to specify a value for this parameter.

You can specify more than one agent. For more information, see Using multiple agents for your transfer.

You cannot add or remove agents from a storage location after you initially create it.

Specifies the access tier that you want your objects or files transferred into. This only applies when using the location as a transfer destination. For more information, see Access tiers.

Specifies the type of blob that you want your objects or files to be when transferring them into Azure Blob Storage. Currently, DataSync only supports moving data into Azure Blob Storage as block blobs. For more information on blob types, see the Azure Blob Storage documentation.

Specifies the SAS configuration that allows DataSync to access your Azure Blob Storage.

Specifies the authentication method DataSync uses to access your Azure Blob Storage. DataSync can access blob storage using a shared access signature (SAS).

Specifies path segments if you want to limit your transfer to a virtual directory in your container (for example, /my/images).

Specifies the ARN of the Azure Blob Storage transfer location that you're updating.

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

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

Specifies the keys in the tags that you want to remove.

Specifies the Amazon Resource Name (ARN) of the resource to remove the tags from.

Indicates how your task schedule was disabled.

• USER - Your schedule was manually disabled by using the UpdateTask operation or DataSync console.
• SERVICE - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.

Provides a reason if the task schedule is disabled.

If your schedule is disabled by USER, you see a Manually disabled by user. message.

If your schedule is disabled by SERVICE, you see an error message to help you understand why the task keeps failing. For information on resolving DataSync errors, see Troubleshooting issues with DataSync transfers.

Indicates the last time the status of your task schedule changed. For example, if DataSync automatically disables your schedule because of a repeated error, you can see when the schedule was disabled.

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

The name of the task.

The status of the task.

The Amazon Resource Name (ARN) of the task.

The operator that is used to compare filter values (for example, Equals or Contains).

The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.

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.

The detailed description of an error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

An error that DataSync encountered during your task execution. You can use this information to help troubleshoot issues.

The status of the VERIFYING step for your task execution. For more information, see Task execution statuses.

The time in milliseconds that your task execution was in the VERIFYING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync verifies your data's integrity.

The status of the TRANSFERRING step for your task execution. For more information, see Task execution statuses.

The time in milliseconds that your task execution was in the TRANSFERRING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync transfers your data.

The time in milliseconds that your task execution ran.

The status of the PREPARING step for your task execution. For more information, see Task execution statuses.

The time in milliseconds that your task execution was in the PREPARING step. For more information, see Task execution statuses.

For Enhanced mode tasks, the value is always 0. For more information, see How DataSync prepares your data transfer.

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

The status of a task execution. For more information, see Task execution statuses.

The Amazon Resource Name (ARN) of a task execution.

The number of directories that DataSync finds at your destination location. This counter is only applicable if you configure your task to delete data in the destination that isn't in the source.

The number of directories that DataSync finds at your source location.

• With a manifest, DataSync lists only what's in your manifest (and not everything at your source location).
• With an include filter, DataSync lists only what matches the filter at your source location.
• With an exclude filter, DataSync lists everything at your source location before applying the filter.

The number of directories that DataSync fails to delete during your task execution.

The number of directories that DataSync fails to verify during your task execution.

The number of directories that DataSync fails to transfer during your task execution.

The number of directories that DataSync fails to prepare during your task execution.

The number of directories that DataSync fails to list during your task execution.

The number of files or objects that DataSync finds at your destination location. This counter is only applicable if you configure your task to delete data in the destination that isn't in the source.

The number of files or objects that DataSync finds at your source location.

• With a manifest, DataSync lists only what's in your manifest (and not everything at your source location).
• With an include filter, DataSync lists only what matches the filter at your source location.
• With an exclude filter, DataSync lists everything at your source location before applying the filter.

The number of files or objects that DataSync fails to delete during your task execution.

The number of files or objects that DataSync fails to verify during your task execution.

The number of files or objects that DataSync fails to transfer during your task execution.

The number of files or objects that DataSync fails to prepare during your task execution.

The value for an Amazon Web Services resource tag.

The key for an Amazon Web Services resource tag.

Specifies the tags that you want to apply to the resource.

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

The ARN of the running task execution.

Specifies the tags that you want to apply to the Amazon Resource Name (ARN) representing the task execution.

Tags are key-value pairs that help you manage, filter, and search for your DataSync resources.

Specifies how you want to configure a task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a task report configuration, specify this parameter as empty.

Configures a manifest, which is a list of files or objects that you want DataSync to transfer. For more information and configuration examples, see Specifying what DataSync transfers by using a manifest.

When using this parameter, your caller identity (the role that you're using DataSync with) must have the iam:PassRole permission. The AWSDataSyncFullAccess policy includes this permission.

To remove a manifest configuration, specify this parameter with an empty value.

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

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

Specifies the Amazon Resource Name (ARN) of the task that you want to start.

Provides details about issues creating a report.

Indicates the code associated with the error if DataSync can't create a complete report.

Indicates whether DataSync is still working on your report, created a report, or can't create a complete report.

Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.

Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN.

Specifies the VPC endpoint provided by Amazon Web Services PrivateLink that your agent connects to.

Specifies the ID of the VPC endpoint that your agent connects to.

The version of the DataSync agent.

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 or IPv6 address or a hostname that is compliant with 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.

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.

The operator that is used to compare filter values (for example, Equals or Contains).

The values that you want to filter for. For example, you might want to display only Amazon S3 locations.

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

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

A list of all the tasks that are returned.

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.

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

The maximum number of tasks to return.

The opaque string that indicates the position to begin the next list of results in the response.

A list of the task's executions.

Specifies an opaque string that indicates the position at which to begin the next list of results in the response.

Specifies how many results you want in the response.

Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.

The opaque string that indicates the position to begin the next list of results in the response.

An array of tags applied to the specified resource.

Specifies an opaque string that indicates the position to begin the next list of results in the response.

Specifies how many results that you want in the response.

Specifies the Amazon Resource Name (ARN) of the resource that you want tag information on.

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

An array that contains a list of locations.

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.

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

The maximum number of locations to return.

The platform-related details about the agent, such as the version number.

The status of an agent.

• If the status is ONLINE, the agent is configured properly and ready to use.
• If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

The name of an agent.

The Amazon Resource Name (ARN) of a DataSync agent.

The opaque string that indicates the position to begin the next list of results in the response.

A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents' Amazon Resource Names (ARNs).

Specifies an opaque string that indicates the position to begin the next list of results in the response.

Specifies the maximum number of DataSync agents to list in a response. By default, a response shows a maximum of 100 agents.

The time that the transfer task ends.

The time that the task execution actually begins. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

The number of directories that DataSync fails to list, prepare, transfer, verify, and delete during your task execution.

Applies only to Enhanced mode tasks.

The number of directories that DataSync finds at your locations.

Applies only to Enhanced mode tasks.

The number of directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

Applies only to Enhanced mode tasks.

The number of directories that DataSync verifies during your transfer.

Applies only to Enhanced mode tasks.

The number of directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFoldersToTransfer. In some cases, this value can also be greater than EstimatedFoldersToTransfer.

Applies only to Enhanced mode tasks.

The number of directories that DataSync will attempt to transfer after comparing your source and destination locations.

Applies only to Enhanced mode tasks.

This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

The number of directories that DataSync skips during your transfer.

Applies only to Enhanced mode tasks.

The number of directories that DataSync expects to transfer over the network. This value is calculated as DataSync prepares directories to transfer.

How this gets calculated depends primarily on your task’s transfer mode configuration:

• If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:

  • Anything that's added or modified at the source location.
  • Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).
• If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.

Applies only to Enhanced mode tasks.

The number of directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

Applies only to Enhanced mode tasks.

The number of files or objects that DataSync fails to prepare, transfer, verify, and delete during your task execution.

Applies only to Enhanced mode tasks.

The number of files or objects that DataSync finds at your locations.

Applies only to Enhanced mode tasks.

The number of files or objects that DataSync will attempt to transfer after comparing your source and destination locations.

Applies only to Enhanced mode tasks.

This counter isn't applicable if you configure your task to transfer all data. In that scenario, DataSync copies everything from the source to the destination without comparing differences between the locations.

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

The number of files, objects, and directories that DataSync expects to delete in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in EstimatedFoldersToDelete.

Indicates whether DataSync generated a complete task report for your transfer.

The number of files, objects, and directories that DataSync verifies during your transfer.

When you configure your task to verify only the data that's transferred, DataSync doesn't verify directories in some situations or files that fail to transfer.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersVerified.

The number of files, objects, and directories that DataSync skips during your transfer.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersSkipped.

The number of files, objects, and directories that DataSync actually deletes in your destination location. If you don't configure your task to delete data in the destination that isn't in the source, the value is always 0.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersDeleted.

The configuration of your task report, which provides detailed information about for your DataSync transfer. For more information, see Creating a task report.

The result of the task execution.

The number of physical bytes that DataSync transfers over the network after compression (if compression is possible). This number is typically less than BytesTransferred unless the data isn't compressible.

The number of bytes that DataSync sends to the network before compression (if compression is possible). For the number of bytes transferred over the network, see BytesCompressed.

The number of logical bytes that DataSync actually writes to the destination location.

The number of files, objects, and directories that DataSync actually transfers over the network. This value is updated periodically during your task execution when something is read from the source and sent over the network.

If DataSync fails to transfer something, this value can be less than EstimatedFilesToTransfer. In some cases, this value can also be greater than EstimatedFilesToTransfer. This element is implementation-specific for some location types, so don't use it as an exact indication of what's transferring or to monitor your task execution.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in FoldersTransferred.

The number of logical bytes that DataSync expects to write to the destination location.

The number of files, objects, and directories that DataSync expects to transfer over the network. This value is calculated while DataSync prepares the transfer.

How this gets calculated depends primarily on your task’s transfer mode configuration:

• If TranserMode is set to CHANGED - The calculation is based on comparing the content of the source and destination locations and determining the difference that needs to be transferred. The difference can include:

  • Anything that's added or modified at the source location.
  • Anything that's in both locations and modified at the destination after an initial transfer (unless OverwriteMode is set to NEVER).
  • (Basic task mode only) The number of items that DataSync expects to delete (if PreserveDeletedFiles is set to REMOVE).
• If TranserMode is set to ALL - The calculation is based only on the items that DataSync finds at the source location.

For Enhanced mode tasks, this counter only includes files or objects. Directories are counted in EstimatedFoldersToTransfer.

The time that DataSync sends the request to start the task execution. For non-queued tasks, LaunchTime and StartTime are typically the same. For queued tasks, LaunchTime is typically later than StartTime because previously queued tasks must finish running before newer tasks can begin.

The configuration of the manifest that lists the files or objects to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

A list of filter rules that include specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

A list of filter rules that exclude specific data during your transfer. For more information and examples, see Filtering data transferred by DataSync.

The status of the task execution.

The ARN of the task execution that you wanted information about. 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.

Specifies the Amazon Resource Name (ARN) of the task execution that you want information about.

The task mode that you're using. For more information, see Choosing a task mode for your data transfer.

The details about your task schedule.

The configuration of your task report, which provides detailed information about your DataSync transfer. For more information, see Monitoring your DataSync transfers with task reports.

The configuration of the manifest that lists the files or objects that you want DataSync to transfer. For more information, see Specifying what DataSync transfers by using a manifest.

The include filters that define the files, objects, and folders in your source location that you want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

The time that the task was created.

If there's an issue with your task, you can use the error details to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

If there's an issue with your task, you can use the error code to help you troubleshoot the problem. For more information, see Troubleshooting issues with DataSync transfers.

The schedule for when you want your task to run. For more information, see Scheduling your task.

The exclude filters that define the files, objects, and folders in your source location that you don't want DataSync to transfer. For more information and examples, see Specifying what DataSync transfers by using filters.

The task's settings. For example, what file metadata gets preserved, how data integrity gets verified at the end of your transfer, bandwidth limits, among other options.

The ARNs of the network interfaces that DataSync created for your destination location.

The ARNs of the network interfaces that DataSync created for your source location.

The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring your task.

For more information, see Monitoring data transfers with CloudWatch Logs.

The ARN of your transfer's destination location.

The ARN of your transfer's source location.

The ARN of the most recent task execution.

The name of your task.

The status of your task. For information about what each status means, see Task statuses.

The ARN of your task.

Specifies the Amazon Resource Name (ARN) of the transfer task that you want information about.

Describes configuration information for a customer-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Describes configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed KMS key.

Describes configuration information for a DataSync-managed secret, such as a Password or KerberosKeytab that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

The authentication protocol that DataSync uses to connect to your SMB file server.

The Kerberos principal that has permission to access the files, folders, and file metadata in your SMB file server.

The IPv4 or IPv6 addresses for the DNS servers that your SMB file server belongs to. This element applies only if AuthenticationType is set to KERBEROS.

The time that the SMB location was created.

The SMB protocol version that DataSync uses to access your SMB file server.

The name of the Windows domain that the SMB file server belongs to. This element applies only if AuthenticationType is set to NTLM.

The user that can mount and access the files, folders, and file metadata in your SMB file server. This element applies only if AuthenticationType is set to NTLM.

The ARNs of the DataSync agents that can connect with your SMB file server.

The URI of the SMB location.

The ARN of the SMB location.

Specifies the Amazon Resource Name (ARN) of the SMB location that you want information about.

The time that the Amazon S3 location was created.

The ARNs of the DataSync agents deployed on your Outpost when using working with Amazon S3 on Outposts.

For more information, see Deploy your DataSync agent on Outposts.

When Amazon S3 is a destination location, this is the storage class that you chose for your objects.

Some storage classes have behaviors that can affect your Amazon S3 storage costs. For more information, see Storage class considerations with Amazon S3 transfers.

The URL of the Amazon S3 location that was described.

The ARN of the Amazon S3 location.

Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

Describes configuration information for a customer-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Describes configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location, and a customer-managed KMS key.

Describes configuration information for a DataSync-managed secret, such as an authentication token or set of credentials that DataSync uses to access a specific transfer location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

The certificate chain for DataSync to authenticate with your object storage system if the system uses a private or self-signed certificate authority (CA).

The time that the location was created.

The ARNs of the DataSync agents that can connect with your object storage system.

The protocol that your object storage system uses to communicate.

The port that your object storage server accepts inbound network traffic on (for example, port 443).

The access key (for example, a user name) required to authenticate with the object storage system.

The URI of the object storage system location.

The ARN of the object storage system location.

Specifies the Amazon Resource Name (ARN) of the object storage system location.

The time when the NFS location was created.

The mount options that DataSync uses to mount your NFS file server.

The URI of the NFS location.

The ARN of the NFS location.

Specifies the Amazon Resource Name (ARN) of the NFS location that you want information about.

Describes configuration information for a customer-managed secret, such as a KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Describes configuration information for a DataSync-managed secret, such as a KerberosKeytab that DataSync uses to access a specific storage location, with a customer-managed KMS key.

Describes configuration information for a DataSync-managed secret, such as a KerberosKeytab that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

The time that the HDFS location was created.

The ARNs of the DataSync agents that can connect with your HDFS cluster.

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.

The user name to identify the client on the host operating system. This parameter is used if the AuthenticationType is defined as SIMPLE.

The type of authentication used to determine the identity of the user.

The Quality of Protection (QOP) configuration, which specifies the Remote Procedure Call (RPC) and data transfer protection settings configured on the HDFS cluster.

The URI of the HDFS cluster's Key Management Server (KMS).

The number of DataNodes to replicate the data to when writing to the HDFS cluster.

The size of the data blocks to write into the HDFS cluster.

The NameNode that manages the HDFS namespace.

The URI of the HDFS location.

The ARN of the HDFS location.

Specifies the Amazon Resource Name (ARN) of the HDFS location.

Describes configuration information for a customer-managed secret, such as a Password that DataSync uses to access a specific storage location, with a customer-managed Identity and Access Management (IAM) role that provides access to the secret.

Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location, with a customer-managed KMS key.

Describes configuration information for a DataSync-managed secret, such as a Password that DataSync uses to access a specific storage location. DataSync uses the default Amazon Web Services-managed KMS key to encrypt this secret in Secrets Manager.

The name of the Microsoft Active Directory domain that the FSx for Windows File Server file system belongs to.

The user with the permissions to mount and access the FSx for Windows File Server file system.

The time that the FSx for Windows File Server location was created.

The ARNs of the Amazon EC2 security groups that provide access to your file system's preferred subnet.

For information about configuring security groups for file system access, see the Amazon FSx for Windows File Server User Guide.

The uniform resource identifier (URI) of the FSx for Windows File Server location.

The ARN of the FSx for Windows File Server location.

Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server location.

The time that the FSx for OpenZFS location was created.

The type of protocol that DataSync uses to access your file system.

The ARNs of the security groups that are configured for the FSx for OpenZFS file system.

The uniform resource identifier (URI) of the FSx for OpenZFS location that was described.

Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder

The ARN of the FSx for OpenZFS location that was described.

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

The ARN of the FSx for ONTAP file system.

The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system where you're copying data to or from.

The security groups that DataSync uses to access your FSx for ONTAP file system.

The uniform resource identifier (URI) of the FSx for ONTAP file system location.

The ARN of the FSx for ONTAP file system location.

The time that the location was created.

Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system location that you want information about.

The time that the FSx for Lustre location was created.

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

The URI of the FSx for Lustre location that was described.

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

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

Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.

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.

Indicates whether DataSync uses Transport Layer Security (TLS) encryption when transferring data to or from the Amazon EFS file system.

The Identity and Access Management (IAM) role that allows DataSync to access your Amazon EFS file system.

For more information, see Creating a DataSync IAM role for file system access.

The ARN of the access point that DataSync uses to access the Amazon EFS file system.

For more information, see Accessing restricted file systems.

The time that the location was created.

The URL of the Amazon EFS file system location.

The ARN of the Amazon EFS file system location.

The Amazon Resource Name (ARN) of the Amazon EFS file system location that you want information about.