ListStreams - Amazon Kinesis Video Streams

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

ListStreams

StreamInfo オブジェクトの配列を返します。各オブジェクトがストリームを記述します。特定の条件を満たすストリームだけを取得するには、StreamNameCondition を指定します。

リクエストの構文

POST /listStreams HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "StreamNameCondition": { "ComparisonOperator": "string", "ComparisonValue": "string" } }

URI リクエストパラメータ

リクエストでは URI パラメータを使用しません。

リクエストボディ

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

MaxResults

レスポンスに返されるストリームの最大数。デフォルトは 10,000 です。

型: 整数

値の範囲: 最小値 は 1 です。最大値は 10,000 です。

必須: いいえ

NextToken

このパラメータを指定すると、ListStreams 操作の結果が切り捨てられ、呼び出しはレスポンスで NextToken を返します。ストリームの別のバッチを取得するには、次のリクエストでこのトークンを指定してください。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 512 です。

Pattern: [a-zA-Z0-9+/=]*

必須: いいえ

StreamNameCondition

オプション: 特定の条件を満たすストリームだけを返します。現在、条件としてストリーム名のプレフィックスだけを指定できます。

型: StreamNameCondition オブジェクト

必須: いいえ

レスポンスの構文

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "StreamInfoList": [ { "CreationTime": number, "DataRetentionInHours": number, "DeviceName": "string", "KmsKeyId": "string", "MediaType": "string", "Status": "string", "StreamARN": "string", "StreamName": "string", "Version": "string" } ] }

レスポンス要素

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

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

NextToken

レスポンスが切り捨てられた場合、呼び出しはトークンを含む要素を返します。次のストリームバッチを取得するには、このトークンを次のリクエストで使用してください。

型: 文字列

長さの制限: 最小長は 0 です。最大長は 512 です。

Pattern: [a-zA-Z0-9+/=]*

StreamInfoList

StreamInfo オブジェクトの配列。

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

エラー

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

ClientLimitExceededException

Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。

HTTP ステータスコード:400

InvalidArgumentException

この入力パラメータの値は無効です。

HTTP ステータスコード:400

その他の参照資料

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