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

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

CreateSignalingChannel

シグナリングチャネルを作成します。

CreateSignalingChannel は非同期の操作です。

リクエストの構文

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

{
   "ChannelName": "string",
   "ChannelType": "string",
   "SingleMasterConfiguration": { 
      "MessageTtlSeconds": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI リクエストパラメータ

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

リクエストボディ

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

ChannelName

作成しているシグナリングチャネルの名前。 AWS アカウント 両者で一意でなければなりません AWS リージョン。

型: 文字列

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

パターン：[a-zA-Z0-9_.-]+

必須：はい

ChannelType

作成しているシグナリングチャネルのタイプ。現在サポートされている唯一のチャネルタイプは SINGLE_MASTER です。

型: 文字列

有効な値：SINGLE_MASTER | FULL_MESH

必須：いいえ

SingleMasterConfiguration

SINGLE_MASTER チャネルタイプの設定を含む構造体。

型: SingleMasterConfiguration オブジェクト

必須: いいえ

Tags

このチャネルに関連付ける一連のタグ (キーと値のペア)。

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

配列メンバー：最小数は 0 項目です。最大数は 50 項目です。

必須：いいえ

レスポンスの構文

HTTP/1.1 200
Content-type: application/json

{
   "ChannelARN": "string"
}

レスポンス要素

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

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

ChannelARN

新たに作成されたチャネルの Amazon リソースネーム (ARN)。

型: 文字列

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

パターン：arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+

エラー

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

AccessDeniedException

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

HTTP ステータスコード: 401

AccountChannelLimitExceededException

AWS アカウント このリージョンで有効なシグナリングチャネルの上限に達しました。

HTTP ステータスコード：400

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

TagsPerResourceExceededLimitException

リソースに関連付けることができるタグの上限を超えています。Kinesis ビデオストリームは最大 50 個のタグをサポートできます。

HTTP ステータスコード：400

その他の参照資料

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