CreateSignalingChannel - Amazon Kinesis Video Streams
Syntaxe de la demandeParamètres de demande URICorps de la demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CreateSignalingChannel

Crée un canal de signalisation.

CreateSignalingChannel est une opération asynchrone.

Syntaxe de la demande

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

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

Paramètres de demande URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

ChannelName

Un nom pour le canal de signalisation que vous êtes en train de créer. Il doit être unique pour chacun Compte AWS et Région AWS.

Type : chaîne

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : [a-zA-Z0-9_.-]+

Obligatoire : oui

ChannelType

Un type du canal de signalisation que vous êtes en train de créer. Actuellement, le seul type de canal pris en charge est SINGLE_MASTER.

Type : chaîne

Valeurs valides : SINGLE_MASTER | FULL_MESH

Obligatoire : non

SingleMasterConfiguration

Structure contenant la configuration pour le type de SINGLE_MASTER canal.

Type : objet SingleMasterConfiguration

Obligatoire : non

Tags

Ensemble de balises (paires clé-valeur) que vous souhaitez associer à ce canal.

Type : tableau d’objets Tag

Membres du tableau : nombre minimum de 0 élément. Nombre maximal de 50 éléments.

Obligatoire : non

Syntaxe de la réponse

HTTP/1.1 200
Content-type: application/json

{
   "ChannelARN": "string"
}

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

ChannelARN

Le nom de ressource Amazon (ARN) du canal créé.

Type : chaîne

Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.

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

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Vous ne disposez pas des autorisations requises pour effectuer cette opération.

Code d'état HTTP : 401

AccountChannelLimitExceededException

Vous avez atteint la limite maximale de canaux de signalisation actifs pour cela Compte AWS dans cette région.

Code d’état HTTP : 400

ClientLimitExceededException

Kinesis Video Streams a limité le nombre de demandes car vous avez dépassé le nombre maximal d'appels clients autorisés. Essayez de passer l'appel plus tard.

Code d’état HTTP : 400

InvalidArgumentException

La valeur de ce paramètre d'entrée n'est pas valide.

Code d’état HTTP : 400

ResourceInUseException

Lorsque l'entrée StreamARN ou ChannelARN l'entrée CLOUD_STORAGE_MODE est déjà mappée à une autre ressource Kinesis Video Stream, ou si l'StreamARNentrée ChannelARN fournie n'est pas active, essayez l'une des solutions suivantes :

  1. L'DescribeMediaStorageConfigurationAPI permettant de déterminer à quoi le canal donné est mappé.

  2. L'DescribeMappedResourceConfigurationAPI permettant de déterminer le canal auquel le flux donné est mappé.

  3. L'DescribeSignalingChannelAPI DescribeStream or pour déterminer le statut de la ressource.

Code d’état HTTP : 400

TagsPerResourceExceededLimitException

Vous avez dépassé le nombre limite de balises que vous pouvez associer à la ressource. Un flux vidéo Kinesis peut prendre en charge jusqu'à 50 balises.

Code d’état HTTP : 400

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :