StreamJournalToKinesis - Amazon Quantum 台帳データベース (Amazon QLDB)

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

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 です。

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

ExclusiveEndTime

ストリームの終了を指定する日時。この日時は範囲内に含まれません。このパラメータを定義しない場合、ストリームはキャンセルするまで無期限に実行されます。

ExclusiveEndTime は、ISO 8601 の日付と時刻の形式および協定世界時 (UTC) である必要があります。例えば、2019-06-13T21:36:34Z です。

型: タイムスタンプ

必須: いいえ

InclusiveStartTime

ジャーナルデータのストリーミングを開始する日時。この日時は範囲内に含まれます。このパラメータは、ISO 8601 の日付と時刻の形式および協定世界時 (UTC) である必要があります。例えば、2019-06-13T21:36:34Z です。

InclusiveStartTime を将来の日時にすることはできず、ExclusiveEndTime より前にする必要があります。

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

型: タイムスタンプ

必須: はい

KinesisConfiguration

ストリームリクエストの Kinesis Data Streams 送信先の構成設定です。

型: KinesisConfiguration オブジェクト

必須: はい

RoleArn

Kinesis Data Streams リソースにデータレコードを書き込むためのジャーナルストリームに対する QLDB アクセス許可を付与する IAM ロールの Amazon リソースネーム (ARN)。

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

型: 文字列

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

必須: はい

StreamName

QLDB ジャーナルストリームに割り当てる名前。ユーザー定義の名前は、ストリームの目的を識別して示すのに役立ちます。

ストリーム名は、特定の台帳の他のアクティブなストリーム間で一意である必要があります。ストリーム名は台帳名と同じ命名の制約があります。この制約は、「Amazon QLDB デベロッパーガイド」の「Amazon QLDB のクォータ」で定義されています。

型: 文字列

長さの制限:最小長は 1 です。最大長は 32 です。

Pattern: (?!^.*--)(?!^[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

リクエスト内の 1 つ以上のパラメータが有効ではありません。

HTTP ステータスコード:400

ResourceNotFoundException

指定されたリソースは存在しません。

HTTP ステータスコード: 404

ResourcePreconditionNotMetException

事前に条件が満たされていなかったため、オペレーションが失敗しました。

HTTP ステータスコード: 412

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。