StreamJournalToKinesis - Amazon Quantum Ledger 資料庫 （Amazon QLDB）
請求語法URI 請求參數請求主體回應語法回應元素錯誤另請參閱

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

StreamJournalToKinesis

為指定的 Amazon QLDB 分類帳建立日誌串流。串流會擷取認可至總類日誌的每個文件修訂版本，並將資料傳送至指定的 Amazon Kinesis Data Streams 資源。

請求語法

POST /ledgers/name/journal-kinesis-streams HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "KinesisConfiguration": { 
      "AggregationEnabled": boolean,
      "StreamArn": "string"
   },
   "RoleArn": "string",
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI 請求參數

請求會使用下列 URI 參數。

name

分類帳的名稱。

長度限制：長度下限為 1。長度上限為 32。

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

必要：是

請求主體

請求接受採用 JSON 格式的下列資料。

ExclusiveEndTime

指定串流結束時間的專屬日期和時間。如果您未定義此參數，串流會無限期地執行，直到您取消它為止。

ExclusiveEndTime 必須採用 ISO 8601 日期和時間格式，並以國際標準時間 (UTC) 表示。例如：2019-06-13T21:36:34Z。

類型：Timestamp

必要：否

InclusiveStartTime

開始串流日誌資料的包含開始日期和時間。此參數必須是 ISO 8601 日期和時間格式，並以國際標準時間 (UTC) 表示。例如：2019-06-13T21:36:34Z。

InclusiveStartTime 不能在未來，且必須在 ExclusiveEndTime 之前。

如果您提供位於分類帳 CreationDateTime 之前的分類帳 InclusiveStartTime，QLDB 實際上會將其預設為分類帳的 CreationDateTime。

類型：Timestamp

必要：是

KinesisConfiguration

串流請求之 Kinesis Data Streams 目的地的組態設定。

類型：KinesisConfiguration 物件

必要：是

RoleArn

IAM 角色的 Amazon Resource Name (ARN)，可授予日誌串流的 QLDB 許可，以便將資料記錄寫入 Kinesis Data Streams 資源。

若要在請求日誌串流時將角色傳遞至 QLDB，則您必須擁有針對 IAM 角色資源執行 iam:PassRole 動作的許可。所有日誌串流請求都需有此許可。

類型：字串

長度限制︰長度下限為 20。長度上限為 1600。

必要：是

StreamName

您要指派給 QLDB 日誌串流的名稱。使用者定義的名稱可協助識別和指示串流用途。

對於特定分類帳，您的串流名稱在其他作用中串流間必須是唯一的。串流名稱與分類帳名稱有相同的命名限制，如《Amazon QLDB 開發人員指南》中 Amazon QLDB 中的配額所定義。

類型：字串

長度限制：長度下限為 1。長度上限為 32。

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

必要：是

Tags

鍵值對作為標籤添加到您要創建的流。標籤鍵會區分大小寫。標籤值區分大小寫，並且可以為 null。

類型：字串到字串映射

地圖項目：0 個項目的最小數目。項目數上限為 200。

索引鍵長度限制：長度下限為 1。長度上限為 128。

值長度限制：最小長度為 0。長度上限為 256。

必要：否

回應語法

HTTP/1.1 200
Content-type: application/json

{
   "StreamId": "string"
}

回應元素

如果動作成功，則服務傳回 HTTP 200 回應。

服務會傳回下列 JSON 格式的資料。

StreamId

QLDB 指派給每個 QLDB 日誌串流的 UUID (以 Base62 編碼的文字表示)。

類型：字串

長度約束：固定長度為 22。

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

錯誤

如需所有動作常見錯誤的資訊，請參閱常見錯誤。

InvalidParameterException

請求中的一個或多個參數無效。

HTTP 狀態碼：400

ResourceNotFoundException

指定的資源不存在。

HTTP 狀態碼：404

ResourcePreconditionNotMetException

作業失敗，因為未事先滿足條件。

HTTP 狀態碼：412

另請參閱

如需在其中一個特定語言 AWS SDK 中使用此 API 的詳細資訊，請參閱下列內容：