# Data Types
<a name="API_Types"></a>

The following data types are supported:
+  [AgentListEntry](API_AgentListEntry.md) 
+  [AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md) 
+  [CmkSecretConfig](API_CmkSecretConfig.md) 
+  [CustomSecretConfig](API_CustomSecretConfig.md) 
+  [Ec2Config](API_Ec2Config.md) 
+  [FilterRule](API_FilterRule.md) 
+  [FsxProtocol](API_FsxProtocol.md) 
+  [FsxProtocolNfs](API_FsxProtocolNfs.md) 
+  [FsxProtocolSmb](API_FsxProtocolSmb.md) 
+  [FsxUpdateProtocol](API_FsxUpdateProtocol.md) 
+  [FsxUpdateProtocolSmb](API_FsxUpdateProtocolSmb.md) 
+  [HdfsNameNode](API_HdfsNameNode.md) 
+  [LocationFilter](API_LocationFilter.md) 
+  [LocationListEntry](API_LocationListEntry.md) 
+  [ManagedSecretConfig](API_ManagedSecretConfig.md) 
+  [ManifestConfig](API_ManifestConfig.md) 
+  [NfsMountOptions](API_NfsMountOptions.md) 
+  [OnPremConfig](API_OnPremConfig.md) 
+  [Options](API_Options.md) 
+  [Platform](API_Platform.md) 
+  [PrivateLinkConfig](API_PrivateLinkConfig.md) 
+  [QopConfiguration](API_QopConfiguration.md) 
+  [ReportDestination](API_ReportDestination.md) 
+  [ReportDestinationS3](API_ReportDestinationS3.md) 
+  [ReportOverride](API_ReportOverride.md) 
+  [ReportOverrides](API_ReportOverrides.md) 
+  [ReportResult](API_ReportResult.md) 
+  [S3Config](API_S3Config.md) 
+  [S3ManifestConfig](API_S3ManifestConfig.md) 
+  [SmbMountOptions](API_SmbMountOptions.md) 
+  [SourceManifestConfig](API_SourceManifestConfig.md) 
+  [TagListEntry](API_TagListEntry.md) 
+  [TaskExecutionFilesFailedDetail](API_TaskExecutionFilesFailedDetail.md) 
+  [TaskExecutionFilesListedDetail](API_TaskExecutionFilesListedDetail.md) 
+  [TaskExecutionFoldersFailedDetail](API_TaskExecutionFoldersFailedDetail.md) 
+  [TaskExecutionFoldersListedDetail](API_TaskExecutionFoldersListedDetail.md) 
+  [TaskExecutionListEntry](API_TaskExecutionListEntry.md) 
+  [TaskExecutionResultDetail](API_TaskExecutionResultDetail.md) 
+  [TaskFilter](API_TaskFilter.md) 
+  [TaskListEntry](API_TaskListEntry.md) 
+  [TaskReportConfig](API_TaskReportConfig.md) 
+  [TaskSchedule](API_TaskSchedule.md) 
+  [TaskScheduleDetails](API_TaskScheduleDetails.md) 

# AgentListEntry
<a name="API_AgentListEntry"></a>

Represents a single entry in a list (or array) of AWS DataSync agents when you call the [ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) operation.

## Contents
<a name="API_AgentListEntry_Contents"></a>

 ** AgentArn **   <a name="DataSync-Type-AgentListEntry-AgentArn"></a>
The Amazon Resource Name (ARN) of a DataSync agent.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`   
Required: No

 ** Name **   <a name="DataSync-Type-AgentListEntry-Name"></a>
The name of an agent.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s+=._:@/-]+$`   
Required: No

 ** Platform **   <a name="DataSync-Type-AgentListEntry-Platform"></a>
The platform-related details about the agent, such as the version number.  
Type: [Platform](API_Platform.md) object  
Required: No

 ** Status **   <a name="DataSync-Type-AgentListEntry-Status"></a>
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?](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
Type: String  
Valid Values: `ONLINE | OFFLINE`   
Required: No

## See Also
<a name="API_AgentListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/AgentListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/AgentListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/AgentListEntry) 

# AzureBlobSasConfiguration
<a name="API_AzureBlobSasConfiguration"></a>

The shared access signature (SAS) configuration that allows AWS DataSync to access your Microsoft Azure Blob Storage.

For more information, see [SAS tokens](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens) for accessing your Azure Blob Storage.

## Contents
<a name="API_AzureBlobSasConfiguration_Contents"></a>

 ** Token **   <a name="DataSync-Type-AzureBlobSasConfiguration-Token"></a>
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`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^.+$`   
Required: Yes

## See Also
<a name="API_AzureBlobSasConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/AzureBlobSasConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/AzureBlobSasConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/AzureBlobSasConfiguration) 

# CmkSecretConfig
<a name="API_CmkSecretConfig"></a>

Specifies configuration information for a DataSync-managed secret, such as an authentication token, secret key, password, or Kerberos keytab that DataSync uses to access a specific storage location, with a customer-managed AWS KMS key.

**Note**  
You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request.

## Contents
<a name="API_CmkSecretConfig_Contents"></a>

 ** KmsKeyArn **   <a name="DataSync-Type-CmkSecretConfig-KmsKeyArn"></a>
Specifies the ARN for the customer-managed AWS KMS key that DataSync uses to encrypt the DataSync-managed secret stored for `SecretArn`. DataSync provides this key to AWS Secrets Manager.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z\-0-9]+:[0-9]{12}:key/.*|)$`   
Required: No

 ** SecretArn **   <a name="DataSync-Type-CmkSecretConfig-SecretArn"></a>
Specifies the ARN for the DataSync-managed AWS 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`.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`   
Required: No

## See Also
<a name="API_CmkSecretConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CmkSecretConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CmkSecretConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CmkSecretConfig) 

# CustomSecretConfig
<a name="API_CustomSecretConfig"></a>

Specifies configuration information for a customer-managed Secrets Manager secret where a storage location credentials is stored in Secrets Manager as plain text (for authentication token, secret key, or password) or as binary (for Kerberos keytab). This configuration includes the secret ARN, and the ARN for an IAM role that provides access to the secret.

**Note**  
You can use either `CmkSecretConfig` or `CustomSecretConfig` to provide credentials for a `CreateLocation` request. Do not provide both parameters for the same request.

## Contents
<a name="API_CustomSecretConfig_Contents"></a>

 ** SecretAccessRoleArn **   <a name="DataSync-Type-CustomSecretConfig-SecretAccessRoleArn"></a>
Specifies the ARN for the AWS Identity and Access Management role that DataSync uses to access the secret specified for `SecretArn`.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+|)$`   
Required: No

 ** SecretArn **   <a name="DataSync-Type-CustomSecretConfig-SecretArn"></a>
Specifies the ARN for an AWS Secrets Manager secret.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`   
Required: No

## See Also
<a name="API_CustomSecretConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CustomSecretConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CustomSecretConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CustomSecretConfig) 

# Ec2Config
<a name="API_Ec2Config"></a>

The subnet and security groups that AWS DataSync uses to connect to one of your Amazon EFS file system's [mount targets](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html).

## Contents
<a name="API_Ec2Config_Contents"></a>

 ** SecurityGroupArns **   <a name="DataSync-Type-Ec2Config-SecurityGroupArns"></a>
Specifies the Amazon Resource Names (ARNs) of the security groups associated with an Amazon EFS file system's mount target.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`   
Required: Yes

 ** SubnetArn **   <a name="DataSync-Type-Ec2Config-SubnetArn"></a>
Specifies the ARN of a subnet where DataSync creates the [network interfaces](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-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.
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/subnet-[a-f0-9]+$`   
Required: Yes

## See Also
<a name="API_Ec2Config_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Ec2Config) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Ec2Config) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Ec2Config) 

# FilterRule
<a name="API_FilterRule"></a>

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

## Contents
<a name="API_FilterRule_Contents"></a>

 ** FilterType **   <a name="DataSync-Type-FilterRule-FilterType"></a>
The type of filter rule to apply. AWS DataSync only supports the SIMPLE\$1PATTERN rule type.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^[A-Z0-9_]+$`   
Valid Values: `SIMPLE_PATTERN`   
Required: No

 ** Value **   <a name="DataSync-Type-FilterRule-Value"></a>
A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "\$1" (that is, a pipe), for example: `/folder1|/folder2`   
   
Type: String  
Length Constraints: Maximum length of 102400.  
Pattern: `^[^\x00]+$`   
Required: No

## See Also
<a name="API_FilterRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FilterRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FilterRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FilterRule) 

# FsxProtocol
<a name="API_FsxProtocol"></a>

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

## Contents
<a name="API_FsxProtocol_Contents"></a>

 ** NFS **   <a name="DataSync-Type-FsxProtocol-NFS"></a>
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).  
Type: [FsxProtocolNfs](API_FsxProtocolNfs.md) object  
Required: No

 ** SMB **   <a name="DataSync-Type-FsxProtocol-SMB"></a>
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's SVM.  
Type: [FsxProtocolSmb](API_FsxProtocolSmb.md) object  
Required: No

## See Also
<a name="API_FsxProtocol_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocol) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocol) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocol) 

# FsxProtocolNfs
<a name="API_FsxProtocolNfs"></a>

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

## Contents
<a name="API_FsxProtocolNfs_Contents"></a>

 ** MountOptions **   <a name="DataSync-Type-FsxProtocolNfs-MountOptions"></a>
Specifies how DataSync can access a location using the NFS protocol.  
Type: [NfsMountOptions](API_NfsMountOptions.md) object  
Required: No

## See Also
<a name="API_FsxProtocolNfs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocolNfs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocolNfs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocolNfs) 

# FsxProtocolSmb
<a name="API_FsxProtocolSmb"></a>

Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see [Providing DataSync access to FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).

## Contents
<a name="API_FsxProtocolSmb_Contents"></a>

 ** User **   <a name="DataSync-Type-FsxProtocolSmb-User"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb).  
Type: String  
Length Constraints: Maximum length of 104.  
Pattern: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Required: Yes

 ** CmkSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-CmkSecretConfig"></a>
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 AWS 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 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-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.
Type: [CmkSecretConfig](API_CmkSecretConfig.md) object  
Required: No

 ** CustomSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-CustomSecretConfig"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-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.
Type: [CustomSecretConfig](API_CustomSecretConfig.md) object  
Required: No

 ** Domain **   <a name="DataSync-Type-FsxProtocolSmb-Domain"></a>
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.  
Type: String  
Length Constraints: Maximum length of 253.  
Pattern: `^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`   
Required: No

 ** ManagedSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-ManagedSecretConfig"></a>
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 AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.  
Do not provide this for a `CreateLocation` request. `ManagedSecretConfig` is a ReadOnly property and is only be populated in the `DescribeLocation` response.
Type: [ManagedSecretConfig](API_ManagedSecretConfig.md) object  
Required: No

 ** MountOptions **   <a name="DataSync-Type-FsxProtocolSmb-MountOptions"></a>
Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.  
Type: [SmbMountOptions](API_SmbMountOptions.md) object  
Required: No

 ** Password **   <a name="DataSync-Type-FsxProtocolSmb-Password"></a>
Specifies the password of a user who has permission to access your SVM.  
Type: String  
Length Constraints: Maximum length of 104.  
Pattern: `^.{0,104}$`   
Required: No

## See Also
<a name="API_FsxProtocolSmb_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocolSmb) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocolSmb) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocolSmb) 

# FsxUpdateProtocol
<a name="API_FsxUpdateProtocol"></a>

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

**Note**  
You can't update the Network File System (NFS) protocol configuration for FSx for ONTAP locations. DataSync currently only supports NFS version 3 with this location type.

