本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
执行批量导入和导出操作
本主题介绍如何执行批量导入和导出操作以及如何处理传输任务中的错误。它提供了使用 CLI 命令传输任务的示例。
AWS IoT TwinMaker API 参考包含有关 CreateMetadataTransferJob和其他 API 操作的信息。
元数据TransferJob 先决条件
在运行元数据之前，请完成以下先决条件TransferJob：
创建 AWS IoT TwinMaker 工作空间。该工作空间可以是元数据的导入目的地或导出源TransferJob。有关创建工作空间的信息，请参阅创建工作区。
创建 Amazon S3 存储桶以存储资源。有关使用 Amazon S3 的更多信息，请参阅 “什么是亚马逊 S3？”
IAM 权限
当您执行批量操作时，您需要创建一个 IAM 策略，允许在 Amazon S3、 AWS IoT TwinMaker AWS IoT SiteWise、和您的本地计算机之间交换 AWS 资源。有关创建 IAM 策略的更多信息，请参阅创建 IAM 策略。
以下列出了 AWS IoT SiteWise 和 Amazon S3 的政策声明： AWS IoT TwinMaker
AWS IoT TwinMaker 政策：
AWS IoT SiteWise 政策：
亚马逊 S3 政策：
{ "Effect": "Allow", "Action": [ "s3:PutObject", "s3:GetObject", "s3:GetBucketLocation", "s3:ListBucket", "s3:AbortMultipartUpload", "s3:ListBucketMultipartUploads", "s3:ListMultipartUploadParts" ], "Resource": "*" }或者，您可以将您的 Amazon S3 策略范围限制为仅访问单个 Amazon S3 存储桶，请参阅以下策略。
Amazon S3 单存储桶范围政策
{ "Effect": "Allow", "Action": [ "s3:PutObject", "s3:GetObject", "s3:GetBucketLocation", "s3:ListBucket", "s3:AbortMultipartUpload", "s3:ListBucketMultipartUploads", "s3:ListMultipartUploadParts" ], "Resource": [ "arn:aws:s3:::bucket name", "arn:aws:s3:::bucket name/*" ] }
为元数据设置访问控制 TransferJob
要控制用户可以访问的任务类型，请将以下 IAM 策略添加到用于调用的角色中 AWS IoT TwinMaker。
注意
此策略仅允许访问将资源转移到 Amazon S3 或从 Amazon S3 转移的导 AWS IoT TwinMaker 入和导出任务。
{ "Effect": "Allow", "Action": [ "iottwinmaker:*DataTransferJob*" ], "Resource": "*", "Condition": { "StringLikeIfExists": { "iottwinmaker:sourceType": [ "s3", "iottwinmaker" ], "iottwinmaker:destinationType": [ "iottwinmaker", "s3" ] } } }
运行批量操作
本节介绍如何执行批量导入和导出操作。
将数据从 Amazon S3 导入到 AWS IoT TwinMaker
-
使用 AWS IoT TwinMaker 元数据TransferJob 架构指定要传输的资源。在您的 Amazon S3 存储桶中创建并存储您的架构文件。
有关架构示例，请参见导入元数据模板。
-
创建请求正文并将其另存为 JSON 文件。请求正文指定传输作业的源和目标。确保将您的 Amazon S3 存储桶指定为源，将您的 AWS IoT TwinMaker 工作空间指定为目标。
以下是请求正文的示例：
{ "metadataTransferJobId": "your-transfer-job-Id", "sources": [{ "type": "s3", "s3Configuration": { "location": "arn:aws:s3:::amzn-s3-demo-bucket/your_import_data.json" } }], "destination": { "type": "iottwinmaker", "iotTwinMakerConfiguration": { "workspace": "arn:aws:iottwinmaker:us-east-1:111122223333:workspace/your-worksapce-name" } } }记录您为请求正文提供的文件名，下一步将需要该文件名。在此示例中，请求正文被命名
createMetadataTransferJobImport.json。 -
运行以下 CLI 命令进行调用
CreateMetadataTransferJob（用您为请求正文提供的名称替换 input-json 文件名）：aws iottwinmaker create-metadata-transfer-job --region us-east-1 \ --cli-input-json file://createMetadataTransferJobImport.json这将创建元数据TransferJob 并开始传输所选资源的过程。
从中导出数据 AWS IoT TwinMaker 到亚马逊 S3
-
使用相应的过滤器创建 JSON 请求正文以选择要导出的资源。在这个例子中，我们使用：
{ "metadataTransferJobId": "your-transfer-job-Id", "sources": [{ "type": "iottwinmaker", "iotTwinMakerConfiguration": { "workspace": "arn:aws:iottwinmaker:us-east-1:111122223333:workspace/your-workspace-name", "filters": [{ "filterByEntity": { "entityId": "parent" }}, { "filterByEntity": { "entityId": "child" }}, { "filterByComponentType": { "componentTypeId": "component.type.minimal" }} ] } }], "destination": { "type": "s3", "s3Configuration": { "location": "arn:aws:s3:::amzn-s3-demo-bucket" } } }该
filters阵列允许您指定要导出的资源。在此示例中，我们按entity、和进行过滤componentType。确保将您的 AWS IoT TwinMaker 工作空间指定为源，将您的 Amazon S3 存储桶指定为元数据传输任务的目的地。
保存请求正文并记录文件名，下一步将需要它。在此示例中，我们命名了请求正文
createMetadataTransferJobExport.json。 -
运行以下 CLI 命令进行调用
CreateMetadataTransferJob（用您为请求正文提供的名称替换 input-json 文件名）：aws iottwinmaker create-metadata-transfer-job --region us-east-1 \ --cli-input-json file://createMetadataTransferJobExport.json这将创建元数据TransferJob 并开始传输所选资源的过程。
要检查或更新传输任务的状态，请使用以下命令：
-
要取消任务，请使用 CancelMetadataTransferJob API 操作。当您调用时 CancelMetadataTransferJob，API 仅取消正在运行的元数据TransferJob，并且任何已经导出或导入的资源都不会受到此 API 调用的影响。
-
要检索有关特定任务的信息，请使用 GetMetadataTransferJob API 操作。
或者，您可以使用 GetMetadataTransferJob 以下 CLI 命令调用现有传输任务：
aws iottwinmaker get-metadata-transfer-job --job-idExistingJobId如果您调用不存在 GetMetadataTransferJob 的 AWS IoT TwinMaker 导入或导出任务，则会收到
ResourceNotFoundException错误响应。 -
要列出当前任务，请使用 ListMetadataTransferJobs API 操作。
以下是一个 CLI 示例，它 ListMetadataTransferJobs 使用 AWS IoT TwinMaker 作为目标类型和
s3作为源类型进行调用：aws iottwinmaker list-metadata-transfer-jobs --destination-type iottwinmaker --source-type s3注意
您可以更改 sourceType 和 DestinationType 参数的值，以匹配您的导入或导出任务的源和目标。
有关调用这些 API 操作的 CLI 命令的更多示例，请参阅AWS IoT TwinMaker 元数据TransferJob 示例。
如果您在传输任务期间遇到任何错误，请参阅错误处理。
错误处理
创建并运行传输任务后，您可以调 GetMetadataTransferJob用诊断出现的任何错误：
aws iottwinmaker get-metadata-transfer-job \ --metadata-transfer-job-idyour_metadata_transfer_job_id\ --region us-east-1
看到任务状态变为后COMPLETED，即可验证作业结果。 GetMetadataTransferJob 返回一个名为的对象 MetadataTransferJobProgress，该对象包含以下字段：
-
FailedCount：表示在传输过程中失败的资源数量。
-
跳过的数量：表示在转移过程中跳过的资源数量。
-
成功次数：表示在转移过程中成功的资源数量。
-
总数：表示转移过程中涉及的资源总数。
此外，还会返回一个包含预签名网址的 reportUrl 元素。如果您的转移任务存在错误，您希望进一步调查，则可以使用此 URL 下载完整的错误报告。
导入元数据模板
您可以通过一次批量导入操作导入许多组件、组件类型或实体。本节中的示例说明了如何执行此操作。
AWS IoT TwinMaker 元数据TransferJob 示例
使用以下命令管理您的元数据传输：
-
CreateMetadataTransferJobAPI 操作。
CLI 命令示例：
aws iottwinmaker create-metadata-transfer-job --region us-east-1 \ --cli-input-json file://yourTransferFileName.json -
要取消任务，请使用 CancelMetadataTransferJob API 操作。
CLI 命令示例：
aws iottwinmaker cancel-metadata-transfer-job --region us-east-1 \ --metadata-transfer-job-idjob-to-cancel-id当你调用时 CancelMetadataTransferJob，它只会取消特定的元数据传输任务，任何已经导出或导入的资源都不会受到影响。
-
要检索有关特定任务的信息，请使用 GetMetadataTransferJob API 操作。
CLI 命令示例：
aws iottwinmaker get-metadata-transfer-job \ --metadata-transfer-job-idyour_metadata_transfer_job_id\ --region us-east-1 \ -
要列出当前任务，请使用 ListMetadataTransferJobs API 操作。
您可以 ListMetadataTransferJobs 使用 JSON 文件筛选返回的结果。使用 CLI 查看以下步骤：
-
创建 CLI 输入 JSON 文件以指定要使用的过滤器：
{ "sourceType": "s3", "destinationType": "iottwinmaker", "filters": [{ "workspaceId": "workspaceforbulkimport" }, { "state": "COMPLETED" }] }保存并记录文件名，输入 CLI 命令时将需要它。
-
使用 JSON 文件作为以下 CLI 命令的参数：
aws iottwinmaker list-metadata-transfer-job --region us-east-1 \ --cli-input-json file://ListMetadataTransferJobsExample.json
-
