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.
DescribeImageGenerationConfiguration
Obtiene elImageGenerationConfiguration
valor de una transmisión de vídeo de Kinesis determinada.
Sintaxis de la solicitud
POST /describeImageGenerationConfiguration HTTP/1.1
Content-type: application/json
{
"StreamARN": "string
",
"StreamName": "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.
- StreamARN
-
Anota el nombre de recurso de Amazon (ARN) de la secuencia de vídeo de Kinesis a la que la configuración de generación de imágenes. Debe especificar el
StreamName
o elStreamARN
.Tipo: cadena
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
- StreamName
-
El nombre del flujo desde el que se va a recuperar la configuración de generación de imágenes. Debe especificar el
StreamName
o elStreamARN
.Tipo: cadena
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
{
"ImageGenerationConfiguration": {
"DestinationConfig": {
"DestinationRegion": "string",
"Uri": "string"
},
"Format": "string",
"FormatConfig": {
"string" : "string"
},
"HeightPixels": number,
"ImageSelectorType": "string",
"SamplingInterval": number,
"Status": "string",
"WidthPixels": number
}
}
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.
- ImageGenerationConfiguration
-
La estructura que contiene la información requerida para la entrega de imágenes de Kinesis video Stream (KVS). Si esta estructura es nula, la configuración se eliminará de la transmisión.
Tipo: objeto ImageGenerationConfiguration
Errores
Para obtener información sobre los errores comunes a todas las acciones, consulteErrores comunes.
- AccessDeniedException
-
No tiene permiso para realizar esta operación.
Código de estado de HTTP: 401
- ClientLimitExceededException
-
Kinesis Video Streams ha limitado la solicitud porque ha superado el límite de llamadas de cliente permitidas. Intenta hacer 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 especificó.
Código de estado HTTP: 404
Véase también
Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: