本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 資料類型
<a name="API_Types"></a>

目前支援下列資料類型：
+  [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>

當您呼叫 [ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) 操作時，代表 AWS DataSync 客服人員清單 （或陣列） 中的單一項目。

## 目錄
<a name="API_AgentListEntry_Contents"></a>

 ** AgentArn **   <a name="DataSync-Type-AgentListEntry-AgentArn"></a>
DataSync 代理程式的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^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}$`  
必要：否

 ** Name **   <a name="DataSync-Type-AgentListEntry-Name"></a>
代理程式的名稱。  
類型：字串  
長度限制：長度下限為 0。長度上限為 256。  
模式：`^[a-zA-Z0-9\s+=._:@/-]+$`  
必要：否

 ** Platform **   <a name="DataSync-Type-AgentListEntry-Platform"></a>
有關代理程式的平台相關詳細資訊，例如版本編號。  
類型：[Platform](API_Platform.md) 物件  
必要：否

 ** Status **   <a name="DataSync-Type-AgentListEntry-Status"></a>
代理程式的狀態。  
+ 如果狀態為 `ONLINE`，表示代理程式已正確設定且可供使用。
+ 如果狀態為 `OFFLINE`，則客服人員已與 DataSync 中斷聯絡五分鐘或更長時間。這可能有幾個原因。如需詳細資訊，請參閱[如果我的客服人員離線該怎麼辦？](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 
類型：字串  
有效值:`ONLINE | OFFLINE`   
必要：否

## 另請參閱
<a name="API_AgentListEntry_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/AgentListEntry) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/AgentListEntry) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/AgentListEntry) 

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

允許 AWS DataSync 存取 Microsoft Azure Blob Storage 的共用存取簽章 (SAS) 組態。

如需詳細資訊，請參閱存取 Azure Blob Storage 的 [SAS 字符](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-sas-tokens)。

## 目錄
<a name="API_AzureBlobSasConfiguration_Contents"></a>

 ** Token **   <a name="DataSync-Type-AzureBlobSasConfiguration-Token"></a>
指定 SAS 字符，提供存取 Azure Blob Storage 的許可。  
字符是 SAS URI 字串的一部分，該字串位於儲存資源 URI 和問號之後。字符看起來像這樣：  
 `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`   
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`^.+$`  
必要：是

## 另請參閱
<a name="API_AzureBlobSasConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/AzureBlobSasConfiguration) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/AzureBlobSasConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/AzureBlobSasConfiguration) 

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

指定 DataSync 受管秘密的組態資訊，例如身分驗證字符、私密金鑰、密碼或 Kerberos 金鑰標籤，DataSync 使用客戶受管存取特定儲存位置 AWS KMS key。

**注意**  
您可以使用 `CmkSecretConfig`或 `CustomSecretConfig` 來提供`CreateLocation`請求的登入資料。請勿為相同的請求提供這兩個參數。

## 目錄
<a name="API_CmkSecretConfig_Contents"></a>

 ** KmsKeyArn **   <a name="DataSync-Type-CmkSecretConfig-KmsKeyArn"></a>
指定 AWS KMS key DataSync 用來加密 儲存之 DataSync 受管秘密的客戶受管 ARN`SecretArn`。DataSync 提供此金鑰給 AWS Secrets Manager。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):kms:[a-z\-0-9]+:[0-9]{12}:key/.*|)$`  
必要：否

 ** SecretArn **   <a name="DataSync-Type-CmkSecretConfig-SecretArn"></a>
指定用於存取特定儲存位置之 DataSync 受管 AWS Secrets Manager 秘密的 ARN。此屬性是由 DataSync 產生，且為唯讀。DataSync 會使用您為 指定的 KMS 金鑰來加密此秘密`KmsKeyArn`。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`  
必要：否

## 另請參閱
<a name="API_CmkSecretConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CmkSecretConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CmkSecretConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CmkSecretConfig) 

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

指定客戶受管 Secrets Manager 秘密的組態資訊，其中儲存位置憑證會以純文字 （用於身分驗證字符、私密金鑰或密碼） 或二進位 （用於 Kerberos keytab) 形式存放在 Secrets Manager 中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。

**注意**  
您可以使用 `CmkSecretConfig`或 `CustomSecretConfig` 來提供`CreateLocation`請求的登入資料。請勿為相同的請求提供這兩個參數。

## 目錄
<a name="API_CustomSecretConfig_Contents"></a>

 ** SecretAccessRoleArn **   <a name="DataSync-Type-CustomSecretConfig-SecretAccessRoleArn"></a>
指定 DataSync 用來存取為 指定之秘密 AWS Identity and Access Management 的角色 ARN`SecretArn`。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_-]+|)$`  
必要：否

 ** SecretArn **   <a name="DataSync-Type-CustomSecretConfig-SecretArn"></a>
指定 AWS Secrets Manager 秘密的 ARN。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`  
必要：否

## 另請參閱
<a name="API_CustomSecretConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CustomSecretConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CustomSecretConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CustomSecretConfig) 

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

 AWS DataSync 用來連線至其中一個 Amazon EFS 檔案系統[掛載目標](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)的子網路和安全群組。

## 目錄
<a name="API_Ec2Config_Contents"></a>

 ** SecurityGroupArns **   <a name="DataSync-Type-Ec2Config-SecurityGroupArns"></a>
指定與 Amazon EFS 檔案系統的掛載目標相關聯的安全群組的 Amazon Resource Name (ARN)。  
類型：字串陣列  
陣列成員：項目數下限為 1。項目數上限為 5。  
長度限制：長度上限為 128。  
模式：`^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]+$`  
必要：是

 ** SubnetArn **   <a name="DataSync-Type-Ec2Config-SubnetArn"></a>
指定子網路的 ARN，DataSync 在該子網路建立[網路介面](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)以便在傳輸期間管理流量。  
子網路必須位於：  
+ 與 Amazon EFS 檔案系統相同的 Virtual Private Cloud (VPC) 中。
+ 與 Amazon EFS 檔案系統的至少一個掛載目標相同的可用區域中。
您不需要指定包含檔案系統掛載目標的子網路。
類型：字串  
長度限制：長度上限為 128。  
模式：`^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]+$`  
必要：是

## 另請參閱
<a name="API_Ec2Config_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Ec2Config) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Ec2Config) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Ec2Config) 

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

指定將檔案從來源傳輸到目的地時，要包含或排除的檔案、資料夾和物件。

## 目錄
<a name="API_FilterRule_Contents"></a>

 ** FilterType **   <a name="DataSync-Type-FilterRule-FilterType"></a>
要套用的篩選條件規則類型。 AWS DataSync 僅支援 SIMPLE\$1PATTERN 規則類型。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^[A-Z0-9_]+$`  
有效值:`SIMPLE_PATTERN`   
必要：否

 ** Value **   <a name="DataSync-Type-FilterRule-Value"></a>
由要包含或排除的模式組成的單一篩選字串。模式由 "\$1" (即管道) 分隔，例如：`/folder1|/folder2`  
   
類型：字串  
長度限制：長度上限為 102400。  
模式：`^[^\x00]+$`  
必要：否

## 另請參閱
<a name="API_FilterRule_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FilterRule) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FilterRule) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FilterRule) 

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

指定 AWS DataSync 用於存取 Amazon FSx 檔案系統的資料傳輸通訊協定。

## 目錄
<a name="API_FsxProtocol_Contents"></a>

 ** NFS **   <a name="DataSync-Type-FsxProtocol-NFS"></a>
指定 DataSync 用來存取 FSx for OpenZFS 檔案系統或 FSx for ONTAP 檔案系統的儲存虛擬機器 (SVM) 的網路檔案系統 (NFS) 通訊協定組態。  
類型：[FsxProtocolNfs](API_FsxProtocolNfs.md) 物件  
必要：否

 ** SMB **   <a name="DataSync-Type-FsxProtocol-SMB"></a>
指定伺服器訊息區塊 (SMB) 通訊協定組態，DataSync 使用該組態來存取 FSx for ONTAP 檔案系統的 SVM。  
類型：[FsxProtocolSmb](API_FsxProtocolSmb.md) 物件  
必要：否

## 另請參閱
<a name="API_FsxProtocol_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocol) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocol) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocol) 

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

指定 DataSync 用來存取 FSx for OpenZFS 檔案系統或 FSx for ONTAP 檔案系統的儲存虛擬機器 (SVM) 的網路檔案系統 (NFS) 通訊協定組態。

## 目錄
<a name="API_FsxProtocolNfs_Contents"></a>

 ** MountOptions **   <a name="DataSync-Type-FsxProtocolNfs-MountOptions"></a>
指定 DataSync 如何使用 NFS 通訊協定存取位置。  
類型：[NfsMountOptions](API_NfsMountOptions.md) 物件  
必要：否

## 另請參閱
<a name="API_FsxProtocolNfs_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocolNfs) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocolNfs) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocolNfs) 

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

指定 AWS DataSync 用於存取 Amazon FSx for NetApp ONTAP 檔案系統的儲存虛擬機器 (SVM) 的伺服器訊息區塊 (SMB) 通訊協定組態。如需詳細資訊，請參閱[提供 FSx for ONTAP 檔案系統的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access)。

## 目錄
<a name="API_FsxProtocolSmb_Contents"></a>

 ** User **   <a name="DataSync-Type-FsxProtocolSmb-User"></a>
指定可掛載和存取 SVM 中檔案、資料夾和中繼資料的使用者。  
如需選擇具有適當層級傳輸存取權之使用者的相關資訊，請參閱[使用 SMB 通訊協定](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb)。  
類型：字串  
長度限制：長度上限為 104。  
模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`  
必要：是

 ** CmkSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-CmkSecretConfig"></a>
指定 DataSync 受管秘密的組態資訊，其中包含 DataSync 用來存取特定 FSx for ONTAP 儲存位置 （使用 SMB) 以及客戶受管的密碼 AWS KMS key。  
當您將此參數包含在`CreateLocationFsxOntap`請求中時，您只需提供 KMS 金鑰 ARN。DataSync 會搭配`Password`您為 指定的 使用此 KMS 金鑰，以建立 DataSync 受管秘密來存放位置存取憑證。  
請確定 DataSync 具有存取您指定 KMS 金鑰的許可。如需詳細資訊，請參閱[使用以自訂加密的服務受管秘密 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)。  
您可以使用 `CmkSecretConfig`（搭配 `Password`) 或 `CustomSecretConfig`（不含 `Password`) 來提供`CreateLocationFsxOntap`請求的登入資料。請勿為相同的請求提供這兩個參數。
類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件  
必要：否

 ** CustomSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-CustomSecretConfig"></a>
指定客戶受管 Secrets Manager 秘密的組態資訊，其中 FSx for ONTAP 儲存位置 （使用 SMB) 的密碼存放在 Secrets Manager 的純文字中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱[使用您管理的秘密](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。  
您可以使用 `CmkSecretConfig`（搭配 `Password`) 或 `CustomSecretConfig`（不含 `Password`) 來提供`CreateLocationFsxOntap`請求的登入資料。請勿為相同的請求提供這兩個參數。
類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件  
必要：否

 ** Domain **   <a name="DataSync-Type-FsxProtocolSmb-Domain"></a>
指定儲存虛擬機器 (SVM) 所屬的 Windows 網域名稱。  
如果您的環境中有多個網域，請設定此設定可確保 DataSync 連線至正確的 SVM。  
如果您的環境中有多個 Active Directory 網域，請設定此參數可確保 DataSync 連線至正確的 SVM。  
類型：字串  
長度限制：長度上限為 253。  
模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$`  
必要：否

 ** ManagedSecretConfig **   <a name="DataSync-Type-FsxProtocolSmb-ManagedSecretConfig"></a>
描述 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`Password`的 。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。  
請勿為`CreateLocation`請求提供此項。 `ManagedSecretConfig` 是 ReadOnly 屬性，且只會填入`DescribeLocation`回應中。
類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件  
必要：否

 ** MountOptions **   <a name="DataSync-Type-FsxProtocolSmb-MountOptions"></a>
指定 AWS DataSync 用來存取 SMB 檔案伺服器的伺服器訊息區塊 (SMB) 通訊協定版本。  
類型：[SmbMountOptions](API_SmbMountOptions.md) 物件  
必要：否

 ** Password **   <a name="DataSync-Type-FsxProtocolSmb-Password"></a>
指定有權存取 SVM 之使用者的密碼。  
類型：字串  
長度限制：長度上限為 104。  
模式：`^.{0,104}$`  
必要：否

## 另請參閱
<a name="API_FsxProtocolSmb_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxProtocolSmb) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxProtocolSmb) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxProtocolSmb) 

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

指定 AWS DataSync 用來存取 Amazon FSx 檔案系統的資料傳輸通訊協定。

**注意**  
您無法更新 FSx for ONTAP 位置的網路檔案系統 (NFS) 通訊協定組態。DataSync 目前僅支援具有此位置類型的 NFS 第 3 版。

## 目錄
<a name="API_FsxUpdateProtocol_Contents"></a>

 ** NFS **   <a name="DataSync-Type-FsxUpdateProtocol-NFS"></a>
指定 DataSync 用來存取 FSx for OpenZFS 檔案系統或 FSx for ONTAP 檔案系統的儲存虛擬機器 (SVM) 的網路檔案系統 (NFS) 通訊協定組態。  
類型：[FsxProtocolNfs](API_FsxProtocolNfs.md) 物件  
必要：否

 ** SMB **   <a name="DataSync-Type-FsxUpdateProtocol-SMB"></a>
指定 DataSync 用來存取 FSx for ONTAP 檔案系統的儲存虛擬機器 (SVM) 的伺服器訊息區塊 (SMB) 通訊協定組態。  
類型：[FsxUpdateProtocolSmb](API_FsxUpdateProtocolSmb.md) 物件  
必要：否

## 另請參閱
<a name="API_FsxUpdateProtocol_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxUpdateProtocol) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxUpdateProtocol) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxUpdateProtocol) 

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

指定 AWS DataSync 用於存取 Amazon FSx for NetApp ONTAP 檔案系統的儲存虛擬機器 (SVM) 的伺服器訊息區塊 (SMB) 通訊協定組態。如需詳細資訊，請參閱[提供 FSx for ONTAP 檔案系統的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access)。

## 目錄
<a name="API_FsxUpdateProtocolSmb_Contents"></a>

 ** CmkSecretConfig **   <a name="DataSync-Type-FsxUpdateProtocolSmb-CmkSecretConfig"></a>
指定 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的一組`Password`或一組登入資料，以及客戶受管的登入資料 AWS KMS key。  
類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件  
必要：否

 ** CustomSecretConfig **   <a name="DataSync-Type-FsxUpdateProtocolSmb-CustomSecretConfig"></a>
指定客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的 `Password`或一組登入資料。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。  
類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件  
必要：否

 ** Domain **   <a name="DataSync-Type-FsxUpdateProtocolSmb-Domain"></a>
指定儲存虛擬機器 (SVM) 所屬的 Windows 網域名稱。  
如果您的環境中有多個 Active Directory 網域，請設定此參數可確保 DataSync 連線至正確的 SVM。  
類型：字串  
長度限制：長度上限為 253。  
模式：`^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$`  
必要：否

 ** MountOptions **   <a name="DataSync-Type-FsxUpdateProtocolSmb-MountOptions"></a>
指定 AWS DataSync 用來存取 SMB 檔案伺服器的伺服器訊息區塊 (SMB) 通訊協定版本。  
類型：[SmbMountOptions](API_SmbMountOptions.md) 物件  
必要：否

 ** Password **   <a name="DataSync-Type-FsxUpdateProtocolSmb-Password"></a>
指定有權存取 SVM 之使用者的密碼。  
類型：字串  
長度限制：長度上限為 104。  
模式：`^.{0,104}$`  
必要：否

 ** User **   <a name="DataSync-Type-FsxUpdateProtocolSmb-User"></a>
指定可掛載和存取 SVM 中檔案、資料夾和中繼資料的使用者。  
如需選擇具有適當層級傳輸存取權之使用者的相關資訊，請參閱[使用 SMB 通訊協定](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb)。  
類型：字串  
長度限制：長度上限為 104。  
模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$`  
必要：否

## 另請參閱
<a name="API_FsxUpdateProtocolSmb_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/FsxUpdateProtocolSmb) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/FsxUpdateProtocolSmb) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/FsxUpdateProtocolSmb) 

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

Hadoop 分散式檔案系統 (HDFS) 的 NameNode。NameNode 會管理檔案系統的命名空間。該 NameNode 會執行開啟、關閉以及重新命名檔案和目錄等操作。該 NameNode 包含將資料區塊映射到 DataNode 的資訊。

## 目錄
<a name="API_HdfsNameNode_Contents"></a>

 ** Hostname **   <a name="DataSync-Type-HdfsNameNode-Hostname"></a>
HDFS 叢集中 NameNode 的主機名稱。這個值是 NameNode 的 IP 地址或網域名稱服務 (DNS) 名稱。內部部署安裝的代理程式會使用此主機名稱與網路中的 NameNode 進行通訊。  
類型：字串  
長度限制：長度下限為 1。長度上限為 255。  
模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])$`  
必要：是

 ** Port **   <a name="DataSync-Type-HdfsNameNode-Port"></a>