## Contents
<a name="API_FsxUpdateProtocol_Contents"></a>

 ** NFS **   <a name="DataSync-Type-FsxUpdateProtocol-NFS"></a>
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).  
Type: [FsxProtocolNfs](API_FsxProtocolNfs.md) object  
Required: No

 ** SMB **   <a name="DataSync-Type-FsxUpdateProtocol-SMB"></a>
Specifies the Server Message Block (SMB) protocol configuration that DataSync uses to access your FSx for ONTAP file system's storage virtual machine (SVM).  
Type: [FsxUpdateProtocolSmb](API_FsxUpdateProtocolSmb.md) object  
Required: No

## See Also
<a name="API_FsxUpdateProtocol_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxUpdateProtocol) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxUpdateProtocol) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxUpdateProtocol) 

# FsxUpdateProtocolSmb
<a name="API_FsxUpdateProtocolSmb"></a>

Specifies the Server Message Block (SMB) protocol configuration that AWS DataSync uses to access your Amazon FSx for NetApp ONTAP file system's storage virtual machine (SVM). For more information, see [Providing DataSync access to FSx for ONTAP file systems](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).

## Contents
<a name="API_FsxUpdateProtocolSmb_Contents"></a>

 ** CmkSecretConfig **   <a name="DataSync-Type-FsxUpdateProtocolSmb-CmkSecretConfig"></a>
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 AWS KMS key.  
Type: [CmkSecretConfig](API_CmkSecretConfig.md) object  
Required: No

 ** CustomSecretConfig **   <a name="DataSync-Type-FsxUpdateProtocolSmb-CustomSecretConfig"></a>
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.  
Type: [CustomSecretConfig](API_CustomSecretConfig.md) object  
Required: No

 ** Domain **   <a name="DataSync-Type-FsxUpdateProtocolSmb-Domain"></a>
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.  
Type: String  
Length Constraints: Maximum length of 253.  
Pattern: `^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$`   
Required: No

 ** MountOptions **   <a name="DataSync-Type-FsxUpdateProtocolSmb-MountOptions"></a>
Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.  
Type: [SmbMountOptions](API_SmbMountOptions.md) object  
Required: No

 ** Password **   <a name="DataSync-Type-FsxUpdateProtocolSmb-Password"></a>
Specifies the password of a user who has permission to access your SVM.  
Type: String  
Length Constraints: Maximum length of 104.  
Pattern: `^.{0,104}$`   
Required: No

 ** User **   <a name="DataSync-Type-FsxUpdateProtocolSmb-User"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb).  
Type: String  
Length Constraints: Maximum length of 104.  
Pattern: `^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`   
Required: No

## See Also
<a name="API_FsxUpdateProtocolSmb_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxUpdateProtocolSmb) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxUpdateProtocolSmb) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxUpdateProtocolSmb) 

# HdfsNameNode
<a name="API_HdfsNameNode"></a>

The NameNode of the Hadoop Distributed File System (HDFS). The NameNode manages the file system's namespace. The NameNode performs operations such as opening, closing, and renaming files and directories. The NameNode contains the information to map blocks of data to the DataNodes.

## Contents
<a name="API_HdfsNameNode_Contents"></a>

 ** Hostname **   <a name="DataSync-Type-HdfsNameNode-Hostname"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`   
Required: Yes

 ** Port **   <a name="DataSync-Type-HdfsNameNode-Port"></a>
The port that the NameNode uses to listen to client requests.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65536.  
Required: Yes

## See Also
<a name="API_HdfsNameNode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/HdfsNameNode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/HdfsNameNode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/HdfsNameNode) 

# LocationFilter
<a name="API_LocationFilter"></a>

Narrow down the list of resources returned by `ListLocations`. For example, to see all your Amazon S3 locations, create a filter using `"Name": "LocationType"`, `"Operator": "Equals"`, and `"Values": "S3"`.

For more information, see [filtering resources](https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html).

## Contents
<a name="API_LocationFilter_Contents"></a>

 ** Name **   <a name="DataSync-Type-LocationFilter-Name"></a>
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`).  
Type: String  
Valid Values: `LocationUri | LocationType | CreationTime`   
Required: Yes

 ** Operator **   <a name="DataSync-Type-LocationFilter-Operator"></a>
The operator that is used to compare filter values (for example, `Equals` or `Contains`).  
Type: String  
Valid Values: `Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith`   
Required: Yes

 ** Values **   <a name="DataSync-Type-LocationFilter-Values"></a>
The values that you want to filter for. For example, you might want to display only Amazon S3 locations.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[0-9a-zA-Z_\ \-\:\*\.\\/\?-]*$`   
Required: Yes

## See Also
<a name="API_LocationFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/LocationFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/LocationFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/LocationFilter) 

# LocationListEntry
<a name="API_LocationListEntry"></a>

Represents a single entry in a list of locations. `LocationListEntry` returns an array that contains a list of locations when the [ListLocations](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) operation is called.

## Contents
<a name="API_LocationListEntry_Contents"></a>

 ** LocationArn **   <a name="DataSync-Type-LocationListEntry-LocationArn"></a>
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.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$`   
Required: No

 ** LocationUri **   <a name="DataSync-Type-LocationListEntry-LocationUri"></a>
Represents a list of URIs of a location. `LocationUri` returns an array that contains a list of locations when the [ListLocations](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) operation is called.  
Format: `TYPE://GLOBAL_ID/SUBDIR`.  
TYPE designates the type of location (for example, `nfs` or `s3`).  
GLOBAL\$1ID 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 \$1nix 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.  
  
Type: String  
Length Constraints: Maximum length of 4360.  
Pattern: `^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`   
Required: No

## See Also
<a name="API_LocationListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/LocationListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/LocationListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/LocationListEntry) 

# ManagedSecretConfig
<a name="API_ManagedSecretConfig"></a>

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. DataSync uses the default AWS-managed KMS key to encrypt this secret in AWS Secrets Manager.

## Contents
<a name="API_ManagedSecretConfig_Contents"></a>

 ** SecretArn **   <a name="DataSync-Type-ManagedSecretConfig-SecretArn"></a>
