ExportJournalToS3 - Amazon Quantum Ledger Database (Amazon QLDB)
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ExportJournalToS3

日時範囲内のジャーナルコンテンツを、台帳から指定先の Amazon Simple Storage Service (Amazon S3) バケットにエクスポートします。ジャーナルエクスポートジョブは、Amazon Ion 形式のテキストまたはバイナリ表現、または JSON Lines テキスト形式でデータオブジェクトを書き込むことができます。

指定された Name を持つ台帳が存在しない場合は、ResourceNotFoundException をスローします。

指定された Name を持つ台帳が CREATING ステータスの場合は、ResourcePreconditionNotMetException をスローします。

各台帳に対して最大 2 つの同時ジャーナルエクスポートリクエストを開始できます。この制限を超えると、ジャーナルエクスポートリクエストで 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 です。

Pattern: (?!^.*--)(?!^[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 より前の日時にする必要があります。

台帳の CreationDateTime より前の InclusiveStartTime を指定した場合、Amazon QLDB のデフォルトは台帳の CreationDateTime になります。

型: タイムスタンプ

必須: はい

OutputFormat

エクスポートするジャーナルデータの出力形式。ジャーナルエクスポートジョブは、Amazon Ion 形式のテキストまたはバイナリ表現、または JSON Lines テキスト形式でデータオブジェクトを書き込むことができます。

デフォルト: ION_TEXT

JSON Lines 形式では、エクスポートされたデータオブジェクト内の各ジャーナルブロックは、改行で区切られた有効な JSON オブジェクトです。これらのサービスは改行区切りのJSON を自動的に解析できるため、この形式を使用して、JSON エクスポートを Amazon Athena や AWS Glue などの分析ツールと直接統合できます。

型: 文字列

有効な値：ION_BINARY | ION_TEXT | JSON

必須：いいえ

RoleArn

次のことを実行するジャーナルエクスポートジョブに対する QLDB アクセス許可を付与する IAM ロールの Amazon リソースネーム (ARN)。

  • Amazon S3 バケットにオブジェクトを書き込みます。

  • （オプション) AWS Key Management Service （AWS KMS) のカスタマーマネージドキーを使用して、エクスポートしたデータのサーバー側の暗号化を行います。

ジャーナルエクスポートをリクエストするときに QLDB にロールを渡すには、IAM ロールリソースで iam:PassRole アクションを実行するためのアクセス許可が必要です。これはすべてのジャーナルエクスポートリクエストに必要です。

型: 文字列

長さの制限: 最小長は 20 です。最大長は 1600 です。

必須: はい

S3ExportConfiguration

エクスポートリクエストの Simple Storage Service (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 SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。