ListFragments - Amazon Kinesis Video Streams

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.

ListFragments

Devuelve una lista de Fragment objetos del flujo y el rango de marcas de tiempo especificados dentro de los datos archivados.

Al final, enumerar los fragmentos es coherente. Esto significa que, aunque el productor reciba un acuse de recibo de que un fragmento se conserva, es posible que el resultado no se devuelva inmediatamente al solicitarlo. ListFragments Sin embargo, los resultados suelen estar disponibles en menos de un segundo.

nota

Primero debe llamar a la GetDataEndpoint API para obtener un punto final. A continuación, envíe las ListFragments solicitudes a este punto final mediante el parámetro --endpoint-url.

importante

Si se produce un error después de invocar una API de contenido multimedia archivado de Kinesis Video Streams, además del código de estado HTTP y el cuerpo de la respuesta, se incluye la siguiente información:

  • x-amz-ErrorTypeEncabezado HTTP: contiene un tipo de error más específico además del que proporciona el código de estado HTTP.

  • x-amz-RequestIdEncabezado HTTP: si quieres informar de un problema AWS, el equipo de soporte puede diagnosticar mejor el problema si se le proporciona el identificador de la solicitud.

Tanto el código de estado HTTP como el ErrorType encabezado se pueden utilizar para tomar decisiones programáticas sobre si los errores se pueden volver a cometer y en qué condiciones, así como para proporcionar información sobre las medidas que el programador del cliente podría tener que tomar para volver a intentarlo correctamente.

Para obtener más información, consulte la sección de errores al final de este tema, así como la sección Errores comunes.

Sintaxis de la solicitud

POST /listFragments HTTP/1.1 Content-type: application/json { "FragmentSelector": { "FragmentSelectorType": "string", "TimestampRange": { "EndTimestamp": number, "StartTimestamp": number } }, "MaxResults": number, "NextToken": "string", "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.

FragmentSelector

Describe el rango de marcas de tiempo y el origen de las marcas de tiempo del rango de fragmentos que se van a devolver.

nota

Esto solo es necesario cuando NextToken no se incluye en la API.

Tipo: objeto FragmentSelector

Obligatorio: no

MaxResults

El número total de fragmentos que se van a devolver. Si el número total de fragmentos disponibles es superior al valor especificado enmax-results, NextToken se proporciona un ListFragments: en el resultado, que puede utilizar para reanudar la paginación.

El valor predeterminado es 100.

Tipo: largo

Rango válido: valor mínimo de 1. Valor máximo de 1000.

Obligatorio: no

NextToken

Un token destinado a especificar dónde iniciar la paginación. Este es el ListFragments: NextToken de una respuesta previamente truncada.

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

StreamARN

El nombre del recurso de Amazon (ARN) de la transmisión desde la que se va a recuperar una lista de fragmentos. Especifique este parámetro o el StreamName parámetro.

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 de la secuencia desde la que se va a recuperar una lista de fragmentos. Especifique este parámetro o el StreamARN parámetro.

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 { "Fragments": [ { "FragmentLengthInMilliseconds": number, "FragmentNumber": "string", "FragmentSizeInBytes": number, "ProducerTimestamp": number, "ServerTimestamp": 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.

Fragments

Una lista de Fragment objetos archivados de la secuencia que cumplen los criterios del selector. Los resultados no están en un orden específico, ni siquiera en todas las páginas.

Si no hay fragmentos en la secuencia que cumplan los criterios de selección, se devuelve una lista vacía.

Tipo: matriz de objetos Fragment

NextToken

Si la lista devuelta está truncada, la operación devuelve este token para usarlo en la siguiente página de resultados. Este valor se produce null cuando no hay más resultados que devolver.

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 Errores comunes.

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.

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

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

GetImagesmostrará este error cuando Kinesis Video Streams no encuentre la transmisión que ha especificado.

GetHLSStreamingSessionURLy 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: