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.
DescribeSignalingChannel
Renvoie les informations les plus récentes sur le canal de signalisation. Vous devez spécifier le nom ou l'Amazon Resource Name (ARN) du canal que vous souhaitez décrire.
Syntaxe de la demande
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string
",
"ChannelName": "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.
- ChannelARN
-
L'ARN du canal de signalisation que vous souhaitez décrire.
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]+
Obligatoire : non
- ChannelName
-
Nom du canal de signalisation que vous souhaitez décrire.
Type : chaîne
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.
Modèle :
[a-zA-Z0-9_.-]+
Obligatoire : non
Syntaxe de la réponse
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfo": {
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "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.
- ChannelInfo
-
Structure qui encapsule les métadonnées et les propriétés du canal de signalisation spécifié.
Type : objet ChannelInfo
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
- 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
- ResourceNotFoundException
-
Amazon Kinesis Video Streams ne trouve pas le flux que vous avez spécifié.
Code d’état HTTP : 404
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 :