Specifies the ARN for an AWS Secrets Manager secret.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`   
Required: No

## See Also
<a name="API_ManagedSecretConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ManagedSecretConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ManagedSecretConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ManagedSecretConfig) 

# ManifestConfig
<a name="API_ManifestConfig"></a>

Configures a manifest, which is a list of files or objects that you want AWS DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).

## Contents
<a name="API_ManifestConfig_Contents"></a>

 ** Action **   <a name="DataSync-Type-ManifestConfig-Action"></a>
Specifies what DataSync uses the manifest for.  
Type: String  
Valid Values: `TRANSFER`   
Required: No

 ** Format **   <a name="DataSync-Type-ManifestConfig-Format"></a>
Specifies the file format of your manifest. For more information, see [Creating a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create).  
Type: String  
Valid Values: `CSV`   
Required: No

 ** Source **   <a name="DataSync-Type-ManifestConfig-Source"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access).
Type: [SourceManifestConfig](API_SourceManifestConfig.md) object  
Required: No

## See Also
<a name="API_ManifestConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ManifestConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ManifestConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ManifestConfig) 

# NfsMountOptions
<a name="API_NfsMountOptions"></a>

Specifies how DataSync can access a location using the NFS protocol.

## Contents
<a name="API_NfsMountOptions_Contents"></a>

 ** Version **   <a name="DataSync-Type-NfsMountOptions-Version"></a>
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.
Type: String  
Valid Values: `AUTOMATIC | NFS3 | NFS4_0 | NFS4_1`   
Required: No

## See Also
<a name="API_NfsMountOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/NfsMountOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/NfsMountOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/NfsMountOptions) 

# OnPremConfig
<a name="API_OnPremConfig"></a>

The AWS DataSync agents that can connect to your Network File System (NFS) file server.

## Contents
<a name="API_OnPremConfig_Contents"></a>

 ** AgentArns **   <a name="DataSync-Type-OnPremConfig-AgentArns"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents).  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 8 items.  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$`   
Required: Yes

## See Also
<a name="API_OnPremConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/OnPremConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/OnPremConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/OnPremConfig) 

# Options
<a name="API_Options"></a>

Indicates how your transfer task is configured. These options include how DataSync handles files, objects, and their associated metadata during your transfer. You also can specify how to verify data integrity, set bandwidth limits for your task, among other options.

Each option has a default value. Unless you need to, you don't have to configure any option before calling [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).

You also can override your task options for each task execution. For example, you might want to adjust the `LogLevel` for an individual execution.

## Contents
<a name="API_Options_Contents"></a>

 ** Atime **   <a name="DataSync-Type-Options-Atime"></a>
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`. 
Type: String  
Valid Values: `NONE | BEST_EFFORT`   
Required: No

 ** BytesPerSecond **   <a name="DataSync-Type-Options-BytesPerSecond"></a>
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`).  
Type: Long  
Valid Range: Minimum value of -1.  
Required: No

 ** Gid **   <a name="DataSync-Type-Options-Gid"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html).  
Type: String  
Valid Values: `NONE | INT_VALUE | NAME | BOTH`   
Required: No

 ** LogLevel **   <a name="DataSync-Type-Options-LogLevel"></a>
Specifies the type of logs that DataSync publishes to a Amazon CloudWatch Logs log group. To specify the log group, see [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-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.
Type: String  
Valid Values: `OFF | BASIC | TRANSFER`   
Required: No

 ** Mtime **   <a name="DataSync-Type-Options-Mtime"></a>
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`. 
Type: String  
Valid Values: `NONE | PRESERVE`   
Required: No

 ** ObjectTags **   <a name="DataSync-Type-Options-ObjectTags"></a>
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.  
Type: String  
Valid Values: `PRESERVE | NONE`   
Required: No

 ** OverwriteMode **   <a name="DataSync-Type-Options-OverwriteMode"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).
+  `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.
Type: String  
Valid Values: `ALWAYS | NEVER`   
Required: No

 ** PosixPermissions **   <a name="DataSync-Type-Options-PosixPermissions"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html).  
+  `PRESERVE` (default) - Preserves POSIX-style permissions, which is recommended.
+  `NONE` - Ignores POSIX-style permissions. 
DataSync can preserve extant permissions of a source location.
Type: String  
Valid Values: `NONE | PRESERVE`   
Required: No

 ** PreserveDeletedFiles **   <a name="DataSync-Type-Options-PreserveDeletedFiles"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).  
+  `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.
Type: String  
Valid Values: `PRESERVE | REMOVE`   
Required: No

 ** PreserveDevices **   <a name="DataSync-Type-Options-PreserveDevices"></a>
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.
Type: String  
Valid Values: `NONE | PRESERVE`   
Required: No

 ** SecurityDescriptorCopyFlags **   <a name="DataSync-Type-Options-SecurityDescriptorCopyFlags"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html).  
+  `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](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions), [FSx for Windows File Server](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions), or [FSx for ONTAP](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb) (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. 
Type: String  
Valid Values: `NONE | OWNER_DACL | OWNER_DACL_SACL`   
Required: No

 ** TaskQueueing **   <a name="DataSync-Type-Options-TaskQueueing"></a>
Specifies whether your transfer tasks should be put into a queue during certain scenarios when [running multiple tasks](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks). This is `ENABLED` by default.  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

 ** TransferMode **   <a name="DataSync-Type-Options-TransferMode"></a>
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.
Type: String  
Valid Values: `CHANGED | ALL`   
Required: No

 ** Uid **   <a name="DataSync-Type-Options-Uid"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied).  
Type: String  
Valid Values: `NONE | INT_VALUE | NAME | BOTH`   
Required: No

 ** VerifyMode **   <a name="DataSync-Type-Options-VerifyMode"></a>
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.
**Note**  
This is the default option for [Enhanced mode tasks](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

  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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).
+  `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.
**Note**  
The is the default option for [Basic mode tasks](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html) and isn't currently supported with Enhanced mode tasks.

  If you use a [manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html), 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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes).
+  `NONE` - DataSync performs data integrity checks only during your transfer. Unlike other options, there's no additional verification at the end of your transfer.
Type: String  
Valid Values: `POINT_IN_TIME_CONSISTENT | ONLY_FILES_TRANSFERRED | NONE`   
Required: No

## See Also
<a name="API_Options_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Options) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Options) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Options) 

# Platform
<a name="API_Platform"></a>

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

## Contents
<a name="API_Platform_Contents"></a>

 ** Version **   <a name="DataSync-Type-Platform-Version"></a>
The version of the DataSync agent.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s+=._:@/-]+$`   
Required: No

## See Also
<a name="API_Platform_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Platform) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Platform) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Platform) 

# PrivateLinkConfig
<a name="API_PrivateLinkConfig"></a>

Specifies how your AWS DataSync agent connects to AWS using a [virtual private cloud (VPC) service endpoint](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc). An agent that uses a VPC endpoint isn't accessible over the public internet.

## Contents
<a name="API_PrivateLinkConfig_Contents"></a>

 ** PrivateLinkEndpoint **   <a name="DataSync-Type-PrivateLinkConfig-PrivateLinkEndpoint"></a>
Specifies the VPC endpoint provided by [AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html) that your agent connects to.  
Type: String  
Length Constraints: Minimum length of 7. Maximum length of 15.  
Pattern: `\A(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}\z`   
Required: No

 ** SecurityGroupArns **   <a name="DataSync-Type-PrivateLinkConfig-SecurityGroupArns"></a>
Specifies the Amazon Resource Names (ARN) of the security group that provides DataSync access to your VPC endpoint. You can only specify one ARN.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$`   
Required: No

 ** SubnetArns **   <a name="DataSync-Type-PrivateLinkConfig-SubnetArns"></a>
Specifies the ARN of the subnet where your VPC endpoint is located. You can only specify one ARN.  
Type: Array of strings  
Array Members: Fixed number of 1 item.  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:subnet/subnet-[a-f0-9]+$`   
Required: No

 ** VpcEndpointId **   <a name="DataSync-Type-PrivateLinkConfig-VpcEndpointId"></a>
Specifies the ID of the VPC endpoint that your agent connects to.  
Type: String  
Pattern: `^vpce-[0-9a-f]{17}$`   
Required: No

## See Also
<a name="API_PrivateLinkConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/PrivateLinkConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/PrivateLinkConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/PrivateLinkConfig) 

# QopConfiguration
<a name="API_QopConfiguration"></a>

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.

## Contents
<a name="API_QopConfiguration_Contents"></a>

 ** DataTransferProtection **   <a name="DataSync-Type-QopConfiguration-DataTransferProtection"></a>
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.  
Type: String  
Valid Values: `DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY`   
Required: No

 ** RpcProtection **   <a name="DataSync-Type-QopConfiguration-RpcProtection"></a>
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.  
Type: String  
Valid Values: `DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY`   
Required: No

## See Also
<a name="API_QopConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/QopConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/QopConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/QopConfiguration) 

# ReportDestination
<a name="API_ReportDestination"></a>

