

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

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

Aumenta ou diminui o período de retenção de dados do stream de acordo com o valor que você especificar. Para indicar se você deseja aumentar ou diminuir o período de retenção de dados, especifique o `Operation` parâmetro no corpo da solicitação. Na solicitação, você deve especificar o `StreamName` ou `StreamARN` o. 

Essa operação exige permissão para a ação `KinesisVideo:UpdateDataRetention`.

A alteração do período de retenção de dados afeta os dados no fluxo da seguinte forma:
+ Se o período de retenção de dados for aumentado, os dados existentes serão retidos pelo novo período de retenção. Por exemplo, se o período de retenção de dados for aumentado de uma hora para sete horas, todos os dados existentes serão retidos por sete horas.
+ Se o período de retenção de dados for reduzido, os dados existentes serão retidos pelo novo período de retenção. Por exemplo, se o período de retenção de dados for reduzido de sete horas para uma hora, todos os dados existentes serão retidos por uma hora e todos os dados com mais de uma hora serão excluídos imediatamente.

## Sintaxe da Solicitação
<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"
}
```

## Parâmetros da solicitação de URI
<a name="API_UpdateDataRetention_RequestParameters"></a>

A solicitação não usa nenhum parâmetro de URI.

## Corpo da Solicitação
<a name="API_UpdateDataRetention_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [CurrentVersion](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-CurrentVersion"></a>
A versão do stream cujo período de retenção você deseja alterar. Para obter a versão, chame a API `DescribeStream` ou a `ListStreams` API.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 64.  
Padrão: `[a-zA-Z0-9]+`   
Obrigatório: Sim

 ** [DataRetentionChangeInHours](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-DataRetentionChangeInHours"></a>
O número de horas para ajustar a retenção atual. O valor especificado é adicionado ou subtraído do valor atual, dependendo do. `operation`  
O valor mínimo para retenção de dados é 0 e o valor máximo é 87600 (dez anos).  
Tipo: inteiro  
Intervalo válido: valor mínimo de 1.  
Obrigatório: Sim

 ** [Operation](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-Operation"></a>
Indica se você deseja aumentar ou diminuir o período de retenção.  
Tipo: string  
Valores válidos: `INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION`   
Obrigatório: Sim

 ** [StreamARN](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamARN"></a>
O Amazon Resource Name (ARN) do stream cujo período de retenção você deseja alterar.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. O comprimento máximo é 1.024.  
Padrão: `arn:[a-z\d-]+:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+`   
Obrigatório: não

 ** [StreamName](#API_UpdateDataRetention_RequestSyntax) **   <a name="KinesisVideo-UpdateDataRetention-request-StreamName"></a>
O nome do stream cujo período de retenção você deseja alterar.  
Tipo: string  
Restrições de tamanho: tamanho mínimo 1. Tamanho máximo de 256.  
Padrão: `[a-zA-Z0-9_.-]+`   
Obrigatório: Não

## Sintaxe da resposta
<a name="API_UpdateDataRetention_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Elementos de Resposta
<a name="API_UpdateDataRetention_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço reenviará uma resposta 200 HTTP com um corpo HTTP vazio.

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

Para informações sobre os erros comuns retornados pelas ações, consulte [Tipos de erro comuns](CommonErrors.md).

 ** ClientLimitExceededException **   
O Kinesis Video Streams limitou a solicitação porque você excedeu o limite permitido de chamadas de clientes. Tente fazer a ligação mais tarde.  
Código de status HTTP: 400

 ** InvalidArgumentException **   
O valor desse parâmetro de entrada é inválido.  
Código de status HTTP: 400

 ** NotAuthorizedException **   
O chamador não está autorizado a realizar essa operação.  
Código de status HTTP: 401

 ** ResourceInUseException **   
Quando a entrada `StreamARN` ou `ChannelARN` a entrada já estiverem mapeadas para um recurso diferente do Kinesis Video Stream, ou se a `StreamARN` entrada `ChannelARN` fornecida não estiver no status Ativo, tente uma das seguintes opções: `CLOUD_STORAGE_MODE`   

1. A `DescribeMediaStorageConfiguration` API para determinar para qual stream determinado canal é mapeado. 

1. A `DescribeMappedResourceConfiguration` API para determinar o canal para o qual o determinado fluxo é mapeado. 

1. A `DescribeSignalingChannel` API `DescribeStream` ou para determinar o status do recurso. 
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O Amazon Kinesis Video Streams não consegue encontrar o stream que você especificou.  
Código de status HTTP: 404

 ** VersionMismatchException **   
A versão do stream que você especificou não é a versão mais recente. Para obter a versão mais recente, use a [DescribeStream](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_DescribeStream.html)API.  
Código de Status HTTP: 400

## Consulte também
<a name="API_UpdateDataRetention_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Interface de linha de comando V2](https://docs.aws.amazon.com/goto/cli2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/kinesisvideo-2017-09-30/UpdateDataRetention) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kinesisvideo-2017-09-30/UpdateDataRetention) 