DescribeJournalKinesisStream - Amazon Quantum 台帳データベース (Amazon QLDB）
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

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

DescribeJournalKinesisStream

特定の Amazon QLDB ジャーナルストリームに関する詳細情報を返します。出力には、Amazon リソースネーム (ARN)、ストリーム名、現在のステータス、作成時刻、および元のストリーム作成リクエストのパラメータが含まれます。

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

リクエストの構文

GET /ledgers/name/journal-kinesis-streams/streamId HTTP/1.1

URI リクエストパラメータ

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

name

台帳の名前。

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

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

必須：はい

streamId

記述する QLDB ジャーナルストリームの UUID (Base62 でエンコードされたテキストで表されます)。

長さの制限: 22 の固定長

Pattern: ^[A-Za-z-0-9]+$

必須: はい

リクエストボディ

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

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "Stream": { 
      "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 形式で返されます。

Stream

DescribeJournalS3Export リクエストによって返される QLDB ジャーナルストリームに関する情報。

型: JournalKinesisStreamDescription オブジェクト

エラー

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

InvalidParameterException

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

HTTP ステータスコード：400

ResourceNotFoundException

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

HTTP ステータスコード: 404

ResourcePreconditionNotMetException

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

HTTP ステータスコード: 412

その他の参照資料

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