ExportJournalToS3 - Amazon Quantum Ledger Database (Amazon QLDB)
请求语法URI 请求参数请求体响应语法响应元素错误另请参阅

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

ExportJournalToS3

将日期和时间范围内的日记账内容从分类账导出至 Amazon Simple Storage Service (Amazon S3) 存储桶中。日记账导出任务可以以 Amazon Ion 格式的文本或二进制形式或 JSON 行 文本格式写入数据对象。

如果给定Name分类账不存在，则抛出ResourceNotFoundException。

如果给定Name分类账处于CREATING状态，则抛出ResourcePreconditionNotMetException。

您最多可为每个分类帐启动两个并发日记账账导出请求。超过此限制，则日记账账导出请求会抛出LimitExceededException。

请求语法

POST /ledgers/name/journal-s3-exports HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "OutputFormat": "string",
   "RoleArn": "string",
   "S3ExportConfiguration": { 
      "Bucket": "string",
      "EncryptionConfiguration": { 
         "KmsKeyArn": "string",
         "ObjectEncryptionType": "string"
      },
      "Prefix": "string"
   }
}

URI 请求参数

请求使用以下 URI 参数。

name

分类账的名称。

长度限制：长度下限为 1。最大长度为 32。

模式：(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

必需：是

请求体

请求接受采用 JSON 格式的以下数据。

ExclusiveEndTime

要导出的日记账内容范围的唯一结束日期和时间。

ExclusiveEndTime 必须采用 ISO 8601 日期和时间格式以及通用协调时间 (UTC)。例如：2019-06-13T21:36:34Z。

ExclusiveEndTime 必须小于或等于当前的 UTC 日期和时间。

类型：时间戳

必需：是

InclusiveStartTime

要导出的日记账内容范围的全部起始日期和时间。

InclusiveStartTime 必须采用 ISO 8601 日期和时间格式以及通用协调时间 (UTC)。例如：2019-06-13T21:36:34Z。

InclusiveStartTime必须在ExclusiveEndTime之前。

如果您提供的 InclusiveStartTime 是在分类账的 CreationDateTime 之前，则 Amazon QLDB 有效地将其默认视为分类账的 CreationDateTime。

类型：时间戳

必需：是

OutputFormat

导出的日记账数据的输出格式。日记账导出作业可以以 Amazon Ion 格式的文本或二进制形式或 JSON 行文本格式写入数据对象。

默认：ION_TEXT

在 JSON 行格式中，导出的数据对象中的每个日记账数据块都是由换行符分隔的有效 JSON 对象。您可以使用这种格式将 JSON 导出与 Amazon Athena 和 AWS Glue 等分析工具直接集成，因为这些服务可以自动解析以换行符分隔的 JSON。

类型：字符串

有效值：ION_BINARY | ION_TEXT | JSON

必需：否

RoleArn

IAM 角色的 Amazon 资源名称（ARN），该名称授予日记账导出任务的 QLDB 权限：

  • 将对象写入 Amazon S3 存储桶。

  • （可选）使用 AWS Key Management Service (AWS KMS) 中的客户托管密钥对导出的数据进行服务器端加密。

要在请求日记账导出时将角色传递给 QLDB，您必须具有对 IAM 角色资源执行 iam:PassRole 操作的权限。这是所有日记账流请求所必需的。

类型：字符串

长度约束：最小长度为 20。长度上限为 1600。

必需：是

S3ExportConfiguration

导出请求 Amazon S3 存储桶目标的配置设置。

类型：S3ExportConfiguration 对象

必需：是

响应语法

HTTP/1.1 200
Content-type: application/json

{
   "ExportId": "string"
}

响应元素

如果此操作成功，则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

ExportId

QLDB 分配到每个日记账流导出作业的 UUID (以 Base62 编码的文本表示)。

要描述您的导出请求并检查任务状态，您可以使用ExportId致电DescribeJournalS3Export。

类型：字符串

长度限制：固定长度为 22。

模式：^[A-Za-z-0-9]+$

错误

有关所有操作返回的常见错误的信息，请参阅 常见错误。

ResourceNotFoundException

指定的资源不存在。

HTTP 状态代码：404

ResourcePreconditionNotMetException

由于未提前满足条件，操作失败。

HTTP 状态代码：412

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息，请参阅以下内容：