翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
DescribeStream
指定されたストリームに関する最新の情報を返します。StreamName または StreamARN のパラメータを指定する必要があります。
リクエストの構文
POST /describeStream HTTP/1.1
Content-type: application/json
{
"StreamARN": "string",
"StreamName": "string"
}URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
- StreamARN
-
ストリームの Amazon リソースネーム (ARN)。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 1,024 です。
パターン:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+必須: いいえ
- StreamName
-
ストリームの名前。
型: 文字列
長さの制限：最小長は 1 です。最大長は 256 です。
パターン：
[a-zA-Z0-9_.-]+必須: いいえ
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"StreamInfo": {
"CreationTime": number,
"DataRetentionInHours": number,
"DeviceName": "string",
"KmsKeyId": "string",
"MediaType": "string",
"Status": "string",
"StreamARN": "string",
"StreamName": "string",
"Version": "string"
}
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- StreamInfo
-
ストリームを記述するオブジェクト。
型: StreamInfo オブジェクト
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- ClientLimitExceededException
-
Kinesis Video Streams は、許可されたクライアントコールの制限を超えているため、リクエストをスロットリングしました。後で呼び出しを試みてください。
HTTP ステータスコード：400
- InvalidArgumentException
-
この入力パラメータの値は無効です。
HTTP ステータスコード：400
- NotAuthorizedException
-
呼び出し元には、この操作を実行するための権限がありません。
HTTP ステータスコード: 401
- ResourceNotFoundException
-
Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
