Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
DescribeSignalingChannel
Devuelve la información más actual sobre el canal de señalización. Debe especificar el nombre o el nombre de recurso de Amazon (ARN) del canal que desea describir.
Sintaxis de la solicitud
POST /describeSignalingChannel HTTP/1.1
Content-type: application/json
{
"ChannelARN": "string",
"ChannelName": "string"
}Parámetros de solicitud del URI
La solicitud no utiliza ningún parámetro de URI.
Cuerpo de la solicitud
La solicitud acepta los siguientes datos en formato JSON.
- ChannelARN
-
El ARN del canal de señalización que desea describir.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 1024 caracteres.
Patrón:
arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+Obligatorio: no
- ChannelName
-
El nombre del canal de señalización que desea describir.
Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 256 caracteres.
Patrón:
[a-zA-Z0-9_.-]+Obligatorio: no
Sintaxis de la respuesta
HTTP/1.1 200
Content-type: application/json
{
"ChannelInfo": {
"ChannelARN": "string",
"ChannelName": "string",
"ChannelStatus": "string",
"ChannelType": "string",
"CreationTime": number,
"SingleMasterConfiguration": {
"MessageTtlSeconds": number
},
"Version": "string"
}
}Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.
El servicio devuelve los datos siguientes en formato JSON.
- ChannelInfo
-
Estructura que encapsula los metadatos y las propiedades del canal de señalización especificado.
Tipo: objeto ChannelInfo
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- AccessDeniedException
-
No tiene los permisos necesarios para realizar esta operación.
Código de estado HTTP: 401
- ClientLimitExceededException
-
Kinesis Video Streams ha limitado la solicitud porque ha superado el límite de llamadas de clientes permitidas. Intente realizar la llamada más tarde.
Código de estado HTTP: 400
- InvalidArgumentException
-
El valor de este parámetro de entrada no es válido.
Código de estado HTTP: 400
- ResourceNotFoundException
-
Amazon Kinesis Video Streams no encuentra la transmisión que ha especificado.
Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en uno de los AWS SDK específicos del idioma, consulte lo siguiente:
