UpdateSignalingChannel - Amazon Kinesis Video Streams

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

UpdateSignalingChannel

既存のシグナリングチャネルを更新します。これは非同期の操作であり、完了するまでに時間がかかります。

MessageTtlSeconds の値が更新された場合(増加または減少)、更新後にこのチャネルを介して送信された新しいメッセージだけに適用されます。以前の MessageTtlSeconds の値の通り、既存のメッセージはまだ期限切れになっています。

リクエストの構文

POST /updateSignalingChannel HTTP/1.1 Content-type: application/json { "ChannelARN": "string", "CurrentVersion": "string", "SingleMasterConfiguration": { "MessageTtlSeconds": number } }

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]+

必須:はい

CurrentVersion

更新するシグナリングチャネルの現在のバージョン。

型: 文字列

長さの制限:最小長は 1 です。最大長は 64 文字です。

パターン: [a-zA-Z0-9]+

必須:はい

SingleMasterConfiguration

更新するシグナリングチャネルの SINGLE_MASTER 型の設定を含む構造。  

型: SingleMasterConfiguration オブジェクト

必須: いいえ

レスポンスの構文

HTTP/1.1 200

レスポンス要素

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

エラー

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

AccessDeniedException

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

HTTP ステータスコード: 401

ClientLimitExceededException

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

HTTP ステータスコード:400

InvalidArgumentException

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

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

VersionMismatchException

指定したストリームバージョンは最新バージョンではありません。最新バージョンを入手するには DescribeStreamAPI を使用してください。

HTTP ステータスコード:400

その他の参照資料

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