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. # GetImages El soporte gestionado para imágenes proporciona una forma totalmente gestionada de obtener imágenes de los datos de vídeo transmitidos y almacenados en Kinesis Video Streams. Puede usar imágenes para ejecutar cargas de trabajo de aprendizaje automático (ML), como la detección de personas, mascotas o vehículos. Las imágenes también se pueden utilizar para añadir elementos interactivos a la reproducción, como previsualizaciones de imágenes para eventos de movimiento o para barrer un videoclip. GetImages también recupera una lista de imágenes correspondientes a cada marca de tiempo para un intervalo de tiempo, intervalo de muestreo y configuración de formato de imagen determinados. **nota** Primero debe llamar a la `GetDataEndpoint` API para obtener un punto final. A continuación, envíe las `GetImages` solicitudes a este punto final mediante el parámetro [--endpoint-url](https://docs.aws.amazon.com/cli/latest/reference/). Requisitos de la [pista de reproducción de vídeo](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/video-playback-requirements.html). ## Sintaxis de la solicitud ``` POST /getImages HTTP/1.1 Content-type: application/json { "EndTimestamp": number, "Format": "string", "FormatConfig": { "string" : "string" }, "HeightPixels": number, "ImageSelectorType": "string", "MaxResults": number, "NextToken": "string", "SamplingInterval": number, "StartTimestamp": number, "StreamARN": "string", "StreamName": "string", "WidthPixels": number } ``` ## 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. ** [EndTimestamp](#API_reader_GetImages_RequestSyntax) ** La marca de tiempo final del rango de imágenes que se va a generar. Si el intervalo de tiempo `StartTimestamp` comprendido entre y `EndTimestamp` supera los 300 segundos`StartTimestamp`, recibirá un. `IllegalArgumentException` Tipo: marca temporal Obligatorio: sí ** [Format](#API_reader_GetImages_RequestSyntax) ** El formato que se utilizará para codificar la imagen. Tipo: cadena Valores válidos: `JPEG | PNG` Obligatorio: sí ** [FormatConfig](#API_reader_GetImages_RequestSyntax) ** La lista de una estructura de pares clave-valor que contiene parámetros adicionales que se pueden aplicar al generar la imagen. La `FormatConfig` clave es la`JPEGQuality`, que indica la clave de calidad JPEG que se utilizará para generar la imagen. El `FormatConfig` valor acepta enteros de 1 a 100. Si el valor es 1, la imagen se generará con menos calidad y con la mejor compresión. Si el valor es 100, la imagen se generará con la mejor calidad y menos compresión. Si no se proporciona ningún valor, el valor predeterminado de la `JPEGQuality` clave se establecerá en 80. Tipo: mapa de cadena a cadena Entradas de mapa: número máximo de 1 elemento. Claves válidas: `JPEGQuality` Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres. Patrón de valores: `^[a-zA-Z_0-9]+` Obligatorio: no ** [HeightPixels](#API_reader_GetImages_RequestSyntax) ** La altura de la imagen de salida que se utiliza junto con el `WidthPixels` parámetro. Cuando se proporcionan ambos `HeightPixels` `WidthPixels` parámetros, la imagen se estirará para ajustarse a la relación de aspecto especificada. Si solo se proporciona el `HeightPixels` parámetro, se utilizará su relación de aspecto original para `WidthPixels` calcularla. Si no se proporciona ninguno de los parámetros, se devolverá el tamaño original de la imagen. Tipo: entero Rango válido: valor mínimo de 1. Valor máximo de 2160. Obligatorio: no ** [ImageSelectorType](#API_reader_GetImages_RequestSyntax) ** El origen de las marcas de tiempo del servidor o del productor que se van a utilizar para generar las imágenes. Tipo: cadena Valores válidos: `PRODUCER_TIMESTAMP | SERVER_TIMESTAMP` Obligatorio: sí ** [MaxResults](#API_reader_GetImages_RequestSyntax) ** El número máximo de imágenes que devolverá la API. El límite predeterminado es de 25 imágenes por respuesta de la API. Si se proporciona un valor `MaxResults` superior a este valor, se obtendrá un tamaño de página de 25. Los resultados adicionales se paginarán. Tipo: largo Rango válido: valor mínimo de 1. Valor máximo de 100. Obligatorio: no ** [NextToken](#API_reader_GetImages_RequestSyntax) ** Un token que especifica dónde empezar a paginar el siguiente conjunto de imágenes. Es el `GetImages:NextToken` de una respuesta truncada anteriormente. Tipo: cadena Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 4096 caracteres. Patrón: `[a-zA-Z0-9+/]+={0,2}` Obligatorio: no ** [SamplingInterval](#API_reader_GetImages_RequestSyntax) ** El intervalo de tiempo en milisegundos (ms) en el que se deben generar las imágenes a partir de la transmisión. El valor mínimo que se puede proporcionar es de 200 ms (5 imágenes por segundo). Si el intervalo de marca temporal es inferior al intervalo de muestreo, se `startTimestamp` devolverá la imagen del, si está disponible. Tipo: entero Obligatorio: no ** [StartTimestamp](#API_reader_GetImages_RequestSyntax) ** El punto de partida desde el que se deben generar las imágenes. `StartTimestamp`Debe estar dentro de un rango inclusivo de marcas de tiempo para que se devuelva una imagen. Tipo: marca temporal Obligatorio: sí ** [StreamARN](#API_reader_GetImages_RequestSyntax) ** El nombre del recurso de Amazon (ARN) de la transmisión desde la que se van a recuperar las imágenes. Debe especificar el `StreamName` o el`StreamARN`. 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](#API_reader_GetImages_RequestSyntax) ** El nombre de la secuencia de la que se van a recuperar las imágenes. Debe especificar el `StreamName` o el`StreamARN`. 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 ** [WidthPixels](#API_reader_GetImages_RequestSyntax) ** El ancho de la imagen de salida que se utiliza junto con el `HeightPixels` parámetro. Cuando se proporcionan ambos `WidthPixels` `HeightPixels` parámetros, la imagen se estirará para ajustarse a la relación de aspecto especificada. Si solo se proporciona el `WidthPixels` parámetro o si solo `HeightPixels` se proporciona el parámetro, `ValidationException` aparecerá un. Si no se proporciona ninguno de los parámetros, se devolverá el tamaño de imagen original de la secuencia. Tipo: entero Rango válido: valor mínimo de 1. Valor máximo de 3840. Obligatorio: no ## Sintaxis de la respuesta ``` HTTP/1.1 200 Content-type: application/json { "Images": [ { "Error": "string", "ImageContent": "string", "TimeStamp": number } ], "NextToken": "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. ** [Images](#API_reader_GetImages_ResponseSyntax) ** La lista de imágenes generadas a partir de la transmisión de vídeo. Si no hay contenido multimedia disponible para la marca de tiempo indicada, el `NO_MEDIA` error aparecerá en la salida. Si se produce un error durante la generación de la imagen, `MEDIA_ERROR` aparecerá en el resultado como la causa de la falta de imagen. Tipo: matriz de objetos [Image](API_reader_Image.md) ** [NextToken](#API_reader_GetImages_ResponseSyntax) ** El token cifrado que se utilizó en la solicitud para obtener más imágenes. Tipo: cadena Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 4096 caracteres. Patrón: `[a-zA-Z0-9+/]+={0,2}` ## Errores Para obtener información acerca de los errores comunes a todas las acciones, consulte [Tipos de errores comunes](CommonErrors.md). ** ClientLimitExceededException ** Kinesis Video Streams ha limitado la solicitud porque ha superado un límite. Intente realizar la llamada más tarde. Para obtener información sobre los límites, consulte Cuotas de [Kinesis Video Streams](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/limits.html). Código de estado HTTP: 400 ** InvalidArgumentException ** Un parámetro específico supera sus restricciones, no se admite o no se puede usar. Código de estado HTTP: 400 ** NoDataRetentionException ** `GetImages`se solicitó para una transmisión que no retiene datos (es decir, tiene un valor `DataRetentionInHours` de 0). Código de estado HTTP: 400 ** NotAuthorizedException ** Código de estado: 403. La persona que llama no está autorizada a realizar ninguna operación en la transmisión en cuestión o el token ha caducado. Código de estado HTTP: 401 ** ResourceNotFoundException ** `GetImages`mostrará este error cuando Kinesis Video Streams no encuentre la transmisión que ha especificado. `GetHLSStreamingSessionURL`y `GetDASHStreamingSessionURL` arroja este error si una sesión con un `PlaybackMode` de `ON_DEMAND` o `LIVE_REPLAY` se solicita una transmisión que no tiene fragmentos en el intervalo de tiempo solicitado, o si `LIVE` se solicita una sesión con un `PlaybackMode` de o para una transmisión que no tiene fragmentos en los últimos 30 segundos. 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 idiomas específicos AWS SDKs, consulta lo siguiente: + [AWS Interfaz de línea de comandos V2](https://docs.aws.amazon.com/goto/cli2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/kinesis-video-reader-data-2017-09-30/GetImages) + [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesis-video-reader-data-2017-09-30/GetImages)