Specifies where DataSync uploads your [task report](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Contents
<a name="API_ReportDestination_Contents"></a>

 ** S3 **   <a name="DataSync-Type-ReportDestination-S3"></a>
Specifies the Amazon S3 bucket where DataSync uploads your task report.  
Type: [ReportDestinationS3](API_ReportDestinationS3.md) object  
Required: No

## See Also
<a name="API_ReportDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportDestination) 

# ReportDestinationS3
<a name="API_ReportDestinationS3"></a>

Specifies the Amazon S3 bucket where DataSync uploads your [task report](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Contents
<a name="API_ReportDestinationS3_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-ReportDestinationS3-BucketAccessRoleArn"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Required: Yes

 ** S3BucketArn **   <a name="DataSync-Type-ReportDestinationS3-S3BucketArn"></a>
Specifies the ARN of the S3 bucket where DataSync uploads your report.  
Type: String  
Length Constraints: Maximum length of 268.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$`   
Required: Yes

 ** Subdirectory **   <a name="DataSync-Type-ReportDestinationS3-Subdirectory"></a>
Specifies a bucket prefix for your report.  
Type: String  
Length Constraints: Maximum length of 4096.  
Pattern: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Required: No

## See Also
<a name="API_ReportDestinationS3_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportDestinationS3) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportDestinationS3) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportDestinationS3) 

# ReportOverride
<a name="API_ReportOverride"></a>

Specifies the level of detail for a particular aspect of your DataSync [task report](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Contents
<a name="API_ReportOverride_Contents"></a>

 ** ReportLevel **   <a name="DataSync-Type-ReportOverride-ReportLevel"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html) 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`).  
Type: String  
Valid Values: `ERRORS_ONLY | SUCCESSES_AND_ERRORS`   
Required: No

## See Also
<a name="API_ReportOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportOverride) 

# ReportOverrides
<a name="API_ReportOverrides"></a>

The level of detail included in each aspect of your DataSync [task report](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Contents
<a name="API_ReportOverrides_Contents"></a>

 ** Deleted **   <a name="DataSync-Type-ReportOverrides-Deleted"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html) to delete data in the destination that isn't in the source.  
Type: [ReportOverride](API_ReportOverride.md) object  
Required: No

 ** Skipped **   <a name="DataSync-Type-ReportOverrides-Skipped"></a>
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to skip during your transfer.  
Type: [ReportOverride](API_ReportOverride.md) object  
Required: No

 ** Transferred **   <a name="DataSync-Type-ReportOverrides-Transferred"></a>
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to transfer.  
Type: [ReportOverride](API_ReportOverride.md) object  
Required: No

 ** Verified **   <a name="DataSync-Type-ReportOverrides-Verified"></a>
Specifies the level of reporting for the files, objects, and directories that DataSync attempted to verify at the end of your transfer.  
Type: [ReportOverride](API_ReportOverride.md) object  
Required: No

## See Also
<a name="API_ReportOverrides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportOverrides) 

# ReportResult
<a name="API_ReportResult"></a>

Indicates whether DataSync created a complete [task report](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) for your transfer.

## Contents
<a name="API_ReportResult_Contents"></a>

 ** ErrorCode **   <a name="DataSync-Type-ReportResult-ErrorCode"></a>
Indicates the code associated with the error if DataSync can't create a complete report.  
Type: String  
Required: No

 ** ErrorDetail **   <a name="DataSync-Type-ReportResult-ErrorDetail"></a>
Provides details about issues creating a report.  
Type: String  
Required: No

 ** Status **   <a name="DataSync-Type-ReportResult-Status"></a>
Indicates whether DataSync is still working on your report, created a report, or can't create a complete report.  
Type: String  
Valid Values: `PENDING | SUCCESS | ERROR`   
Required: No

## See Also
<a name="API_ReportResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportResult) 

# S3Config
<a name="API_S3Config"></a>

Specifies the Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

For more information, see [Providing DataSync access to S3 buckets](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access).

## Contents
<a name="API_S3Config_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-S3Config-BucketAccessRoleArn"></a>
Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Required: Yes

## See Also
<a name="API_S3Config_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/S3Config) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/S3Config) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/S3Config) 

# S3ManifestConfig
<a name="API_S3ManifestConfig"></a>

Specifies the S3 bucket where you're hosting the manifest that you want AWS DataSync to use. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).

## Contents
<a name="API_S3ManifestConfig_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-S3ManifestConfig-BucketAccessRoleArn"></a>
Specifies the AWS Identity and Access Management (IAM) role that allows DataSync to access your manifest. For more information, see [Providing DataSync access to your manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access).  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`   
Required: Yes

 ** ManifestObjectPath **   <a name="DataSync-Type-S3ManifestConfig-ManifestObjectPath"></a>
Specifies the Amazon S3 object key of your manifest. This can include a prefix (for example, `prefix/my-manifest.csv`).  
Type: String  
Length Constraints: Maximum length of 4096.  
Pattern: `^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`   
Required: Yes

 ** S3BucketArn **   <a name="DataSync-Type-S3ManifestConfig-S3BucketArn"></a>
Specifies the Amazon Resource Name (ARN) of the S3 bucket where you're hosting your manifest.  
Type: String  
Length Constraints: Maximum length of 268.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:[a-z\-0-9]*:[0-9]{12}:accesspoint[/:][a-zA-Z0-9\-.]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3-outposts:[a-z\-0-9]+:[0-9]{12}:outpost[/:][a-zA-Z0-9\-]{1,63}[/:]accesspoint[/:][a-zA-Z0-9\-]{1,63}$|^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):s3:::[a-zA-Z0-9.\-_]{1,255}$`   
Required: Yes

 ** ManifestObjectVersionId **   <a name="DataSync-Type-S3ManifestConfig-ManifestObjectVersionId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `^.+$`   
Required: No

## See Also
<a name="API_S3ManifestConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/S3ManifestConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/S3ManifestConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/S3ManifestConfig) 

# SmbMountOptions
<a name="API_SmbMountOptions"></a>

Specifies the version of the Server Message Block (SMB) protocol that AWS DataSync uses to access an SMB file server.

## Contents
<a name="API_SmbMountOptions_Contents"></a>

 ** Version **   <a name="DataSync-Type-SmbMountOptions-Version"></a>
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.
**Note**  
The `SMB1` option isn't available when [creating an Amazon FSx for NetApp ONTAP location](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html).
Type: String  
Valid Values: `AUTOMATIC | SMB2 | SMB3 | SMB1 | SMB2_0`   
Required: No

## See Also
<a name="API_SmbMountOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/SmbMountOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/SmbMountOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/SmbMountOptions) 

# SourceManifestConfig
<a name="API_SourceManifestConfig"></a>

Specifies the manifest that you want AWS DataSync to use and where it's hosted. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html).

## Contents
<a name="API_SourceManifestConfig_Contents"></a>

 ** S3 **   <a name="DataSync-Type-SourceManifestConfig-S3"></a>
Specifies the S3 bucket where you're hosting your manifest.  
Type: [S3ManifestConfig](API_S3ManifestConfig.md) object  
Required: Yes

## See Also
<a name="API_SourceManifestConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/SourceManifestConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/SourceManifestConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/SourceManifestConfig) 

# TagListEntry
<a name="API_TagListEntry"></a>

A key-value pair representing a single tag that's been applied to an AWS resource.

## Contents
<a name="API_TagListEntry_Contents"></a>

 ** Key **   <a name="DataSync-Type-TagListEntry-Key"></a>
The key for an AWS resource tag.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s+=._:/-]+$`   
Required: Yes

 ** Value **   <a name="DataSync-Type-TagListEntry-Value"></a>
The value for an AWS resource tag.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s+=._:@/-]+$`   
Required: No

## See Also
<a name="API_TagListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TagListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TagListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TagListEntry) 

# TaskExecutionFilesFailedDetail
<a name="API_TaskExecutionFilesFailedDetail"></a>

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

