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.
UpdateDataRetention
Aumenta o reduce el período de retención de datos de la transmisión en función del valor que especifique. Para indicar si desea aumentar o disminuir el período de retención de datos, especifique el Operation parámetro en el cuerpo de la solicitud. En la solicitud, debe especificar el StreamName o elStreamARN.
Esta operación necesita permiso para la acción KinesisVideo:UpdateDataRetention.
El cambio del período de retención de datos afecta a los datos de la transmisión de la siguiente manera:
-
Si se aumenta el período de retención de datos, los datos existentes se conservan durante el nuevo período de retención. Por ejemplo, si el período de retención de datos se incrementa de una hora a siete horas, todos los datos existentes se conservan durante siete horas.
-
Si se reduce el período de retención de datos, los datos existentes se conservan durante el nuevo período de retención. Por ejemplo, si el período de retención de datos se reduce de siete horas a una hora, todos los datos existentes se conservan durante una hora y los datos que tengan más de una hora se eliminan inmediatamente.
Sintaxis de la solicitud
POST /updateDataRetention HTTP/1.1
Content-type: application/json
{
"CurrentVersion": "string",
"DataRetentionChangeInHours": number,
"Operation": "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.
- CurrentVersion
-
La versión de la transmisión cuyo período de retención quieres cambiar. Para obtener la versión, llama a la API
DescribeStreamo a laListStreamsAPI.Tipo: string
Limitaciones de longitud: longitud mínima de 1. La longitud máxima es de 64.
Patrón:
[a-zA-Z0-9]+Obligatorio: sí
- DataRetentionChangeInHours
-
El número de horas en las que se va a ajustar la retención actual. El valor que especifique se suma o resta del valor actual, según el.
operationEl valor mínimo de retención de datos es 0 y el valor máximo es 87600 (diez años).
Tipo: entero
Rango válido: valor mínimo de 1.
Obligatorio: sí
- Operation
-
Indica si desea aumentar o disminuir el período de retención.
Tipo: cadena
Valores válidos:
INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTIONObligatorio: sí
- StreamARN
-
El nombre del recurso de Amazon (ARN) de la transmisión cuyo período de retención quieres cambiar.
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
- StreamName
-
El nombre de la transmisión cuyo período de retención quieres cambiar.
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
Elementos de respuesta
Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200 con un cuerpo HTTP vacío.
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 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
- NotAuthorizedException
-
La persona que llama no está autorizada a realizar esta operación.
Código de estado HTTP: 401
- ResourceInUseException
-
Si la entrada
StreamARNoChannelARNentrada yaCLOUD_STORAGE_MODEestá mapeada a otro recurso de Kinesis Video Stream, o si laStreamARNentradaChannelARNproporcionada no está en estado Activo, pruebe una de las siguientes opciones:-
La
DescribeMediaStorageConfigurationAPI para determinar a qué está asignado el canal de transmisión en cuestión. -
La
DescribeMappedResourceConfigurationAPI para determinar el canal al que está mapeada la transmisión determinada. -
La
DescribeStreamoDescribeSignalingChannelAPI para determinar el estado del recurso.
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
- VersionMismatchException
-
La versión de transmisión que especificó no es la versión más reciente. Para obtener la versión más reciente, usa la DescribeStreamAPI.
Código de estado HTTP: 400
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, consulta lo siguiente:
