

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# UpdateDataRetention
<a name="API_UpdateDataRetention"></a>

Augmente ou diminue la durée de conservation des données du flux selon la valeur que vous spécifiez. Pour indiquer si vous souhaitez augmenter ou diminuer la durée de conservation des données, spécifiez le `Operation` paramètre dans le corps de la demande. Dans la demande, vous devez spécifier le `StreamName` ou le`StreamARN`. 

Cette opération nécessite une autorisation pour l’action `KinesisVideo:UpdateDataRetention`.

La modification de la période de conservation des données affecte les données du flux comme suit :
+ Si la période de conservation des données est prolongée, les données existantes sont conservées pendant la nouvelle période de conservation. Par exemple, si la durée de conservation des données passe d'une heure à sept heures, toutes les données existantes sont conservées pendant sept heures.
+ Si la période de conservation des données est réduite, les données existantes sont conservées pendant la nouvelle période de conservation. Par exemple, si la période de conservation des données est réduite de sept heures à une heure, toutes les données existantes sont conservées pendant une heure et toutes les données datant de plus d'une heure sont immédiatement supprimées.

## Syntaxe de la demande
<a name="API_UpdateDataRetention_RequestSyntax"></a>

```
POST /updateDataRetention HTTP/1.1
Content-type: application/json

{
   "CurrentVersion": "string",
   "DataRetentionChangeInHours": number,
   "Operation": "string",
   "StreamARN": "string",
   "StreamName": "string"
}
```

## Paramètres de demande URI
<a name="API_UpdateDataRetention_RequestParameters"></a>

La demande n’utilise pas de paramètres URI.

## Corps de la demande
<a name="API_UpdateDataRetention_RequestBody"></a>

Cette demande accepte les données suivantes au format JSON.

 ** [CurrentVersion](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-CurrentVersion"></a>
Version du flux dont vous souhaitez modifier la période de conservation. Pour obtenir la version, appelez l'API `DescribeStream` ou l'`ListStreams`API.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximale de 64 caractères.  
Modèle : `[a-zA-Z0-9]+`   
Obligatoire : oui

 ** [DataRetentionChangeInHours](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-DataRetentionChangeInHours"></a>
Le nombre d'heures nécessaires pour ajuster la rétention actuelle. La valeur que vous spécifiez est ajoutée ou soustraite de la valeur actuelle, selon le`operation`.  
La valeur minimale pour la conservation des données est 0 et la valeur maximale est de 87 600 (dix ans).  
Type : entier  
Plage valide : Valeur minimum de 1.  
Obligatoire : oui

 ** [Operation](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-Operation"></a>
Indique si vous souhaitez augmenter ou diminuer la période de rétention.  
Type : Chaîne  
Valeurs valides : `INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION`   
Obligatoire : oui

 ** [StreamARN](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamARN"></a>
Le nom de ressource Amazon (ARN) du flux dont vous souhaitez modifier la période de rétention.  
Type : Chaîne  
Contraintes de longueur : Longueur minimum de 1. Longueur maximum de 1024.  
Modèle : `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Obligatoire : non

 ** [StreamName](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamName"></a>
Le nom du flux dont vous souhaitez modifier la période de rétention.  
Type : Chaîne  
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.  
Modèle : `[a-zA-Z0-9_.-]+`   
Obligatoire : non

## Syntaxe de la réponse
<a name="API_UpdateDataRetention_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Eléments de réponse
<a name="API_UpdateDataRetention_ResponseElements"></a>

Si l’action aboutit, le service renvoie une réponse HTTP 200 avec un corps HTTP vide.

## Erreurs
<a name="API_UpdateDataRetention_Errors"></a>

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez [Types d'erreurs courants](CommonErrors.md).

 ** ClientLimitExceededException **   
Kinesis Video Streams a limité le nombre de demandes car vous avez dépassé le nombre maximal d'appels clients autorisés. Essayez de passer l'appel plus tard.  
Code d’état HTTP : 400

 ** InvalidArgumentException **   
La valeur de ce paramètre d'entrée n'est pas valide.  
Code d’état HTTP : 400

 ** NotAuthorizedException **   
L'appelant n'est pas autorisé à effectuer cette opération.  
Code d'état HTTP : 401

 ** ResourceInUseException **   
Lorsque l'entrée `StreamARN` ou `ChannelARN` l'entrée `CLOUD_STORAGE_MODE` est déjà mappée à une autre ressource Kinesis Video Stream, ou si l'`StreamARN`entrée `ChannelARN` fournie n'est pas active, essayez l'une des solutions suivantes :   

1. L'`DescribeMediaStorageConfiguration`API permettant de déterminer à quoi le canal donné est mappé. 

1. L'`DescribeMappedResourceConfiguration`API permettant de déterminer le canal auquel le flux donné est mappé. 

1. L'`DescribeSignalingChannel`API `DescribeStream` or pour déterminer le statut de la ressource. 
Code d’état HTTP : 400

 ** ResourceNotFoundException **   
Amazon Kinesis Video Streams ne trouve pas le flux que vous avez spécifié.  
Code d’état HTTP :404

 ** VersionMismatchException **   
La version de diffusion que vous avez spécifiée n'est pas la dernière version. Pour obtenir la dernière version, utilisez l'[DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API.  
Code d’état HTTP : 400

## Voir aussi
<a name="API_UpdateDataRetention_SeeAlso"></a>

Pour plus d'informations sur l'utilisation de cette API dans l'un des langages spécifiques AWS SDKs, consultez ce qui suit :
+  [AWS Interface de ligne de commande V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour V3 JavaScript ](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK pour Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateDataRetention) 