**Note**  
Applies only to [Enhanced mode tasks](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Contents
<a name="API_TaskExecutionFilesFailedDetail_Contents"></a>

 ** Delete **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Delete"></a>
The number of files or objects that DataSync fails to delete during your task execution.  
Type: Long  
Required: No

 ** Prepare **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Prepare"></a>
The number of files or objects that DataSync fails to prepare during your task execution.  
Type: Long  
Required: No

 ** Transfer **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Transfer"></a>
The number of files or objects that DataSync fails to transfer during your task execution.  
Type: Long  
Required: No

 ** Verify **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Verify"></a>
The number of files or objects that DataSync fails to verify during your task execution.  
Type: Long  
Required: No

## See Also
<a name="API_TaskExecutionFilesFailedDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 

# TaskExecutionFilesListedDetail
<a name="API_TaskExecutionFilesListedDetail"></a>

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

**Note**  
Applies only to [Enhanced mode tasks](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Contents
<a name="API_TaskExecutionFilesListedDetail_Contents"></a>

 ** AtDestinationForDelete **   <a name="DataSync-Type-TaskExecutionFilesListedDetail-AtDestinationForDelete"></a>
The number of files or objects that DataSync finds at your destination location. This counter is only applicable if you [configure your task](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling) to delete data in the destination that isn't in the source.  
Type: Long  
Required: No

 ** AtSource **   <a name="DataSync-Type-TaskExecutionFilesListedDetail-AtSource"></a>
The number of files or objects that DataSync finds at your source location.  
+ With a [manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html), DataSync lists only what's in your manifest (and not everything at your source location).
+ With an include [filter](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html), 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.
Type: Long  
Required: No

## See Also
<a name="API_TaskExecutionFilesListedDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFilesListedDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFilesListedDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFilesListedDetail) 

# TaskExecutionFoldersFailedDetail
<a name="API_TaskExecutionFoldersFailedDetail"></a>

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

**Note**  
Applies only to [Enhanced mode tasks](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Contents
<a name="API_TaskExecutionFoldersFailedDetail_Contents"></a>

 ** Delete **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Delete"></a>
The number of directories that DataSync fails to delete during your task execution.  
Type: Long  
Required: No

 ** List **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-List"></a>
The number of directories that DataSync fails to list during your task execution.  
Type: Long  
Required: No

 ** Prepare **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Prepare"></a>
The number of directories that DataSync fails to prepare during your task execution.  
Type: Long  
Required: No

 ** Transfer **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Transfer"></a>
The number of directories that DataSync fails to transfer during your task execution.  
Type: Long  
Required: No

 ** Verify **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Verify"></a>
The number of directories that DataSync fails to verify during your task execution.  
Type: Long  
Required: No

## See Also
<a name="API_TaskExecutionFoldersFailedDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 

# TaskExecutionFoldersListedDetail
<a name="API_TaskExecutionFoldersListedDetail"></a>

The number of directories that DataSync finds at your locations.

**Note**  
Applies only to [Enhanced mode tasks](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).

## Contents
<a name="API_TaskExecutionFoldersListedDetail_Contents"></a>

 ** AtDestinationForDelete **   <a name="DataSync-Type-TaskExecutionFoldersListedDetail-AtDestinationForDelete"></a>
The number of directories that DataSync finds at your destination location. This counter is only applicable if you [configure your task](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling) to delete data in the destination that isn't in the source.  
Type: Long  
Required: No

 ** AtSource **   <a name="DataSync-Type-TaskExecutionFoldersListedDetail-AtSource"></a>
The number of directories that DataSync finds at your source location.  
+ With a [manifest](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html), DataSync lists only what's in your manifest (and not everything at your source location).
+ With an include [filter](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html), 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.
Type: Long  
Required: No

## See Also
<a name="API_TaskExecutionFoldersListedDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 

# TaskExecutionListEntry
<a name="API_TaskExecutionListEntry"></a>

Represents a single entry in a list of AWS DataSync task executions that's returned with the [ListTaskExecutions](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) operation.

## Contents
<a name="API_TaskExecutionListEntry_Contents"></a>

 ** Status **   <a name="DataSync-Type-TaskExecutionListEntry-Status"></a>
The status of a task execution. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Type: String  
Valid Values: `QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR`   
Required: No

 ** TaskExecutionArn **   <a name="DataSync-Type-TaskExecutionListEntry-TaskExecutionArn"></a>
The Amazon Resource Name (ARN) of a task execution.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$`   
Required: No

 ** TaskMode **   <a name="DataSync-Type-TaskExecutionListEntry-TaskMode"></a>
The task mode that you're using. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Type: String  
Valid Values: `BASIC | ENHANCED`   
Required: No

## See Also
<a name="API_TaskExecutionListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionListEntry) 

# TaskExecutionResultDetail
<a name="API_TaskExecutionResultDetail"></a>

Provides detailed information about the result of your AWS DataSync task execution.

## Contents
<a name="API_TaskExecutionResultDetail_Contents"></a>

 ** ErrorCode **   <a name="DataSync-Type-TaskExecutionResultDetail-ErrorCode"></a>
An error that DataSync encountered during your task execution. You can use this information to help [troubleshoot issues](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Type: String  
Required: No

 ** ErrorDetail **   <a name="DataSync-Type-TaskExecutionResultDetail-ErrorDetail"></a>
The detailed description of an error that DataSync encountered during your task execution. You can use this information to help [troubleshoot issues](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).   
Type: String  
Required: No

 ** PrepareDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-PrepareDuration"></a>
The time in milliseconds that your task execution was in the `PREPARING` step. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
For Enhanced mode tasks, the value is always `0`. For more information, see [How DataSync prepares your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-prepares).  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** PrepareStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-PrepareStatus"></a>
The status of the `PREPARING` step for your task execution. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Type: String  
Valid Values: `PENDING | SUCCESS | ERROR`   
Required: No

 ** TotalDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-TotalDuration"></a>
The time in milliseconds that your task execution ran.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** TransferDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-TransferDuration"></a>
The time in milliseconds that your task execution was in the `TRANSFERRING` step. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
For Enhanced mode tasks, the value is always `0`. For more information, see [How DataSync transfers your data](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-transfers).  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** TransferStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-TransferStatus"></a>
The status of the `TRANSFERRING` step for your task execution. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Type: String  
Valid Values: `PENDING | SUCCESS | ERROR`   
Required: No

 ** VerifyDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-VerifyDuration"></a>
The time in milliseconds that your task execution was in the `VERIFYING` step. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
For Enhanced mode tasks, the value is always `0`. For more information, see [How DataSync verifies your data's integrity](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works).  
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** VerifyStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-VerifyStatus"></a>
The status of the `VERIFYING` step for your task execution. For more information, see [Task execution statuses](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses).  
Type: String  
Valid Values: `PENDING | SUCCESS | ERROR`   
Required: No

## See Also
<a name="API_TaskExecutionResultDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionResultDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionResultDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionResultDetail) 

# TaskFilter
<a name="API_TaskFilter"></a>

You can use API filters to narrow down the list of resources returned by `ListTasks`. For example, to retrieve all tasks on a source location, you can use `ListTasks` with filter name `LocationId` and `Operator Equals` with the ARN for the location.

For more information, see [filtering DataSync resources](https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html).

## Contents
<a name="API_TaskFilter_Contents"></a>

 ** Name **   <a name="DataSync-Type-TaskFilter-Name"></a>
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`.  
Type: String  
Valid Values: `LocationId | CreationTime`   
Required: Yes

 ** Operator **   <a name="DataSync-Type-TaskFilter-Operator"></a>
The operator that is used to compare filter values (for example, `Equals` or `Contains`).  
Type: String  
Valid Values: `Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith`   
Required: Yes

 ** Values **   <a name="DataSync-Type-TaskFilter-Values"></a>
The values that you want to filter for. For example, you might want to display only tasks for a specific destination location.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[0-9a-zA-Z_\ \-\:\*\.\\/\?-]*$`   
Required: Yes

## See Also
<a name="API_TaskFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskFilter) 

# TaskListEntry
<a name="API_TaskListEntry"></a>

Represents a single entry in a list of tasks. `TaskListEntry` returns an array that contains a list of tasks when the [ListTasks](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html) operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

## Contents
<a name="API_TaskListEntry_Contents"></a>

 ** Name **   <a name="DataSync-Type-TaskListEntry-Name"></a>
The name of the task.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\s+=._:@/-]+$`   
Required: No

 ** Status **   <a name="DataSync-Type-TaskListEntry-Status"></a>
The status of the task.  
Type: String  
Valid Values: `AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE`   
Required: No

 ** TaskArn **   <a name="DataSync-Type-TaskListEntry-TaskArn"></a>
The Amazon Resource Name (ARN) of the task.  
Type: String  
Length Constraints: Maximum length of 128.  
Pattern: `^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:task/task-[0-9a-f]{17}$`   
Required: No

 ** TaskMode **   <a name="DataSync-Type-TaskListEntry-TaskMode"></a>
The task mode that you're using. For more information, see [Choosing a task mode for your data transfer](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html).  
Type: String  
Valid Values: `BASIC | ENHANCED`   
Required: No

## See Also
<a name="API_TaskListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskListEntry) 

# TaskReportConfig
<a name="API_TaskReportConfig"></a>

Specifies how you want to configure a task report, which provides detailed information about for your AWS DataSync transfer.

For more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html).

## Contents
<a name="API_TaskReportConfig_Contents"></a>

 ** Destination **   <a name="DataSync-Type-TaskReportConfig-Destination"></a>
Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see [Task reports](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access).  
Type: [ReportDestination](API_ReportDestination.md) object  
Required: No

 ** ObjectVersionIds **   <a name="DataSync-Type-TaskReportConfig-ObjectVersionIds"></a>
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](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html). Keep in mind that setting this to `INCLUDE` can increase the duration of your task execution.  
Type: String  
Valid Values: `INCLUDE | NONE`   
Required: No

 ** OutputType **   <a name="DataSync-Type-TaskReportConfig-OutputType"></a>
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.
Type: String  
Valid Values: `SUMMARY_ONLY | STANDARD`   
Required: No

 ** Overrides **   <a name="DataSync-Type-TaskReportConfig-Overrides"></a>
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.  
Type: [ReportOverrides](API_ReportOverrides.md) object  
Required: No

 ** ReportLevel **   <a name="DataSync-Type-TaskReportConfig-ReportLevel"></a>
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.
Type: String  
Valid Values: `ERRORS_ONLY | SUCCESSES_AND_ERRORS`   
Required: No

## See Also
<a name="API_TaskReportConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskReportConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskReportConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskReportConfig) 

# TaskSchedule
<a name="API_TaskSchedule"></a>

Configures your AWS DataSync task to run on a [schedule](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html) (at a minimum interval of 1 hour).

## Contents
<a name="API_TaskSchedule_Contents"></a>

 ** ScheduleExpression **   <a name="DataSync-Type-TaskSchedule-ScheduleExpression"></a>
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 [https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-scheduled-rule-pattern.html).  
Type: String  
Length Constraints: Maximum length of 256.  
Pattern: `^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$`   
Required: Yes

 ** Status **   <a name="DataSync-Type-TaskSchedule-Status"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html).  
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: No