NameNode 用來監聽用戶端請求的連接埠。  
類型：整數  
有效範圍：最小值為 1。最大值為 65536。  
必要：是

## 另請參閱
<a name="API_HdfsNameNode_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/HdfsNameNode) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/HdfsNameNode) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/HdfsNameNode) 

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

縮小 傳回的資源清單`ListLocations`。例如，若要查看所有 Amazon S3 位置，請使用 `"Name": "LocationType"`、 `"Operator": "Equals"`和 建立篩選條件`"Values": "S3"`。

如需詳細資訊，請參閱[篩選資源](https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html)。

## 目錄
<a name="API_LocationFilter_Contents"></a>

 ** Name **   <a name="DataSync-Type-LocationFilter-Name"></a>
正在使用的篩選條件名稱。每個 API 呼叫都支援可用的篩選條件清單 （例如，`LocationType`適用於 `ListLocations`)。  
類型：字串  
有效值:`LocationUri | LocationType | CreationTime`   
必要：是

 ** Operator **   <a name="DataSync-Type-LocationFilter-Operator"></a>
用來比較篩選條件值的運算子 （例如 `Equals`或 `Contains`)。  
類型：字串  
有效值:`Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith`   
必要：是

 ** Values **   <a name="DataSync-Type-LocationFilter-Values"></a>
您要篩選的值。例如，您可能只想顯示 Amazon S3 位置。  
類型：字串陣列  
長度限制：長度下限為 1。長度上限為 255。  
模式：`^[0-9a-zA-Z_\ \-\:\*\.\\/\?-]*$`  
必要：是

## 另請參閱
<a name="API_LocationFilter_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/LocationFilter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/LocationFilter) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/LocationFilter) 

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

代表位置清單中的單一項目。 會在呼叫 [ListLocations](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) 操作時`LocationListEntry`傳回包含位置清單的陣列。

## 目錄
<a name="API_LocationListEntry_Contents"></a>

 ** LocationArn **   <a name="DataSync-Type-LocationListEntry-LocationArn"></a>
位置的 Amazon Resource Name (ARN)。對於網路檔案系統 (NFS) 或 Amazon EFS，位置是匯出路徑。對於 Amazon S3，位置是您要掛載並使用做為位置根目錄的字首路徑。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^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}$`  
必要：否

 ** LocationUri **   <a name="DataSync-Type-LocationListEntry-LocationUri"></a>
代表位置URIs 清單。 會在呼叫 [ListLocations](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) 操作時`LocationUri`傳回包含位置清單的陣列。  
格式：`TYPE://GLOBAL_ID/SUBDIR`。  
TYPE 會指定位置類型 （例如 `nfs`或 `s3`)。  
GLOBAL\$1ID 是備份位置之資源的全域唯一識別符。EFS 的範例為 `us-east-2.fs-abcd1234`。Amazon S3 的範例是儲存貯體名稱，例如 `myBucket`。NFS 的範例是有效的 IPv4 或 IPv6 地址，或是符合 DNS 的主機名稱。  
SUBDIR 是有效的檔案系統路徑，以正斜線分隔，如同 \$1nix 慣例。對於 NFS 和 Amazon EFS，它是掛載位置的匯出路徑。對於 Amazon S3，這是您掛載並視為位置根目錄的字首路徑。  
  
類型：字串  
長度限制：長度上限為 4360。  
模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$`  
必要：否

## 另請參閱
<a name="API_LocationListEntry_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/LocationListEntry) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/LocationListEntry) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/LocationListEntry) 

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

指定 DataSync 受管秘密的組態資訊，例如身分驗證字符，或 DataSync 用來存取特定傳輸位置的一組登入資料。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。

## 目錄
<a name="API_ManagedSecretConfig_Contents"></a>

 ** SecretArn **   <a name="DataSync-Type-ManagedSecretConfig-SecretArn"></a>
指定 AWS Secrets Manager 秘密的 ARN。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^(arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.*|)$`  
必要：否

## 另請參閱
<a name="API_ManagedSecretConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ManagedSecretConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ManagedSecretConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ManagedSecretConfig) 

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

設定資訊清單，這是您要 AWS DataSync 傳輸的檔案或物件清單。如需詳細資訊和組態範例，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。

## 目錄
<a name="API_ManifestConfig_Contents"></a>

 ** Action **   <a name="DataSync-Type-ManifestConfig-Action"></a>
指定 DataSync 使用資訊清單的用途。  
類型：字串  
有效值:`TRANSFER`   
必要：否

 ** Format **   <a name="DataSync-Type-ManifestConfig-Format"></a>
指定資訊清單的檔案格式。如需詳細資訊，請參閱[建立資訊清單](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-create)。  
類型：字串  
有效值:`CSV`   
必要：否

 ** Source **   <a name="DataSync-Type-ManifestConfig-Source"></a>
指定您希望 DataSync 使用的資訊清單及其託管位置。  
如果您在 2024 年 2 月 7 日或之後設定新的資訊清單，則必須指定此參數。  
如果沒有，您會收到 400 狀態碼和`ValidationException`錯誤，指出您缺少 DataSync 的 IAM 角色，以存取託管資訊清單的 S3 儲存貯體。如需詳細資訊，請參閱[提供資訊清單的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access)。
類型：[SourceManifestConfig](API_SourceManifestConfig.md) 物件  
必要：否

## 另請參閱
<a name="API_ManifestConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ManifestConfig) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ManifestConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ManifestConfig) 

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

指定 DataSync 如何使用 NFS 通訊協定存取位置。

## 目錄
<a name="API_NfsMountOptions_Contents"></a>

 ** Version **   <a name="DataSync-Type-NfsMountOptions-Version"></a>
指定您希望 DataSync 在掛載 NFS 共用時使用的 NFS 版本。如果伺服器拒絕使用指定的版本，則任務將會失敗。  
您可以指定下列選項：  
+  `AUTOMATIC`（預設）：DataSync 選擇 NFS 版本 4.1。
+  `NFS3`：允許在伺服器上進行非同步寫入的無狀態通訊協定版本。
+  `NFSv4_0`：支援委派和虛擬檔案系統的具狀態、防火牆適用通訊協定版本。
+  `NFSv4_1`：支援工作階段、目錄委派和平行資料處理的具狀態通訊協定版本。NFS 版本 4.1 還包含 4.0 版中提供的所有功能。
DataSync 目前僅支援 NFS 版本 3，搭配 Amazon FSx for NetApp ONTAP 位置使用。
類型：字串  
有效值:`AUTOMATIC | NFS3 | NFS4_0 | NFS4_1`   
必要：否

## 另請參閱
<a name="API_NfsMountOptions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/NfsMountOptions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/NfsMountOptions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/NfsMountOptions) 

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

可連線至網路檔案系統 (NFS) 檔案伺服器的 AWS DataSync 代理程式。

## 目錄
<a name="API_OnPremConfig_Contents"></a>

 ** AgentArns **   <a name="DataSync-Type-OnPremConfig-AgentArns"></a>
可連線至 NFS 檔案伺服器的 DataSync 代理程式的 Amazon Resource Name (ARNs)。  
您可以指定多個代理程式。如需詳細資訊，請參閱[使用多個 DataSync 代理程式](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents)。  
類型：字串陣列  
陣列成員：項目數下限為 1。最多 8 個項目。  
長度限制：長度上限為 128。  
模式：`^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}$`  
必要：是

## 另請參閱
<a name="API_OnPremConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/OnPremConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/OnPremConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/OnPremConfig) 

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

指出傳輸任務的設定方式。這些選項包括 DataSync 如何在傳輸期間處理檔案、物件及其相關聯的中繼資料。您也可以指定如何驗證資料完整性、設定任務的頻寬限制，以及其他選項。

每個選項都有預設值。除非需要，否則您不需要在呼叫 [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) 之前設定任何選項。

您也可以覆寫每個任務執行的任務選項。例如，您可能想要調整個別執行`LogLevel`的 。

## 目錄
<a name="API_Options_Contents"></a>

 ** Atime **   <a name="DataSync-Type-Options-Atime"></a>
指定是否保留中繼資料，指出檔案上次讀取或寫入的時間。  
的行為`Atime`並非跨平台的完全標準，因此 DataSync 只能盡力做到這一點。
+  `BEST_EFFORT` （預設） - DataSync `Atime` 嘗試在所有來源檔案 （即任務執行`PREPARING`步驟之前的 版本） 上保留原始屬性。建議使用此選項。
+  `NONE` - 忽略 `Atime`。
如果 `Atime` 設定為 `BEST_EFFORT`，`Mtime` 必須設定為 `PRESERVE`。  
如果 `Atime` 設定為 `NONE`，則 `Mtime` 也必須為 `NONE`。
類型：字串  
有效值:`NONE | BEST_EFFORT`   
必要：否

 ** BytesPerSecond **   <a name="DataSync-Type-Options-BytesPerSecond"></a>
限制 DataSync 任務使用的頻寬。例如，如果您希望 DataSync 使用最多 1 MB，請將此值設定為 `1048576`(`=1024*1024`)。  
類型：Long  
有效範圍：最小值為 -1。  
必要：否

 ** Gid **   <a name="DataSync-Type-Options-Gid"></a>
指定檔案擁有者的 POSIX 群組 ID (GID)。  
+  `INT_VALUE` （預設） - 保留建議的使用者 ID (UID) 和 GID 的整數值。
+  `NONE` - 忽略 UID 和 GID。
如需詳細資訊，請參閱[了解 DataSync 如何處理檔案和物件中繼資料](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html)。  
類型：字串  
有效值:`NONE | INT_VALUE | NAME | BOTH`   
必要：否

 ** LogLevel **   <a name="DataSync-Type-Options-LogLevel"></a>
指定 DataSync 發佈至 Amazon CloudWatch Logs 日誌群組的日誌類型。若要指定日誌群組，請參閱 [CloudWatchLogGroupArn](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn)。  
+  `BASIC` - 發佈僅包含基本資訊的日誌 （例如傳輸錯誤）。
+  `TRANSFER` - 發佈 DataSync 任務傳輸的所有檔案或物件的日誌，並執行資料完整性檢查。
+  `OFF` - 不會發佈日誌。
類型：字串  
有效值:`OFF | BASIC | TRANSFER`   
必要：否

 ** Mtime **   <a name="DataSync-Type-Options-Mtime"></a>
指定是否保留中繼資料，指出在任務執行`PREPARING`步驟之前最後一次寫入檔案。當您需要多次執行任務時，需要此選項。  
+  `PRESERVE` （預設） - 保留原始 `Mtime`，建議使用。
+  `NONE` - 忽略 `Mtime`。
如果 `Mtime` 設定為 `PRESERVE`，`Atime` 必須設定為 `BEST_EFFORT`。  
如果將 `Mtime` 設定為 `NONE`，則 `Atime` 也必須設定為 `NONE`。
類型：字串  
有效值:`NONE | PRESERVE`   
必要：否

 ** ObjectTags **   <a name="DataSync-Type-Options-ObjectTags"></a>
指定您是否希望 DataSync 在`PRESERVE`物件儲存系統之間傳輸時物件標籤 （預設行為）。如果您希望 DataSync 任務忽略物件標籤，請指定 `NONE` 值。  
類型：字串  
有效值:`PRESERVE | NONE`   
必要：否

 ** OverwriteMode **   <a name="DataSync-Type-Options-OverwriteMode"></a>
