ListJournalKinesisStreamsForLedger - Amazon Quantum Ledger Database (Amazon QLDB)

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

ListJournalKinesisStreamsForLedger

指定された台帳のすべての Amazon QLDB ジャーナルストリームストリームを返します。

このアクションでは、有効期限切れのジャーナルストリームは返されません。詳細については、「Amazon QLDB デベロッパーガイド」の「端末ストリームの有効期限」を参照してください。

このアクションは最大 MaxResults 個の項目を返します。これは、ListJournalKinesisStreamsForLedger を複数回呼び出してすべての項目を取得できるようにページ分割されます。

リクエストの構文

GET /ledgers/name/journal-kinesis-streams?max_results=MaxResults&next_token=NextToken HTTP/1.1

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

name

台帳の名前。

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

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

必須:はい

MaxResults

1 回の ListJournalKinesisStreamsForLedger リクエストで返す結果の最大数。(実際に返される結果の数は少なくなる可能性があります。)

有効範囲: 最小値 は 1 です。最大値は 100 です。

NextToken

次の結果ページを取得することを示すページ分割トークン。前の ListJournalKinesisStreamsForLedger 呼び出しからのレスポンスで NextToken の値を受け取った場合は、入力値として、ここでその値を使用する必要があります。

長さの制限: 最小長は 4 です。最大長は 1,024 です。

パターン: ^[A-Za-z-0-9+/=]+$

リクエストボディ

リクエストにリクエスト本文がありません。

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "Streams": [ { "Arn": "string", "CreationTime": number, "ErrorCause": "string", "ExclusiveEndTime": number, "InclusiveStartTime": number, "KinesisConfiguration": { "AggregationEnabled": boolean, "StreamArn": "string" }, "LedgerName": "string", "RoleArn": "string", "Status": "string", "StreamId": "string", "StreamName": "string" } ] }

レスポンス要素

アクションが成功すると、サービスは HTTP 200 レスポンスを返します。

サービスから以下のデータが JSON 形式で返されます。

NextToken
  • NextToken が空の場合は、結果の最後のページが処理されており、それ以上取得する結果はありません。

  • NextToken が空でない場合は、さらに結果があります。結果の次のページを取得するには、後続の ListJournalKinesisStreamsForLedger 呼び出しで NextToken の値を使用します。

型: 文字列

長さの制限: 最小長は 4 です。最大長は 1,024 です。

パターン: ^[A-Za-z-0-9+/=]+$

Streams

指定された台帳に現在関連付けられている QLDB ジャーナルストリーム。

型: JournalKinesisStreamDescription オブジェクトの配列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InvalidParameterException

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

HTTP ステータスコード:400

ResourceNotFoundException

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

HTTP ステータスコード: 404

ResourcePreconditionNotMetException

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

HTTP ステータスコード: 412

その他の参照資料

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