本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # 動作支援以下動作： + [CancelTaskExecution](API_CancelTaskExecution.md) + [CreateAgent](API_CreateAgent.md) + [CreateLocationAzureBlob](API_CreateLocationAzureBlob.md) + [CreateLocationEfs](API_CreateLocationEfs.md) + [CreateLocationFsxLustre](API_CreateLocationFsxLustre.md) + [CreateLocationFsxOntap](API_CreateLocationFsxOntap.md) + [CreateLocationFsxOpenZfs](API_CreateLocationFsxOpenZfs.md) + [CreateLocationFsxWindows](API_CreateLocationFsxWindows.md) + [CreateLocationHdfs](API_CreateLocationHdfs.md) + [CreateLocationNfs](API_CreateLocationNfs.md) + [CreateLocationObjectStorage](API_CreateLocationObjectStorage.md) + [CreateLocationS3](API_CreateLocationS3.md) + [CreateLocationSmb](API_CreateLocationSmb.md) + [CreateTask](API_CreateTask.md) + [DeleteAgent](API_DeleteAgent.md) + [DeleteLocation](API_DeleteLocation.md) + [DeleteTask](API_DeleteTask.md) + [DescribeAgent](API_DescribeAgent.md) + [DescribeLocationAzureBlob](API_DescribeLocationAzureBlob.md) + [DescribeLocationEfs](API_DescribeLocationEfs.md) + [DescribeLocationFsxLustre](API_DescribeLocationFsxLustre.md) + [DescribeLocationFsxOntap](API_DescribeLocationFsxOntap.md) + [DescribeLocationFsxOpenZfs](API_DescribeLocationFsxOpenZfs.md) + [DescribeLocationFsxWindows](API_DescribeLocationFsxWindows.md) + [DescribeLocationHdfs](API_DescribeLocationHdfs.md) + [DescribeLocationNfs](API_DescribeLocationNfs.md) + [DescribeLocationObjectStorage](API_DescribeLocationObjectStorage.md) + [DescribeLocationS3](API_DescribeLocationS3.md) + [DescribeLocationSmb](API_DescribeLocationSmb.md) + [DescribeTask](API_DescribeTask.md) + [DescribeTaskExecution](API_DescribeTaskExecution.md) + [ListAgents](API_ListAgents.md) + [ListLocations](API_ListLocations.md) + [ListTagsForResource](API_ListTagsForResource.md) + [ListTaskExecutions](API_ListTaskExecutions.md) + [ListTasks](API_ListTasks.md) + [StartTaskExecution](API_StartTaskExecution.md) + [TagResource](API_TagResource.md) + [UntagResource](API_UntagResource.md) + [UpdateAgent](API_UpdateAgent.md) + [UpdateLocationAzureBlob](API_UpdateLocationAzureBlob.md) + [UpdateLocationEfs](API_UpdateLocationEfs.md) + [UpdateLocationFsxLustre](API_UpdateLocationFsxLustre.md) + [UpdateLocationFsxOntap](API_UpdateLocationFsxOntap.md) + [UpdateLocationFsxOpenZfs](API_UpdateLocationFsxOpenZfs.md) + [UpdateLocationFsxWindows](API_UpdateLocationFsxWindows.md) + [UpdateLocationHdfs](API_UpdateLocationHdfs.md) + [UpdateLocationNfs](API_UpdateLocationNfs.md) + [UpdateLocationObjectStorage](API_UpdateLocationObjectStorage.md) + [UpdateLocationS3](API_UpdateLocationS3.md) + [UpdateLocationSmb](API_UpdateLocationSmb.md) + [UpdateTask](API_UpdateTask.md) + [UpdateTaskExecution](API_UpdateTaskExecution.md) # CancelTaskExecution 停止進行中 AWS DataSync 的任務執行。某些檔案的傳輸會突然中斷。傳輸至目的地的檔案內容可能不完整或與來源檔案不一致。不過，如果您使用相同的任務啟動新的任務執行並允許它完成，則目的地上的檔案內容將完整且一致。這適用於中斷任務執行的其他未預期失敗。在所有這些情況下，DataSync 會在您開始下一個任務執行時成功完成傳輸。 ## 請求語法 ``` { "TaskExecutionArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [TaskExecutionArn](#API_CancelTaskExecution_RequestSyntax) ** 要停止之任務執行的 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}$` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，就會擲出此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CancelTaskExecution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CancelTaskExecution) # CreateAgent 啟用您在儲存環境中部署的 AWS DataSync 代理程式。啟用程序會將代理程式與您的建立關聯 AWS 帳戶。如果您尚未部署代理程式，請參閱[我需要 DataSync 代理程式嗎？](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html) ## 請求語法 ``` { "ActivationKey": "string", "AgentName": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "VpcEndpointId": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [ActivationKey](#API_CreateAgent_RequestSyntax) ** 指定 DataSync 代理程式的啟用金鑰。如果您沒有啟用金鑰，請參閱[啟用您的代理](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)程式。類型：字串長度限制：長度上限為 29。模式：`[A-Z0-9]{5}(-[A-Z0-9]{5}){4}` 必要：是 ** [AgentName](#API_CreateAgent_RequestSyntax) ** 指定代理程式的名稱。建議您指定可記住的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` 必要：否 ** [SecurityGroupArns](#API_CreateAgent_RequestSyntax) ** 指定安全群組的 Amazon Resource Name (ARN)，允許代理程式和 VPC 服務端點之間的流量。您只能指定一個 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](#API_CreateAgent_RequestSyntax) ** 指定 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]+$` 必要：否 ** [Tags](#API_CreateAgent_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。我們建議為您的代理程式建立至少一個標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ** [VpcEndpointId](#API_CreateAgent_RequestSyntax) ** 指定您正在使用的 [VPC 服務端點](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#datasync-in-vpc) ID。例如，VPC 端點 ID 看起來像 `vpce-01234d5aff67890e1`。您使用的 VPC 服務端點必須包含 DataSync 服務名稱（例如 `com.amazonaws.us-east-2.datasync`)。類型：字串模式：`^vpce-[0-9a-f]{17}$` 必要：否 ## 回應語法 ``` { "AgentArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AgentArn](#API_CreateAgent_ResponseSyntax) ** 您剛啟用之代理程式的 ARN。使用 [ListAgents](https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) 操作傳回 AWS 帳戶和中的客服人員清單 AWS 區域。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例會啟用 DataSync 代理程式。 ``` { "ActivationKey": "AAAAA-1AAAA-BB1CC-33333-EEEEE", "AgentName": "MyAgent", "Tags": [{ "Key": "Job", "Value": "TransferJob-1" }] } ``` ### 回應範例回應會傳回已啟用代理程式的 ARN。 ``` { "AgentArn": "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44baca3" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateAgent) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateAgent) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateAgent) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateAgent) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateAgent) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateAgent) # CreateLocationAzureBlob 建立 Microsoft Azure Blob Storage Container 的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸來源或目的地。您可以使用或不使用連線至容器的 [DataSync 代理](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent)程式來進行傳輸。開始之前，請確定您知道 [ DataSync 如何存取 Azure Blob Storage](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access)，以及如何使用[存取層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)和 [Blob 類型](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types)。 ## 請求語法 ``` { "AccessTier": "string", "AgentArns": [ "string" ], "AuthenticationType": "string", "BlobType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "ContainerUrl": "string", "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "SasConfiguration": { "Token": "string" }, "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AccessTier](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定您希望物件或檔案傳輸到的存取層。這僅適用於使用位置做為傳輸目的地時。如需詳細資訊，請參閱[存取層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)。類型：字串有效值:`HOT | COOL | ARCHIVE` 必要：否 ** [AgentArns](#API_CreateLocationAzureBlob_RequestSyntax) ** （選用）指定可與 Azure Blob Storage 容器連線之 DataSync 代理程式的 Amazon Resource Name (ARN)。如果您要設定無代理程式跨雲端傳輸，則不需要為此參數指定值。您可以指定多個代理程式。如需詳細資訊，請參閱[使用多個客服人員進行轉接](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html)。首次建立儲存位置時，請務必正確設定此參數。您無法在建立代理程式之後，從儲存位置新增或移除代理程式。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [AuthenticationType](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定 DataSync 用來存取 Azure Blob Storage 的身分驗證方法。DataSync 可以使用共用存取簽章 (SAS) 存取 Blob 儲存。類型：字串有效值:`SAS | NONE` 必要：是 ** [BlobType](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定您希望物件或檔案在傳輸到 Azure Blob Storage 時的 Blob 類型。目前，DataSync 僅支援將資料移至 Azure Blob Storage 做為區塊 Blob。如需 Blob 類型的詳細資訊，請參閱 [Azure Blob Storage 文件](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)。類型：字串有效值:`BLOCK` 必要：否 ** [CmkSecretConfig](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，其中包含 DataSync 使用客戶受管存取特定 AzureBlob 儲存位置的身分驗證字符 AWS KMS key。當您將此參數包含在`CreateLocationAzureBlob`請求中時，您只需提供 KMS 金鑰 ARN。DataSync 會將此 KMS 金鑰與您為指定的身分驗證字符搭配使用`SasConfiguration`，以建立 DataSync 受管秘密來存放位置存取憑證。請確定 DataSync 具有存取您指定 KMS 金鑰的許可。如需詳細資訊，請參閱[使用以自訂加密的服務受管秘密 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)。您可以使用 `CmkSecretConfig`（使用 `SasConfiguration`) 或 `CustomSecretConfig`（不使用 `SasConfiguration`) 來提供`CreateLocationAzureBlob`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [ContainerUrl](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定傳輸所涉及 Azure Blob Storage 容器的 URL。類型：字串長度限制：長度上限為 325。模式：`^https:\/\/[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}\/[a-z0-9](-?[a-z0-9]){2,62}$` 必要：是 ** [CustomSecretConfig](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定客戶受管 Secrets Manager 秘密的組態資訊，其中 AzureBlob 儲存位置的身分驗證字符存放在 Secrets Manager 的純文字中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱[使用您管理的秘密](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。您可以使用 `CmkSecretConfig`（使用 `SasConfiguration`) 或 `CustomSecretConfig`（不使用 `SasConfiguration`) 來提供`CreateLocationAzureBlob`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [SasConfiguration](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定允許 DataSync 存取 Azure Blob Storage 的 SAS 組態。如果您使用提供身分驗證字符`SasConfiguration`，但未使用 `CmkSecretConfig`或提供秘密組態詳細資訊`CustomSecretConfig`，則 DataSync 會使用您 AWS 帳戶的秘密管理員秘密來存放字符。類型：[AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md) 物件必要：否 ** [Subdirectory](#API_CreateLocationAzureBlob_RequestSyntax) ** 如果您想要將傳輸限制在容器中的虛擬目錄（例如，)，請指定路徑區段`/my/images`。類型：字串長度限制：長度上限為 1024。模式：`^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$` 必要：否 ** [Tags](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。我們建議為您的傳輸位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationAzureBlob_ResponseSyntax) ** 您建立之 Azure Blob Storage 傳輸位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationAzureBlob) # CreateLocationEfs 建立 Amazon EFS 檔案系統的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 Amazon EFS 檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access)。 ## 請求語法 ``` { "AccessPointArn": "string", "Ec2Config": { "SecurityGroupArns": [ "string" ], "SubnetArn": "string" }, "EfsFilesystemArn": "string", "FileSystemAccessRoleArn": "string", "InTransitEncryption": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AccessPointArn](#API_CreateLocationEfs_RequestSyntax) ** 指定 DataSync 用來掛載 Amazon EFS 檔案系統的存取點的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱[存取受限制的檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` 必要：否 ** [Ec2Config](#API_CreateLocationEfs_RequestSyntax) ** 指定 DataSync 用來連線至其中一個 Amazon EFS 檔案系統[掛載目標](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)的子網路和安全群組。類型：[Ec2Config](API_Ec2Config.md) 物件必要：是 ** [EfsFilesystemArn](#API_CreateLocationEfs_RequestSyntax) ** 指定 Amazon EFS 檔案系統的 ARN。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]{8,40}$` 必要：是 ** [FileSystemAccessRoleArn](#API_CreateLocationEfs_RequestSyntax) ** 指定允許 DataSync 存取 Amazon EFS 檔案系統的 AWS Identity and Access Management (IAM) 角色。如需建立此角色的資訊，請參閱[建立用於檔案系統存取的 DataSync IAM 角色](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)。類型：字串長度限制：長度上限為 2048。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` 必要：否 ** [InTransitEncryption](#API_CreateLocationEfs_RequestSyntax) ** 指定當您的 Amazon EFS 檔案系統傳輸資料時，您是否希望 DataSync 使用 Transport Layer Security (TLS) 1.2 加密。如果您使用 `AccessPointArn` 指定存取點或使用 `FileSystemAccessRoleArn` 指定 IAM 角色，則必須將此參數設定為 `TLS1_2`。類型：字串有效值:`NONE | TLS1_2` 必要：否 ** [Subdirectory](#API_CreateLocationEfs_RequestSyntax) ** 為 Amazon EFS 檔案系統指定掛載路徑。這是 DataSync 在檔案系統上讀取或寫入資料的地方（取決於這是來源或目的地位置）。根據預設，DataSync 會使用根目錄（如果您使用提供[存取點](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html))`AccessPointArn`。您也可以使用斜線包含子目錄（例如，`/path/to/folder`)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` 必要：否 ** [Tags](#API_CreateLocationEfs_RequestSyntax) ** 指定代表您要新增至資源之標籤的鍵/值對。此數值可以是空字串。此值可協助您管理、篩選和搜尋資源。建議您為位置建立名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationEfs_ResponseSyntax) ** 您建立之 Amazon EFS 檔案系統位置的 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}:location/loc-[0-9a-z]{17}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例會建立 Amazon EFS 檔案系統的位置。 ``` { "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:11122233344:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:11122233344:security-group/sg-1234567890abcdef2" ] }, "EfsFilesystemArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:file-system/fs-021345abcdef6789", "Subdirectory": "/mount/path", "Tags": [{ "Key": "Name", "Value": "ElasticFileSystem-1" }] } ``` ### 請求範例：為受限的 Amazon EFS 檔案系統建立位置下列範例會為存取受限的 Amazon EFS 檔案系統建立位置。在這種情況下，您可能需要在請求`InTransitEncryption`中指定 `AccessPointArn`、 `FileSystemAccessRoleArn`和的值。 ``` { "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0", "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew", "InTransitEncryption": "TLS1_2", "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/", "Subdirectory": "/mount/path", "Tags": [{ "Key": "Name", "Value": "ElasticFileSystem-1" }] } ``` ### 回應範例回應會傳回 Amazon EFS 檔案系統的位置 ARN。 ``` { "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationEfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationEfs) # CreateLocationFsxLustre 建立 Amazon FSx for Lustre 檔案系統的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 FSx for Lustre 檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access)。 ## 請求語法 ``` { "FsxFilesystemArn": "string", "SecurityGroupArns": [ "string" ], "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [FsxFilesystemArn](#API_CreateLocationFsxLustre_RequestSyntax) ** 指定 FSx for Lustre 檔案系統的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` 必要：是 ** [SecurityGroupArns](#API_CreateLocationFsxLustre_RequestSyntax) ** 指定最多五個安全群組的 Amazon Resource Name (ARNs)，這些安全群組可讓您存取 FSx for Lustre 檔案系統。安全群組必須能夠存取檔案系統的連接埠。檔案系統也必須允許來自安全群組的存取。如需有關檔案系統存取的資訊，請參閱 [https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/LustreGuide/limit-access-security-groups.html)。類型：字串陣列陣列成員：項目數下限為 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]+$` 必要：是 ** [Subdirectory](#API_CreateLocationFsxLustre_RequestSyntax) ** 指定 FSx for Lustre 檔案系統的掛載路徑。路徑可以包含子目錄。當位置用作來源時，DataSync 會從掛載路徑讀取資料。當位置用作目的地時，DataSync 會將資料寫入掛載路徑。如果您未包含此參數，DataSync 會使用檔案系統的根目錄 (`/`)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ** [Tags](#API_CreateLocationFsxLustre_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationFsxLustre_ResponseSyntax) ** 您建立的 FSx for Lustre 檔案系統位置的 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}:location/loc-[0-9a-z]{17}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxLustre) # CreateLocationFsxOntap 建立 Amazon FSx for NetApp ONTAP 檔案系統的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 FSx for ONTAP 檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access)。 ## 請求語法 ``` { "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "SecurityGroupArns": [ "string" ], "StorageVirtualMachineArn": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [Protocol](#API_CreateLocationFsxOntap_RequestSyntax) ** 指定 AWS DataSync 用於存取 Amazon FSx 檔案系統的資料傳輸通訊協定。類型：[FsxProtocol](API_FsxProtocol.md) 物件必要：是 ** [SecurityGroupArns](#API_CreateLocationFsxOntap_RequestSyntax) ** 指定可讓您存取檔案系統偏好子網路的 Amazon EC2 安全群組。安全群組必須允許下列連接埠上的傳出流量（取決於您使用的通訊協定）： + **網路檔案系統 (NFS)**：TCP 連接埠 111、635 和 2049 + **伺服器訊息區塊 (SMB)**：TCP 連接埠 445 檔案系統的安全群組也必須允許相同連接埠上的傳入流量。類型：字串陣列陣列成員：項目數下限為 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]+$` 必要：是 ** [StorageVirtualMachineArn](#API_CreateLocationFsxOntap_RequestSyntax) ** 指定檔案系統 (要在其中複製或貼上資料) 中儲存虛擬機器 (SVM) 的 ARN。類型：字串長度限制：長度上限為 162。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` 必要：是 ** [Subdirectory](#API_CreateLocationFsxOntap_RequestSyntax) ** 指定要在其中傳輸資料的 SVM 中檔案共享的路徑。您可以指定接合路徑 (也稱為掛載點)、qtree 路徑 (用於 NFS 檔案共用) 或共用名稱 (用於 SMB 檔案共用)。例如，您的掛載路徑可能是 `/vol1`、`/vol1/tree1` 或 `/share1`。請勿在 SVM 的根磁碟區中指定接合路徑。如需詳細資訊，請參閱《Amazon FSx for NetApp ONTAP 使用者指南》中的[管理 FSx for ONTAP 儲存虛擬機器](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html)。類型：字串長度限制：長度上限為 255。模式：`^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$` 必要：否 ** [Tags](#API_CreateLocationFsxOntap_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationFsxOntap_ResponseSyntax) ** 指定您建立的 FSx for ONTAP 檔案系統位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOntap) # CreateLocationFsxOpenZfs 建立 Amazon FSx for OpenZFS 檔案系統的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 FSx for OpenZFS 檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access)。 **注意** `CreateLocationFsxOpenZfs` 操作`SMB`不支援與相關的請求參數。 ## 請求語法 ``` { "FsxFilesystemArn": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "SecurityGroupArns": [ "string" ], "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [FsxFilesystemArn](#API_CreateLocationFsxOpenZfs_RequestSyntax) ** FSx for OpenZFS 檔案系統的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` 必要：是 ** [Protocol](#API_CreateLocationFsxOpenZfs_RequestSyntax) ** AWS DataSync 用來存取檔案系統的通訊協定類型。類型：[FsxProtocol](API_FsxProtocol.md) 物件必要：是 ** [SecurityGroupArns](#API_CreateLocationFsxOpenZfs_RequestSyntax) ** 用來設定 FSx for OpenZFS 檔案系統之安全群組的 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]+$` 必要：是 ** [Subdirectory](#API_CreateLocationFsxOpenZfs_RequestSyntax) ** 位置路徑中的子目錄必須以 `/fsx` 開頭。DataSync 會使用此子目錄來讀取或寫入資料 (視檔案系統是來源還是目的地位置而定)。類型：字串長度限制：長度上限為 4096。模式：`^[^\u0000\u0085\u2028\u2029\r\n]{1,4096}$` 必要：否 ** [Tags](#API_CreateLocationFsxOpenZfs_RequestSyntax) ** 代表您要新增至資源之標籤的鍵/值對。此數值可以是空字串。此值可協助您管理、篩選和搜尋資源。建議您為位置建立名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationFsxOpenZfs_ResponseSyntax) ** 您建立之 FSx for OpenZFS 檔案系統位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) # CreateLocationFsxWindows 建立 Amazon FSx for Windows File Server 檔案系統的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 FSx for Windows File Server 檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access)。 ## 請求語法 ``` { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "FsxFilesystemArn": "string", "Password": "string", "SecurityGroupArns": [ "string" ], "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [CmkSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，其中包含 DataSync 使用客戶受管存取特定 FSx Windows 儲存位置的密碼 AWS KMS key。當您將此參數包含在`CreateLocationFsxWindows`請求中時，您只需提供 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`) 來提供`CreateLocationFsxWindows`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定客戶受管 Secrets Manager 秘密的組態資訊，其中 FSx for Windows File Server 儲存位置的密碼存放在 Secrets Manager 的純文字中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱[使用您管理的秘密](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `Password`) 或 `CustomSecretConfig`（不含 `Password`) 來提供`CreateLocationFsxWindows`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [Domain](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定 FSx for Windows File Server 檔案系統所屬的 Windows 網域名稱。如果您的環境中有多個 Active Directory 網域，請設定此參數可確保 DataSync 連線至正確的檔案系統。類型：字串長度限制：長度上限為 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 必要：否 ** [FsxFilesystemArn](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定 FSx for Windows File Server 檔案系統的 Amazon Resource Name (ARN)。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` 必要：是 ** [Password](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定具有許可的使用者密碼，以掛載和存取 FSx for Windows File Server 檔案系統中的檔案、資料夾和檔案中繼資料。類型：字串長度限制：長度上限為 104。模式：`^.{0,104}$` 必要：否 ** [SecurityGroupArns](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定 Amazon EC2 安全群組ARNs，可讓您存取檔案系統偏好的子網路。您指定的安全群組必須能夠與檔案系統的安全群組通訊。如需為檔案系統存取設定安全群組的詳細資訊，請參閱 [https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html)。如果您選擇不允許其本身連線的安全群組，請執行下列其中一項操作： + 設定安全群組以允許其自行通訊。 + 選擇可與掛載目標安全群組通訊的不同安全群組。類型：字串陣列陣列成員：項目數下限為 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]+$` 必要：是 ** [Subdirectory](#API_CreateLocationFsxWindows_RequestSyntax) ** 使用正斜線指定檔案系統的掛載路徑。這是 DataSync 讀取或寫入資料的位置 (取決於這是來源還是目的地位置)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ** [Tags](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ** [User](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定具有許可的使用者，以掛載和存取 FSx for Windows File Server 檔案系統中的檔案、資料夾和檔案中繼資料。如需有關為傳輸選擇具有適當存取層級的使用者的資訊，請參閱 FSx for Windows File Server 位置[的必要許可](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions)。類型：字串長度限制：長度上限為 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 必要：是 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationFsxWindows_ResponseSyntax) ** 您建立的 FSx for Windows File Server 檔案系統位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationFsxWindows) # CreateLocationHdfs 建立 Hadoop 分散式檔案系統 (HDFS) 的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 HDFS 叢集](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs)。 ## 請求語法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "BlockSize": number, "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "KmsKeyProviderUri": "string", "NameNodes": [ { "Hostname": "string", "Port": number } ], "QopConfiguration": { "DataTransferProtection": "string", "RpcProtection": "string" }, "ReplicationFactor": number, "SimpleUser": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArns](#API_CreateLocationHdfs_RequestSyntax) ** 可連線至 HDFS 叢集之 DataSync 代理程式的 Amazon Resource Name (ARNs)。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：是 ** [AuthenticationType](#API_CreateLocationHdfs_RequestSyntax) ** 用來判斷使用者身分的身分驗證類型。類型：字串有效值:`SIMPLE | KERBEROS` 必要：是 ** [BlockSize](#API_CreateLocationHdfs_RequestSyntax) ** 寫入至 HDFS 叢集的資料區塊大小。區塊大小必須是 512 個位元組的倍數。預設區塊大小為 128 MiB。類型：整數有效範圍：最小值為 1048576。最大值為 1073741824。必要：否 ** [CmkSecretConfig](#API_CreateLocationHdfs_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，其中包含 DataSync 使用客戶受管存取特定 Hadoop 分散式檔案系統 (HDFS) 儲存位置的 Kerberos 金鑰標籤 AWS KMS key。當您將此參數包含在`CreateLocationHdfs`請求中時，您只需提供 KMS 金鑰 ARN。DataSync 會將此 KMS 金鑰與您為 `KerberosKeytab`指定的搭配使用，以建立 DataSync 受管秘密來存放位置存取憑證。請確定 DataSync 具有存取您指定 KMS 金鑰的許可。如需詳細資訊，請參閱[使用以自訂加密的服務受管秘密 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `KerberosKeytab`) 或 `CustomSecretConfig`（不含 `KerberosKeytab`) 來提供`CreateLocationHdfs`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_CreateLocationHdfs_RequestSyntax) ** 指定客戶受管 Secrets Manager 秘密的組態資訊，其中 HDFS 儲存位置的 Kerberos keytab 存放在 Secrets Manager 的二進位中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱[使用您管理的秘密](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `KerberosKeytab`) 或 `CustomSecretConfig`（不含 `KerberosKeytab`) 來提供`CreateLocationHdfs`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [KerberosKeytab](#API_CreateLocationHdfs_RequestSyntax) ** 此為 Kerberos 金鑰資料表 (keytab)，其中包含已定義 Kerberos 主體與已加密金鑰之間的映射。您可以透過提供檔案的地址，從檔案載入 keytab。如果為 `AuthenticationType` 指定了 `KERBEROS`，則此參數必要項目。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 65536。必要：否 ** [KerberosKrb5Conf](#API_CreateLocationHdfs_RequestSyntax) ** 包含 Kerberos 組態資訊的 `krb5.conf` 檔案。您可以透過提供`krb5.conf`檔案的地址來載入檔案。如果您使用的是 AWS CLI，它會為您執行 base64 編碼。否則，請提供 base64 編碼的文字。如果為 `AuthenticationType` 指定了 `KERBEROS`，則此參數必要項目。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 131072。必要：否 ** [KerberosPrincipal](#API_CreateLocationHdfs_RequestSyntax) ** 此為 Kerberos 主體，有權存取 HDFS 叢集上的檔案和資料夾。如果為 `AuthenticationType` 指定了 `KERBEROS`，則此參數必要項目。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^.+$` 必要：否 ** [KmsKeyProviderUri](#API_CreateLocationHdfs_RequestSyntax) ** HDFS 叢集金鑰管理伺服器 (KMS) 的 URI。類型：字串長度限制：長度下限為 1。長度上限為 255。模式：`^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$` 必要：否 ** [NameNodes](#API_CreateLocationHdfs_RequestSyntax) ** 管理 HDFS 命名空間的 NameNode。該 NameNode 會執行開啟、關閉以及重新命名檔案和目錄等操作。該 NameNode 包含將資料區塊映射到 DataNode 的資訊。您只能使用一個 NameNode。類型：[HdfsNameNode](API_HdfsNameNode.md) 物件陣列陣列成員：項目數下限為 1。必要：是 ** [QopConfiguration](#API_CreateLocationHdfs_RequestSyntax) ** 保護品質 (QOP) 組態會指定 Hadoop 分散式檔案系統 (HDFS) 叢集上設定的遠端程序呼叫 (RPC) 和資料傳輸保護設定。若沒有指定 `QopConfiguration`，則 `RpcProtection` 和 `DataTransferProtection` 預設為 `PRIVACY`。如果設定 `RpcProtection` 或 `DataTransferProtection`，則另一個參數會承繼相同的值。類型：[QopConfiguration](API_QopConfiguration.md) 物件必要：否 ** [ReplicationFactor](#API_CreateLocationHdfs_RequestSyntax) ** 寫入至 HDFS 叢集時要將資料複製到其中的 DataNode 數目。預設情況下，資料會複製到三個 DataNode。類型：整數有效範圍：最小值為 1。最大值為 512。必要：否 ** [SimpleUser](#API_CreateLocationHdfs_RequestSyntax) ** 用於識別主機作業系統上用戶端的使用者名稱。如果為 `AuthenticationType` 指定了 `SIMPLE`，則此參數必要項目。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^[_.A-Za-z0-9][-_.A-Za-z0-9]*$` 必要：否 ** [Subdirectory](#API_CreateLocationHdfs_RequestSyntax) ** HDFS 叢集中的子目錄。此子目錄用於從 HDFS 叢集讀取資料或將資料寫入至其中。如未指定子目錄，其預設值為 `/`。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ** [Tags](#API_CreateLocationHdfs_RequestSyntax) ** 代表您要新增至位置之標籤的鍵/值對。此數值可以是空字串。建議您使用標籤來命名資源。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationHdfs_ResponseSyntax) ** 您建立之來源 HDFS 叢集位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationHdfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationHdfs) # CreateLocationNfs 建立網路檔案系統 (NFS) 檔案伺服器的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何[存取 NFS 檔案伺服器](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs)。 ## 請求語法 ``` { "MountOptions": { "Version": "string" }, "OnPremConfig": { "AgentArns": [ "string" ] }, "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [MountOptions](#API_CreateLocationNfs_RequestSyntax) ** 指定 DataSync 可用來掛載 NFS 檔案伺服器的選項。類型：[NfsMountOptions](API_NfsMountOptions.md) 物件必要：否 ** [OnPremConfig](#API_CreateLocationNfs_RequestSyntax) ** 指定可連線至 NFS 檔案伺服器的 DataSync 代理程式的 Amazon Resource Name (ARN)。您可以指定多個代理程式。如需詳細資訊，請參閱[使用多個 DataSync 代理程式](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#multiple-agents)。類型：[OnPremConfig](API_OnPremConfig.md) 物件必要：是 ** [ServerHostname](#API_CreateLocationNfs_RequestSyntax) ** 指定 DataSync 代理程式連線的 NFS 檔案伺服器的 DNS 名稱或 IP 地址 (IPv4 或 IPv6)。類型：字串長度限制：長度上限為 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必要：是 ** [Subdirectory](#API_CreateLocationNfs_RequestSyntax) ** 指定您要 DataSync 掛載之 NFS 檔案伺服器的匯出路徑。此路徑（或路徑的子目錄）是 DataSync 往返傳輸資料的位置。如需設定 DataSync 匯出的資訊，請參閱[存取 NFS 檔案伺服器](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]+$` 必要：是 ** [Tags](#API_CreateLocationNfs_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationNfs_ResponseSyntax) ** 您為 NFS 檔案伺服器建立的傳輸位置 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 範例下列範例會為 NFS 檔案伺服器建立 DataSync 傳輸位置。 #### 請求範例 ``` { "MountOptions": { "Version": : "NFS4_0" }, "OnPremConfig": { "AgentArn": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ] }, "ServerHostname": "MyServer@amazon.com", "Subdirectory": "/MyFolder", "Tags": [ { "Key": "Name", "Value": "FileSystem-1" } ] } ``` ### 範例回應會傳回 NFS 位置的 ARN。 #### 回應範例 ``` { "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationNfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationNfs) # CreateLocationObjectStorage 建立物件儲存系統的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。您可以使用或不使用 [DataSync 代理](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html#when-agent-required)程式進行傳輸。開始之前，請確定您了解 DataSync 使用物件儲存系統的[先決條件](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites)。 ## 請求語法 ``` { "AccessKey": "string", "AgentArns": [ "string" ], "BucketName": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "SecretKey": "string", "ServerCertificate": blob, "ServerHostname": "string", "ServerPort": number, "ServerProtocol": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AccessKey](#API_CreateLocationObjectStorage_RequestSyntax) ** 如果需要憑證才能與物件儲存伺服器進行驗證，請指定存取金鑰 (例如，使用者名稱)。類型：字串長度限制：長度下限為 0。長度上限為 200。模式：`^.*$` 必要：否 ** [AgentArns](#API_CreateLocationObjectStorage_RequestSyntax) ** （選用）指定可與物件儲存系統連線之 DataSync 代理程式的 Amazon Resource Name (ARNs)。如果您要設定無代理程式跨雲端傳輸，則不需要為此參數指定值。首次建立儲存位置時，請務必正確設定此參數。您無法在建立代理程式之後，從儲存位置新增或移除代理程式。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [BucketName](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定傳輸中涉及的物件儲存貯體的名稱。類型：字串長度限制：長度下限為 3。長度上限為 63。模式：`^[a-zA-Z0-9_\-\+\.\$\p{Zs}]+$` 必要：是 ** [CmkSecretConfig](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，其中包括 `SecretKey` DataSync 使用客戶受管存取特定物件儲存位置的 AWS KMS key。當您將此參數包含在`CreateLocationObjectStorage`請求中時，您只需提供 KMS 金鑰 ARN。DataSync 會將此 KMS 金鑰與您為 `SecretKey` 參數指定的值搭配使用，以建立 DataSync 受管秘密來存放位置存取憑證。請確定 DataSync 具有存取您指定 KMS 金鑰的許可。如需詳細資訊，請參閱[使用以自訂加密的服務受管秘密 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `SecretKey`) 或 `CustomSecretConfig`（不含 `SecretKey`) 來提供`CreateLocationObjectStorage`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定客戶受管 Secrets Manager 秘密的組態資訊，其中特定物件儲存位置的私密金鑰會以純文字儲存在 Secrets Manager 中。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱[使用您管理的秘密](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `SecretKey`) 或 `CustomSecretConfig`（不含 `SecretKey`) 來提供`CreateLocationObjectStorage`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [SecretKey](#API_CreateLocationObjectStorage_RequestSyntax) ** 如果需要憑證才能與物件儲存伺服器進行驗證，請指定私密金鑰 (例如，密碼)。如果您使用提供秘密`SecretKey`，但未使用 `CmkSecretConfig`或提供秘密組態詳細資訊`CustomSecretConfig`，則 DataSync 會使用您 AWS 帳戶的 Secrets Manager 秘密來存放字符。類型：字串長度限制：長度下限為 0。長度上限為 200。模式：`^.*$` 必要：否 ** [ServerCertificate](#API_CreateLocationObjectStorage_RequestSyntax) ** 如果系統使用私有或自我簽署憑證授權單位 (CA)，則指定 DataSync 的憑證鏈來驗證您的物件儲存系統。您必須指定具有完整憑證鏈的單一`.pem`檔案（例如 `file:///home/user/.ssh/object_storage_certificates.pem`)。憑證鏈可能包括： + 物件儲存系統的憑證 + 所有中繼憑證（如果有的話） + 簽署 CA 的根憑證您可以將憑證串連至`.pem`檔案（在 base64 編碼之前最多可達 32768 個位元組）。下列範例`cat`命令會建立包含三個憑證`object_storage_certificates.pem`的檔案： `cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem` 若要使用此參數，請將 `ServerProtocol`設定為 `HTTPS`。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 32768。必要：否 ** [ServerHostname](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定 DataSync 代理程式連線之物件儲存伺服器的網域名稱或 IP 地址 (IPv4 或 IPv6)。類型：字串長度限制：長度上限為 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必要：是 ** [ServerPort](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定物件儲存伺服器接受傳入網路流量的連接埠 (例如，連接埠 443)。類型：整數有效範圍：最小值為 1。最大值為 65536。必要：否 ** [ServerProtocol](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定物件儲存伺服器用來通訊的通訊協定。若未指定，預設值為 `HTTPS`。類型：字串有效值:`HTTPS | HTTP` 必要：否 ** [Subdirectory](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定物件儲存伺服器的物件字首。如果這是來源位置，DataSync 只會複製具有此字首的物件。如果這是目的地位置，DataSync 會寫入具有此字首的所有物件。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` 必要：否 ** [Tags](#API_CreateLocationObjectStorage_RequestSyntax) ** 指定代表您要新增至資源之標籤的鍵/值對。標籤可協助您管理、篩選和搜尋資源。建議您為位置建立名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationObjectStorage_ResponseSyntax) ** 指定您建立之物件儲存系統位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationObjectStorage) # CreateLocationS3 建立 Amazon S3 儲存貯體的傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。 **重要** 開始之前，請確定您已閱讀下列主題： [Amazon S3 位置的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) [使用 DataSync 時評估 S3 請求成本](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) 如需詳細資訊，請參閱[使用 Amazon S3 設定傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html)。 ## 請求語法 ``` { "AgentArns": [ "string" ], "S3BucketArn": "string", "S3Config": { "BucketAccessRoleArn": "string" }, "S3StorageClass": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArns](#API_CreateLocationS3_RequestSyntax) ** （僅限 Outposts 上的 Amazon S3) 指定 Outpost 上 DataSync 代理程式的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱在 [上部署 DataSync 代理程式 AWS Outposts](https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent)。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [S3BucketArn](#API_CreateLocationS3_RequestSyntax) ** 指定您要用作位置之 S3 儲存貯體的 ARN。（稍後建立 DataSync 任務時，您可以指定此位置是傳輸來源還是目的地。) 如果您的 S3 儲存貯體位於 AWS Outposts 資源上，您必須指定 Amazon S3 存取點。如需詳細資訊，請參閱《[Amazon S3 使用者指南》中的使用 Amazon S3 存取點管理資料存取](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html)。 *Amazon S3 * 類型：字串長度限制：長度上限為 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}$` 必要：是 ** [S3Config](#API_CreateLocationS3_RequestSyntax) ** 指定 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)。類型：[S3Config](API_S3Config.md) 物件必要：是 ** [S3StorageClass](#API_CreateLocationS3_RequestSyntax) ** 指定當 Amazon S3 是傳輸目的地時，您希望物件使用的儲存體方案。對於中的儲存貯體 AWS 區域，儲存類別預設為 `STANDARD`。對於上的儲存貯體 AWS Outposts，儲存體方案預設為 `OUTPOSTS`。如需詳細資訊，請參閱 [Amazon S3 傳輸的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。類型：字串有效值:`STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL` 必要：否 ** [Subdirectory](#API_CreateLocationS3_RequestSyntax) ** 在 DataSync 讀取或寫入的 S3 儲存貯體中指定字首（取決於儲存貯體是來源或目的地位置）。 DataSync 無法傳輸字首開頭為斜線 (`/`) 或包含 `//`、 `/./`或 `/../` 模式的物件。例如： + `/photos` + `photos//2006/January` + `photos/./2006/February` + `photos/../2006/March` 類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` 必要：否 ** [Tags](#API_CreateLocationS3_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。我們建議為您的傳輸位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationS3_ResponseSyntax) ** 您建立之 S3 位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationS3) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationS3) # CreateLocationSmb 為伺服器訊息區塊 (SMB) 檔案伺服器建立傳輸*位置*。 AWS DataSync 可以使用此位置做為傳輸資料的來源或目的地。開始之前，請確定您了解 DataSync 如何存取 SMB 檔案伺服器。如需詳細資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。 ## 請求語法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "User": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArns](#API_CreateLocationSmb_RequestSyntax) ** 指定可連線至 SMB 檔案伺服器的 DataSync 代理程式（或代理程式）。您可以使用代理程式的 Amazon Resource Name (ARN) 來指定代理程式。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：是 ** [AuthenticationType](#API_CreateLocationSmb_RequestSyntax) ** 指定 DataSync 用來連線至 SMB 檔案伺服器的身分驗證通訊協定。DataSync 支援 `NTLM`（預設）和`KERBEROS`身分驗證。如需詳細資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。類型：字串有效值:`NTLM | KERBEROS` 必要：否 ** [CmkSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，或 `Password``KerberosKeytab`（分別為 `NTLM`（預設）和`KERBEROS`身分驗證類型），DataSync 會使用客戶受管存取特定 SMB 儲存位置 AWS KMS key。當您將此參數包含在`CreateLocationSmbRequest`請求中時，您只需提供 KMS 金鑰 ARN。DataSync 會使用此 KMS 金鑰搭配 `Password``KerberosKeytab`或您指定的來建立 DataSync 受管秘密，以存放位置存取憑證。請確定 DataSync 具有存取您指定 KMS 金鑰的許可。如需詳細資訊，請參閱[使用以自訂加密的服務受管秘密 AWS KMS key](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#service-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `Password`或 `KerberosKeytab`) 或 `CustomSecretConfig`（不含任何 `Password`和 `KerberosKeytab`) 來提供`CreateLocationSmbRequest`請求的登入資料。請勿同時為相同的請求提供 `CmkSecretConfig`和 `CustomSecretConfig` 參數。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** 指定客戶受管 Secrets Manager 秘密的組態資訊，其中 SMB 儲存位置憑證會以純文字（適用於 `Password`) 或二進位（適用於 ) 形式存放在 Secrets Manager 中`KerberosKeytab`。此組態包含秘密 ARN，以及提供秘密存取權之 IAM 角色的 ARN。如需詳細資訊，請參閱[使用您管理的秘密](https://docs.aws.amazon.com/datasync/latest/userguide/location-credentials.html#custom-secret-custom-key)。您可以使用 `CmkSecretConfig`（搭配 `SasConfiguration`) 或 `CustomSecretConfig`（不含 `SasConfiguration`) 來提供`CreateLocationSmbRequest`請求的登入資料。請勿為相同的請求提供這兩個參數。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [DnsIpAddresses](#API_CreateLocationSmb_RequestSyntax) ** 指定 SMB 檔案伺服器所屬之 DNS 伺服器的 IPv4 或 IPv6 地址。此參數僅適用於 `AuthenticationType` 設為的情況`KERBEROS`。如果您的環境中有多個網域，設定此參數可確保 DataSync 連線至正確的 SMB 檔案伺服器。類型：字串陣列陣列成員：最多 2 個項目。長度限制：長度下限為 7。長度上限為 39。模式：`\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z` 必要：否 ** [Domain](#API_CreateLocationSmb_RequestSyntax) ** 指定 SMB 檔案伺服器所屬的 Windows 網域名稱。此參數僅適用於 `AuthenticationType` 設定為的情況`NTLM`。如果您的環境中有多個網域，設定此參數可確保 DataSync 連線至正確的檔案伺服器。類型：字串長度限制：長度上限為 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 必要：否 ** [KerberosKeytab](#API_CreateLocationSmb_RequestSyntax) ** 指定您的 Kerberos 金鑰資料表 (keytab) 檔案，其中包含 Kerberos 主體和加密金鑰之間的映射。為了避免任務執行錯誤，請確定您用來建立 keytab 檔案的 Kerberos 主體與您為指定的完全相符`KerberosPrincipal`。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 65536。必要：否 ** [KerberosKrb5Conf](#API_CreateLocationSmb_RequestSyntax) ** 指定定義 Kerberos 領域組態的 Kerberos 組態檔案 (`krb5.conf`)。檔案必須為 base64 編碼。如果您使用的是 AWS CLI，編碼會為您完成。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 131072。必要：否 ** [KerberosPrincipal](#API_CreateLocationSmb_RequestSyntax) ** 指定 Kerberos 主體，這是 Kerberos 領域中的身分，有權存取 SMB 檔案伺服器中的檔案、資料夾和檔案中繼資料。 Kerberos 主體可能看起來像 `HOST/kerberosuser@MYDOMAIN.ORG`。主體名稱區分大小寫。如果您為此參數指定的委託人與您用來建立 keytab 檔案的委託人不完全相符，您的 DataSync 任務執行將會失敗。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^.+$` 必要：否 ** [MountOptions](#API_CreateLocationSmb_RequestSyntax) ** 指定 DataSync 用來存取 SMB 檔案伺服器的 SMB 通訊協定版本。類型：[SmbMountOptions](API_SmbMountOptions.md) 物件必要：否 ** [Password](#API_CreateLocationSmb_RequestSyntax) ** 指定可掛載 SMB 檔案伺服器的使用者的密碼，並具有存取傳輸所涉及檔案和資料夾的許可。此參數僅適用於 `AuthenticationType` 設定為的情況`NTLM`。類型：字串長度限制：長度上限為 104。模式：`^.{0,104}$` 必要：否 ** [ServerHostname](#API_CreateLocationSmb_RequestSyntax) ** 指定 DataSync 代理程式連線之 SMB 檔案伺服器的網域名稱或 IP 地址 (IPv4 或 IPv6)。如果您使用 Kerberos 身分驗證，則必須指定網域名稱。類型：字串長度限制：長度上限為 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必要：是 ** [Subdirectory](#API_CreateLocationSmb_RequestSyntax) ** 指定由 SMB 檔案伺服器匯出的共用名稱，DataSync 會在其中讀取或寫入資料。您可以在共用路徑中包含子目錄（例如，`/path/to/subdirectory`)。請確定您網路中的其他 SMB 用戶端也可以掛載此路徑。若要複製子目錄中的所有資料，DataSync 必須能夠掛載 SMB 共用並存取其所有資料。如需詳細資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：是 ** [Tags](#API_CreateLocationSmb_RequestSyntax) ** 指定可協助您分類、篩選和搜尋 AWS 資源的標籤。建議您為位置建立至少一個名稱標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ** [User](#API_CreateLocationSmb_RequestSyntax) ** 指定可掛載和存取 SMB 檔案伺服器中檔案、資料夾和檔案中繼資料的使用者。此參數僅適用於 `AuthenticationType` 設定為的情況`NTLM`。如需選擇具有適當傳輸存取權層級之使用者的相關資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。類型：字串長度限制：長度上限為 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 必要：否 ## 回應語法 ``` { "LocationArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [LocationArn](#API_CreateLocationSmb_ResponseSyntax) ** 您建立之 SMB 位置的 ARN。類型：字串長度限制：長度上限為 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例會建立 SMB 檔案伺服器的位置。 ``` { "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs", "arn:aws:datasync:us-east-2:111222333444:agent/agent-2345noo35nnee1123ovo3" ], "Domain":"AMAZON", "MountOptions":{ "Version":"SMB3" }, "Password":"string", "ServerHostname":"MyServer.amazon.com", "Subdirectory":"share", "Tags":[ { "Key":"department", "Value":"finance" } ], "User":"user-1" } ``` ### 回應範例回應會傳回 SMB 檔案伺服器的位置 ARN。 ``` { "LocationArn": "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateLocationSmb) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateLocationSmb) # CreateTask 設定*任務*，定義資料傳輸的位置和方式 AWS DataSync 。任務包含來源位置、目的地位置和傳輸選項（例如頻寬限制、排程等）。 **重要** 如果您打算在 Amazon S3 位置之間傳輸資料，請在開始之前檢閱 [ DataSync 如何影響您的 S3 請求費用](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)和 [DataSync 定價頁面](https://aws.amazon.com/datasync/pricing/)。 ## 請求語法 ``` { "CloudWatchLogGroupArn": "string", "DestinationLocationArn": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "Name": "string", "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Schedule": { "ScheduleExpression": "string", "Status": "string" }, "SourceLocationArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [CloudWatchLogGroupArn](#API_CreateTask_RequestSyntax) ** 指定 Amazon CloudWatch 日誌群組的 Amazon Resource Name (ARN)，以監控您的任務。對於增強型模式任務，您不需要指定任何項目。DataSync 會自動將日誌傳送至名為的 CloudWatch 日誌群組`/aws/datasync`。如需詳細資訊，請參閱[使用 CloudWatch Logs 監控資料傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)。類型：字串長度限制：長度上限為 562。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` 必要：否 ** [DestinationLocationArn](#API_CreateTask_RequestSyntax) ** 指定傳輸目的地位置的 ARN。類型：字串長度限制：長度上限為 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}$` 必要：是 ** [Excludes](#API_CreateTask_RequestSyntax) ** 指定排除篩選條件，以定義您不希望 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。必要：否 ** [Includes](#API_CreateTask_RequestSyntax) ** 指定包含篩選條件，以定義您要 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。必要：否 ** [ManifestConfig](#API_CreateTask_RequestSyntax) ** 設定資訊清單，這是您希望 DataSync 傳輸的檔案或物件清單。如需詳細資訊和組態範例，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。使用此參數時，您的呼叫者身分（與 DataSync 搭配使用的角色）必須具有 `iam:PassRole`許可。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) 政策包含此許可。類型：[ManifestConfig](API_ManifestConfig.md) 物件必要：否 ** [Name](#API_CreateTask_RequestSyntax) ** 指定任務的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` 必要：否 ** [Options](#API_CreateTask_RequestSyntax) ** 指定任務的設定，例如保留檔案中繼資料、驗證資料完整性，以及其他選項。類型：[Options](API_Options.md) 物件必要：否 ** [Schedule](#API_CreateTask_RequestSyntax) ** 指定您希望任務何時執行的排程。如需詳細資訊，請參閱[任務排程](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)。類型：[TaskSchedule](API_TaskSchedule.md) 物件必要：否 ** [SourceLocationArn](#API_CreateTask_RequestSyntax) ** 指定傳輸來源位置的 ARN。類型：字串長度限制：長度上限為 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}$` 必要：是 ** [Tags](#API_CreateTask_RequestSyntax) ** 指定您要套用至任務的標籤。 *標籤*是有助於管理、篩選和搜尋 DataSync 資源的鍵值對。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ** [TaskMode](#API_CreateTask_RequestSyntax) ** 為您的資料傳輸指定下列其中一個任務模式： + `ENHANCED` - 傳輸幾乎無限制數量的物件，其效能高於基本模式。增強型模式任務透過平行列出、準備、傳輸和驗證資料來最佳化資料傳輸程序。增強型模式目前適用於 Amazon S3 位置之間的傳輸、Azure Blob 與 Amazon S3 之間不使用代理程式的傳輸，以及其他雲端與 Amazon S3 之間不使用代理程式的傳輸。 **注意** 若要建立增強型模式任務，您用來呼叫 `CreateTask`操作的 IAM 角色必須具有 `iam:CreateServiceLinkedRole`許可。 + `BASIC` （預設） - 在儲存體和所有其他支援的 DataSync 位置之間 AWS 傳輸檔案或物件。基本模式任務會受到資料集中檔案、物件和目錄數量[的配額](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-limits.html)限制。基本模式會循序準備、傳輸和驗證資料，使其比大多數工作負載的增強模式慢。如需詳細資訊，請參閱[了解任務模式差異](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences)。類型：字串有效值:`BASIC | ENHANCED` 必要：否 ** [TaskReportConfig](#API_CreateTask_RequestSyntax) ** 指定您要如何設定任務報告，以提供 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱[使用任務報告監控 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。使用此參數時，您的呼叫者身分（與 DataSync 搭配使用的角色）必須具有 `iam:PassRole`許可。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) 政策包含此許可。類型：[TaskReportConfig](API_TaskReportConfig.md) 物件必要：否 ## 回應語法 ``` { "TaskArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [TaskArn](#API_CreateTask_ResponseSyntax) ** 任務的 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 增強型模式任務的範例請求下列範例會建立使用增強模式的 DataSync 任務。與建立基本模式任務不同，您不需要指定 Amazon CloudWatch 日誌群組。使用增強型模式任務時，DataSync 會自動將任務日誌傳送至名為的日誌群組`/aws/datasync`。如果您的中不存在該日誌群組 AWS 區域，DataSync 會在您建立任務時代表您建立日誌群組。 ``` { "SourceLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-1:111222333444:location/0000zzzz1111yyyy2", "Name": "My Enhanced mode task", "TaskMode": "ENHANCED", "Options": { "TransferMode": "CHANGED", "VerifyMode": "ONLY_FILES_TRANSFERRED", "ObjectTags": "PRESERVE", "LogLevel": "TRANSFER" } } ``` ### 基本模式任務的範例請求下列範例會建立使用基本模式的 DataSync 任務。 ``` { "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "Name": "My Basic mode task", "TaskMode": "BASIC", "Options": { "Atime": "BEST_EFFORT", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "ONLY_FILES_TRANSFERRED" }, "Schedule": { "ScheduleExpression": "0 12 ? * SUN,WED *" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*", "Tags": [ { "Key": "Name", "Value": "Migration-wave-1" } ] } ``` ### 回應範例下列回應包含已建立任務的 ARN。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateTask) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/CreateTask) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/CreateTask) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateTask) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateTask) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/CreateTask) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/CreateTask) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateTask) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/CreateTask) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/CreateTask) # DeleteAgent 從移除 AWS DataSync 代理程式資源 AWS 帳戶。請記住，此操作（無法復原）不會從您的儲存環境移除代理程式的虛擬機器 (VM) 或 Amazon EC2 執行個體。對於後續步驟，您可以從儲存環境刪除 VM 或執行個體，或重複使用它來[啟用新的代理](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)程式。 ## 請求語法 ``` { "AgentArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArn](#API_DeleteAgent_RequestSyntax) ** 要刪除之代理程式的 Amazon Resource Name (ARN)。使用 `ListAgents`操作來傳回您帳戶和的客服人員清單 AWS 區域。類型：字串長度限制：長度上限為 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}$` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DeleteAgent) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DeleteAgent) # DeleteLocation 從刪除轉接位置資源 AWS DataSync。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DeleteLocation_RequestSyntax) ** 要刪除位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DeleteLocation) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DeleteLocation) # DeleteTask 從中刪除轉移任務資源 AWS DataSync。 ## 請求語法 ``` { "TaskArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [TaskArn](#API_DeleteTask_RequestSyntax) ** 指定您要刪除之任務的 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}$` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteTask) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DeleteTask) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DeleteTask) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteTask) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteTask) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DeleteTask) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DeleteTask) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteTask) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DeleteTask) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DeleteTask) # DescribeAgent 傳回 AWS DataSync 代理程式的相關資訊，例如其名稱、服務端點類型和狀態。 ## 請求語法 ``` { "AgentArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArn](#API_DescribeAgent_RequestSyntax) ** 指定您要取得相關資訊之 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}$` 必要：是 ## 回應語法 ``` { "AgentArn": "string", "CreationTime": number, "EndpointType": "string", "LastConnectionTime": number, "Name": "string", "Platform": { "Version": "string" }, "PrivateLinkConfig": { "PrivateLinkEndpoint": "string", "SecurityGroupArns": [ "string" ], "SubnetArns": [ "string" ], "VpcEndpointId": "string" }, "Status": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AgentArn](#API_DescribeAgent_ResponseSyntax) ** 客服人員的 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}$` ** [CreationTime](#API_DescribeAgent_ResponseSyntax) ** 客服人員[啟用](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html)的時間。類型：Timestamp ** [EndpointType](#API_DescribeAgent_ResponseSyntax) ** 您的代理程式所連線[的服務端點](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html)類型。類型：字串有效值:`PUBLIC | PRIVATE_LINK | FIPS | FIPS_PRIVATE_LINK` ** [LastConnectionTime](#API_DescribeAgent_ResponseSyntax) ** 上次客服人員與 DataSync 服務通訊的時間。類型：Timestamp ** [Name](#API_DescribeAgent_ResponseSyntax) ** 代理程式的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` ** [Platform](#API_DescribeAgent_ResponseSyntax) ** 代理程式的平台相關詳細資訊，例如版本號碼。類型：[Platform](API_Platform.md) 物件 ** [PrivateLinkConfig](#API_DescribeAgent_ResponseSyntax) ** 代理程式連線至 [VPC 服務端點](https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc)時所使用的網路組態。類型：[PrivateLinkConfig](API_PrivateLinkConfig.md) 物件 ** [Status](#API_DescribeAgent_ResponseSyntax) ** 代理程式的狀態。 + 如果狀態為 `ONLINE`，表示代理程式已正確設定且可供使用。 + 如果狀態為 `OFFLINE`，則客服人員已與 DataSync 中斷聯絡五分鐘或更長時間。這可能有幾個原因。如需詳細資訊，請參閱[如果我的客服人員離線該怎麼辦？](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline) 類型：字串有效值:`ONLINE | OFFLINE` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例會傳回請求中指定代理程式的相關資訊。 ``` { "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0" } ``` ### 回應範例下列範例回應說明使用公有服務端點的代理程式。 ``` { "AgentArn": "arn:aws:datasync:us-east-2:111122223333:agent/agent-1234567890abcdef0", "Name": "Data center migration agent", "Status": "ONLINE", "LastConnectionTime": "2022-10-17T17:21:35.540000+00:00", "CreationTime": "2022-10-05T20:52:29.499000+00:00", "EndpointType": "PUBLIC", "Platform": { "Version": "2" } } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeAgent) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeAgent) # DescribeLocationAzureBlob 提供如何設定 Microsoft Azure Blob Storage AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationAzureBlob_RequestSyntax) ** 指定 Azure Blob Storage 傳輸位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "AccessTier": "string", "AgentArns": [ "string" ], "AuthenticationType": "string", "BlobType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CreationTime": number, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "LocationArn": "string", "LocationUri": "string", "ManagedSecretConfig": { "SecretArn": "string" } } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AccessTier](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 您希望物件或檔案傳輸到的存取層。這僅適用於使用位置做為傳輸目的地時。如需詳細資訊，請參閱[存取層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)。類型：字串有效值:`HOT | COOL | ARCHIVE` ** [AgentArns](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 可與 Azure Blob Storage 容器連線的 DataSync 代理程式 ARNs。類型：字串陣列陣列成員：項目數下限為 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}$` ** [AuthenticationType](#API_DescribeLocationAzureBlob_ResponseSyntax) ** DataSync 用來存取 Azure Blob Storage 的身分驗證方法。DataSync 可以使用共用存取簽章 (SAS) 存取 Blob 儲存。類型：字串有效值:`SAS | NONE` ** [BlobType](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 您希望物件或檔案在傳輸到 Azure Blob Storage 時的 Blob 類型。目前，DataSync 僅支援將資料移至 Azure Blob Storage 做為區塊 Blob。如需 Blob 類型的詳細資訊，請參閱 [Azure Blob Storage 文件](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)。類型：字串有效值:`BLOCK` ** [CmkSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 DataSync 使用客戶受管來存取特定儲存位置的身分驗證字符 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件 ** [CreationTime](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 建立 Azure Blob Storage 傳輸位置的時間。類型：Timestamp ** [CustomSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 描述客戶受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置的身分驗證字符，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件 ** [LocationArn](#API_DescribeLocationAzureBlob_ResponseSyntax) ** Azure Blob Storage 傳輸位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 傳輸所涉及 Azure Blob Storage 容器的 URL。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [ManagedSecretConfig](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置的身分驗證字符。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationAzureBlob) # DescribeLocationEfs 提供如何設定 Amazon EFS 檔案系統 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationEfs_RequestSyntax) ** 您希望取得資訊之 Amazon EFS 檔案系統位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "AccessPointArn": "string", "CreationTime": number, "Ec2Config": { "SecurityGroupArns": [ "string" ], "SubnetArn": "string" }, "FileSystemAccessRoleArn": "string", "InTransitEncryption": "string", "LocationArn": "string", "LocationUri": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AccessPointArn](#API_DescribeLocationEfs_ResponseSyntax) ** DataSync 用來存取 Amazon EFS 檔案系統的存取點 ARN。如需詳細資訊，請參閱[存取受限制的檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$` ** [CreationTime](#API_DescribeLocationEfs_ResponseSyntax) ** 建立位置的時間。類型：Timestamp ** [Ec2Config](#API_DescribeLocationEfs_ResponseSyntax) ** AWS DataSync 用來連線至其中一個 Amazon EFS 檔案系統[掛載目標](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)的子網路和安全群組。類型：[Ec2Config](API_Ec2Config.md) 物件 ** [FileSystemAccessRoleArn](#API_DescribeLocationEfs_ResponseSyntax) ** 允許 DataSync 存取 Amazon EFS 檔案系統的 AWS Identity and Access Management (IAM) 角色。如需詳細資訊，請參閱[建立用於檔案系統存取的 DataSync IAM 角色](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)。類型：字串長度限制：長度上限為 2048。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$` ** [InTransitEncryption](#API_DescribeLocationEfs_ResponseSyntax) ** 指出在 Amazon EFS 檔案系統之間傳輸資料時，DataSync 是否使用 Transport Layer Security (TLS) 加密。類型：字串有效值:`NONE | TLS1_2` ** [LocationArn](#API_DescribeLocationEfs_ResponseSyntax) ** Amazon EFS 檔案系統位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationEfs_ResponseSyntax) ** Amazon EFS 檔案系統位置的 URL。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例示範如何取得特定 Amazon EFS 檔案系統位置的相關資訊。 ``` { "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-12abcdef012345678" } ``` ### 回應範例下列範例會傳回 Amazon EFS 檔案系統的位置詳細資訊。 ``` { "CreationTime": 1653319021.353, "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/" } ``` ### 回應範例：描述受限 Amazon EFS 檔案系統的位置下列範例會傳回具有限制存取之 Amazon EFS 檔案系統的位置詳細資訊，包括 `AccessPointArn`、 `FileSystemAccessRoleArn`和 `InTransitEncryption`元素。 ``` { "CreationTime": 1653319021.353, "AccessPointArn": "arn:aws:elasticfilesystem:us-east-2:111222333444:access-point/fsap-1234567890abcdef0", "Ec2Config": { "SubnetArn": "arn:aws:ec2:us-east-2:111222333444:subnet/subnet-1234567890abcdef1", "SecurityGroupArns": [ "arn:aws:ec2:us-east-2:111222333444:security-group/sg-1234567890abcdef2" ] }, "FileSystemAccessRoleArn": "arn:aws:iam::111222333444:role/AwsDataSyncFullAccessNew", "InTransitEncryption": "TLS1_2", "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-abcdef01234567890", "LocationUri": "efs://us-east-2.fs-021345abcdef6789/", "Subdirectory": "/mount/path", "Tags": [{ "Key": "Name", "Value": "ElasticFileSystem-1" }] } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationEfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationEfs) # DescribeLocationFsxLustre 提供如何設定 Amazon FSx for Lustre 檔案系統 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationFsxLustre_RequestSyntax) ** 要描述的 FSx for Lustre 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "CreationTime": number, "LocationArn": "string", "LocationUri": "string", "SecurityGroupArns": [ "string" ] } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [CreationTime](#API_DescribeLocationFsxLustre_ResponseSyntax) ** FSx for Lustre 位置建立的時間。類型：Timestamp ** [LocationArn](#API_DescribeLocationFsxLustre_ResponseSyntax) ** 所描述 FSx for Lustre 位置的 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}:location/loc-[0-9a-z]{17}$` ** [LocationUri](#API_DescribeLocationFsxLustre_ResponseSyntax) ** 描述的 FSx for Lustre 位置的 URI。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [SecurityGroupArns](#API_DescribeLocationFsxLustre_ResponseSyntax) ** 針對 FSx for Lustre 檔案系統設定的安全群組的 Amazon Resource Name (ARNs)。類型：字串陣列陣列成員：項目數下限為 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]+$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxLustre) # DescribeLocationFsxOntap 提供如何設定 Amazon FSx for NetApp ONTAP 檔案系統 AWS DataSync 傳輸位置的詳細資訊。 **注意** 如果您的位置使用 SMB，`DescribeLocationFsxOntap`操作不會實際傳回 `Password`。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationFsxOntap_RequestSyntax) ** 指定您要取得相關資訊的 FSx for ONTAP 檔案系統位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "CreationTime": number, "FsxFilesystemArn": "string", "LocationArn": "string", "LocationUri": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "SecurityGroupArns": [ "string" ], "StorageVirtualMachineArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [CreationTime](#API_DescribeLocationFsxOntap_ResponseSyntax) ** 建立位置的時間。類型：Timestamp ** [FsxFilesystemArn](#API_DescribeLocationFsxOntap_ResponseSyntax) ** FSx for ONTAP 檔案系統的 ARN。類型：字串長度限制：長度上限為 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:file-system/fs-[0-9a-f]+$` ** [LocationArn](#API_DescribeLocationFsxOntap_ResponseSyntax) ** FSx for ONTAP 檔案系統位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationFsxOntap_ResponseSyntax) ** FSx for ONTAP 檔案系統位置的統一資源識別符 (URI)。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [Protocol](#API_DescribeLocationFsxOntap_ResponseSyntax) ** 指定 AWS DataSync 用於存取 Amazon FSx 檔案系統的資料傳輸通訊協定。類型：[FsxProtocol](API_FsxProtocol.md) 物件 ** [SecurityGroupArns](#API_DescribeLocationFsxOntap_ResponseSyntax) ** DataSync 用來存取 FSx for ONTAP 檔案系統的安全群組。類型：字串陣列陣列成員：項目數下限為 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]+$` ** [StorageVirtualMachineArn](#API_DescribeLocationFsxOntap_ResponseSyntax) ** FSx for ONTAP 檔案系統上儲存虛擬機器 (SVM) 的 ARN，您要從中複製資料。類型：字串長度限制：長度上限為 162。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):fsx:[a-z\-0-9]+:[0-9]{12}:storage-virtual-machine/fs-[0-9a-f]+/svm-[0-9a-f]{17,}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxOntap) # DescribeLocationFsxOpenZfs 提供如何設定 Amazon FSx for OpenZFS 檔案系統 AWS DataSync 傳輸位置的詳細資訊。 **注意** `DescribeLocationFsxOpenZfs` 操作`SMB`不支援與相關的回應元素。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationFsxOpenZfs_RequestSyntax) ** 要描述的 FSx for OpenZFS 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "CreationTime": number, "LocationArn": "string", "LocationUri": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "SecurityGroupArns": [ "string" ] } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [CreationTime](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) ** FSx for OpenZFS 位置建立的時間。類型：Timestamp ** [LocationArn](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) ** 所述的 FSx for OpenZFS 位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) ** 描述的 FSx for OpenZFS 位置的統一資源識別符 (URI)。範例：`fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder` 類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [Protocol](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) ** AWS DataSync 用來存取檔案系統的通訊協定類型。類型：[FsxProtocol](API_FsxProtocol.md) 物件 ** [SecurityGroupArns](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) ** 針對 FSx for OpenZFS 檔案系統設定的安全群組 ARNs。類型：字串陣列陣列成員：項目數下限為 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]+$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs) # DescribeLocationFsxWindows 提供如何設定 Amazon FSx for Windows File Server 檔案系統 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationFsxWindows_RequestSyntax) ** 指定 FSx for Windows File Server 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CreationTime": number, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "LocationArn": "string", "LocationUri": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "SecurityGroupArns": [ "string" ], "User": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [CmkSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 `Password` DataSync 使用客戶受管存取特定儲存位置的 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件 ** [CreationTime](#API_DescribeLocationFsxWindows_ResponseSyntax) ** FSx for Windows File Server 位置的建立時間。類型：Timestamp ** [CustomSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 說明客戶受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`Password`的，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件 ** [Domain](#API_DescribeLocationFsxWindows_ResponseSyntax) ** FSx for Windows File Server 檔案系統所屬的 Microsoft Active Directory 網域名稱。類型：字串長度限制：長度上限為 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` ** [LocationArn](#API_DescribeLocationFsxWindows_ResponseSyntax) ** FSx for Windows File Server 位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationFsxWindows_ResponseSyntax) ** FSx for Windows File Server 位置的統一資源識別符 (URI)。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [ManagedSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`Password`的。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件 ** [SecurityGroupArns](#API_DescribeLocationFsxWindows_ResponseSyntax) ** Amazon EC2 安全群組的 ARNs，可讓您存取檔案系統偏好的子網路。如需有關為檔案系統存取設定安全群組的資訊，請參閱 [https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/limit-access-security-groups.html)。類型：字串陣列陣列成員：項目數下限為 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]+$` ** [User](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 具有掛載和存取 FSx for Windows File Server 檔案系統許可的使用者。類型：字串長度限制：長度上限為 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationFsxWindows) # DescribeLocationHdfs 提供如何設定 Hadoop 分散式檔案系統 (HDFS) AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationHdfs_RequestSyntax) ** 指定 HDFS 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "BlockSize": number, "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CreationTime": number, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "KerberosPrincipal": "string", "KmsKeyProviderUri": "string", "LocationArn": "string", "LocationUri": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "NameNodes": [ { "Hostname": "string", "Port": number } ], "QopConfiguration": { "DataTransferProtection": "string", "RpcProtection": "string" }, "ReplicationFactor": number, "SimpleUser": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AgentArns](#API_DescribeLocationHdfs_ResponseSyntax) ** 可與 HDFS 叢集連線的 DataSync 代理程式 ARNs。類型：字串陣列陣列成員：項目數下限為 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}$` ** [AuthenticationType](#API_DescribeLocationHdfs_ResponseSyntax) ** 用來判斷使用者身分的身分驗證類型。類型：字串有效值:`SIMPLE | KERBEROS` ** [BlockSize](#API_DescribeLocationHdfs_ResponseSyntax) ** 要寫入 HDFS 叢集的資料區塊大小。類型：整數有效範圍：最小值為 1048576。最大值為 1073741824。 ** [CmkSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 `KerberosKeytab` DataSync 使用客戶受管存取特定儲存位置的 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件 ** [CreationTime](#API_DescribeLocationHdfs_ResponseSyntax) ** 建立 HDFS 位置的時間。類型：Timestamp ** [CustomSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) ** 描述客戶受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`KerberosKeytab`的，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件 ** [KerberosPrincipal](#API_DescribeLocationHdfs_ResponseSyntax) ** 此為 Kerberos 主體，有權存取 HDFS 叢集上的檔案和資料夾。如果 `AuthenticationType` 定義為，則會使用此參數`KERBEROS`。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^.+$` ** [KmsKeyProviderUri](#API_DescribeLocationHdfs_ResponseSyntax) ** HDFS 叢集金鑰管理伺服器 (KMS) 的 URI。類型：字串長度限制：長度下限為 1。長度上限為 255。模式：`^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$` ** [LocationArn](#API_DescribeLocationHdfs_ResponseSyntax) ** HDFS 位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationHdfs_ResponseSyntax) ** HDFS 位置的 URI。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [ManagedSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`KerberosKeytab`的。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件 ** [NameNodes](#API_DescribeLocationHdfs_ResponseSyntax) ** 管理 HDFS 命名空間的 NameNode。類型：[HdfsNameNode](API_HdfsNameNode.md) 物件陣列陣列成員：項目數下限為 1。 ** [QopConfiguration](#API_DescribeLocationHdfs_ResponseSyntax) ** 保護品質 (QOP) 組態，指定在 HDFS 叢集上設定的遠端程序呼叫 (RPC) 和資料傳輸保護設定。類型：[QopConfiguration](API_QopConfiguration.md) 物件 ** [ReplicationFactor](#API_DescribeLocationHdfs_ResponseSyntax) ** 寫入至 HDFS 叢集時要將資料複製到其中的 DataNode 數目。類型：整數有效範圍：最小值為 1。最大值為 512。 ** [SimpleUser](#API_DescribeLocationHdfs_ResponseSyntax) ** 在主機作業系統上識別用戶端的使用者名稱。如果 `AuthenticationType` 定義為，則會使用此參數`SIMPLE`。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^[_.A-Za-z0-9][-_.A-Za-z0-9]*$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationHdfs) # DescribeLocationNfs 提供如何設定網路檔案系統 (NFS) 檔案伺服器的 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationNfs_RequestSyntax) ** 指定您要取得資訊之 NFS 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "CreationTime": number, "LocationArn": "string", "LocationUri": "string", "MountOptions": { "Version": "string" }, "OnPremConfig": { "AgentArns": [ "string" ] } } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [CreationTime](#API_DescribeLocationNfs_ResponseSyntax) ** 建立 NFS 位置的時間。類型：Timestamp ** [LocationArn](#API_DescribeLocationNfs_ResponseSyntax) ** NFS 位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationNfs_ResponseSyntax) ** NFS 位置的 URI。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [MountOptions](#API_DescribeLocationNfs_ResponseSyntax) ** DataSync 用來掛載 NFS 檔案伺服器的掛載選項。類型：[NfsMountOptions](API_NfsMountOptions.md) 物件 ** [OnPremConfig](#API_DescribeLocationNfs_ResponseSyntax) ** 可連線至網路檔案系統 (NFS) 檔案伺服器的 AWS DataSync 代理程式。類型：[OnPremConfig](API_OnPremConfig.md) 物件 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，就會擲出此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 範例下列範例會傳回範例請求中指定之 NFS 位置的相關資訊。 #### 請求範例 ``` { "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa" } ``` ### 範例此範例說明 DescribeLocationNfs 的一個用途。 #### 回應範例 ``` { "CreationTime": 1532660733.39, "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50aa", "LocationUri": "hostname.amazon.com", "OnPremConfig": { "AgentArns": [ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0b0addbeef44b3nfs" ] } } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationNfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationNfs) # DescribeLocationObjectStorage 提供如何設定物件儲存系統 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationObjectStorage_RequestSyntax) ** 指定物件儲存系統位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "AccessKey": "string", "AgentArns": [ "string" ], "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CreationTime": number, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "LocationArn": "string", "LocationUri": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "ServerCertificate": blob, "ServerPort": number, "ServerProtocol": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AccessKey](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 使用物件儲存系統進行身分驗證所需的存取金鑰（例如，使用者名稱）。類型：字串長度限制：長度下限為 0。長度上限為 200。模式：`^.*$` ** [AgentArns](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 可與物件儲存系統連線的 DataSync 代理程式 ARNs。類型：字串陣列陣列成員：項目數下限為 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}$` ** [CmkSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如身分驗證字符或一組登入資料，供 DataSync 用來存取特定傳輸位置，以及客戶受管 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件 ** [CreationTime](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 建立位置的時間。類型：Timestamp ** [CustomSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 描述客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的身分驗證字符或一組登入資料，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件 ** [LocationArn](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 物件儲存系統位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 物件儲存系統位置的 URI。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [ManagedSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如身分驗證字符或一組登入資料，供 DataSync 用來存取特定傳輸位置。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件 ** [ServerCertificate](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 如果系統使用私有或自我簽署憑證授權單位 (CA)，DataSync 的憑證鏈會與您的物件儲存系統進行驗證。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 32768。 ** [ServerPort](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 物件儲存伺服器接受傳入網路流量的連接埠（例如連接埠 443)。類型：整數有效範圍：最小值為 1。最大值為 65536。 ** [ServerProtocol](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 物件儲存系統用來通訊的通訊協定。類型：字串有效值:`HTTPS | HTTP` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationObjectStorage) # DescribeLocationS3 提供如何設定 S3 儲存貯體 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationS3_RequestSyntax) ** 指定 Amazon S3 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "AgentArns": [ "string" ], "CreationTime": number, "LocationArn": "string", "LocationUri": "string", "S3Config": { "BucketAccessRoleArn": "string" }, "S3StorageClass": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AgentArns](#API_DescribeLocationS3_ResponseSyntax) ** 使用 Amazon S3 on Outposts 時，部署在 Outpost 上的 DataSync 代理程式 ARNs。如需詳細資訊，請參閱[在上部署 DataSync 代理程式 AWS Outposts](https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent)。類型：字串陣列陣列成員：項目數下限為 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}$` ** [CreationTime](#API_DescribeLocationS3_ResponseSyntax) ** 建立 Amazon S3 位置的時間。類型：Timestamp ** [LocationArn](#API_DescribeLocationS3_ResponseSyntax) ** Amazon S3 位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationS3_ResponseSyntax) ** 描述的 Amazon S3 位置 URL。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [S3Config](#API_DescribeLocationS3_ResponseSyntax) ** 指定 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)。類型：[S3Config](API_S3Config.md) 物件 ** [S3StorageClass](#API_DescribeLocationS3_ResponseSyntax) ** 當 Amazon S3 是目的地位置時，這是您為物件選擇的儲存類別。有些儲存類別的行為可能會影響您的 Amazon S3 儲存成本。如需詳細資訊，請參閱 [Amazon S3 傳輸的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。類型：字串有效值:`STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 範例下列範例會傳回範例請求中指定之 Amazon S3 位置的相關資訊。 #### 請求範例 ``` { "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3" } ``` ### 範例此範例說明 DescribeLocationS3 的一個用途。 #### 回應範例 ``` { "CreationTime": 1532660733.39, "LocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-07db7abfc326c50s3", "LocationUri": "s3://amzn-s3-demo-bucket", "S3Config": { "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/amzn-s3-demo-bucket-access-role", } "S3StorageClass": "STANDARD" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationS3) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationS3) # DescribeLocationSmb 提供如何設定伺服器訊息區塊 (SMB) 檔案伺服器的 AWS DataSync 傳輸位置的詳細資訊。 ## 請求語法 ``` { "LocationArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) ** 指定您要取得資訊之 SMB 位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ## 回應語法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CreationTime": number, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosPrincipal": "string", "LocationArn": "string", "LocationUri": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "MountOptions": { "Version": "string" }, "User": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [AgentArns](#API_DescribeLocationSmb_ResponseSyntax) ** 可與 SMB 檔案伺服器連線的 DataSync 代理程式 ARNs。類型：字串陣列陣列成員：項目數下限為 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}$` ** [AuthenticationType](#API_DescribeLocationSmb_ResponseSyntax) ** DataSync 用來連線至 SMB 檔案伺服器的身分驗證通訊協定。類型：字串有效值:`NTLM | KERBEROS` ** [CmkSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 `KerberosKeytab` DataSync 使用客戶受管存取特定儲存位置的 `Password`或 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件 ** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) ** 建立 SMB 位置的時間。類型：Timestamp ** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) ** 說明客戶受管秘密的組態資訊，例如 DataSync 用來存取特定儲存位置`KerberosKeytab`的 `Password`或，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件 ** [DnsIpAddresses](#API_DescribeLocationSmb_ResponseSyntax) ** SMB 檔案伺服器所屬之 DNS 伺服器的 IPv4 或 IPv6 地址。此元素只有在 `AuthenticationType` 設定為時才適用`KERBEROS`。類型：字串陣列陣列成員：最多 2 個項目。長度限制：長度下限為 7。長度上限為 39。模式：`\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z` ** [Domain](#API_DescribeLocationSmb_ResponseSyntax) ** SMB 檔案伺服器所屬的 Windows 網域名稱。此元素只有在 `AuthenticationType` 設定為時才適用`NTLM`。類型：字串長度限制：長度上限為 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` ** [KerberosPrincipal](#API_DescribeLocationSmb_ResponseSyntax) ** 有權存取 SMB 檔案伺服器中檔案、資料夾和檔案中繼資料的 Kerberos 主體。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^.+$` ** [LocationArn](#API_DescribeLocationSmb_ResponseSyntax) ** SMB 位置的 ARN。類型：字串長度限制：長度上限為 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](#API_DescribeLocationSmb_ResponseSyntax) ** SMB 位置的 URI。類型：字串長度限制：長度上限為 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [ManagedSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) ** 描述 DataSync 受管秘密的組態資訊，例如 `Password`或 DataSync 用來存取特定儲存位置`KerberosKeytab`的。DataSync 使用預設受管 KMS AWS金鑰來加密此秘密 AWS Secrets Manager。類型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 物件 ** [MountOptions](#API_DescribeLocationSmb_ResponseSyntax) ** DataSync 用來存取 SMB 檔案伺服器的 SMB 通訊協定版本。類型：[SmbMountOptions](API_SmbMountOptions.md) 物件 ** [User](#API_DescribeLocationSmb_ResponseSyntax) ** 可掛載和存取 SMB 檔案伺服器中檔案、資料夾和檔案中繼資料的使用者。此元素只有在 `AuthenticationType` 設定為時才適用`NTLM`。類型：字串長度限制：長度上限為 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 範例此範例說明 DescribeLocationSmb 的一個用途。 #### 請求範例 ``` { "arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49" } ``` ### 範例此範例說明 DescribeLocationSmb 的一個用途。 #### 回應範例 ``` { "AgentArns":[ "arn:aws:datasync:us-east-2:111222333444:agent/agent-0bc3b3dc9bbc15145", "arn:aws:datasync:us-east-2:111222333444:agent/agent-04b3fe3d261a18c8f" ], "CreationTime":"1532660733.39", "Domain":"AMAZON", "LocationArn":"arn:aws:datasync:us-east-1:111222333444:location/loc-0f01451b140b2af49", "LocationUri":"smb://hostname.amazon.com/share", "MountOptions":{ "Version":"SMB3" }, "User":"user-1" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeLocationSmb) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeLocationSmb) # DescribeTask 提供*任務*的相關資訊，定義 AWS DataSync 資料傳輸的位置和方式。 ## 請求語法 ``` { "TaskArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [TaskArn](#API_DescribeTask_RequestSyntax) ** 指定您要取得相關資訊之傳輸任務的 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}$` 必要：是 ## 回應語法 ``` { "CloudWatchLogGroupArn": "string", "CreationTime": number, "CurrentTaskExecutionArn": "string", "DestinationLocationArn": "string", "DestinationNetworkInterfaceArns": [ "string" ], "ErrorCode": "string", "ErrorDetail": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "Name": "string", "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Schedule": { "ScheduleExpression": "string", "Status": "string" }, "ScheduleDetails": { "DisabledBy": "string", "DisabledReason": "string", "StatusUpdateTime": number }, "SourceLocationArn": "string", "SourceNetworkInterfaceArns": [ "string" ], "Status": "string", "TaskArn": "string", "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [CloudWatchLogGroupArn](#API_DescribeTask_ResponseSyntax) ** 用於監控任務的 Amazon CloudWatch 日誌群組的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱[使用 CloudWatch Logs 監控資料傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)。類型：字串長度限制：長度上限為 562。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` ** [CreationTime](#API_DescribeTask_ResponseSyntax) ** 建立任務的時間。類型：Timestamp ** [CurrentTaskExecutionArn](#API_DescribeTask_ResponseSyntax) ** 最新任務執行的 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}$` ** [DestinationLocationArn](#API_DescribeTask_ResponseSyntax) ** 傳輸目的地位置的 ARN。類型：字串長度限制：長度上限為 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}$` ** [DestinationNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) ** DataSync 為您的目的地位置建立之[網路介面](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)的 ARNs。類型：字串陣列長度限制：長度上限為 128。模式：`^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` ** [ErrorCode](#API_DescribeTask_ResponseSyntax) ** 如果您的任務發生問題，您可以使用錯誤碼來協助您疑難排解問題。如需詳細資訊，請參閱[針對 DataSync 傳輸的問題進行故障診斷](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。類型：字串 ** [ErrorDetail](#API_DescribeTask_ResponseSyntax) ** 如果您的任務發生問題，您可以使用錯誤詳細資訊來協助您疑難排解問題。如需詳細資訊，請參閱[針對 DataSync 傳輸的問題進行故障診斷](https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html)。類型：字串 ** [Excludes](#API_DescribeTask_ResponseSyntax) ** 排除篩選條件，以定義您不希望 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。 ** [Includes](#API_DescribeTask_ResponseSyntax) ** 包含篩選條件，可定義您要 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。 ** [ManifestConfig](#API_DescribeTask_ResponseSyntax) ** 列出您希望 DataSync 傳輸之檔案或物件的資訊清單組態。如需詳細資訊，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。類型：[ManifestConfig](API_ManifestConfig.md) 物件 ** [Name](#API_DescribeTask_ResponseSyntax) ** 任務的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` ** [Options](#API_DescribeTask_ResponseSyntax) ** 任務的設定。例如，會保留哪些檔案中繼資料、如何在傳輸結束時驗證資料完整性、頻寬限制，以及其他選項。類型：[Options](API_Options.md) 物件 ** [Schedule](#API_DescribeTask_ResponseSyntax) ** 您希望任務執行的排程。如需詳細資訊，請參閱[任務排程](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)。類型：[TaskSchedule](API_TaskSchedule.md) 物件 ** [ScheduleDetails](#API_DescribeTask_ResponseSyntax) ** [任務排程](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)的詳細資訊。類型：[TaskScheduleDetails](API_TaskScheduleDetails.md) 物件 ** [SourceLocationArn](#API_DescribeTask_ResponseSyntax) ** 傳輸來源位置的 ARN。類型：字串長度限制：長度上限為 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}$` ** [SourceNetworkInterfaceArns](#API_DescribeTask_ResponseSyntax) ** DataSync 為您的來源位置建立之[網路界面](https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces)ARNs。類型：字串陣列長度限制：長度上限為 128。模式：`^arn:aws[\-a-z]{0,}:ec2:[a-z\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$` ** [Status](#API_DescribeTask_ResponseSyntax) ** 任務的狀態。如需每個狀態含義的資訊，請參閱[任務狀態](https://docs.aws.amazon.com/datasync/latest/userguide/create-task-how-to.html#understand-task-creation-statuses)。類型：字串有效值:`AVAILABLE | CREATING | QUEUED | RUNNING | UNAVAILABLE` ** [TaskArn](#API_DescribeTask_ResponseSyntax) ** 任務的 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](#API_DescribeTask_ResponseSyntax) ** 您使用的任務模式。如需詳細資訊，請參閱[為您的資料傳輸選擇任務模式](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：字串有效值:`BASIC | ENHANCED` ** [TaskReportConfig](#API_DescribeTask_ResponseSyntax) ** 任務報告的組態，提供 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱[使用任務報告監控 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。類型：[TaskReportConfig](API_TaskReportConfig.md) 物件 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例指定要取得相關資訊的 DataSync 任務 ARN。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } ``` ### 回應範例下列範例顯示`DescribeTask`回應。 ``` { "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026", "Name": "MyTask", "TaskMode": "BASIC", "Status": "RUNNING", "SourceLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-1111aaaa2222bbbb3", "DestinationLocationArn": "arn:aws:datasync:us-east-2:111222333444:location/loc-0000zzzz1111yyyy2", "CurrentTaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f", "CreationTime": 1532660733.39, "Options": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "CloudWatchLogGroupArn": "arn:aws:logs:us-east-2:111222333444:log-group:/log-group-name:*" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTask) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTask) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTask) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTask) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTask) # DescribeTaskExecution 提供 AWS DataSync 任務執行的相關資訊。您可以使用此操作來協助監控持續資料傳輸的進度，或檢查傳輸的結果。 **注意** 有些`DescribeTaskExecution`回應元素僅與特定任務模式相關。如需詳細資訊，請參閱[了解任務模式差異](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences)和[了解資料傳輸效能計數器](https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html)。 ## 請求語法 ``` { "TaskExecutionArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [TaskExecutionArn](#API_DescribeTaskExecution_RequestSyntax) ** 指定您希望取得資訊之任務執行的 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}$` 必要：是 ## 回應語法 ``` { "BytesCompressed": number, "BytesTransferred": number, "BytesWritten": number, "EndTime": number, "EstimatedBytesToTransfer": number, "EstimatedFilesToDelete": number, "EstimatedFilesToTransfer": number, "EstimatedFoldersToDelete": number, "EstimatedFoldersToTransfer": number, "Excludes": [ { "FilterType": "string", "Value": "string" } ], "FilesDeleted": number, "FilesFailed": { "Delete": number, "Prepare": number, "Transfer": number, "Verify": number }, "FilesListed": { "AtDestinationForDelete": number, "AtSource": number }, "FilesPrepared": number, "FilesSkipped": number, "FilesTransferred": number, "FilesVerified": number, "FoldersDeleted": number, "FoldersFailed": { "Delete": number, "List": number, "Prepare": number, "Transfer": number, "Verify": number }, "FoldersListed": { "AtDestinationForDelete": number, "AtSource": number }, "FoldersPrepared": number, "FoldersSkipped": number, "FoldersTransferred": number, "FoldersVerified": number, "Includes": [ { "FilterType": "string", "Value": "string" } ], "LaunchTime": number, "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "ReportResult": { "ErrorCode": "string", "ErrorDetail": "string", "Status": "string" }, "Result": { "ErrorCode": "string", "ErrorDetail": "string", "PrepareDuration": number, "PrepareStatus": "string", "TotalDuration": number, "TransferDuration": number, "TransferStatus": "string", "VerifyDuration": number, "VerifyStatus": "string" }, "StartTime": number, "Status": "string", "TaskExecutionArn": "string", "TaskMode": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [BytesCompressed](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在壓縮後透過網路傳輸的實體位元組數（如果可以壓縮）。除非資料無法壓縮，否則此數字通常小於 [BytesTransferred](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesTransferred)。類型：Long ** [BytesTransferred](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在壓縮之前傳送到網路的位元組數（如果可以壓縮）。如需透過網路傳輸的位元組數，請參閱 [BytesCompressed](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed)。類型：Long ** [BytesWritten](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 實際寫入目的地位置的邏輯位元組數目。類型：Long ** [EndTime](#API_DescribeTaskExecution_ResponseSyntax) ** 傳輸任務結束的時間。類型：Timestamp ** [EstimatedBytesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 預期寫入目的地位置的邏輯位元組數。類型：Long ** [EstimatedFilesToDelete](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 預期在您的目的地位置刪除的檔案、物件和目錄數量。如果您未設定任務來[刪除目的地中不在來源中的資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)，則值一律為 `0`。對於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)，此計數器僅包含檔案或物件。目錄會在 [EstimatedFoldersToDelete](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToDelete) 中計數。類型：Long ** [EstimatedFilesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 預期透過網路傳輸的檔案、物件和目錄數量。此值會在 DataSync [準備](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)傳輸時計算。計算方式主要取決於任務的[傳輸模式](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode)組態： + 如果 `TranserMode` 設定為 `CHANGED` - 計算是根據比較來源和目的地位置的內容，並判斷需要傳輸的差異。差異可能包括： + 在來源位置新增或修改的任何項目。 + 在初始傳輸後，位於兩個位置且於目的地修改的任何內容（除非 [OverwriteMode](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode) 設定為 `NEVER`)。 + **（僅限基本任務模式）** DataSync 預期刪除的項目數量（如果 [PreserveDeletedFiles](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-PreserveDeletedFiles) 設定為 `REMOVE`)。 + 如果 `TranserMode` 設定為 `ALL` - 計算僅根據 DataSync 在來源位置找到的項目。對於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)，此計數器僅包含檔案或物件。目錄在 [EstimatedFoldersToTransfer](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-EstimatedFoldersToTransfer) 中計數。類型：Long ** [EstimatedFoldersToDelete](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 預期在您的目的地位置刪除的目錄數量。如果您未將任務設定為[刪除目的地中不在來源中的資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)，則值一律為 `0`。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：Long ** [EstimatedFoldersToTransfer](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 預期透過網路傳輸的目錄數量。此值的計算方式為 DataSync [準備要傳輸的](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)目錄。計算方式主要取決於任務的[傳輸模式](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-TransferMode)組態： + 如果 `TranserMode` 設定為 `CHANGED` - 計算是根據比較來源和目的地位置的內容，並判斷需要傳輸的差異。差異可能包括： + 在來源位置新增或修改的任何項目。 + 在初始傳輸後，位於兩個位置且於目的地修改的任何項目（除非 [OverwriteMode](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-OverwriteMode) 設定為 `NEVER`)。 + 如果 `TranserMode` 設定為 `ALL` - 計算僅根據 DataSync 在來源位置找到的項目。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：Long ** [Excludes](#API_DescribeTaskExecution_ResponseSyntax) ** 在傳輸期間排除特定資料的篩選條件規則清單。如需詳細資訊和範例，請參閱[篩選 DataSync 傳輸的資料](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。 ** [FilesDeleted](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在您目的地位置中實際刪除的檔案、物件和目錄數量。如果您未將任務設定為[刪除目的地中不在來源中的資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)，則值一律為 `0`。對於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)，此計數器僅包含檔案或物件。目錄會在 [FoldersDeleted](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersDeleted) 中計數。類型：Long ** [FilesFailed](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在任務執行期間無法準備、傳輸、驗證和刪除的檔案或物件數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：[TaskExecutionFilesFailedDetail](API_TaskExecutionFilesFailedDetail.md) 物件 ** [FilesListed](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在您的位置找到的檔案或物件數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：[TaskExecutionFilesListedDetail](API_TaskExecutionFilesListedDetail.md) 物件 ** [FilesPrepared](#API_DescribeTaskExecution_ResponseSyntax) ** 在比較來源和目的地位置之後，DataSync 將嘗試傳輸的檔案或物件數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。如果您將任務設定為[傳輸所有資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode)，則此計數器不適用。在這種情況下，DataSync 會將來源的所有內容複製到目的地，而不會比較位置之間的差異。類型：Long ** [FilesSkipped](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在傳輸期間略過的檔案、物件和目錄數量。對於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)，此計數器僅包含檔案或物件。目錄會在 [FoldersSkipped](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersSkipped) 中計數。類型：Long ** [FilesTransferred](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 透過網路實際傳輸的檔案、物件和目錄數量。當您的任務執行期間，從來源讀取物件並透過網路傳送時，此值會定期更新。如果 DataSync 無法傳輸某些內容，則此值可以小於 `EstimatedFilesToTransfer`。在某些情況下，此值也可以大於 `EstimatedFilesToTransfer`。此元素對於某些位置類型是特定的實作，因此請不要將其用作正在傳輸的內容或監控任務執行的確切指示。對於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)，此計數器僅包含檔案或物件。目錄會在 [FoldersTransferred](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersTransferred) 中計數。類型：Long ** [FilesVerified](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在您傳輸期間驗證的檔案、物件和目錄數量。當您將任務設定為[僅驗證已傳輸的資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html)時，DataSync 在某些情況下不會驗證目錄或無法傳輸的檔案。對於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)，此計數器僅包含檔案或物件。目錄會在 [FoldersVerified](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-FoldersVerified) 中計數。類型：Long ** [FoldersDeleted](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在您的目的地位置實際刪除的目錄數量。如果您未將任務設定為[刪除不在來源中的目的地中的資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html)，則值一律為 `0`。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：Long ** [FoldersFailed](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在任務執行期間無法列出、準備、傳輸、驗證和刪除的目錄數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：[TaskExecutionFoldersFailedDetail](API_TaskExecutionFoldersFailedDetail.md) 物件 ** [FoldersListed](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在您的位置找到的目錄數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：[TaskExecutionFoldersListedDetail](API_TaskExecutionFoldersListedDetail.md) 物件 ** [FoldersPrepared](#API_DescribeTaskExecution_ResponseSyntax) ** 在比較來源和目的地位置之後，DataSync 將嘗試傳輸的目錄數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。如果您將任務設定為[傳輸所有資料](https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html#task-option-transfer-mode)，則此計數器不適用。在這種情況下，DataSync 會將來源的所有內容複製到目的地，而不會比較位置之間的差異。類型：Long ** [FoldersSkipped](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在傳輸期間略過的目錄數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：Long ** [FoldersTransferred](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 透過網路實際傳輸的目錄數量。當您的任務執行期間，從來源讀取物件並透過網路傳送時，此值會定期更新。如果 DataSync 無法傳輸某些內容，則此值可以小於 `EstimatedFoldersToTransfer`。在某些情況下，此值也可以大於 `EstimatedFoldersToTransfer`。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：Long ** [FoldersVerified](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 在您傳輸期間驗證的目錄數量。僅適用於[增強型模式任務](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：Long ** [Includes](#API_DescribeTaskExecution_ResponseSyntax) ** 在傳輸期間包含特定資料的篩選條件規則清單。如需詳細資訊和範例，請參閱[篩選 DataSync 傳輸的資料](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。 ** [LaunchTime](#API_DescribeTaskExecution_ResponseSyntax) ** 任務執行實際開始的時間。對於未排入佇列的任務， `LaunchTime`和 `StartTime` 通常相同。對於排入佇列的任務， `LaunchTime` 通常晚於，`StartTime`因為先前排入佇列的任務必須先完成執行，才能開始較新的任務。類型：Timestamp ** [ManifestConfig](#API_DescribeTaskExecution_ResponseSyntax) ** 列出要傳輸之檔案或物件的資訊清單組態。如需詳細資訊，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。類型：[ManifestConfig](API_ManifestConfig.md) 物件 ** [Options](#API_DescribeTaskExecution_ResponseSyntax) ** 指出傳輸任務的設定方式。這些選項包括 DataSync 如何在傳輸期間處理檔案、物件及其相關聯的中繼資料。您也可以指定如何驗證資料完整性、設定任務的頻寬限制，以及其他選項。每個選項都有預設值。除非需要，否則您不需要在呼叫 [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) 之前設定任何選項。您也可以覆寫每個任務執行的任務選項。例如，您可能想要調整個別執行`LogLevel`的。類型：[Options](API_Options.md) 物件 ** [ReportResult](#API_DescribeTaskExecution_ResponseSyntax) ** 指出 DataSync 是否為您的傳輸產生完整的[任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。類型：[ReportResult](API_ReportResult.md) 物件 ** [Result](#API_DescribeTaskExecution_ResponseSyntax) ** 任務執行的結果。類型：[TaskExecutionResultDetail](API_TaskExecutionResultDetail.md) 物件 ** [StartTime](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 傳送啟動任務執行請求的時間。對於未佇列的任務， `LaunchTime`和 `StartTime` 通常相同。對於排入佇列的任務， `LaunchTime` 通常晚於，`StartTime`因為先前排入佇列的任務必須先完成執行，才能開始較新的任務。類型：Timestamp ** [Status](#API_DescribeTaskExecution_ResponseSyntax) ** 任務執行的狀態。如需任務執行狀態的詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses)。類型：字串有效值:`QUEUED | CANCELLING | LAUNCHING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS | ERROR` ** [TaskExecutionArn](#API_DescribeTaskExecution_ResponseSyntax) ** 您希望取得相關資訊之任務執行的 ARN。 `TaskExecutionArn`是階層式，並`TaskArn`包含所執行任務的。例如，具有 ARN `TaskExecution`的值會使用 ARN `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b`執行任務`arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2`。類型：字串長度限制：長度上限為 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](#API_DescribeTaskExecution_ResponseSyntax) ** 您使用的任務模式。如需詳細資訊，請參閱[為您的資料傳輸選擇任務模式](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。類型：字串有效值:`BASIC | ENHANCED` ** [TaskReportConfig](#API_DescribeTaskExecution_ResponseSyntax) ** 任務報告的組態，可提供有關 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱[建立任務報告](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。類型：[TaskReportConfig](API_TaskReportConfig.md) 物件 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例此範例說明 `DescribeTaskExecution`請求。 ``` { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1" } ``` ### 增強型模式任務執行的回應 1 範例下列範例說明使用增強模式的 DataSync 任務執行。執行也會使用排除和包含篩選條件來傳輸特定資料。 ``` { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode": "ONLY_FILES_TRANSFERRED", "OverwriteMode": "ALWAYS", "Atime": "BEST_EFFORT", "Mtime": "PRESERVE", "Uid": "NONE", "Gid": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PosixPermissions": "NONE", "BytesPerSecond": -1, "TaskQueueing": "ENABLED", "LogLevel": "BASIC", "TransferMode": "CHANGED", "SecurityDescriptorCopyFlags": "NONE", "ObjectTags": "PRESERVE" }, "Excludes": [{ "FilterType": "SIMPLE_PATTERN", "Value": "/archive-files" }], "Includes": [{ "FilterType": "SIMPLE_PATTERN", "Value": "/files" }], "StartTime": "2024-10-16T11:19:56.844000-04:00", "EstimatedFilesToTransfer": 7, "EstimatedFoldersToTransfer": 2, "EstimatedBytesToTransfer": 30, "FilesTransferred": 7, "FoldersTransferred": 2, "BytesWritten": 30, "BytesTransferred": 30, "BytesCompressed": 30, "Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3310, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 7, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 7, "FilesListed": { "AtSource": 7, "AtDestinationForDelete": 0 }, "FilesFailed": { "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 }, "FoldersDeleted": 0, "FoldersSkipped": 0, "FoldersVerified": 2, "FoldersPrepared": 2, "FoldersListed": { "AtSource": 2, "AtDestinationForDelete": 0 }, "FoldersFailed": { "List": 0, "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } } ``` ### 增強型模式任務執行的回應 2 範例下列範例說明另一個使用增強模式的 DataSync 任務執行。在這種情況下，執行會使用資訊清單而非篩選條件來傳輸特定資料。 ``` { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "Status": "SUCCESS", "Options": { "VerifyMode": "ONLY_FILES_TRANSFERRED", "OverwriteMode": "ALWAYS", "Atime": "BEST_EFFORT", "Mtime": "PRESERVE", "Uid": "NONE", "Gid": "NONE", "PreserveDeletedFiles": "PRESERVE", "PreserveDevices": "NONE", "PosixPermissions": "NONE", "BytesPerSecond": -1, "TaskQueueing": "ENABLED", "LogLevel": "TRANSFER", "TransferMode": "CHANGED", "SecurityDescriptorCopyFlags": "NONE", "ObjectTags": "PRESERVE" }, "Excludes": [], "Includes": [], "ManifestConfig": { "Action": "TRANSFER", "Format": "CSV", "S3AccessRoleArn": "arn:aws:iam::111222333444:role/service-role/DataSyncS3ManifestAccess", "S3Bucket": "arn:aws:s3:::manifests-datasync", "VersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG", "Source": { "S3": { "ManifestObjectPath": "manifest-folder/manifest-versioned-files", "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-manifest-role/DataSyncS3ManifestAccess", "S3BucketArn": "arn:aws:s3:::manifests-datasync", "ManifestObjectVersionId": "Ixs7NQzEOj8BkL9r4ywX2FtDh_cPf3mG" } } }, "StartTime": "2024-10-16T09:29:56.757000-04:00", "EstimatedFilesToTransfer": 1, "EstimatedFoldersToTransfer": 0, "EstimatedBytesToTransfer": 6, "FilesTransferred": 1, "FoldersTransferred": 1, "BytesWritten": 6, "BytesTransferred": 6, "BytesCompressed": 6, "Result": { "PrepareDuration": 0, "PrepareStatus": "SUCCESS", "TotalDuration": 3089, "TransferDuration": 0, "TransferStatus": "SUCCESS", "VerifyDuration": 0, "VerifyStatus": "SUCCESS" }, "TaskReportConfig": { "Destination": { "S3": { "Subdirectory": "reports/", "S3BucketArn": "arn:aws:s3:::my-task-report", "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-task-report-role/DataSyncTaskReportS3BucketAccess" } }, "OutputType": "STANDARD", "ReportLevel": "SUCCESSES_AND_ERRORS", "ObjectVersionIds": "INCLUDE" }, "FilesDeleted": 0, "FilesSkipped": 0, "FilesVerified": 1, "ReportResult": { "Status": "SUCCESS" }, "EstimatedFilesToDelete": 0, "TaskMode": "ENHANCED", "FilesPrepared": 1, "FilesListed": { "AtSource": 1, "AtDestinationForDelete": 0 }, "FilesFailed": { "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 }, "FoldersDeleted": 0, "FoldersSkipped": 0, "FoldersVerified": 0, "FoldersPrepared": 0, "FoldersListed": { "AtSource": 0, "AtDestinationForDelete": 0 }, "FoldersFailed": { "List": 0, "Prepare": 0, "Transfer": 0, "Verify": 0, "Delete": 0 } } ``` ### 基本模式任務執行的範例回應下列範例說明使用基本模式的 DataSync 任務執行。 ``` { "TaskExecutionArn": "arn:aws:datasync:us-east-1:111222333444:task/task-aaaabbbbccccddddf/execution/exec-1234abcd1234abcd1", "BytesCompressed": 3500, "BytesTransferred": 5000, "BytesWritten": 5000, "EstimatedBytesToTransfer": 5000, "EstimatedFilesToDelete": 10, "EstimatedFilesToTransfer": 100, "FilesDeleted": 10, "FilesSkipped": 0, "FilesTransferred": 100, "FilesVerified": 100, "Result": { "PrepareDuration": 100, "PrepareStatus": "SUCCESS", "TransferDuration": 60, "TransferStatus": "SUCCESS", "VerifyDuration": 30, "VerifyStatus": "SUCCESS" }, "StartTime": "2024-10-16T11:19:56.844000-04:00", "Status": "SUCCESS", "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": "1000", "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "arn:aws:iam::111222333444:role/my-datasync-role", "S3BucketArn": "arn:aws:s3:::my-task-reports-bucket/*", "Subdirectory": "reports" } }, "ObjectVersionIds": "INCLUDE", "OutputType": "STANDARD", "Overrides": { "Deleted": { "ReportLevel": "ERRORS_ONLY" }, "Skipped": { "ReportLevel": "SUCCESSES_AND_ERRORS" }, "Transferred": { "ReportLevel": "ERRORS_ONLY" }, "Verified": { "ReportLevel": "ERRORS_ONLY" } }, "ReportLevel": "ERRORS_ONLY" } } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/DescribeTaskExecution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/DescribeTaskExecution) # ListAgents 在請求中 AWS 區域指定的 AWS 帳戶中傳回屬於的 AWS DataSync 客服人員清單。透過分頁，您可以減少回應中傳回的客服人員數量。如果您在回應中收到截斷的客服人員清單，回應會包含您可以在下一個請求中指定的標記，以擷取客服人員的下一頁。 `ListAgents` 最終一致。這表示執行操作的結果可能不會反映您剛建立或刪除代理程式。例如，如果您使用 [CreateAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html) 建立代理程式，然後立即執行 `ListAgents`，則該代理程式可能不會立即出現在清單中。在這類情況下，您可以使用 [DescribeAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html) 來確認是否已建立（或刪除）代理程式。 ## 請求語法 ``` { "MaxResults": number, "NextToken": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [MaxResults](#API_ListAgents_RequestSyntax) ** 指定要在回應中列出的 DataSync 代理程式數量上限。根據預設，回應最多可顯示 100 個客服人員。類型：整數有效範圍：最小值為 0。最大值為 100。必要：否 ** [NextToken](#API_ListAgents_RequestSyntax) ** 指定不透明字串，指出在回應中開始下一個結果清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` 必要：否 ## 回應語法 ``` { "Agents": [ { "AgentArn": "string", "Name": "string", "Platform": { "Version": "string" }, "Status": "string" } ], "NextToken": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [Agents](#API_ListAgents_ResponseSyntax) ** 請求中 AWS 區域指定之 AWS 帳戶中中的 DataSync 代理程式清單。清單會依客服人員的 Amazon Resource Name (ARNs) 排序。類型：[AgentListEntry](API_AgentListEntry.md) 物件陣列 ** [NextToken](#API_ListAgents_ResponseSyntax) ** 不透明字串，指出在回應中開始下一個結果清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListAgents) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListAgents) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListAgents) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListAgents) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListAgents) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListAgents) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListAgents) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListAgents) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListAgents) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListAgents) # ListLocations 傳回來源和目的地位置的清單。如果您的位置多於回應中傳回的位置（也就是回應只會傳回已截斷的客服人員清單），則回應會包含權杖，您可以在下一個請求中指定權杖，以擷取位置的下一頁。 ## 請求語法 ``` { "Filters": [ { "Name": "string", "Operator": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [Filters](#API_ListLocations_RequestSyntax) ** 您可以使用 API 篩選條件來縮小傳回的資源清單`ListLocations`。例如，若要擷取特定來源位置上的所有任務，您可以使用 `ListLocations`搭配篩選條件名稱 `LocationType S3`和 `Operator Equals`。類型：[LocationFilter](API_LocationFilter.md) 物件陣列必要：否 ** [MaxResults](#API_ListLocations_RequestSyntax) ** 要傳回的位置數量上限。類型：整數有效範圍：最小值為 0。最大值為 100。必要：否 ** [NextToken](#API_ListLocations_RequestSyntax) ** 不透明字串，指出開始下一個位置清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` 必要：否 ## 回應語法 ``` { "Locations": [ { "LocationArn": "string", "LocationUri": "string" } ], "NextToken": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [Locations](#API_ListLocations_ResponseSyntax) ** 包含位置清單的陣列。類型：[LocationListEntry](API_LocationListEntry.md) 物件陣列 ** [NextToken](#API_ListLocations_ResponseSyntax) ** 不透明字串，指出開始傳回下一個位置清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListLocations) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListLocations) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListLocations) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListLocations) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListLocations) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListLocations) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListLocations) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListLocations) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListLocations) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListLocations) # ListTagsForResource 傳回與 AWS 資源相關聯的所有標籤。 ## 請求語法 ``` { "MaxResults": number, "NextToken": "string", "ResourceArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [MaxResults](#API_ListTagsForResource_RequestSyntax) ** 指定您想要在回應中有多少結果。類型：整數有效範圍：最小值為 0。最大值為 100。必要：否 ** [NextToken](#API_ListTagsForResource_RequestSyntax) ** 指定不透明字串，指出在回應中開始下一個結果清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` 必要：否 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** 指定您要標記資訊之資源的 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|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$` 必要：是 ## 回應語法 ``` { "NextToken": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [NextToken](#API_ListTagsForResource_ResponseSyntax) ** 不透明字串，指出在回應中開始下一個結果清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` ** [Tags](#API_ListTagsForResource_ResponseSyntax) ** 套用至指定資源的標籤陣列。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。最多 55 個項目。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListTagsForResource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListTagsForResource) # ListTaskExecutions 傳回 AWS DataSync 傳輸任務的執行清單。 ## 請求語法 ``` { "MaxResults": number, "NextToken": "string", "TaskArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [MaxResults](#API_ListTaskExecutions_RequestSyntax) ** 指定您想要在回應中有多少結果。類型：整數有效範圍：最小值為 0。最大值為 100。必要：否 ** [NextToken](#API_ListTaskExecutions_RequestSyntax) ** 指定不透明字串，指出在回應中開始下一個結果清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` 必要：否 ** [TaskArn](#API_ListTaskExecutions_RequestSyntax) ** 指定您要執行資訊之任務的 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}$` 必要：否 ## 回應語法 ``` { "NextToken": "string", "TaskExecutions": [ { "Status": "string", "TaskExecutionArn": "string", "TaskMode": "string" } ] } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [NextToken](#API_ListTaskExecutions_ResponseSyntax) ** 不透明字串，指出在回應中開始下一個結果清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` ** [TaskExecutions](#API_ListTaskExecutions_ResponseSyntax) ** 任務執行的清單。類型：[TaskExecutionListEntry](API_TaskExecutionListEntry.md) 物件陣列 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，就會擲出此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListTaskExecutions) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListTaskExecutions) # ListTasks 傳回您建立 AWS DataSync 的任務清單。 ## 請求語法 ``` { "Filters": [ { "Name": "string", "Operator": "string", "Values": [ "string" ] } ], "MaxResults": number, "NextToken": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [Filters](#API_ListTasks_RequestSyntax) ** 您可以使用 API 篩選條件來縮小傳回的資源清單`ListTasks`。例如，若要擷取特定來源位置上的所有任務，您可以使用 `ListTasks` 搭配篩選名稱`LocationId`，以及`Operator Equals`搭配該位置的 ARN。類型：[TaskFilter](API_TaskFilter.md) 物件陣列必要：否 ** [MaxResults](#API_ListTasks_RequestSyntax) ** 要傳回的任務數量上限。類型：整數有效範圍：最小值為 0。最大值為 100。必要：否 ** [NextToken](#API_ListTasks_RequestSyntax) ** 不透明字串，指出開始下一個任務清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` 必要：否 ## 回應語法 ``` { "NextToken": "string", "Tasks": [ { "Name": "string", "Status": "string", "TaskArn": "string", "TaskMode": "string" } ] } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [NextToken](#API_ListTasks_ResponseSyntax) ** 不透明字串，指出開始傳回下一個任務清單的位置。類型：字串長度限制：長度上限為 65535。模式：`[a-zA-Z0-9=_-]+` ** [Tasks](#API_ListTasks_ResponseSyntax) ** 傳回的所有任務清單。類型：[TaskListEntry](API_TaskListEntry.md) 物件陣列 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTasks) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/ListTasks) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/ListTasks) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTasks) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTasks) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/ListTasks) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/ListTasks) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTasks) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/ListTasks) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/ListTasks) # StartTaskExecution 啟動 AWS DataSync 傳輸任務。對於每個任務，您一次只能執行一個任務執行。任務執行有幾個步驟。如需詳細資訊，請參閱[任務執行狀態](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-task-execution-statuses)。 **重要** 如果您打算在 Amazon S3 位置之間傳輸資料，請在開始之前檢閱 [ DataSync 如何影響您的 S3 請求費用](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)和 [DataSync 定價頁面](https://aws.amazon.com/datasync/pricing/)。 ## 請求語法 ``` { "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "OverrideOptions": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "TaskArn": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [Excludes](#API_StartTaskExecution_RequestSyntax) ** 指定篩選條件規則清單，以決定要從任務中排除哪些檔案。清單包含單一篩選字串，其中包含要排除的模式。模式以 "\$1" (也就是管道) 分隔，例如 `"/folder1|/folder2"`。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。必要：否 ** [Includes](#API_StartTaskExecution_RequestSyntax) ** 指定篩選條件規則清單，以決定執行任務時要包含哪些檔案。模式應包含單一篩選條件字串，其中包含要包含的模式。模式以 "\$1" (也就是管道) 分隔，例如 `"/folder1|/folder2"`。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。必要：否 ** [ManifestConfig](#API_StartTaskExecution_RequestSyntax) ** 設定資訊清單，這是您希望 DataSync 傳輸的檔案或物件清單。如需詳細資訊和組態範例，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。使用此參數時，您的呼叫者身分（與 DataSync 搭配使用的角色）必須具有 `iam:PassRole`許可。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) 政策包含此許可。若要移除資訊清單組態，請以空值指定此參數。類型：[ManifestConfig](API_ManifestConfig.md) 物件必要：否 ** [OverrideOptions](#API_StartTaskExecution_RequestSyntax) ** 指出傳輸任務的設定方式。這些選項包括 DataSync 如何在傳輸期間處理檔案、物件及其相關聯的中繼資料。您也可以指定如何驗證資料完整性、設定任務的頻寬限制，以及其他選項。每個選項都有預設值。除非您需要，否則在呼叫 [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) 之前，您不需要設定任何選項。您也可以覆寫每個任務執行的任務選項。例如，您可能想要調整個別執行`LogLevel`的。類型：[Options](API_Options.md) 物件必要：否 ** [Tags](#API_StartTaskExecution_RequestSyntax) ** 指定您要套用至代表任務執行之 Amazon Resource Name (ARN) 的標籤。 *標籤*是有助於管理、篩選和搜尋 DataSync 資源的鍵值對。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：否 ** [TaskArn](#API_StartTaskExecution_RequestSyntax) ** 指定您要啟動之任務的 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}$` 必要：是 ** [TaskReportConfig](#API_StartTaskExecution_RequestSyntax) ** 指定您要如何設定任務報告，以提供 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱[使用任務報告監控 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。使用此參數時，您的呼叫者身分（與 DataSync 搭配使用的角色）必須具有 `iam:PassRole`許可。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) 政策包含此許可。若要移除任務報告組態，請將此參數指定為空白。類型：[TaskReportConfig](API_TaskReportConfig.md) 物件必要：否 ## 回應語法 ``` { "TaskExecutionArn": "string" } ``` ## 回應元素如果動作成功，則服務傳回 HTTP 200 回應。服務會傳回下列 JSON 格式的資料。 ** [TaskExecutionArn](#API_StartTaskExecution_ResponseSyntax) ** 執行中任務執行的 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}$` ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 範例 ### 請求範例下列範例使用指定任務的預設選項啟動任務執行。 ``` { "OverrideOptions": { "Atime": "BEST_EFFORT", "BytesPerSecond": 1000, "Gid": "NONE", "Mtime": "PRESERVE", "PosixPermissions": "PRESERVE", "PreserveDevices": "NONE", "PreserveDeletedFiles": "PRESERVE", "Uid": "NONE", "VerifyMode": "POINT_IN_TIME_CONSISTENT" }, "TaskArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026" } ``` ### 回應範例此範例說明 StartTaskExecution 的一個用途。 ``` { "TaskExecutionArn": "arn:aws:datasync:us-east-2:111222333444:task/task-08de6e6697796f026/execution/exec-04ce9d516d69bd52f" } ``` ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/StartTaskExecution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/StartTaskExecution) # TagResource 將*標籤*套用至 AWS 資源。標籤是索引鍵/值對，可協助您管理、篩選和搜尋資源。這些 AWS DataSync 資源包括位置、任務和任務執行。 ## 請求語法 ``` { "ResourceArn": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [ResourceArn](#API_TagResource_RequestSyntax) ** 指定要套用標籤之資源的 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|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$` 必要：是 ** [Tags](#API_TagResource_RequestSyntax) ** 指定您要套用至資源的標籤。類型：[TagListEntry](API_TagListEntry.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 50。必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/TagResource) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/TagResource) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/TagResource) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/TagResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TagResource) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/TagResource) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/TagResource) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/TagResource) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/TagResource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/TagResource) # UntagResource 從 AWS 資源移除標籤。 ## 請求語法 ``` { "Keys": [ "string" ], "ResourceArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [Keys](#API_UntagResource_RequestSyntax) ** 指定您要移除之標籤中的索引鍵。類型：字串陣列陣列成員：項目數下限為 1。項目數上限為 50。長度限制：長度下限為 1。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:/-]+$` 必要：是 ** [ResourceArn](#API_UntagResource_RequestSyntax) ** 指定要從中移除標籤之資源的 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|task|location)/(agent|task|loc)-[a-z0-9]{17}(/execution/exec-[a-f0-9]{17})?)|(system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?))$` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UntagResource) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UntagResource) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UntagResource) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UntagResource) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UntagResource) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UntagResource) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UntagResource) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UntagResource) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UntagResource) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UntagResource) # UpdateAgent 更新 AWS DataSync 代理程式的名稱。 ## 請求語法 ``` { "AgentArn": "string", "Name": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArn](#API_UpdateAgent_RequestSyntax) ** 要更新的代理程式的 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](#API_UpdateAgent_RequestSyntax) ** 您要用來設定代理程式的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 Java V2 的開發套件](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateAgent) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateAgent) # UpdateLocationAzureBlob 修改下列您搭配使用的 Microsoft Azure Blob Storage 傳輸位置組態 AWS DataSync。如需詳細資訊，請參閱[使用 Azure Blob Storage 設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html)。 ## 請求語法 ``` { "AccessTier": "string", "AgentArns": [ "string" ], "AuthenticationType": "string", "BlobType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "LocationArn": "string", "SasConfiguration": { "Token": "string" }, "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AccessTier](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定您希望物件或檔案傳輸到的存取層。這僅適用於使用位置做為傳輸目的地時。如需詳細資訊，請參閱[存取層](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)。類型：字串有效值:`HOT | COOL | ARCHIVE` 必要：否 ** [AgentArns](#API_UpdateLocationAzureBlob_RequestSyntax) ** （選用）指定可與 Azure Blob Storage 容器連線之 DataSync 代理程式的 Amazon Resource Name (ARN)。如果您要設定無代理程式跨雲端傳輸，則不需要為此參數指定值。您可以指定多個代理程式。如需詳細資訊，請參閱[使用多個客服人員進行轉接](https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html)。您無法在最初建立代理程式之後，從儲存位置新增或移除代理程式。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [AuthenticationType](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定 DataSync 用來存取 Azure Blob Storage 的身分驗證方法。DataSync 可以使用共用存取簽章 (SAS) 存取 Blob 儲存。類型：字串有效值:`SAS | NONE` 必要：否 ** [BlobType](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定您希望物件或檔案在傳輸到 Azure Blob Storage 時的 Blob 類型。目前，DataSync 僅支援將資料移至 Azure Blob Storage 做為區塊 Blob。如需 Blob 類型的詳細資訊，請參閱 [Azure Blob Storage 文件](https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs)。類型：字串有效值:`BLOCK` 必要：否 ** [CmkSecretConfig](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，例如身分驗證字符或一組憑證，供 DataSync 用來存取特定傳輸位置，以及客戶受管 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的身分驗證字符或一組登入資料，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [LocationArn](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定您要更新的 Azure Blob Storage 傳輸位置的 ARN。類型：字串長度限制：長度上限為 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}$` 必要：是 ** [SasConfiguration](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定允許 DataSync 存取 Azure Blob Storage 的 SAS 組態。類型：[AzureBlobSasConfiguration](API_AzureBlobSasConfiguration.md) 物件必要：否 ** [Subdirectory](#API_UpdateLocationAzureBlob_RequestSyntax) ** 如果您想要將傳輸限制在容器中的虛擬目錄（例如，)，請指定路徑區段`/my/images`。類型：字串長度限制：長度上限為 1024。模式：`^[\p{L}\p{M}\p{Z}\p{S}\p{N}\p{P}\p{C}]*$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationAzureBlob) # UpdateLocationEfs 修改您正在使用的 Amazon EFS 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 Amazon EFS 設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html)。 ## 請求語法 ``` { "AccessPointArn": "string", "FileSystemAccessRoleArn": "string", "InTransitEncryption": "string", "LocationArn": "string", "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AccessPointArn](#API_UpdateLocationEfs_RequestSyntax) ** 指定 DataSync 用來掛載 Amazon EFS 檔案系統的存取點的 Amazon Resource Name (ARN)。如需詳細資訊，請參閱[存取受限的 Amazon EFS 檔案系統](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam)。類型：字串長度限制：長度上限為 128。模式：`(^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):elasticfilesystem:[a-z\-0-9]+:[0-9]{12}:access-point/fsap-[0-9a-f]{8,40}$)|(^$)` 必要：否 ** [FileSystemAccessRoleArn](#API_UpdateLocationEfs_RequestSyntax) ** 指定允許 DataSync 存取 Amazon EFS 檔案系統的 AWS Identity and Access Management (IAM) 角色。如需建立此角色的資訊，請參閱[為 Amazon EFS 檔案系統存取建立 DataSync IAM 角色](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-iam-role)。類型：字串長度限制：長度上限為 2048。模式：`(^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$)|(^$)` 必要：否 ** [InTransitEncryption](#API_UpdateLocationEfs_RequestSyntax) ** 指定當您的 Amazon EFS 檔案系統傳輸資料時，您是否希望 DataSync 使用 Transport Layer Security (TLS) 1.2 加密。如果您使用 `AccessPointArn` 指定存取點或使用 `FileSystemAccessRoleArn` 指定 IAM 角色，則必須將此參數設定為 `TLS1_2`。類型：字串有效值:`NONE | TLS1_2` 必要：否 ** [LocationArn](#API_UpdateLocationEfs_RequestSyntax) ** 指定您要更新的 Amazon EFS 轉移位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [Subdirectory](#API_UpdateLocationEfs_RequestSyntax) ** 為 Amazon EFS 檔案系統指定掛載路徑。這是 DataSync 在檔案系統上讀取或寫入資料的位置（取決於這是來源或目的地位置）。根據預設，DataSync 會使用根目錄（如果您使用提供[存取點](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html))`AccessPointArn`。您也可以使用斜線包含子目錄（例如，`/path/to/folder`)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，就會擲出此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationEfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationEfs) # UpdateLocationFsxLustre 修改您正在使用的 Amazon FSx for Lustre 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 FSx for Lustre 設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html)。 ## 請求語法 ``` { "LocationArn": "string", "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_UpdateLocationFsxLustre_RequestSyntax) ** 指定您要更新之 FSx for Lustre 傳輸位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [Subdirectory](#API_UpdateLocationFsxLustre_RequestSyntax) ** 指定 FSx for Lustre 檔案系統的掛載路徑。路徑可以包含子目錄。當位置用作來源時，DataSync 會從掛載路徑讀取資料。當位置用作目的地時，DataSync 會將資料寫入掛載路徑。如果您未包含此參數，DataSync 會使用檔案系統的根目錄 (`/`)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，就會擲出此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxLustre) # UpdateLocationFsxOntap 修改您搭配使用之 Amazon FSx for NetApp ONTAP 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 FSx for ONTAP 設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html)。 ## 請求語法 ``` { "LocationArn": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_UpdateLocationFsxOntap_RequestSyntax) ** 指定您要更新的 FSx for ONTAP 傳輸位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [Protocol](#API_UpdateLocationFsxOntap_RequestSyntax) ** 指定 DataSync 用來存取 Amazon FSx 檔案系統的資料傳輸通訊協定。類型：[FsxUpdateProtocol](API_FsxUpdateProtocol.md) 物件必要：否 ** [Subdirectory](#API_UpdateLocationFsxOntap_RequestSyntax) ** 指定要在其中傳輸資料的儲存虛擬機器 (SVM) 中檔案共享的路徑。您可以指定接合路徑 (也稱為掛載點)、qtree 路徑 (用於 NFS 檔案共用) 或共用名稱 (用於 SMB 檔案共用)。例如，您的掛載路徑可能是 `/vol1`、`/vol1/tree1` 或 `/share1`。請勿在 SVM 的根磁碟區中指定接合路徑。如需詳細資訊，請參閱《Amazon FSx for NetApp ONTAP 使用者指南》中的[管理 FSx for ONTAP 儲存虛擬機器](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html)。類型：字串長度限制：長度上限為 255。模式：`^[^\u0000\u0085\u2028\u2029\r\n]{1,255}$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxOntap) # UpdateLocationFsxOpenZfs 修改您正在使用的 Amazon FSx for OpenZFS 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 FSx for OpenZFS 設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html)。 **注意** `UpdateLocationFsxOpenZfs` 操作`SMB`不支援與相關的請求參數。 ## 請求語法 ``` { "LocationArn": "string", "Protocol": { "NFS": { "MountOptions": { "Version": "string" } }, "SMB": { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "ManagedSecretConfig": { "SecretArn": "string" }, "MountOptions": { "Version": "string" }, "Password": "string", "User": "string" } }, "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_UpdateLocationFsxOpenZfs_RequestSyntax) ** 指定您要更新的 FSx for OpenZFS 傳輸位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [Protocol](#API_UpdateLocationFsxOpenZfs_RequestSyntax) ** 指定 AWS DataSync 用於存取 Amazon FSx 檔案系統的資料傳輸通訊協定。類型：[FsxProtocol](API_FsxProtocol.md) 物件必要：否 ** [Subdirectory](#API_UpdateLocationFsxOpenZfs_RequestSyntax) ** 指定位置路徑中必須以開頭的子目錄`/fsx`。DataSync 會使用此子目錄來讀取或寫入資料 (視檔案系統是來源還是目的地位置而定)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs) # UpdateLocationFsxWindows 修改您搭配使用之 Amazon FSx for Windows File Server 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 FSx for Windows File Server 設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html)。 ## 請求語法 ``` { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "LocationArn": "string", "Password": "string", "Subdirectory": "string", "User": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [CmkSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的一組`Password`或一組登入資料，以及客戶受管的登入資料 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的 `Password`或一組登入資料，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [Domain](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定 FSx for Windows File Server 檔案系統所屬的 Windows 網域名稱。如果您的環境中有多個 Active Directory 網域，請設定此參數可確保 DataSync 連線至正確的檔案系統。類型：字串長度限制：長度上限為 253。模式：`^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$` 必要：否 ** [LocationArn](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定您要更新的 FSx for Windows File Server 傳輸位置的 ARN。類型：字串長度限制：長度上限為 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}$` 必要：是 ** [Password](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定具有許可的使用者密碼，以掛載和存取 FSx for Windows File Server 檔案系統中的檔案、資料夾和檔案中繼資料。類型：字串長度限制：長度上限為 104。模式：`^.{0,104}$` 必要：否 ** [Subdirectory](#API_UpdateLocationFsxWindows_RequestSyntax) ** 使用正斜線指定檔案系統的掛載路徑。DataSync 會使用此子目錄來讀取或寫入資料 (視檔案系統是來源還是目的地位置而定)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ** [User](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定具有許可的使用者，以掛載和存取 FSx for Windows File Server 檔案系統中的檔案、資料夾和檔案中繼資料。如需選擇具有適當層級傳輸存取權之使用者的相關資訊，請參閱 FSx for Windows File Server 位置[的必要許可](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions)。類型：字串長度限制：長度上限為 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationFsxWindows) # UpdateLocationHdfs 修改您使用的 Hadoop 分散式檔案系統 (HDFS) 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 HDFS 叢集設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html)。 ## 請求語法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "BlockSize": number, "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "KmsKeyProviderUri": "string", "LocationArn": "string", "NameNodes": [ { "Hostname": "string", "Port": number } ], "QopConfiguration": { "DataTransferProtection": "string", "RpcProtection": "string" }, "ReplicationFactor": number, "SimpleUser": "string", "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArns](#API_UpdateLocationHdfs_RequestSyntax) ** 可連線至 HDFS 叢集之 DataSync 代理程式的 Amazon Resource Name (ARNs)。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [AuthenticationType](#API_UpdateLocationHdfs_RequestSyntax) ** 用來判斷使用者身分的身分驗證類型。類型：字串有效值:`SIMPLE | KERBEROS` 必要：否 ** [BlockSize](#API_UpdateLocationHdfs_RequestSyntax) ** 要寫入 HDFS 叢集的資料區塊大小。類型：整數有效範圍：最小值為 1048576。最大值為 1073741824。必要：否 ** [CmkSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的一組`KerberosKeytab`或一組登入資料，以及客戶受管的登入資料 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) ** 指定客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的 `KerberosKeytab`或一組登入資料，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [KerberosKeytab](#API_UpdateLocationHdfs_RequestSyntax) ** 此為 Kerberos 金鑰資料表 (keytab)，其中包含已定義 Kerberos 主體與已加密金鑰之間的映射。您可以透過提供檔案的地址，從檔案載入 keytab。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 65536。必要：否 ** [KerberosKrb5Conf](#API_UpdateLocationHdfs_RequestSyntax) ** 包含 Kerberos 組態資訊的 `krb5.conf` 檔案。您可以透過提供`krb5.conf`檔案的地址來載入檔案。如果您使用的是 AWS CLI，它會為您執行 base64 編碼。否則，請提供 base64 編碼的文字。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 131072。必要：否 ** [KerberosPrincipal](#API_UpdateLocationHdfs_RequestSyntax) ** 此為 Kerberos 主體，有權存取 HDFS 叢集上的檔案和資料夾。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^.+$` 必要：否 ** [KmsKeyProviderUri](#API_UpdateLocationHdfs_RequestSyntax) ** HDFS 叢集金鑰管理伺服器 (KMS) 的 URI。類型：字串長度限制：長度下限為 1。長度上限為 255。模式：`^kms:\/\/http[s]?@(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9])(;(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-]*[A-Za-z0-9]))*:[0-9]{1,5}\/kms$` 必要：否 ** [LocationArn](#API_UpdateLocationHdfs_RequestSyntax) ** 來源 HDFS 叢集位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [NameNodes](#API_UpdateLocationHdfs_RequestSyntax) ** 管理 HDFS 命名空間的 NameNode。該 NameNode 會執行開啟、關閉以及重新命名檔案和目錄等操作。該 NameNode 包含將資料區塊映射到 DataNode 的資訊。您只能使用一個 NameNode。類型：[HdfsNameNode](API_HdfsNameNode.md) 物件陣列陣列成員：項目數下限為 1。必要：否 ** [QopConfiguration](#API_UpdateLocationHdfs_RequestSyntax) ** 保護品質 (QOP) 組態可指定 Hadoop 分散式檔案系統 (HDFS) 叢集上設定的遠端程序呼叫 (RPC) 和資料傳輸隱私權設定。類型：[QopConfiguration](API_QopConfiguration.md) 物件必要：否 ** [ReplicationFactor](#API_UpdateLocationHdfs_RequestSyntax) ** 寫入至 HDFS 叢集時要將資料複製到其中的 DataNode 數目。類型：整數有效範圍：最小值為 1。最大值為 512。必要：否 ** [SimpleUser](#API_UpdateLocationHdfs_RequestSyntax) ** 用於識別主機作業系統上用戶端的使用者名稱。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^[_.A-Za-z0-9][-_.A-Za-z0-9]*$` 必要：否 ** [Subdirectory](#API_UpdateLocationHdfs_RequestSyntax) ** HDFS 叢集中的子目錄。此子目錄用於從 HDFS 叢集讀取資料或將資料寫入至其中。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationHdfs) # UpdateLocationNfs 修改下列與搭配使用之網路檔案系統 (NFS) 傳輸位置的組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 NFS 檔案伺服器設定傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html)。 ## 請求語法 ``` { "LocationArn": "string", "MountOptions": { "Version": "string" }, "OnPremConfig": { "AgentArns": [ "string" ] }, "ServerHostname": "string", "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_UpdateLocationNfs_RequestSyntax) ** 指定您要更新的 NFS 傳輸位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [MountOptions](#API_UpdateLocationNfs_RequestSyntax) ** 指定 DataSync 如何使用 NFS 通訊協定存取位置。類型：[NfsMountOptions](API_NfsMountOptions.md) 物件必要：否 ** [OnPremConfig](#API_UpdateLocationNfs_RequestSyntax) ** 可連線至網路檔案系統 (NFS) 檔案伺服器的 AWS DataSync 代理程式。類型：[OnPremConfig](API_OnPremConfig.md) 物件必要：否 ** [ServerHostname](#API_UpdateLocationNfs_RequestSyntax) ** 指定 DataSync 代理程式連線之 NFS 檔案伺服器的 DNS 名稱或 IP 地址 (IPv4 或 IPv6)。類型：字串長度限制：長度上限為 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必要：否 ** [Subdirectory](#API_UpdateLocationNfs_RequestSyntax) ** 指定 NFS 檔案伺服器中您希望 DataSync 掛載的匯出路徑。此路徑（或路徑的子目錄）是 DataSync 往返傳輸資料的位置。如需設定 DataSync 匯出的資訊，請參閱[存取 NFS 檔案伺服器](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]+$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationNfs) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationNfs) # UpdateLocationObjectStorage 修改您正在使用之物件儲存體傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用物件儲存系統設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html)。 ## 請求語法 ``` { "AccessKey": "string", "AgentArns": [ "string" ], "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "LocationArn": "string", "SecretKey": "string", "ServerCertificate": blob, "ServerHostname": "string", "ServerPort": number, "ServerProtocol": "string", "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AccessKey](#API_UpdateLocationObjectStorage_RequestSyntax) ** 如果需要憑證才能與物件儲存伺服器進行驗證，請指定存取金鑰 (例如，使用者名稱)。類型：字串長度限制：長度下限為 0。長度上限為 200。模式：`^.*$` 必要：否 ** [AgentArns](#API_UpdateLocationObjectStorage_RequestSyntax) ** （選用）指定可與物件儲存系統連線之 DataSync 代理程式的 Amazon Resource Name (ARNs)。如果您要設定無代理程式跨雲端傳輸，則不需要為此參數指定值。您無法在最初建立代理程式之後，從儲存位置新增或移除代理程式。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [CmkSecretConfig](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，例如身分驗證字符或一組憑證，供 DataSync 用來存取特定傳輸位置，以及客戶受管 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的身分驗證字符或一組登入資料，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [LocationArn](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定您要更新之物件儲存系統位置的 ARN。類型：字串長度限制：長度上限為 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}$` 必要：是 ** [SecretKey](#API_UpdateLocationObjectStorage_RequestSyntax) ** 如果需要憑證才能與物件儲存伺服器進行驗證，請指定私密金鑰 (例如，密碼)。如果您使用提供秘密`SecretKey`，但未使用 `CmkSecretConfig`或提供秘密組態詳細資訊`CustomSecretConfig`，則 DataSync 會使用您 AWS 帳戶的 Secrets Manager 秘密來存放字符。類型：字串長度限制：長度下限為 0。長度上限為 200。模式：`^.*$` 必要：否 ** [ServerCertificate](#API_UpdateLocationObjectStorage_RequestSyntax) ** 如果系統使用私有或自我簽署憑證授權單位 (CA)，則指定 DataSync 的憑證鏈來驗證物件儲存系統。您必須指定具有完整憑證鏈的單一`.pem`檔案（例如 `file:///home/user/.ssh/object_storage_certificates.pem`)。憑證鏈可能包括： + 物件儲存系統的憑證 + 所有中繼憑證（如果有的話） + 簽署 CA 的根憑證您可以將憑證串連至`.pem`檔案（在 base64 編碼之前最多可達 32768 個位元組）。下列範例`cat`命令會建立包含三個憑證`object_storage_certificates.pem`的檔案： `cat object_server_certificate.pem intermediate_certificate.pem ca_root_certificate.pem > object_storage_certificates.pem` 若要使用此參數，請將 `ServerProtocol`設定為 `HTTPS`。更新此參數不會影響您正在進行的任務。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 32768。必要：否 ** [ServerHostname](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定 DataSync 代理程式連線之物件儲存伺服器的網域名稱或 IP 地址 (IPv4 或 IPv6)。類型：字串長度限制：長度上限為 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必要：否 ** [ServerPort](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定物件儲存伺服器接受傳入網路流量的連接埠 (例如，連接埠 443)。類型：整數有效範圍：最小值為 1。最大值為 65536。必要：否 ** [ServerProtocol](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定物件儲存伺服器用來通訊的通訊協定。類型：字串有效值:`HTTPS | HTTP` 必要：否 ** [Subdirectory](#API_UpdateLocationObjectStorage_RequestSyntax) ** 指定物件儲存伺服器的物件字首。如果這是來源位置，DataSync 只會複製具有此字首的物件。如果這是目的地位置，DataSync 會寫入具有此字首的所有物件。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationObjectStorage) # UpdateLocationS3 修改您搭配使用的 Amazon S3 傳輸位置的下列組態參數 AWS DataSync。 **重要** 開始之前，請確定您已閱讀下列主題： [Amazon S3 位置的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes) [使用 DataSync 時評估 S3 請求成本](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests) ## 請求語法 ``` { "LocationArn": "string", "S3Config": { "BucketAccessRoleArn": "string" }, "S3StorageClass": "string", "Subdirectory": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [LocationArn](#API_UpdateLocationS3_RequestSyntax) ** 指定您要更新的 Amazon S3 傳輸位置的 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}:location/loc-[0-9a-z]{17}$` 必要：是 ** [S3Config](#API_UpdateLocationS3_RequestSyntax) ** 指定 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)。類型：[S3Config](API_S3Config.md) 物件必要：否 ** [S3StorageClass](#API_UpdateLocationS3_RequestSyntax) ** 指定當 Amazon S3 是傳輸目的地時，您希望物件使用的儲存體方案。對於中的儲存貯體 AWS 區域，儲存類別預設為 `STANDARD`。對於上的儲存貯體 AWS Outposts，儲存體方案預設為 `OUTPOSTS`。如需詳細資訊，請參閱 [Amazon S3 傳輸的儲存類別考量](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)。類型：字串有效值:`STANDARD | STANDARD_IA | ONEZONE_IA | INTELLIGENT_TIERING | GLACIER | DEEP_ARCHIVE | OUTPOSTS | GLACIER_INSTANT_RETRIEVAL` 必要：否 ** [Subdirectory](#API_UpdateLocationS3_RequestSyntax) ** 在 DataSync 讀取或寫入的 S3 儲存貯體中指定字首（取決於儲存貯體是來源或目的地位置）。 DataSync 無法傳輸字首開頭為斜線 (`/`) 或包含 `//`、 `/./`或 `/../` 模式的物件。例如： + `/photos` + `photos//2006/January` + `photos/./2006/February` + `photos/../2006/March` 類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\p{Zs}]*$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationS3) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationS3) # UpdateLocationSmb 修改與搭配使用之伺服器訊息區塊 (SMB) 傳輸位置的下列組態參數 AWS DataSync。如需詳細資訊，請參閱[使用 SMB 檔案伺服器設定 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html)。 ## 請求語法 ``` { "AgentArns": [ "string" ], "AuthenticationType": "string", "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "DnsIpAddresses": [ "string" ], "Domain": "string", "KerberosKeytab": blob, "KerberosKrb5Conf": blob, "KerberosPrincipal": "string", "LocationArn": "string", "MountOptions": { "Version": "string" }, "Password": "string", "ServerHostname": "string", "Subdirectory": "string", "User": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [AgentArns](#API_UpdateLocationSmb_RequestSyntax) ** 指定可連線至 SMB 檔案伺服器的 DataSync 代理程式（或代理程式）。您可以使用代理程式的 Amazon Resource Name (ARN) 來指定代理程式。類型：字串陣列陣列成員：項目數下限為 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}$` 必要：否 ** [AuthenticationType](#API_UpdateLocationSmb_RequestSyntax) ** 指定 DataSync 用來連線至 SMB 檔案伺服器的身分驗證通訊協定。DataSync 支援 `NTLM`（預設）和`KERBEROS`身分驗證。如需詳細資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。類型：字串有效值:`NTLM | KERBEROS` 必要：否 ** [CmkSecretConfig](#API_UpdateLocationSmb_RequestSyntax) ** 指定 DataSync 受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的 `Password` 或 `KerberosKeytab` 或一組登入資料，以及客戶受管的登入資料 AWS KMS key。類型：[CmkSecretConfig](API_CmkSecretConfig.md) 物件必要：否 ** [CustomSecretConfig](#API_UpdateLocationSmb_RequestSyntax) ** 指定客戶受管秘密的組態資訊，例如 DataSync 用來存取特定傳輸位置的 `Password` 或 `KerberosKeytab` 或一組登入資料，以及提供秘密存取權的客戶受管 AWS Identity and Access Management (IAM) 角色。類型：[CustomSecretConfig](API_CustomSecretConfig.md) 物件必要：否 ** [DnsIpAddresses](#API_UpdateLocationSmb_RequestSyntax) ** 指定 SMB 檔案伺服器所屬 DNS 伺服器的 IP 地址 (IPv4 或 IPv6)。此參數僅適用於 `AuthenticationType` 設定為的情況`KERBEROS`。如果您的環境中有多個網域，設定此參數可確保 DataSync 連線至正確的 SMB 檔案伺服器。類型：字串陣列陣列成員：最多 2 個項目。長度限制：長度下限為 7。長度上限為 39。模式：`\A((25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}|([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}))\z` 必要：否 ** [Domain](#API_UpdateLocationSmb_RequestSyntax) ** 指定 SMB 檔案伺服器所屬的 Windows 網域名稱。此參數僅適用於 `AuthenticationType` 設為的情況`NTLM`。如果您的環境中有多個網域，設定此參數可確保 DataSync 連線至正確的檔案伺服器。類型：字串長度限制：長度上限為 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 必要：否 ** [KerberosKeytab](#API_UpdateLocationSmb_RequestSyntax) ** 指定您的 Kerberos 金鑰資料表 (keytab) 檔案，其中包含 Kerberos 主體和加密金鑰之間的映射。為了避免任務執行錯誤，請確定您用來建立 keytab 檔案的 Kerberos 主體與您為指定的完全相符`KerberosPrincipal`。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 65536。必要：否 ** [KerberosKrb5Conf](#API_UpdateLocationSmb_RequestSyntax) ** 指定定義 Kerberos 領域組態的 Kerberos 組態檔案 (`krb5.conf`)。檔案必須為 base64 編碼。如果您使用的是 AWS CLI，編碼會為您完成。類型：Base64 編碼的二進位資料物件長度限制：長度上限為 131072。必要：否 ** [KerberosPrincipal](#API_UpdateLocationSmb_RequestSyntax) ** 指定 Kerberos 權限，這是 Kerberos 領域中的身分，有權存取 SMB 檔案伺服器中的檔案、資料夾和檔案中繼資料。 Kerberos 主體可能看起來像 `HOST/kerberosuser@MYDOMAIN.ORG`。主體名稱區分大小寫。如果您為此參數指定的委託人與您用來建立 keytab 檔案的委託人不完全相符，您的 DataSync 任務執行將會失敗。類型：字串長度限制：長度下限為 1。長度上限為 256。模式：`^.+$` 必要：否 ** [LocationArn](#API_UpdateLocationSmb_RequestSyntax) ** 指定您要更新的 SMB 位置 ARN。類型：字串長度限制：長度上限為 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}$` 必要：是 ** [MountOptions](#API_UpdateLocationSmb_RequestSyntax) ** 指定 AWS DataSync 用來存取 SMB 檔案伺服器的伺服器訊息區塊 (SMB) 通訊協定版本。類型：[SmbMountOptions](API_SmbMountOptions.md) 物件必要：否 ** [Password](#API_UpdateLocationSmb_RequestSyntax) ** 指定可掛載 SMB 檔案伺服器的使用者的密碼，並具有存取傳輸所涉及檔案和資料夾的許可。此參數僅適用於 `AuthenticationType` 設為的情況`NTLM`。類型：字串長度限制：長度上限為 104。模式：`^.{0,104}$` 必要：否 ** [ServerHostname](#API_UpdateLocationSmb_RequestSyntax) ** 指定 DataSync 代理程式連線之 SMB 檔案伺服器的網域名稱或 IP 地址 (IPv4 或 IPv6)。如果您使用 Kerberos 身分驗證，則必須指定網域名稱。類型：字串長度限制：長度上限為 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 必要：否 ** [Subdirectory](#API_UpdateLocationSmb_RequestSyntax) ** 指定由 SMB 檔案伺服器匯出的共用名稱，DataSync 會在其中讀取或寫入資料。您可以在共用路徑中包含子目錄（例如，`/path/to/subdirectory`)。請確定您網路中的其他 SMB 用戶端也可以掛載此路徑。若要複製指定子目錄中的所有資料，DataSync 必須能夠掛載 SMB 共用並存取其所有資料。如需詳細資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。類型：字串長度限制：長度上限為 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必要：否 ** [User](#API_UpdateLocationSmb_RequestSyntax) ** 指定可掛載 SMB 檔案伺服器的使用者名稱，並具有存取傳輸所涉及檔案和資料夾的許可。此參數僅適用於 `AuthenticationType` 設為的情況`NTLM`。如需有關選擇具有適當層級傳輸存取權之使用者的資訊，請參閱[提供 SMB 檔案伺服器的 DataSync 存取權](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。類型：字串長度限制：長度上限為 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` 必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateLocationSmb) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateLocationSmb) # UpdateTask 更新*任務*的組態，這會定義 AWS DataSync 資料傳輸的位置和方式。 ## 請求語法 ``` { "CloudWatchLogGroupArn": "string", "Excludes": [ { "FilterType": "string", "Value": "string" } ], "Includes": [ { "FilterType": "string", "Value": "string" } ], "ManifestConfig": { "Action": "string", "Format": "string", "Source": { "S3": { "BucketAccessRoleArn": "string", "ManifestObjectPath": "string", "ManifestObjectVersionId": "string", "S3BucketArn": "string" } } }, "Name": "string", "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "Schedule": { "ScheduleExpression": "string", "Status": "string" }, "TaskArn": "string", "TaskReportConfig": { "Destination": { "S3": { "BucketAccessRoleArn": "string", "S3BucketArn": "string", "Subdirectory": "string" } }, "ObjectVersionIds": "string", "OutputType": "string", "Overrides": { "Deleted": { "ReportLevel": "string" }, "Skipped": { "ReportLevel": "string" }, "Transferred": { "ReportLevel": "string" }, "Verified": { "ReportLevel": "string" } }, "ReportLevel": "string" } } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [CloudWatchLogGroupArn](#API_UpdateTask_RequestSyntax) ** 指定 Amazon CloudWatch 日誌群組的 Amazon Resource Name (ARN)，以監控您的任務。對於增強型模式任務，您必須使用 `/aws/datasync`做為日誌群組名稱。例如： `arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*` 如需詳細資訊，請參閱[使用 CloudWatch Logs 監控資料傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/configure-logging.html)。類型：字串長度限制：長度上限為 562。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$` 必要：否 ** [Excludes](#API_UpdateTask_RequestSyntax) ** 指定排除篩選條件，以定義您不希望 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。必要：否 ** [Includes](#API_UpdateTask_RequestSyntax) ** 指定包含篩選條件，以定義您要 DataSync 傳輸之來源位置中的檔案、物件和資料夾。如需詳細資訊和範例，請參閱[使用篩選條件指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html)。類型：[FilterRule](API_FilterRule.md) 物件陣列陣列成員：項目數下限為 0。項目數上限為 1。必要：否 ** [ManifestConfig](#API_UpdateTask_RequestSyntax) ** 設定資訊清單，這是您希望 DataSync 傳輸的檔案或物件清單。如需詳細資訊和組態範例，請參閱[使用資訊清單指定 DataSync 傳輸的內容](https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html)。使用此參數時，您的呼叫者身分（與 DataSync 搭配使用的 IAM 角色）必須具有 `iam:PassRole`許可。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) 政策包含此許可。若要移除資訊清單組態，請將此參數指定為空白。類型：[ManifestConfig](API_ManifestConfig.md) 物件必要：否 ** [Name](#API_UpdateTask_RequestSyntax) ** 指定任務的名稱。類型：字串長度限制：長度下限為 0。長度上限為 256。模式：`^[a-zA-Z0-9\s+=._:@/-]+$` 必要：否 ** [Options](#API_UpdateTask_RequestSyntax) ** 指出傳輸任務的設定方式。這些選項包括 DataSync 如何在傳輸期間處理檔案、物件及其相關聯的中繼資料。您也可以指定如何驗證資料完整性、設定任務的頻寬限制，以及其他選項。每個選項都有預設值。除非需要，否則您不需要在呼叫 [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) 之前設定任何選項。您也可以覆寫每個任務執行的任務選項。例如，您可能想要調整個別執行`LogLevel`的。類型：[Options](API_Options.md) 物件必要：否 ** [Schedule](#API_UpdateTask_RequestSyntax) ** 指定您希望任務何時執行的排程。如需詳細資訊，請參閱[任務排程](https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html)。類型：[TaskSchedule](API_TaskSchedule.md) 物件必要：否 ** [TaskArn](#API_UpdateTask_RequestSyntax) ** 指定您要更新之任務的 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}$` 必要：是 ** [TaskReportConfig](#API_UpdateTask_RequestSyntax) ** 指定您要如何設定任務報告，以提供 DataSync 傳輸的詳細資訊。如需詳細資訊，請參閱[使用任務報告監控 DataSync 傳輸](https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html)。使用此參數時，您的呼叫者身分（與 DataSync 搭配使用的 IAM 角色）必須具有 `iam:PassRole`許可。[AWSDataSyncFullAccess](https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess) 政策包含此許可。若要移除任務報告組態，請將此參數指定為空白。類型：[TaskReportConfig](API_TaskReportConfig.md) 物件必要：否 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤時，就會擲出此 AWS DataSync 例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateTask) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateTask) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateTask) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateTask) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateTask) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateTask) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateTask) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateTask) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateTask) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateTask) # UpdateTaskExecution 更新執行中 AWS DataSync 任務執行的組態。 **注意** 目前，`Option`您只能使用 `UpdateTaskExecution` 修改 ` [BytesPerSecond](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond) `，這會調節執行中或佇列任務執行的頻寬。 ## 請求語法 ``` { "Options": { "Atime": "string", "BytesPerSecond": number, "Gid": "string", "LogLevel": "string", "Mtime": "string", "ObjectTags": "string", "OverwriteMode": "string", "PosixPermissions": "string", "PreserveDeletedFiles": "string", "PreserveDevices": "string", "SecurityDescriptorCopyFlags": "string", "TaskQueueing": "string", "TransferMode": "string", "Uid": "string", "VerifyMode": "string" }, "TaskExecutionArn": "string" } ``` ## 請求參數如需所有動作的一般參數資訊，請參閱《[Common Parameters](CommonParameters.md)》。請求接受採用 JSON 格式的下列資料。 ** [Options](#API_UpdateTaskExecution_RequestSyntax) ** 指出傳輸任務的設定方式。這些選項包括 DataSync 如何在傳輸期間處理檔案、物件及其相關聯的中繼資料。您也可以指定如何驗證資料完整性、設定任務的頻寬限制，以及其他選項。每個選項都有預設值。除非您需要，否則在呼叫 [StartTaskExecution](https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) 之前，您不需要設定任何選項。您也可以覆寫每個任務執行的任務選項。例如，您可能想要調整個別執行`LogLevel`的。類型：[Options](API_Options.md) 物件必要：是 ** [TaskExecutionArn](#API_UpdateTaskExecution_RequestSyntax) ** 指定您要更新之任務執行的 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}$` 必要：是 ## 回應元素如果動作成功，則服務會傳回具空 HTTP 內文的 HTTP 200 回應。 ## 錯誤如需所有動作常見錯誤的資訊，請參閱[常見錯誤](CommonErrors.md)。 ** InternalException ** 當服務發生錯誤 AWS DataSync 時，會擲回此例外狀況。 HTTP 狀態碼：500 ** InvalidRequestException ** 當用戶端提交格式不正確的請求時，會擲回此例外狀況。 HTTP 狀態碼：400 ## 另請參閱如需在其中一種語言特定 AWS SDKs中使用此 API 的詳細資訊，請參閱下列內容： + [AWS 命令列界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 .NET V4 的 SDK](https://docs.aws.amazon.com/goto/DotNetSDKV4/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 Go 的 SDK v2](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 Java V2 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 JavaScript V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 PHP V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 Python 的 SDK](https://docs.aws.amazon.com/goto/boto3/datasync-2018-11-09/UpdateTaskExecution) + [AWS 適用於 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/datasync-2018-11-09/UpdateTaskExecution)