指定 DataSync 是否應該修改或保留目的地位置的資料。  
+  `ALWAYS` （預設） - DataSync 會在來源資料 （包括中繼資料） 變更時修改目的地位置中的資料。

  如果 DataSync 覆寫物件，您可能會針對特定 Amazon S3 儲存類別產生額外費用 （例如，用於擷取或提早刪除）。如需詳細資訊，請參閱 [Amazon S3 傳輸的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。
+  `NEVER` - DataSync 不會覆寫目的地位置中的資料，即使來源資料已變更。您可以使用此選項來防止覆寫對目的地中的檔案或物件所做的變更。
類型：字串  
有效值:`ALWAYS | NEVER`   
必要：否

 ** PosixPermissions **   <a name="DataSync-Type-Options-PosixPermissions"></a>
指定哪些使用者或群組可以針對特定用途存取檔案，例如讀取、寫入或執行檔案。  
如需詳細資訊，請參閱[了解 DataSync 如何處理檔案和物件中繼資料](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html)。  
+  `PRESERVE` （預設） - 保留建議 POSIX 樣式的許可。
+  `NONE` - 忽略 POSIX 樣式的許可。
DataSync 可以保留來源位置的現有許可。
類型：字串  
有效值:`NONE | PRESERVE`   
必要：否

 ** PreserveDeletedFiles **   <a name="DataSync-Type-Options-PreserveDeletedFiles"></a>
指定是否應保留來源中不存在的目的地位置中的檔案。此選項可能會影響您的 Amazon S3 儲存成本。如果您的任務會刪除物件，您可能需要支付特定儲存方案的最低儲存持續期間費用。如需詳細資訊，請參閱[在 DataSync 中使用 Amazon S3 儲存類別時的考量事項](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。  
+  `PRESERVE` （預設） - 忽略這類建議目的地檔案。
+  `REMOVE` - 刪除來源中不存在的目的地檔案。
如果您將此參數設定為 `REMOVE`，則無法`TransferMode`設定為 `ALL`。當您傳輸所有資料時，DataSync 不會掃描目的地位置，也不知道要刪除什麼。
類型：字串  
有效值:`PRESERVE | REMOVE`   
必要：否

 ** PreserveDevices **   <a name="DataSync-Type-Options-PreserveDevices"></a>
指定 DataSync 是否應將區塊和角色裝置的中繼資料保留在來源位置，並在目的地上重新建立具有該裝置名稱和中繼資料的檔案。DataSync 只會複製此類裝置的名稱和中繼資料。  
DataSync 無法複製這些裝置的實際內容，因為它們不是終端，也不會傳回end-of-file(EOF) 標記。
+  `NONE` （預設） - 忽略特殊裝置 （建議）。
+  `PRESERVE` - 保留字元和區塊型裝置中繼資料。Amazon EFS 目前不支援此選項。
類型：字串  
有效值:`NONE | PRESERVE`   
必要：否

 ** SecurityDescriptorCopyFlags **   <a name="DataSync-Type-Options-SecurityDescriptorCopyFlags"></a>
指定從來源複製到目的地物件的 SMB 安全描述項元件。  
此值僅用於 SMB 與 Amazon FSx for Windows File Server 位置之間或兩個 FSx for Windows File Server 位置之間的傳輸。如需詳細資訊，請參閱[了解 DataSync 如何處理檔案和物件中繼資料](https://docs.aws.amazon.com/datasync/latest/userguide/metadata-copied.html)。  
+  `OWNER_DACL` （預設） - 對於每個複製的物件，DataSync 會複製下列中繼資料：
  + 物件擁有者。
  + NTFS 判別存取控制清單 (DACL)，可決定是否要授與物件存取權。

    DataSync 不會使用此選項複製 NTFS 系統存取控制清單 SACLs)。
+  `OWNER_DACL_SACL` - 對於每個複製的物件，DataSync 會複製下列中繼資料：
  + 物件擁有者。
  + NTFS 判別存取控制清單 (DACL)，可決定是否要授與物件存取權。
  + SACLs，管理員用來記錄存取安全物件的嘗試。

    複製 SACL 需要向 DataSync 用來存取 SMB 位置的 Windows 使用者授與額外許可。如需有關選擇具有適當許可的使用者的資訊，請參閱 [SMB](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)、適用於 [Windows File Server 的 FSx ](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions)或[適用於 ONTAP 的 FSx ](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-smb) 的必要許可 （取決於您傳輸中的位置類型）。
+  `NONE` - 不會複製任何 SMB 安全描述項元件。目標物件由提供用於存取目的地位置的使用者所擁有。DACL 和 SACL 根據目的地伺服器的組態而設定。
類型：字串  
有效值:`NONE | OWNER_DACL | OWNER_DACL_SACL`   
必要：否

 ** TaskQueueing **   <a name="DataSync-Type-Options-TaskQueueing"></a>
指定執行[多個任務時，是否在特定情況下將您的傳輸任務](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#running-multiple-tasks)放入佇列。這是預設`ENABLED`的。  
類型：字串  
有效值:`ENABLED | DISABLED`   
必要：否

 ** TransferMode **   <a name="DataSync-Type-Options-TransferMode"></a>
指定 DataSync 是否在您每次執行任務時，僅傳輸初始複製後位置間不同的資料 （包括中繼資料），或傳輸所有資料。如果您打算定期轉移，您可能只想轉移自上次任務執行以來變更的內容。  
+  `CHANGED` （預設） - 初始完全傳輸後，DataSync 只會複製來源和目的地位置之間不同的資料和中繼資料。
+  `ALL` - DataSync 會將來源中的所有內容複製到目的地，而不比較位置之間的差異。
類型：字串  
有效值:`CHANGED | ALL`   
必要：否

 ** Uid **   <a name="DataSync-Type-Options-Uid"></a>
指定檔案擁有者的 POSIX 使用者 ID (UID)。  
+  `INT_VALUE` （預設） - 保留 UID 和群組 ID (GID) 的整數值，此為建議值。
+  `NONE` - 忽略 UID 和 GID。
如需詳細資訊，請參閱 [ DataSync 複製的中繼資料](https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied)。  
類型：字串  
有效值:`NONE | INT_VALUE | NAME | BOTH`   
必要：否

 ** VerifyMode **   <a name="DataSync-Type-Options-VerifyMode"></a>
指定 DataSync 在傳輸結束時是否及如何檢查資料的完整性。  
+  `ONLY_FILES_TRANSFERRED` （建議） - DataSync 計算來源位置傳輸資料的檢查總和 （包括中繼資料）。在傳輸結束時，DataSync 會接著將此檢查總和與在目的地對該資料計算的檢查總和進行比較。
**注意**  
這是[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)的預設選項。

  傳輸到 S3 Glacier Flexible Retrieval 或 S3 Glacier Deep Archive 儲存類別時，我們建議使用此選項。如需詳細資訊，請參閱 [Amazon S3 位置的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。
+  `POINT_IN_TIME_CONSISTENT` - 在傳輸結束時，DataSync 會檢查整個來源和目的地，以確認兩個位置都完全同步。
**注意**  
是[基本模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)的預設選項，增強型模式任務目前不支援 。

  如果您使用[資訊清單](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)，DataSync 只會掃描和驗證資訊清單中列出的內容。

  轉移至 S3 Glacier Flexible Retrieval 或 S3 Glacier Deep Archive 儲存類別時，無法使用此選項。如需詳細資訊，請參閱 [Amazon S3 位置的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。
+  `NONE` - DataSync 只會在傳輸期間執行資料完整性檢查。與其他選項不同，傳輸結束時沒有額外的驗證。
類型：字串  
有效值:`POINT_IN_TIME_CONSISTENT | ONLY_FILES_TRANSFERRED | NONE`   
必要：否

## 另請參閱
<a name="API_Options_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Options) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Options) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Options) 

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

有關 AWS DataSync 代理程式的平台相關詳細資訊，例如版本編號。

## 目錄
<a name="API_Platform_Contents"></a>

 ** Version **   <a name="DataSync-Type-Platform-Version"></a>
DataSync 代理程式的版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`^[a-zA-Z0-9\s+=._:@/-]+$`  
必要：否

## 另請參閱
<a name="API_Platform_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/Platform) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/Platform) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/Platform) 

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

指定您的 AWS DataSync 代理程式 AWS 如何使用[虛擬私有雲端 (VPC) 服務端點](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc)連線至 。使用 VPC 端點的代理程式無法透過公有網際網路存取。

## 目錄
<a name="API_PrivateLinkConfig_Contents"></a>

 ** PrivateLinkEndpoint **   <a name="DataSync-Type-PrivateLinkConfig-PrivateLinkEndpoint"></a>
指定代理程式連線[AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html)的 所提供的 VPC 端點。  
類型：字串  
長度限制：長度下限為 7。長度上限為 15。  
模式：`\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`  
必要：否

 ** SecurityGroupArns **   <a name="DataSync-Type-PrivateLinkConfig-SecurityGroupArns"></a>
指定提供 DataSync 存取 VPC 端點之安全群組的 Amazon Resource Name (ARN)。您只能指定一個 ARN。  
類型：字串陣列  
陣列成員：固定項目數為 1。  
長度限制：長度上限為 128。  
模式：`^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]+$`  
必要：否

 ** SubnetArns **   <a name="DataSync-Type-PrivateLinkConfig-SubnetArns"></a>
指定 VPC 端點所在的子網路 ARN。您只能指定一個 ARN。  
類型：字串陣列  
陣列成員：固定項目數為 1。  
長度限制：長度上限為 128。  
模式：`^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]+$`  
必要：否

 ** VpcEndpointId **   <a name="DataSync-Type-PrivateLinkConfig-VpcEndpointId"></a>
指定代理程式連線的 VPC 端點 ID。  
類型：字串  
模式：`^vpce-[0-9a-f]{17}$`  
必要：否

## 另請參閱
<a name="API_PrivateLinkConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/PrivateLinkConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/PrivateLinkConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/PrivateLinkConfig) 

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

保護品質 (QOP) 組態可指定 Hadoop 分散式檔案系統 (HDFS) 叢集上設定的遠端程序呼叫 (RPC) 和資料傳輸隱私權設定。

## 目錄
<a name="API_QopConfiguration_Contents"></a>

 ** DataTransferProtection **   <a name="DataSync-Type-QopConfiguration-DataTransferProtection"></a>
HDFS 叢集上設定的資料傳輸保護設定。此設定對應於 Hadoop 叢集上 `hdfs-site.xml` 檔案中的 `dfs.data.transfer.protection` 設定。  
類型：字串  
有效值:`DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY`   
必要：否

 ** RpcProtection **   <a name="DataSync-Type-QopConfiguration-RpcProtection"></a>
在 HDFS 叢集上設定的 RPC 保護設定。此設定對應於 Hadoop 叢集上 `core-site.xml` 檔案中的 `hadoop.rpc.protection` 設定。  
類型：字串  
有效值:`DISABLED | AUTHENTICATION | INTEGRITY | PRIVACY`   
必要：否

## 另請參閱
<a name="API_QopConfiguration_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/QopConfiguration) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/QopConfiguration) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/QopConfiguration) 

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

指定 DataSync 上傳[任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)的位置。

## 目錄
<a name="API_ReportDestination_Contents"></a>

 ** S3 **   <a name="DataSync-Type-ReportDestination-S3"></a>
指定 DataSync 上傳任務報告的 Amazon S3 儲存貯體。  
類型：[ReportDestinationS3](API_ReportDestinationS3.md) 物件  
必要：否

## 另請參閱
<a name="API_ReportDestination_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportDestination) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportDestination) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportDestination) 

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

指定 DataSync 上傳[任務報告的](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html) Amazon S3 儲存貯體。

## 目錄
<a name="API_ReportDestinationS3_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-ReportDestinationS3-BucketAccessRoleArn"></a>
指定 IAM 政策的 Amazon Resource Name (ARN)，允許 DataSync 將任務報告上傳到您的 S3 儲存貯體。如需詳細資訊，請參閱[允許 DataSync 將任務報告上傳至 Amazon S3 儲存貯體](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`  
必要：是

 ** S3BucketArn **   <a name="DataSync-Type-ReportDestinationS3-S3BucketArn"></a>
指定 DataSync 上傳報告的 S3 儲存貯體 ARN。  
類型：字串  
長度限制：長度上限為 268。  
模式：`^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}$`  
必要：是

 ** Subdirectory **   <a name="DataSync-Type-ReportDestinationS3-Subdirectory"></a>
指定報告的儲存貯體字首。  
類型：字串  
長度限制：長度上限為 4096。  
模式：`^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`  
必要：否

## 另請參閱
<a name="API_ReportDestinationS3_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportDestinationS3) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportDestinationS3) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportDestinationS3) 

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

指定 DataSync [任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)特定方面的詳細資訊層級。

## 目錄
<a name="API_ReportOverride_Contents"></a>

 ** ReportLevel **   <a name="DataSync-Type-ReportOverride-ReportLevel"></a>
指定您的任務報告僅包含錯誤或成功和錯誤。  
例如，您的報告可能大部分只包含傳輸中狀況不佳的項目 (`ERRORS_ONLY`)。同時，您想要驗證您的[任務篩選條件](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)是否正常運作。在這種情況下，您可以取得 DataSync 成功略過哪些檔案的清單，以及是否有傳輸的檔案未傳輸 (`SUCCESSES_AND_ERRORS`)。  
類型：字串  
有效值:`ERRORS_ONLY | SUCCESSES_AND_ERRORS`   
必要：否

## 另請參閱
<a name="API_ReportOverride_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportOverride) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportOverride) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportOverride) 

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

DataSync [任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)的每個層面中包含的詳細資訊層級。

## 目錄
<a name="API_ReportOverrides_Contents"></a>

 ** Deleted **   <a name="DataSync-Type-ReportOverrides-Deleted"></a>
指定 DataSync 嘗試在目的地位置刪除的檔案、物件和目錄的報告層級。只有在您將[任務設定為](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)刪除不在來源的目的地中的資料時，才適用此條件。  
類型：[ReportOverride](API_ReportOverride.md) 物件  
必要：否

 ** Skipped **   <a name="DataSync-Type-ReportOverrides-Skipped"></a>
指定 DataSync 在傳輸期間嘗試略過的檔案、物件和目錄的報告層級。  
類型：[ReportOverride](API_ReportOverride.md) 物件  
必要：否

 ** Transferred **   <a name="DataSync-Type-ReportOverrides-Transferred"></a>
指定 DataSync 嘗試傳輸的檔案、物件和目錄的報告層級。  
類型：[ReportOverride](API_ReportOverride.md) 物件  
必要：否

 ** Verified **   <a name="DataSync-Type-ReportOverrides-Verified"></a>
指定 DataSync 在傳輸結束時嘗試驗證的檔案、物件和目錄的報告層級。  
類型：[ReportOverride](API_ReportOverride.md) 物件  
必要：否

## 另請參閱
<a name="API_ReportOverrides_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportOverrides) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportOverrides) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportOverrides) 

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

指出 DataSync 是否為您的傳輸建立完整的[任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。

## 目錄
<a name="API_ReportResult_Contents"></a>

 ** ErrorCode **   <a name="DataSync-Type-ReportResult-ErrorCode"></a>
如果 DataSync 無法建立完整的報告，則表示與錯誤相關聯的程式碼。  
類型：字串  
必要：否

 ** ErrorDetail **   <a name="DataSync-Type-ReportResult-ErrorDetail"></a>
提供有關建立報告的問題的詳細資訊。  
類型：字串  
必要：否

 ** Status **   <a name="DataSync-Type-ReportResult-Status"></a>
指出 DataSync 是否仍在處理報告、建立報告，或無法建立完整的報告。  
類型：字串  
有效值:`PENDING | SUCCESS | ERROR`   
必要：否

## 另請參閱
<a name="API_ReportResult_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ReportResult) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ReportResult) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ReportResult) 

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

指定 DataSync 用來存取 S3 儲存貯體之 AWS Identity and Access Management (IAM) 角色的 Amazon Resource Name (ARN)。

如需詳細資訊，請參閱[提供 S3 儲存貯體的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access)。

## 目錄
<a name="API_S3Config_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-S3Config-BucketAccessRoleArn"></a>
指定 DataSync 用來存取 S3 儲存貯體的 IAM 角色 ARN。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`  
必要：是

## 另請參閱
<a name="API_S3Config_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/S3Config) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/S3Config) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/S3Config) 

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

指定您要用於託管 AWS DataSync 資訊清單的 S3 儲存貯體。如需詳細資訊和組態範例，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。

## 目錄
<a name="API_S3ManifestConfig_Contents"></a>

 ** BucketAccessRoleArn **   <a name="DataSync-Type-S3ManifestConfig-BucketAccessRoleArn"></a>
指定允許 DataSync 存取資訊清單的 AWS Identity and Access Management (IAM) 角色。如需詳細資訊，請參閱[提供資訊清單的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html#transferring-with-manifest-access)。  
類型：字串  
長度限制：長度上限為 2048。  
模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$`  
必要：是

 ** ManifestObjectPath **   <a name="DataSync-Type-S3ManifestConfig-ManifestObjectPath"></a>
指定資訊清單的 Amazon S3 物件金鑰。這可以包含字首 （例如 `prefix/my-manifest.csv`)。  
類型：字串  
長度限制：長度上限為 4096。  
模式：`^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$`  
必要：是

 ** S3BucketArn **   <a name="DataSync-Type-S3ManifestConfig-S3BucketArn"></a>
指定託管資訊清單之 S3 儲存貯體的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 268。  
模式：`^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}$`  
必要：是

 ** ManifestObjectVersionId **   <a name="DataSync-Type-S3ManifestConfig-ManifestObjectVersionId"></a>
指定您要 DataSync 使用的資訊清單的物件版本 ID。如果您未設定此項目，DataSync 會使用物件的最新版本。  
類型：字串  
長度限制：長度下限為 1。長度上限為 100。  
模式：`^.+$`  
必要：否

## 另請參閱
<a name="API_S3ManifestConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/S3ManifestConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/S3ManifestConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/S3ManifestConfig) 

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

指定 AWS DataSync 用於存取 SMB 檔案伺服器的伺服器訊息區塊 (SMB) 通訊協定版本。

## 目錄
<a name="API_SmbMountOptions_Contents"></a>

 ** Version **   <a name="DataSync-Type-SmbMountOptions-Version"></a>
DataSync 預設會根據與您 SMB 檔案伺服器的交涉，自動選擇 SMB 通訊協定版本。您也可以將 DataSync 設定為使用特定 SMB 版本，但我們建議只在 DataSync 自動與 SMB 檔案伺服器交涉發生問題時，才這麼做。  
下列選項可供設定 SMB 版本：  
+  `AUTOMATIC` （預設）：DataSync 和 SMB 檔案伺服器會交涉它們在 2.1 和 3.1.1 之間相互支援的 SMB 最高版本。

  此為建議選項。如果您改為選擇檔案伺服器不支援的特定版本，可能會收到 `Operation Not Supported` 錯誤。
+  `SMB3`：將通訊協定交涉限制為僅限 SMB 3.0.2 版。
+  `SMB2`：將通訊協定交涉限制為僅限 SMB 2.1 版。
+  `SMB2_0`：將通訊協定交涉限制為僅限 SMB 2.0 版。
+  `SMB1`：將通訊協定交涉限制為僅限 SMB 1.0 版。
**注意**  
[建立 Amazon FSx for NetApp ONTAP 位置](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationFsxOntap.html)時，無法使用`SMB1`此選項。
類型：字串  
有效值:`AUTOMATIC | SMB2 | SMB3 | SMB1 | SMB2_0`   
必要：否

## 另請參閱
<a name="API_SmbMountOptions_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/SmbMountOptions) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/SmbMountOptions) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/SmbMountOptions) 

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

指定 AWS DataSync 您要使用的資訊清單及其託管位置。如需詳細資訊和組態範例，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。

## 目錄
<a name="API_SourceManifestConfig_Contents"></a>

 ** S3 **   <a name="DataSync-Type-SourceManifestConfig-S3"></a>
指定您要託管資訊清單的 S3 儲存貯體。  
類型：[S3ManifestConfig](API_S3ManifestConfig.md) 物件  
必要：是

## 另請參閱
<a name="API_SourceManifestConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/SourceManifestConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/SourceManifestConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/SourceManifestConfig) 

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

金鑰值對，代表套用至資源的 AWS 單一標籤。

## 目錄
<a name="API_TagListEntry_Contents"></a>

 ** Key **   <a name="DataSync-Type-TagListEntry-Key"></a>
 AWS 資源標籤的金鑰。  
類型：字串  
長度限制：長度下限為 1。長度上限為 256。  
模式：`^[a-zA-Z0-9\s+=._:/-]+$`  
必要：是

 ** Value **   <a name="DataSync-Type-TagListEntry-Value"></a>
 AWS 資源標籤的值。  
類型：字串  
長度限制：長度下限為 0。長度上限為 256。  
模式：`^[a-zA-Z0-9\s+=._:@/-]+$`  
必要：否

## 另請參閱
<a name="API_TagListEntry_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TagListEntry) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TagListEntry) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TagListEntry) 

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

DataSync 在任務執行期間無法準備、傳輸、驗證和刪除的檔案或物件數量。

**注意**  
僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。

## 目錄
<a name="API_TaskExecutionFilesFailedDetail_Contents"></a>

 ** Delete **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Delete"></a>
DataSync 在任務執行期間無法刪除的檔案或物件數目。  
類型：Long  
必要：否

 ** Prepare **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Prepare"></a>
DataSync 在任務執行期間無法準備的檔案或物件數量。  
類型：Long  
必要：否

 ** Transfer **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Transfer"></a>
DataSync 在任務執行期間無法傳輸的檔案或物件數量。  
類型：Long  
必要：否

 ** Verify **   <a name="DataSync-Type-TaskExecutionFilesFailedDetail-Verify"></a>
DataSync 在任務執行期間無法驗證的檔案或物件數量。  
類型：Long  
必要：否

## 另請參閱
<a name="API_TaskExecutionFilesFailedDetail_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFilesFailedDetail) 

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

DataSync 在您的位置找到的檔案或物件數量。

**注意**  
僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。

## 目錄
<a name="API_TaskExecutionFilesListedDetail_Contents"></a>

 ** AtDestinationForDelete **   <a name="DataSync-Type-TaskExecutionFilesListedDetail-AtDestinationForDelete"></a>
DataSync 在您的目的地位置找到的檔案或物件數量。只有在[您將任務設定為](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling)刪除不在來源的目的地中的資料時，此計數器才適用。  
類型：Long  
必要：否

 ** AtSource **   <a name="DataSync-Type-TaskExecutionFilesListedDetail-AtSource"></a>
DataSync 在您的來源位置找到的檔案或物件數量。  
+ 使用資訊[清單](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)時，DataSync 只會列出資訊清單中的內容 （而不是來源位置的所有內容）。
+ 使用包含[篩選條件](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)時，DataSync 只會列出符合您來源位置篩選條件的內容。
+ 使用排除篩選條件時，DataSync 會在套用篩選條件之前列出來源位置的所有內容。
類型：Long  
必要：否

## 另請參閱
<a name="API_TaskExecutionFilesListedDetail_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFilesListedDetail) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFilesListedDetail) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFilesListedDetail) 

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

DataSync 在任務執行期間無法列出、準備、傳輸、驗證和刪除的目錄數量。

**注意**  
僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。

## 目錄
<a name="API_TaskExecutionFoldersFailedDetail_Contents"></a>

 ** Delete **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Delete"></a>
DataSync 在任務執行期間無法刪除的目錄數目。  
類型：Long  
必要：否

 ** List **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-List"></a>
DataSync 在任務執行期間無法列出的目錄數量。  
類型：Long  
必要：否

 ** Prepare **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Prepare"></a>
DataSync 在任務執行期間無法準備的目錄數量。  
類型：Long  
必要：否

 ** Transfer **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Transfer"></a>
DataSync 在任務執行期間無法傳輸的目錄數量。  
類型：Long  
必要：否

 ** Verify **   <a name="DataSync-Type-TaskExecutionFoldersFailedDetail-Verify"></a>
DataSync 在任務執行期間無法驗證的目錄數量。  
類型：Long  
必要：否

## 另請參閱
<a name="API_TaskExecutionFoldersFailedDetail_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFoldersFailedDetail) 

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

DataSync 在您的位置找到的目錄數量。

**注意**  
僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。

## 目錄
<a name="API_TaskExecutionFoldersListedDetail_Contents"></a>

 ** AtDestinationForDelete **   <a name="DataSync-Type-TaskExecutionFoldersListedDetail-AtDestinationForDelete"></a>
DataSync 在您的目的地位置找到的目錄數量。只有在[您將任務設定為](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-file-object-handling)刪除不在來源的目的地中的資料時，此計數器才適用。  
類型：Long  
必要：否

 ** AtSource **   <a name="DataSync-Type-TaskExecutionFoldersListedDetail-AtSource"></a>
DataSync 在您的來源位置找到的目錄數量。  
+ 透過資訊[清單](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)，DataSync 只會列出資訊清單中的內容 （而不是來源位置的所有內容）。
+ 使用包含[篩選條件](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)時，DataSync 只會列出符合您來源位置篩選條件的內容。
+ 使用排除篩選條件時，DataSync 會在套用篩選條件之前列出來源位置的所有內容。
類型：Long  
必要：否

## 另請參閱
<a name="API_TaskExecutionFoldersListedDetail_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionFoldersListedDetail) 

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

代表使用 [ListTaskExecutions](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) 操作傳回 AWS DataSync 的任務執行清單中的單一項目。

## 目錄
<a name="API_TaskExecutionListEntry_Contents"></a>

 ** Status **   <a name="DataSync-Type-TaskExecutionListEntry-Status"></a>
任務執行的狀態。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
類型：字串  
有效值:`QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR`   
必要：否

 ** TaskExecutionArn **   <a name="DataSync-Type-TaskExecutionListEntry-TaskExecutionArn"></a>
任務執行的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^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}$`  
必要：否

 ** TaskMode **   <a name="DataSync-Type-TaskExecutionListEntry-TaskMode"></a>
您使用的任務模式。如需詳細資訊，請參閱[為您的資料傳輸選擇任務模式](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。  
類型：字串  
有效值:`BASIC | ENHANCED`   
必要：否

## 另請參閱
<a name="API_TaskExecutionListEntry_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionListEntry) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionListEntry) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionListEntry) 

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

提供 AWS DataSync 任務執行結果的詳細資訊。

## 目錄
<a name="API_TaskExecutionResultDetail_Contents"></a>

 ** ErrorCode **   <a name="DataSync-Type-TaskExecutionResultDetail-ErrorCode"></a>
DataSync 在任務執行期間遇到的錯誤。您可以使用此資訊來協助[疑難排解問題](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。  
類型：字串  
必要：否

 ** ErrorDetail **   <a name="DataSync-Type-TaskExecutionResultDetail-ErrorDetail"></a>
DataSync 在任務執行期間遇到的錯誤詳細說明。您可以使用此資訊來協助[疑難排解問題](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。  
類型：字串  
必要：否

 ** PrepareDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-PrepareDuration"></a>
您的任務執行在`PREPARING`步驟中以毫秒為單位的時間。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
對於增強型模式任務，值一律為 `0`。如需詳細資訊，請參閱 [ DataSync 如何準備資料傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-prepares)。  
類型：Long  
有效範圍：最小值為 0。  
必要：否

 ** PrepareStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-PrepareStatus"></a>
任務執行`PREPARING`的步驟狀態。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
類型：字串  
有效值:`PENDING | SUCCESS | ERROR`   
必要：否

 ** TotalDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-TotalDuration"></a>
您的任務執行以毫秒為單位的時間。  
類型：Long  
有效範圍：最小值為 0。  
必要：否

 ** TransferDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-TransferDuration"></a>
您的任務執行在`TRANSFERRING`步驟中以毫秒為單位的時間。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
對於增強型模式任務，值一律為 `0`。如需詳細資訊，請參閱 [ DataSync 如何傳輸您的資料](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-datasync-transfers)。  
類型：Long  
有效範圍：最小值為 0。  
必要：否

 ** TransferStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-TransferStatus"></a>
任務執行`TRANSFERRING`的步驟狀態。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
類型：字串  
有效值:`PENDING | SUCCESS | ERROR`   
必要：否

 ** VerifyDuration **   <a name="DataSync-Type-TaskExecutionResultDetail-VerifyDuration"></a>
您的任務執行在`VERIFYING`步驟中以毫秒為單位的時間。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
對於增強型模式任務，值一律為 `0`。如需詳細資訊，請參閱 [ DataSync 如何驗證資料的完整性](https://docs.aws.amazon.com/datasync/latest/userguide/how-datasync-transfer-works.html#how-verifying-works)。  
類型：Long  
有效範圍：最小值為 0。  
必要：否

 ** VerifyStatus **   <a name="DataSync-Type-TaskExecutionResultDetail-VerifyStatus"></a>
任務執行`VERIFYING`的步驟狀態。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。  
類型：字串  
有效值:`PENDING | SUCCESS | ERROR`   
必要：否

## 另請參閱
<a name="API_TaskExecutionResultDetail_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskExecutionResultDetail) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskExecutionResultDetail) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskExecutionResultDetail) 

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

您可以使用 API 篩選條件來縮小 傳回的資源清單`ListTasks`。例如，若要擷取來源位置上的所有任務，您可以使用 `ListTasks` 搭配篩選條件名稱`LocationId`，以及`Operator Equals`搭配該位置的 ARN。

如需詳細資訊，請參閱[篩選 DataSync 資源](https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html)。

## 目錄
<a name="API_TaskFilter_Contents"></a>

 ** Name **   <a name="DataSync-Type-TaskFilter-Name"></a>
正在使用的篩選條件名稱。每個 API 呼叫都支援可用的篩選條件清單。例如，`ListTasks` 的 `LocationId`。  
類型：字串  
有效值:`LocationId | CreationTime`   
必要：是

 ** Operator **   <a name="DataSync-Type-TaskFilter-Operator"></a>
用來比較篩選條件值的運算子 （例如 `Equals`或 `Contains`)。  
類型：字串  
有效值:`Equals | NotEquals | In | LessThanOrEqual | LessThan | GreaterThanOrEqual | GreaterThan | Contains | NotContains | BeginsWith`   
必要：是

 ** Values **   <a name="DataSync-Type-TaskFilter-Values"></a>
您要篩選的值。例如，您可能只想顯示特定目的地位置的任務。  
類型：字串陣列  
長度限制：長度下限為 1。長度上限為 255。  
模式：`^[0-9a-zA-Z_\ \-\:\*\.\\/\?-]*$`  
必要：是

## 另請參閱
<a name="API_TaskFilter_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskFilter) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskFilter) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskFilter) 

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

代表任務清單中的單一項目。 會在呼叫 [ListTasks](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html) 操作時`TaskListEntry`傳回包含任務清單的陣列。任務包含要同步的來源和目的地檔案系統，以及用於任務的選項。

## 目錄
<a name="API_TaskListEntry_Contents"></a>

 ** Name **   <a name="DataSync-Type-TaskListEntry-Name"></a>
 任務的名稱。  
類型：字串  
長度限制：長度下限為 0。長度上限為 256。  
模式：`^[a-zA-Z0-9\s+=._:@/-]+$`  
必要：否

 ** Status **   <a name="DataSync-Type-TaskListEntry-Status"></a>
任務的狀態。  
類型：字串  
有效值:`AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE`   
必要：否

 ** TaskArn **   <a name="DataSync-Type-TaskListEntry-TaskArn"></a>
任務的 Amazon Resource Name (ARN)。  
類型：字串  
長度限制：長度上限為 128。  
模式：`^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}$`  
必要：否

 ** TaskMode **   <a name="DataSync-Type-TaskListEntry-TaskMode"></a>
您使用的任務模式。如需詳細資訊，請參閱[為您的資料傳輸選擇任務模式](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。  
類型：字串  
有效值:`BASIC | ENHANCED`   
必要：否

## 另請參閱
<a name="API_TaskListEntry_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskListEntry) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskListEntry) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskListEntry) 

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

指定您要如何設定任務報告，以提供 AWS DataSync 傳輸的詳細資訊。

如需詳細資訊，請參閱[任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。

## 目錄
<a name="API_TaskReportConfig_Contents"></a>

 ** Destination **   <a name="DataSync-Type-TaskReportConfig-Destination"></a>
指定 DataSync 上傳任務報告的 Amazon S3 儲存貯體。如需詳細資訊，請參閱[任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html#task-report-access)。  
類型：[ReportDestination](API_ReportDestination.md) 物件  
必要：否

 ** ObjectVersionIds **   <a name="DataSync-Type-TaskReportConfig-ObjectVersionIds"></a>
指定您的任務報告是否包含傳輸至 S3 儲存貯體的每個物件的新版本。這僅適用於在[儲存貯體上啟用版本控制](https://docs.aws.amazon.com/AmazonS3/latest/userguide/manage-versioning-examples.html)的情況。請記住，將此設定為 `INCLUDE`可能會增加任務執行的持續時間。  
類型：字串  
有效值:`INCLUDE | NONE`   
必要：否

 ** OutputType **   <a name="DataSync-Type-TaskReportConfig-OutputType"></a>
指定您想要的任務報告類型：  
+  `SUMMARY_ONLY`：提供任務的必要詳細資訊，包括傳輸的檔案、物件和目錄數量和傳輸持續時間。
+  `STANDARD`：提供任務的完整詳細資訊，包括已傳輸、略過、驗證等檔案、物件和目錄的完整清單。
類型：字串  
有效值:`SUMMARY_ONLY | STANDARD`   
必要：否

 ** Overrides **   <a name="DataSync-Type-TaskReportConfig-Overrides"></a>
自訂任務報告各方面的報告層級。例如，您的報告通常可能只包含錯誤，但您可以指定只針對 DataSync 嘗試在目的地位置刪除的檔案，想要成功和錯誤的清單。  
類型：[ReportOverrides](API_ReportOverrides.md) 物件  
必要：否

 ** ReportLevel **   <a name="DataSync-Type-TaskReportConfig-ReportLevel"></a>
指定您希望任務報告僅包含傳輸時出現的問題，還是包含成功和未成功的內容清單。  
+  `ERRORS_ONLY`：報告顯示 DataSync 無法傳輸、略過、驗證和刪除的內容。
+  `SUCCESSES_AND_ERRORS`：報告顯示 DataSync 能夠且無法傳輸、略過、驗證和刪除的內容。
類型：字串  
有效值:`ERRORS_ONLY | SUCCESSES_AND_ERRORS`   
必要：否

## 另請參閱
<a name="API_TaskReportConfig_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskReportConfig) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskReportConfig) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskReportConfig) 

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

將 AWS DataSync 任務設定為按[排程](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)執行 （至少間隔 1 小時）。

## 目錄
<a name="API_TaskSchedule_Contents"></a>

 ** ScheduleExpression **   <a name="DataSync-Type-TaskSchedule-ScheduleExpression"></a>
使用 Cron 或 Rate 表達式指定您的任務排程。  
針對在特定時間和日期執行的任務排程，使用 Cron 表達式。例如，下列 Cron 表達式會建立任務排程，在每個月的第一個星期三上午 8 點執行：  
 `cron(0 8 * * 3#1)`   
針對定期執行的任務排程使用速率表達式。例如，下列速率表達式會建立每 12 小時執行的任務排程：  
 `rate(12 hours)`   
如需 Cron 和 Rate 表達式語法的詳細資訊，請參閱 [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)。  
類型：字串  
長度限制：長度上限為 256。  
模式：`^[a-zA-Z0-9\ \_\*\?\,\|\^\-\/\#\s\(\)\+]*$`  
必要：是

 ** Status **   <a name="DataSync-Type-TaskSchedule-Status"></a>
指定是否啟用或停用您的任務排程。您的排程預設為啟用，但在某些情況下，您可能需要將其停用。例如，您可能需要暫停定期傳輸，以修正任務的問題或對儲存系統執行維護。  
如果您的任務重複失敗，且出現相同的錯誤，DataSync 可能會自動停用您的排程。如需詳細資訊，請參閱 [TaskScheduleDetails](https://docs.aws.amazon.com/datasync/latest/userguide/API_TaskScheduleDetails.html)。  
類型：字串  
有效值:`ENABLED | DISABLED`   
必要：否

## 另請參閱
<a name="API_TaskSchedule_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱以下內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskSchedule) 
+  [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskSchedule) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskSchedule) 

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

提供任務 AWS DataSync 排程的相關資訊。 [https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)

## 目錄
<a name="API_TaskScheduleDetails_Contents"></a>

 ** DisabledBy **   <a name="DataSync-Type-TaskScheduleDetails-DisabledBy"></a>
指出停用任務排程的方式。  
+  `USER` - 您的排程已使用 [UpdateTask](https://docs.aws.amazon.com/datasync/latest/userguide/API_UpdateTask.html) 操作或 DataSync 主控台手動停用。
+  `SERVICE` - 您的排程已由 DataSync 自動停用，因為任務重複失敗，並出現相同的錯誤。
類型：字串  
有效值:`USER | SERVICE`   
必要：否

 ** DisabledReason **   <a name="DataSync-Type-TaskScheduleDetails-DisabledReason"></a>
如果任務排程已停用，請提供原因。  
如果您的排程已由 停用`USER`，您會看到`Manually disabled by user.`訊息。  
如果您的排程被 停用`SERVICE`，您會看到錯誤訊息，協助您了解任務持續失敗的原因。如需解決 DataSync 錯誤的資訊，請參閱[針對 DataSync 傳輸的問題進行故障診斷](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。  
類型：字串  
長度限制：長度上限為 8192。  
模式：`^[\w\s.,'?!:;\/=|<>()-]*$`  
必要：否

 ** StatusUpdateTime **   <a name="DataSync-Type-TaskScheduleDetails-StatusUpdateTime"></a>
指出任務排程狀態上次變更的時間。例如，如果 DataSync 因為重複錯誤而自動停用排程，您可以查看排程停用的時間。  
類型：Timestamp  
必要：否

## 另請參閱
<a name="API_TaskScheduleDetails_SeeAlso"></a>

如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容：
+  [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TaskScheduleDetails) 
+  [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TaskScheduleDetails) 
+  [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TaskScheduleDetails)