本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # 操作支持以下操作： + [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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [TaskExecutionArn](#API_CancelTaskExecution_RequestSyntax) ** 要停止执行任务的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CancelTaskExecution) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CancelTaskExecution) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CancelTaskExecution) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CancelTaskExecution) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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) ** 指定允许代理与 VPC 服务端点之间流量的安全组的 Amazon 资源名称（ARN）。您只能指定一个 ARN。类型：字符串数组数组成员：固定数量为 1 项。长度限制：最大长度为 128。模式：`^arn:(aws|aws-cn|aws-us-gov|aws-eusc|aws-iso|aws-iso-b):ec2:[a-z\-0-9]*:[0-9]{12}:security-group/sg-[a-f0-9]+$` 必需：否 ** [SubnetArns](#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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateAgent) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateAgent) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateAgent) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateAgent) + [AWS Python 软件开发工具包](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 为微软 Azure Blob 存储容器创建传输*位置*。 AWS DataSync 可以将此位置用作传输源或目的地。无论是否有连接到您的集装箱的[DataSync 代理](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent)，您都可以进行转账。在开始之前，请务必知道[如何 DataSync 访问 Azure Blob 存储空间](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)和 b [lo](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types) b 类型。 ## 请求语法 ``` { "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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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 存储容器连接的 DataSync 代理的亚马逊资源名称 (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) ** 指定用于访问你的 Azure Blob 存储空间的身份验证方法 DataSync 。 DataSync 可以使用共享访问签名 (SAS) 访问 blob 存储。类型：字符串有效值：`SAS | NONE` 是否必需：是 ** [BlobType](#API_CreateLocationAzureBlob_RequestSyntax) ** 指定在将对象或文件传输到 Azure Blob Storage 时想要的 blob 类型。目前， DataSync 仅支持将数据作为块 blob 移动到 Azure 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 AWS KMS key管理的密钥的配置信息，其中包括 DataSync 用于访问特定 AzureBlob存储位置的身份验证令牌。当您在`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 存储空间的 SAS 配置。如果您使用提供身份验证令牌`SasConfiguration`，但不使用`CmkSecretConfig`或提供密钥配置详细信息`CustomSecretConfig`，则使用您 AWS 账户的密钥管理器密钥 DataSync 存储令牌。类型：[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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationAzureBlob) + [AWS Python 软件开发工具包](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AccessPointArn](#API_CreateLocationEfs_RequestSyntax) ** 指定用于挂载 Amazon EFS 文件系统的接入点的 DataSync 亚马逊资源名称 (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) ** 指定用于连接您的 Amazon EFS 文件系统的其中一个[挂载目标](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)的子网和安全组 DataSync 。类型：[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) ** 指定在传输层安全 (TLS) 1.2 加密与您的 Amazon EFS 文件系统之间传输数据时，是否要使用传输层安全 (TLS) 1.2 加密。 DataSync 如果您使用 `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 资源名称（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 文件系统创建位置。在这种情况下，您可能需要在请求中指定 `AccessPointArn`、`FileSystemAccessRoleArn`、和 `InTransitEncryption` 的值。 ``` { "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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationEfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationEfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationEfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationEfs) + [AWS Python 软件开发工具包](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 可以将此位置用作传输数据的源或目的地。在开始之前，请务必了解 [Lustre 文件 FSx 系统的 DataSync访问](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [FsxFilesystemArn](#API_CreateLocationFsxLustre_RequestSyntax) ** 指定 for Lustre 文件系统的亚马逊资源名称 (ARN)。 FSx 类型：字符串长度限制：最大长度为 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 资源名称 (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) ** 您创建的 for Lustre 文件系统位置 FSx 的亚马逊资源名称 (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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxLustre) + [AWS Python 软件开发工具包](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 可以将此位置用作传输数据的源或目的地。在开始之前，请务必了解 [ONTAP 文件 FSx 系统的 DataSync访问](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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 FSx for ONTAP 用户指南》中的管理 NetApp 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) ** 指定您创建的 ONTAP 文件系统位置的 ARN。 FSx 类型：字符串长度限制：最大长度为 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOntap) + [AWS Python 软件开发工具包](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 为亚马逊 FSx 版 OpenZFS 文件系统创建传输*位置*。 AWS DataSync 可以将此位置用作传输数据的源或目的地。在开始之前，请务必了解 [OpenZFS 文件 FSx 系统的 DataSync访问](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [FsxFilesystemArn](#API_CreateLocationFsxOpenZfs_RequestSyntax) ** FSx 适用于 OpenZFS 的文件系统的亚马逊资源名称 (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) ** 用于为 ARNs OpenZFS 文件系统配置的安全组。 FSx 类型：字符串数组数组成员：最少 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) ** 您创建的 OpenZFS 文件系统位置的 ARN。 FSx 类型：字符串长度限制：最大长度为 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxOpenZfs) + [AWS Python 软件开发工具包](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 FSx 为亚马逊 Windows 文件服务器文件系统创建传输*位置*。 AWS DataSync 可以将此位置用作传输数据的源或目的地。在开始之前，请务必了解 [Windows 文件服务器文件系统的 DataSync访问 FSx ](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [CmkSecretConfig](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定由客户 DataSync AWS KMS key管理的密钥的配置信息，其中包括 DataSync 用于访问特定 FSx Windows 存储位置的密码。当您在`CreateLocationFsxWindows`请求中包含此参数时，您仅提供 KMS 密钥 ARN。 DataSync 使用此 KMS 密钥和`Password`您为指定的密钥来创建存储位置访问凭证的 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) ** 指定客户管理的 Secr FSx ets Manager 密钥的配置信息，其中 Windows 文件服务器存储位置的密码以纯文本形式存储在 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) ** 指定 Windows 文件服务器文件系统所属 FSx 的 Windows 域的名称。如果您的环境中有多个 Active Directory 域，则配置此参数可确保这些域 DataSync 连接到正确的文件系统。类型：字符串长度约束：最大长度为 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` 必需：否 ** [FsxFilesystemArn](#API_CreateLocationFsxWindows_RequestSyntax) ** 为 Windows 文件服务器文件系统指定亚马逊资源名称 (ARN)。 FSx 类型：字符串长度限制：最大长度为 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 的 Windows 文件服务器文件系统中的文件、文件夹和文件元数据的用户的密码。类型：字符串长度约束：最大长度为 104。模式：`^.{0,104}$` 必需：否 ** [SecurityGroupArns](#API_CreateLocationFsxWindows_RequestSyntax) ** 指定提供对文件系统首选子网访问权限的 Amazon EC2 安全组的 ARN。您指定的安全组必须能够与文件系统的安全组通信。有关为文件系统访问配置安全组的信息，请参阅《[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 的 Windows 文件服务器文件系统中的文件、文件夹和文件元数据的用户。有关选择具有适当访问权限级别的用户进行传输的信息，请参阅 Windows 文件服务器位置[ FSx 所需的权限](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) ** 您创建的 Windows 文件服务器文件系统位置的 ARN。 FSx 类型：字符串长度限制：最大长度为 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationFsxWindows) + [AWS Python 软件开发工具包](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArns](#API_CreateLocationHdfs_RequestSyntax) ** 可以连接到您的 HDFS 集群的 DataSync 代理的 Amazon 资源名称 (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管理的密钥的配置信息，其中包括用于访问特定 Hadoop 分布式文件系统 (HDFS) 存储位置的 Kerberos 密钥表。 DataSync 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 密钥表以二进制形式存储在 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 主体和加密密钥之间的映射。您可以通过提供文件的地址从该文件加载密钥表。如果为 `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) ** 有权访问 HDFS 集群上的文件和文件夹的 Kerberos 主体。如果为 `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 包含用于将数据块映射到的信息 DataNodes。您只能使用一个 NameNode。类型：[HdfsNameNode](API_HdfsNameNode.md) 对象数组数组成员：最少 1 个物品。是否必需：是 ** [QopConfiguration](#API_CreateLocationHdfs_RequestSyntax) ** 保护质量（QOP）配置指定在 Hadoop Distributed File System（HDFS）集群上配置的远程程序调用（RPC）和数据传输保护设置。如果未指定 `QopConfiguration`，则 `RpcProtection` 和 `DataTransferProtection` 默认值为 `PRIVACY`。如果设置 `RpcProtection` 或 `DataTransferProtection`，则其他参数采用相同的值。类型：[QopConfiguration](API_QopConfiguration.md) 对象必需：否 ** [ReplicationFactor](#API_CreateLocationHdfs_RequestSyntax) ** 写入 HDFS 集群时要将数据复制到的数量。 DataNodes 默认情况下，数据将复制到三个 DataNodes。类型：整数有效范围：最小值为 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationHdfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationHdfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationHdfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationHdfs) + [AWS Python 软件开发工具包](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [MountOptions](#API_CreateLocationNfs_RequestSyntax) ** 指定 DataSync 可用于装载 NFS 文件服务器的选项。类型：[NfsMountOptions](API_NfsMountOptions.md) 对象必需：否 ** [OnPremConfig](#API_CreateLocationNfs_RequestSyntax) ** 指定可以连接到您的 NFS 文件服务器的 DataSync 代理的 Amazon 资源名称 (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 名称IPv4 或 IP 地址（或 IPv6）。类型：字符串长度限制：长度上限为 255。模式：`^(([a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9\-:]*[A-Za-z0-9])$` 是否必需：是 ** [Subdirectory](#API_CreateLocationNfs_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}]+$` 是否必需：是 ** [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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationNfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationNfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationNfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationNfs) + [AWS Python 软件开发工具包](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)，您都可以进行转账。在开始之前，请务必了解使用对象存储系统的[先决条件](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites)。 DataSync ## 请求语法 ``` { "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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AccessKey](#API_CreateLocationObjectStorage_RequestSyntax) ** 如果需要凭证来向对象存储服务器进行身份验证，则指定访问密钥（例如，用户名）。类型：字符串长度限制：最小长度为 0。最大长度为 200。模式：`^.*$` 必需：否 ** [AgentArns](#API_CreateLocationObjectStorage_RequestSyntax) ** （可选）指定可以与您的对象存储系统连接的 DataSync 代理的 Amazon 资源名称 (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 AWS KMS key管理的密钥（包括 DataSync 用于访问特定对象存储位置的密钥）的配置信息。`SecretKey` 当您在`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`，则使用您 AWS 账户的 Secrets Manager 密钥 DataSync 存储令牌。类型：字符串长度限制：最小长度为 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 代理所连接的对象存储服务器的域名IPv4 或 IP 地址（或 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationObjectStorage) + [AWS Python 软件开发工具包](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) [使用时评估 S3 请求成本 DataSync](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArns](#API_CreateLocationS3_RequestSyntax) ** （仅限 Outposts 上的 Amazon S3）指定 Outpost 上 DataSync 代理的亚马逊资源名称 (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)。类型：字符串长度限制：最大长度为 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) ** 指定用于访问您的 S3 存储桶的 AWS Identity and Access Management (IAM) 角色的 DataSync 亚马逊资源名称 (ARN)。有关更多信息，请参阅[提供 DataSync 对 S3 存储桶的访问权限](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) ** 在 S3 存储桶中指定 DataSync 读取或写入的前缀（取决于存储桶是源位置还是目标位置）。 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationS3) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationS3) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateLocationS3) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationS3) + [AWS Python 软件开发工具包](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 文件服务器。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArns](#API_CreateLocationSmb_RequestSyntax) ** 指定 DataSync 可以连接到 SMB 文件服务器的一个或多个代理。使用代理的 Amazon 资源名称 (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`身份验证。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。类型：字符串有效值：`NTLM | KERBEROS` 必需：否 ** [CmkSecretConfig](#API_CreateLocationSmb_RequestSyntax) ** 指定用于访问特定 SMB 存储位置的 DataSync托管密钥的配置信息，可以是`Password`或 `KerberosKeytab``NTLM`（分别是（默认 DataSync ）和`KERBEROS`身份验证类型），该密钥由客户管理。 AWS KMS key 当您在`CreateLocationSmbRequest`请求中包含此参数时，您仅提供 KMS 密钥 ARN。 DataSync 将此 KMS 密钥与`KerberosKeytab`您指定的`Password`或一起使用来创建存储位置访问凭证的 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) ** 指定用于访问您的 SMB 文件服务器的 DataSync SMB 协议的版本。类型：[SmbMountOptions](API_SmbMountOptions.md) 对象必需：否 ** [Password](#API_CreateLocationSmb_RequestSyntax) ** 指定可以挂载 SMB 文件服务器并有权限访问传输中涉及的文件和文件夹的用户的密码。此参数仅在 `AuthenticationType` 设置为 `NTLM` 时适用。类型：字符串长度约束：最大长度为 104。模式：`^.{0,104}$` 必需：否 ** [ServerHostname](#API_CreateLocationSmb_RequestSyntax) ** 指定您的 DataSync 代理所连接的 SMB 文件服务器的域名IPv4 或 IP 地址（或 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 共享并访问其所有数据。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateLocationSmb) + [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateLocationSmb) + [AWS Python 软件开发工具包](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" } } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [CloudWatchLogGroupArn](#API_CreateTask_RequestSyntax) ** 指定用于监控任务的亚马逊 CloudWatch 日志组的亚马逊资源名称 (ARN)。对于增强模式任务，您无需指定任何内容。 DataSync自动将日志发送到名为的 CloudWatch 日志组`/aws/datasync`。有关更多信息，请参阅[使用 CloudWatch 日志监控数据传输](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`（默认）-在 AWS 存储和所有其他支持的 DataSync 位置之间传输文件或对象。基本模式任务在数据集中文件、对象和目录数量方面存在[配额](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 资源名称（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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/CreateTask) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/CreateTask) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/CreateTask) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/CreateTask) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArn](#API_DeleteAgent_RequestSyntax) ** 要删除的代理的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteAgent) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteAgent) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteAgent) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteAgent) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DeleteLocation_RequestSyntax) ** 要删除位置的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteLocation) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteLocation) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteLocation) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteLocation) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [TaskArn](#API_DeleteTask_RequestSyntax) ** 指定您要删除的任务的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DeleteTask) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DeleteTask) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DeleteTask) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DeleteTask) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArn](#API_DescribeAgent_RequestSyntax) ** 指定您想要获取相关信息的 DataSync 代理的 Amazon 资源名称 (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)代理的时间。类型：时间戳 ** [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服务通信的时间。类型：时间戳 ** [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" } } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeAgent) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeAgent) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeAgent) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeAgent) + [AWS Python 软件开发工具包](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 存储的 AWS DataSync 传输位置的详细信息。 ## 请求语法 ``` { "LocationArn": "string" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationAzureBlob_RequestSyntax) ** 指定 Azure Blob 存储传输位置的 Amazon 资源名称（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) ** 可以与你 ARNs 的 Azure Blob 存储容器连接的 DataSync 代理。类型：字符串数组数组成员：最少 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 存储空间的身份验证方法。 DataSync 可以使用共享访问签名 (SAS) 访问 blob 存储。类型：字符串有效值：`SAS | NONE` ** [BlobType](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 在将对象或文件传输到 Azure Blob Storage 时想要的 blob 类型。目前， DataSync 仅支持将数据作为块 blob 移动到 Azure 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 AWS KMS key管理的密钥的配置信息，例如 DataSync 用于访问特定存储位置的身份验证令牌。类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象 ** [CreationTime](#API_DescribeLocationAzureBlob_ResponseSyntax) ** 您创建的 Azure Blob Storage 传输位置的时间。类型：时间戳 ** [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 使用默认 AWS托管的 KMS 密钥在中 AWS Secrets Manager加密此密钥。类型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 对象 ## 错误有关所有操作的常见错误信息，请参阅 [常见错误](CommonErrors.md)。 ** InternalException ** 当 AWS DataSync 服务中发生错误时，会引发此异常。 HTTP 状态代码：500 ** InvalidRequestException ** 当客户端提交格式错误的请求时，会引发此异常。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationAzureBlob) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationEfs_RequestSyntax) ** 您想获取其相关信息的 Amazon EFS 文件系统位置的 Amazon 资源名称（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) ** 创建位置的时间。类型：时间戳 ** [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 使用传输层安全 (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" }] } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationEfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationEfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationEfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationEfs) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationFsxLustre_RequestSyntax) ** 要描述的 for Lustre 地点的 FSx 亚马逊资源名称 (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) ** for Lustre 位置 FSx 的创建时间。类型：时间戳 ** [LocationArn](#API_DescribeLocationFsxLustre_ResponseSyntax) ** 所描述的 for Lustre 地点 FSx 的亚马逊资源名称 (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) ** 所描述的 f FSx or Lustre 位置的 URI。类型：字符串长度约束：最大长度为 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [SecurityGroupArns](#API_DescribeLocationFsxLustre_ResponseSyntax) ** 为 Lustre 文件系统配置的安全组的 Amazon 资源名称 (ARNs)。 FSx 类型：字符串数组数组成员：最少 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxLustre) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationFsxOntap_RequestSyntax) ** 指定您想要了解的 ONTAP 文件系统位置 FSx 的亚马逊资源名称 (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) ** 创建位置的时间。类型：时间戳 ** [FsxFilesystemArn](#API_DescribeLocationFsxOntap_ResponseSyntax) ** FSx 适用于 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 适用于 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) ** ONTAP 文件系统位置的统一资源标识符 (URI)。 FSx 类型：字符串长度约束：最大长度为 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) ** FSx 用于访问您的 DataSync 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) ** 您的 for ONTAP 文件系统上 FSx 用于向其中复制数据或从中复制数据的存储虚拟机 (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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxOntap) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationFsxOpenZfs_RequestSyntax) ** 要描述的 openZFS 位置的亚马逊资源名称 (ARN)。 FSx 类型：字符串长度限制：最大长度为 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 为 OpenZFS 创建位置的时间。类型：时间戳 ** [LocationArn](#API_DescribeLocationFsxOpenZfs_ResponseSyntax) ** 所描述的 FSx 适用于 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) ** 所描述的 OpenZFS 位置 FSx 的统一资源标识符 (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) ** 为 ARNs OpenZFS 文件系统配置的安全组中的 FSx 一个。类型：字符串数组数组成员：最少 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxOpenZfs) + [AWS Python 软件开发工具包](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 for Window FSx s 文件服务器文件系统的 AWS DataSync 传输位置的详细信息。 ## 请求语法 ``` { "LocationArn": "string" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationFsxWindows_RequestSyntax) ** 指定 FSx 适用于 Windows 文件服务器的位置的亚马逊资源名称 (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 AWS KMS key管理的密钥（例如 DataSync 用于访问特定存储位置的密钥）的配置信息。`Password` 类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象 ** [CreationTime](#API_DescribeLocationFsxWindows_ResponseSyntax) ** Windows 文件服务器位置 FSx 的创建时间。类型：时间戳 ** [CustomSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 描述客户管理的密钥的配置信息，例如用于访问特定存储位置的密钥，以及提供对密钥的访问权限的客户托管 AWS Identity and Access Management (IAM) 角色。`Password` DataSync 类型：[CustomSecretConfig](API_CustomSecretConfig.md) 对象 ** [Domain](#API_DescribeLocationFsxWindows_ResponseSyntax) ** FSx 适用于 Windows 文件服务器的文件系统所属的 Microsoft Active Directory 域的名称。类型：字符串长度约束：最大长度为 253。模式：`^[A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252}$` ** [LocationArn](#API_DescribeLocationFsxWindows_ResponseSyntax) ** FSx 适用于 Windows 文件服务器的位置的 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 适用于 Windows 文件服务器位置的统一资源标识符 (URI)。类型：字符串长度约束：最大长度为 4360。模式：`^(efs|nfs|s3|smb|hdfs|fsx[a-z0-9-]+)://[a-zA-Z0-9.:/\-]+$` ** [ManagedSecretConfig](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 描述 DataSync托管密钥的配置信息，例如 DataSync 用于访问特定存储位置的。`Password` DataSync 使用默认 AWS托管的 KMS 密钥在中 AWS Secrets Manager加密此密钥。类型：[ManagedSecretConfig](API_ManagedSecretConfig.md) 对象 ** [SecurityGroupArns](#API_DescribeLocationFsxWindows_ResponseSyntax) ** 提供对文件系统首选子网访问权限的 Amazon EC2 安全组的 ARN。有关为文件系统访问配置安全组的信息，请参阅《[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) ** 有权装载和访问 Window FSx s 文件服务器文件系统的用户。类型：字符串长度约束：最大长度为 104。模式：`^[^\x22\x5B\x5D/\\:;|=,+*?\x3C\x3E]{1,104}$` ## 错误有关所有操作的常见错误信息，请参阅 [常见错误](CommonErrors.md)。 ** InternalException ** 当 AWS DataSync 服务中发生错误时，会引发此异常。 HTTP 状态代码：500 ** InvalidRequestException ** 当客户端提交格式错误的请求时，会引发此异常。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationFsxWindows) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationHdfs_RequestSyntax) ** 指定 HDFS 位置的 Amazon 资源名称（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) ** 可以连接您 ARNs 的 HDFS 集群的 DataSync 代理。类型：字符串数组数组成员：最少 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 AWS KMS key管理的密钥（例如 DataSync 用于访问特定存储位置的密钥）的配置信息。`KerberosKeytab` 类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象 ** [CreationTime](#API_DescribeLocationHdfs_ResponseSyntax) ** 创建 HDFS 位置的时间。类型：时间戳 ** [CustomSecretConfig](#API_DescribeLocationHdfs_ResponseSyntax) ** 描述客户管理的密钥的配置信息，例如用于访问特定存储位置的密钥，以及提供对密钥的访问权限的客户托管 AWS Identity and Access Management (IAM) 角色。`KerberosKeytab` DataSync 类型：[CustomSecretConfig](API_CustomSecretConfig.md) 对象 ** [KerberosPrincipal](#API_DescribeLocationHdfs_ResponseSyntax) ** 有权访问 HDFS 集群上的文件和文件夹的 Kerberos 主体。如果 `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 使用默认 AWS托管的 KMS 密钥在中 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 集群时要将数据复制到的数量。 DataNodes 类型：整数有效范围：最小值为 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationHdfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationHdfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationHdfs) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationNfs_RequestSyntax) ** 指定您要获取信息的 NFS 位置的 Amazon 资源名称（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 位置的创建时间。类型：时间戳 ** [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" ] } } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationNfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationNfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationNfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationNfs) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationObjectStorage_RequestSyntax) ** 指定对象存储系统位置的 Amazon 资源名称（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) ** 创建位置的时间。类型：时间戳 ** [CustomSecretConfig](#API_DescribeLocationObjectStorage_ResponseSyntax) ** 描述客户管理的密钥的配置信息，例如用于访问特定传输位置的身份验证令牌或一组证书，以及提供密钥访问权限的客户管理 AWS Identity and Access Management (IAM) 角色。 DataSync 类型：[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 使用默认 AWS托管的 KMS 密钥在中 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationObjectStorage) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationS3_RequestSyntax) ** 指定 Amazon S3 位置的 Amazon 资源名称（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) ** 在 ARNs Outposts 上使用与 Amazon S3 配合使用时，部署在你的 Outpost 上的 DataSync 代理。有关更多信息，请参阅[在上部署 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 位置的时间。类型：时间戳 ** [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) ** 指定用于访问您的 S3 存储桶的 AWS Identity and Access Management (IAM) 角色的 DataSync 亚马逊资源名称 (ARN)。有关更多信息，请参阅[提供 DataSync 对 S3 存储桶的访问权限](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" } ``` ### 示例此示例说明了 DescribeLocation S3 的一种用法。 #### 示例响应 ``` { "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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationS3) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationS3) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationS3) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationS3) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_DescribeLocationSmb_RequestSyntax) ** 指定您想要了解的 SMB 位置的 Amazon 资源名称（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 AWS KMS key管理的密钥（例如 DataSync 用于访问特定存储位置的`Password`或`KerberosKeytab`）的配置信息。类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象 ** [CreationTime](#API_DescribeLocationSmb_ResponseSyntax) ** 创建 SMB 位置的时间。类型：时间戳 ** [CustomSecretConfig](#API_DescribeLocationSmb_ResponseSyntax) ** 描述客户管理的密钥的配置信息，例如用于访问特定存储位置的`Password`或`KerberosKeytab`，并 DataSync 使用客户托管 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托管密钥的配置信息，例如 DataSync 用于访问特定存储位置的`Password`或`KerberosKeytab`。 DataSync 使用默认 AWS托管的 KMS 密钥在中 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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeLocationSmb) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeLocationSmb) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeLocationSmb) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeLocationSmb) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [TaskArn](#API_DescribeTask_RequestSyntax) ** 指定您想要了解的传输任务的 Amazon 资源名称（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) ** 用于监控您的任务的亚马逊 CloudWatch 日志组的亚马逊资源名称 (ARN)。有关更多信息，请参阅[使用 CloudWatch 日志监控数据传输](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) ** 任务的创建时间。类型：时间戳 ** [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:*" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTask) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTask) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTask) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTask) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [TaskExecutionArn](#API_DescribeTaskExecution_RequestSyntax) ** 指定您想要获取信息的任务执行的 Amazon 资源名称（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)。类型：长整型 ** [BytesTransferred](#API_DescribeTaskExecution_ResponseSyntax) ** 压缩前 DataSync 发送到网络的字节数（如果可以压缩）。有关通过网络传输的字节数，请参阅 [BytesCompressed](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeTaskExecution.html#DataSync-DescribeTaskExecution-response-BytesCompressed)。类型：长整型 ** [BytesWritten](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 实际写入目标位置的逻辑字节数。类型：长整型 ** [EndTime](#API_DescribeTaskExecution_ResponseSyntax) ** 传输任务结束的时间。类型：时间戳 ** [EstimatedBytesToTransfer](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 预期写入目标位置的逻辑字节数。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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 将所有内容从源复制到目的地，而不比较位置之间的差异。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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)。类型：长整型 ** [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 将所有内容从源复制到目的地，而不比较位置之间的差异。类型：长整型 ** [FoldersSkipped](#API_DescribeTaskExecution_ResponseSyntax) ** 传输过程中 DataSync 跳过的目录数量。仅适用于[增强模式任务](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。类型：长整型 ** [FoldersTransferred](#API_DescribeTaskExecution_ResponseSyntax) ** DataSync 实际通过网络传输的目录数量。在任务执行期间，当从源读取内容并通过网络发送内容时，该值会定期更新。如果 DataSync 无法传输某些内容，则此值可以小于`EstimatedFoldersToTransfer`。在某些情况下，此值也可能大于 `EstimatedFoldersToTransfer`。仅适用于[增强模式任务](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。类型：长整型 ** [FoldersVerified](#API_DescribeTaskExecution_ResponseSyntax) ** 在传输过程中进行 DataSync 验证的目录数量。仅适用于[增强模式任务](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html)。类型：长整型 ** [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`，因为先前排队的任务必须完成运行后，才能开始新的任务。类型：时间戳 ** [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`，因为先前排队的任务必须完成运行后，才能开始新的任务。类型：时间戳 ** [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 `arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b` 的 `TaskExecution` 值使用 ARN `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" } } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/DescribeTaskExecution) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/DescribeTaskExecution) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/DescribeTaskExecution) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/DescribeTaskExecution) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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 资源名称 (ARNs) 排序。类型：[AgentListEntry](API_AgentListEntry.md) 对象数组 ** [NextToken](#API_ListAgents_ResponseSyntax) ** 不透明字符串，用于指示响应中下一个结果列表的起始位置。类型：字符串长度约束：最大长度为 65535。模式：`[a-zA-Z0-9=_-]+` ## 错误有关所有操作的常见错误信息，请参阅 [常见错误](CommonErrors.md)。 ** InternalException ** 当 AWS DataSync 服务中发生错误时，会引发此异常。 HTTP 状态代码：500 ** InvalidRequestException ** 当客户端提交格式错误的请求时，会引发此异常。 HTTP 状态代码：400 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListAgents) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListAgents) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListAgents) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListAgents) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListLocations_RequestSyntax) ** 您可以使用 API 筛选器来缩小 `ListLocations` 返回的资源的列表范围。例如，要检索特定源位置上的所有任务，您可以结合筛选器名称 `LocationType S3` 和 `Operator Equals` 使用 `ListLocations`。类型：[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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListLocations) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListLocations) + [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListLocations) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [MaxResults](#API_ListTagsForResource_RequestSyntax) ** 指定您要在响应中显示多少结果。类型：整数有效范围：最小值为 0。最大值为 100。必需：否 ** [NextToken](#API_ListTagsForResource_RequestSyntax) ** 指定一个不透明的字符串，用于指示响应中下一个结果列表的起始位置。类型：字符串长度约束：最大长度为 65535。模式：`[a-zA-Z0-9=_-]+` 必需：否 ** [ResourceArn](#API_ListTagsForResource_RequestSyntax) ** 指定要对其提供标签信息的资源的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTagsForResource) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTagsForResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTagsForResource) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTagsForResource) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [MaxResults](#API_ListTaskExecutions_RequestSyntax) ** 指定您想要在响应中显示多少个结果。类型：整数有效范围：最小值为 0。最大值为 100。必需：否 ** [NextToken](#API_ListTaskExecutions_RequestSyntax) ** 指定一个不透明的字符串，用于指示响应中下一个结果列表的起始位置。类型：字符串长度约束：最大长度为 65535。模式：`[a-zA-Z0-9=_-]+` 必需：否 ** [TaskArn](#API_ListTaskExecutions_RequestSyntax) ** 指定您要获取其执行信息的任务的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTaskExecutions) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTaskExecutions) + [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTaskExecutions) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [Filters](#API_ListTasks_RequestSyntax) ** 您可以使用 API 筛选器来缩小 `ListTasks` 返回的资源的列表范围。例如，要检索特定源位置上的所有任务，您可以结合该位置的 ARN 使用筛选器名称为 `LocationId` 和 `Operator Equals` 的 `ListTasks`。类型：[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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/ListTasks) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/ListTasks) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/ListTasks) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/ListTasks) + [AWS Python 软件开发工具包](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" } } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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 资源名称（ARN）的标签。 *标签*是键值对，可帮助您管理、筛选和搜索 DataSync 资源。类型：[TagListEntry](API_TagListEntry.md) 对象数组数组成员：最少 0 个物品。最多 50 项。必需：否 ** [TaskArn](#API_StartTaskExecution_RequestSyntax) ** 指定您要启动的任务的 Amazon 资源名称（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" } ``` ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/StartTaskExecution) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/StartTaskExecution) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/StartTaskExecution) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/StartTaskExecution) + [AWS Python 软件开发工具包](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" } ] } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [ResourceArn](#API_TagResource_RequestSyntax) ** 指定应用标签的资源的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/TagResource) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/TagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/TagResource) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/TagResource) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [Keys](#API_UntagResource_RequestSyntax) ** 指定您要删除的标签中的密钥。类型：字符串数组数组成员：最少 1 个物品。最多 50 项。长度限制：最小长度为 1。最大长度为 256。模式：`^[a-zA-Z0-9\s+=._:/-]+$` 是否必需：是 ** [ResourceArn](#API_UntagResource_RequestSyntax) ** 指定要从中删除标签的资源的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UntagResource) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UntagResource) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UntagResource) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UntagResource) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArn](#API_UpdateAgent_RequestSyntax) ** 要更新的代理的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateAgent) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateAgent) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateAgent) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateAgent) + [AWS Python 软件开发工具包](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 修改你正在使用的微软 Azure Blob 存储传输位置的以下配置。 AWS DataSync 有关更多信息，请参阅[使用 Azure Blob 存储配置 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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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 存储容器连接的 DataSync 代理的亚马逊资源名称 (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) ** 指定用于访问 Azure Blob 存储空间的身份验证方法 DataSync 。 DataSync 可以使用共享访问签名 (SAS) 访问 blob 存储。类型：字符串有效值：`SAS | NONE` 必需：否 ** [BlobType](#API_UpdateLocationAzureBlob_RequestSyntax) ** 指定在将对象或文件传输到 Azure Blob Storage 时想要的 blob 类型。目前， DataSync 仅支持将数据作为块 blob 移动到 Azure 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) ** 指定客户管理的密钥的配置信息，例如用于访问特定传输位置的身份验证令牌或一组证书，以及提供密钥访问权限的客户管理 AWS Identity and Access Management (IAM) 角色。 DataSync 类型：[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 存储空间的 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationAzureBlob) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AccessPointArn](#API_UpdateLocationEfs_RequestSyntax) ** 指定用于挂载 Amazon EFS 文件系统的接入点的 DataSync 亚马逊资源名称 (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) 角色。有关创建此角色的信息，请参阅创[建 DataSync IAM 角色以访问 Amazon EFS 文件系统](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) ** 指定在传输层安全 (TLS) 1.2 加密与您的 Amazon EFS 文件系统之间传输数据时，是否要使用传输层安全 (TLS) 1.2 加密。 DataSync 如果您使用 `AccessPointArn` 指定访问点或使用 `FileSystemAccessRoleArn` 指定 IAM 角色，则必须将此参数设置为 `TLS1_2`。类型：字符串有效值：`NONE | TLS1_2` 必需：否 ** [LocationArn](#API_UpdateLocationEfs_RequestSyntax) ** 指定要更新的 Amazon EFS 传输位置的 Amazon 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationEfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationEfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationEfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationEfs) + [AWS Python 软件开发工具包](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 有关更多信息，请参阅[为 Lustre 配置 DataSync传输](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html)。 FSx ## 请求语法 ``` { "LocationArn": "string", "Subdirectory": "string" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_UpdateLocationFsxLustre_RequestSyntax) ** 指定您要更新的 for Lustre 传输地点 FSx 的亚马逊资源名称 (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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxLustre) + [AWS Python 软件开发工具包](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 f NetApp o FSx r ONTAP 传输位置的以下配置参数。 AWS DataSync 有关更多信息，请参阅[为 ONTAP 配置 DataSync传输](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html)。 FSx ## 请求语法 ``` { "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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_UpdateLocationFsxOntap_RequestSyntax) ** 指定您要更新的 FSx 适用于 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}$` 是否必需：是 ** [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 FSx for ONTAP 用户指南》中的管理 NetApp 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxOntap) + [AWS Python 软件开发工具包](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 有关更多信息，请参阅[为 OpenZ DataSync FS FSx 配置传输](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_UpdateLocationFsxOpenZfs_RequestSyntax) ** 指定您要更新的 FSx 适用于 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}$` 是否必需：是 ** [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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxOpenZfs) + [AWS Python 软件开发工具包](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 f FSx or Windows 文件服务器传输位置的以下配置参数。 AWS DataSync 有关更多信息，请参阅[为 Windows 文件服务器配置 DataSync传输](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html)。 FSx ## 请求语法 ``` { "CmkSecretConfig": { "KmsKeyArn": "string", "SecretArn": "string" }, "CustomSecretConfig": { "SecretAccessRoleArn": "string", "SecretArn": "string" }, "Domain": "string", "LocationArn": "string", "Password": "string", "Subdirectory": "string", "User": "string" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [CmkSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定 DataSync托管密钥的配置信息，例如用于访问特定传输位置和客户 AWS KMS key管理的 DataSync 凭据的一组`Password`或一组凭据。类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象必需：否 ** [CustomSecretConfig](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定客户管理的密钥的配置信息，例如用于访问特定传输位置的一组`Password`或一组证书，以及提供该 DataSync 密钥访问权限的客户管理 AWS Identity and Access Management (IAM) 角色。类型：[CustomSecretConfig](API_CustomSecretConfig.md) 对象必需：否 ** [Domain](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定你 FSx 的 Windows 文件服务器文件系统所属的 Windows 域的名称。如果您的环境中有多个 Active Directory 域，则配置此参数可确保这些域 DataSync 连接到正确的文件系统。类型：字符串长度约束：最大长度为 253。模式：`^([A-Za-z0-9]((\.|-+)?[A-Za-z0-9]){0,252})?$` 必需：否 ** [LocationArn](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定要更新的 FSx 适用于 Windows 文件服务器的传输位置的 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 的 Windows 文件服务器文件系统中的文件、文件夹和文件元数据的用户的密码。类型：字符串长度约束：最大长度为 104。模式：`^.{0,104}$` 必需：否 ** [Subdirectory](#API_UpdateLocationFsxWindows_RequestSyntax) ** 使用正斜杠为您的文件系统指定挂载路径。 DataSync 使用此子目录读取或写入数据（取决于文件系统是源位置还是目标位置）。类型：字符串长度约束：最大长度为 4096。模式：`^[a-zA-Z0-9_\-\+\./\$\p{Zs}]+$` 必需：否 ** [User](#API_UpdateLocationFsxWindows_RequestSyntax) ** 指定有权装载和访问您 FSx 的 Windows 文件服务器文件系统中的文件、文件夹和文件元数据的用户。有关选择具有适当访问权限级别的用户进行传输的信息，请参阅 Windows 文件服务器位置[ FSx 所需的权限](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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationFsxWindows) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArns](#API_UpdateLocationHdfs_RequestSyntax) ** 可以连接到您的 HDFS 集群的 DataSync 代理的 Amazon 资源名称 (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托管密钥的配置信息，例如用于访问特定传输位置和客户 AWS KMS key管理的 DataSync 凭据的一组`KerberosKeytab`或一组凭据。类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象必需：否 ** [CustomSecretConfig](#API_UpdateLocationHdfs_RequestSyntax) ** 指定客户管理的密钥的配置信息，例如用于访问特定传输位置的一组`KerberosKeytab`或一组证书，以及提供该 DataSync 密钥访问权限的客户管理 AWS Identity and Access Management (IAM) 角色。类型：[CustomSecretConfig](API_CustomSecretConfig.md) 对象必需：否 ** [KerberosKeytab](#API_UpdateLocationHdfs_RequestSyntax) ** Kerberos 密钥表（keytab），其中包含定义的 Kerberos 主体和加密密钥之间的映射。您可以通过提供文件的地址从该文件加载密钥表。类型：Base64 编码的二进制数据对象长度约束：最大长度为 65536。必需：否 ** [KerberosKrb5Conf](#API_UpdateLocationHdfs_RequestSyntax) ** 包含 Kerberos 配置信息的 `krb5.conf` 文件。您可以通过提供文件的地址来加载 `krb5.conf` 文件。如果您使用的是 AWS CLI，它将为您执行 base64 编码。否则，应提供 base64 编码文本。类型：Base64 编码的二进制数据对象长度约束：最大长度为 131072。必需：否 ** [KerberosPrincipal](#API_UpdateLocationHdfs_RequestSyntax) ** 有权访问 HDFS 集群上的文件和文件夹的 Kerberos 主体。类型：字符串长度限制：最小长度为 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 资源名称（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 包含用于将数据块映射到的信息 DataNodes。您只能使用一个 NameNode。类型：[HdfsNameNode](API_HdfsNameNode.md) 对象数组数组成员：最少 1 个物品。必需：否 ** [QopConfiguration](#API_UpdateLocationHdfs_RequestSyntax) ** 保护质量（QOP）配置指定在 Hadoop Distributed File System（HDFS）集群上配置的远程程序调用（RPC）和数据传输隐私设置。类型：[QopConfiguration](API_QopConfiguration.md) 对象必需：否 ** [ReplicationFactor](#API_UpdateLocationHdfs_RequestSyntax) ** 写入 HDFS 集群时要将数据复制到的数量。 DataNodes 类型：整数有效范围：最小值为 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationHdfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationHdfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationHdfs) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_UpdateLocationNfs_RequestSyntax) ** 指定您要更新的 NFS 传输位置的 Amazon 资源名称（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 名称IPv4 或 IP 地址（或 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationNfs) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationNfs) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationNfs) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationNfs) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AccessKey](#API_UpdateLocationObjectStorage_RequestSyntax) ** 如果需要凭证来向对象存储服务器进行身份验证，则指定访问密钥（例如，用户名）。类型：字符串长度限制：最小长度为 0。最大长度为 200。模式：`^.*$` 必需：否 ** [AgentArns](#API_UpdateLocationObjectStorage_RequestSyntax) ** （可选）指定可以与您的对象存储系统连接的 DataSync 代理的 Amazon 资源名称 (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) ** 指定客户管理的密钥的配置信息，例如用于访问特定传输位置的身份验证令牌或一组证书，以及提供密钥访问权限的客户管理 AWS Identity and Access Management (IAM) 角色。 DataSync 类型：[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`，则使用您 AWS 账户的 Secrets Manager 密钥 DataSync 存储令牌。类型：字符串长度限制：最小长度为 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 代理所连接的对象存储服务器的域名IPv4 或 IP 地址（或 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationObjectStorage) + [AWS Python 软件开发工具包](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) [使用时评估 S3 请求成本 DataSync](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [LocationArn](#API_UpdateLocationS3_RequestSyntax) ** 指定要更新的 Amazon S3 传输位置的 Amazon 资源名称（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) ** 指定用于访问您的 S3 存储桶的 AWS Identity and Access Management (IAM) 角色的 DataSync 亚马逊资源名称 (ARN)。有关更多信息，请参阅[提供 DataSync 对 S3 存储桶的访问权限](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) ** 在 S3 存储桶中指定 DataSync 读取或写入的前缀（取决于存储桶是源位置还是目标位置）。 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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationS3) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationS3) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationS3) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationS3) + [AWS Python 软件开发工具包](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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [AgentArns](#API_UpdateLocationSmb_RequestSyntax) ** 指定 DataSync 可以连接到 SMB 文件服务器的一个或多个代理。使用代理的 Amazon 资源名称 (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`身份验证。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions)。类型：字符串有效值：`NTLM | KERBEROS` 必需：否 ** [CmkSecretConfig](#API_UpdateLocationSmb_RequestSyntax) ** 指定 DataSync托管密钥的配置信息，例如用于访问特定传输位置的一组`Password``KerberosKeytab`或或一组凭据以及客户 AWS KMS key管理的凭据。 DataSync 类型：[CmkSecretConfig](API_CmkSecretConfig.md) 对象必需：否 ** [CustomSecretConfig](#API_UpdateLocationSmb_RequestSyntax) ** 指定客户管理的密钥的配置信息，例如用于访问特定传输位置的一组`Password``KerberosKeytab`或或一组证书，以及提供该 DataSync 密钥访问权限的客户管理 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) ** 指定用于访问 SMB 文件服务器的服务器消息块 (SMB) 协议的版本。 AWS DataSync 类型：[SmbMountOptions](API_SmbMountOptions.md) 对象必需：否 ** [Password](#API_UpdateLocationSmb_RequestSyntax) ** 指定可以挂载 SMB 文件服务器并有权限访问传输中涉及的文件和文件夹的用户的密码。此参数仅在 `AuthenticationType` 设置为 `NTLM` 时适用。类型：字符串长度约束：最大长度为 104。模式：`^.{0,104}$` 必需：否 ** [ServerHostname](#API_UpdateLocationSmb_RequestSyntax) ** 指定您的 DataSync 代理所连接的 SMB 文件服务器的域名IPv4 或 IP 地址（或 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 共享并访问其所有数据。有关更多信息，请参阅[提供 DataSync 对 SMB 文件服务器的访问权限](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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateLocationSmb) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateLocationSmb) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateLocationSmb) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateLocationSmb) + [AWS Python 软件开发工具包](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" } } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](CommonParameters.md)。请求接受采用 JSON 格式的以下数据。 ** [CloudWatchLogGroupArn](#API_UpdateTask_RequestSyntax) ** 指定用于监控任务的亚马逊 CloudWatch 日志组的亚马逊资源名称 (ARN)。对于增强模式任务，必须使用 `/aws/datasync` 作为日志组的名称。例如： `arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync:*` 有关更多信息，请参阅[使用 CloudWatch 日志监控数据传输](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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateTask) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateTask) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/datasync-2018-11-09/UpdateTask) + [AWS JavaScript V3 版软件开发工具包](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateTask) + [AWS Python 软件开发工具包](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 任务执行的配置。 **注意** 当前，您唯一通过`UpdateTaskExecution`修改的`Option`是` [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" } ``` ## 请求参数有关所有操作的通用参数的信息，请参阅[常用参数](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 资源名称（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 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/datasync-2018-11-09/UpdateTaskExecution) + [AWS 适用于.NET 的 SDK V4](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 v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/datasync-2018-11-09/UpdateTaskExecution) + [AWS 适用于 Java 的 SDK V2](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 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/datasync-2018-11-09/UpdateTaskExecution) + [AWS Python 软件开发工具包](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)