UpdateMediaStorageConfiguration - Amazon Kinesis Video Streams
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラーその他の参照資料

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

UpdateMediaStorageConfiguration

SignalingChannelをストリームに関連付けてメディアを保存します。指定できるシグナリングモードは次の 2 つです。

  • StorageStatusが有効な場合、StreamARNデータは提供されたファイルに保存されます。WebRTC Ingestionが機能するためには、ストリームのデータ保持が有効になっている必要があります。

  • が無効な場合StorageStatus、データは保存されず、StreamARNパラメータも必要ありません。

重要

有効にすると、直接 peer-to-peer (マスター/ビューア) StorageStatus 接続は行われなくなります。ピアはストレージセッションに直接接続します。JoinStorageSessionAPI を呼び出して SDP オファー送信をトリガーし、ピアとストレージセッション間の接続を確立する必要があります。

リクエストの構文

POST /updateMediaStorageConfiguration HTTP/1.1
Content-type: application/json

{
   "ChannelARN": "string",
   "MediaStorageConfiguration": { 
      "Status": "string",
      "StreamARN": "string"
   }
}

URI リクエストパラメータ

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

リクエストボディ

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

ChannelARN

チャネルの Amazon リソースネーム (ARN)。

型: 文字列

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

Pattern: arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

必須：はい

MediaStorageConfiguration

メディアストレージ設定プロパティをカプセル化または格納する構造。

型: MediaStorageConfiguration オブジェクト

必須: はい

レスポンスの構文

HTTP/1.1 200

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

エラー

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

AccessDeniedException

この操作を実行するために必要なアクセス許可がありません。

HTTP ステータスコード: 401

ClientLimitExceededException

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

HTTP ステータスコード：400

InvalidArgumentException

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

HTTP ステータスコード：400

NoDataRetentionException

Stream データの保持時間 (時間単位) は 0 です。

HTTP ステータスコード：400

ResourceInUseException

StreamARNChannelARNCLOUD_STORAGE_MODE入力または入力が既に別の Kinesis Video Stream リソースにマッピングされている場合、StreamARNChannelARNまたは提供された入力がアクティブステータスでない場合は、次のいずれかを試してください。

  1. DescribeMediaStorageConfigurationAPI は、特定のチャンネルがどのストリームにマップされているかを判断します。

  2. 特定のストリームがマップされているチャンネルを決定するための DescribeMappedResourceConfiguration API。

  3. DescribeStreamまたは DescribeSignalingChannel API を使用してリソースのステータスを判断します。

HTTP ステータスコード：400

ResourceNotFoundException

Amazon Kinesis Video Streams は、指定したストリームを見つけることができません。

HTTP ステータスコード: 404

その他の参照資料

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