## See Also
<a name="API_TaskSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskSchedule) 

# TaskScheduleDetails
<a name="API_TaskScheduleDetails"></a>

Provides information about your AWS DataSync [task schedule](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).

## Contents
<a name="API_TaskScheduleDetails_Contents"></a>

 ** DisabledBy **   <a name="DataSync-Type-TaskScheduleDetails-DisabledBy"></a>
Indicates how your task schedule was disabled.  
+  `USER` - Your schedule was manually disabled by using the [UpdateTask](https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html) operation or DataSync console.
+  `SERVICE` - Your schedule was automatically disabled by DataSync because the task failed repeatedly with the same error.
Type: String  
Valid Values: `USER | SERVICE`   
Required: No

 ** DisabledReason **   <a name="DataSync-Type-TaskScheduleDetails-DisabledReason"></a>
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](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html).  
Type: String  
Length Constraints: Maximum length of 8192.  
Pattern: `^[\w\s.,'?!:;\/=|<>()-]*$`   
Required: No

 ** StatusUpdateTime **   <a name="DataSync-Type-TaskScheduleDetails-StatusUpdateTime"></a>
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.  
Type: Timestamp  
Required: No

## See Also
<a name="API_TaskScheduleDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskScheduleDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskScheduleDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskScheduleDetails)