UpdateDataRetention - Amazon Kinesis Video Streams
Sintaxe da SolicitaçãoParâmetros da solicitação de URICorpo da SolicitaçãoSintaxe da RespostaElementos de RespostaErrosConsulte também

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

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

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 solicitação não usa nenhum parâmetro de URI.

Corpo da Solicitação

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

CurrentVersion

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. Comprimento máximo de 64.

Padrão: [a-zA-Z0-9]+

Exigido: Sim

DataRetentionChangeInHours

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

Indica se você deseja aumentar ou diminuir o período de retenção.

Tipo: strings

Valores Válidos: INCREASE_DATA_RETENTION | DECREASE_DATA_RETENTION

Obrigatório: Sim

StreamARN

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. Tamanho máximo de 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

O nome do stream cujo período de retenção você deseja alterar.

Tipo: string

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 256.

Padrão: [a-zA-Z0-9_.-]+

Obrigatório: Não

Sintaxe da Resposta

HTTP/1.1 200

Elementos de Resposta

Se a ação tiver êxito, o serviço enviará de volta uma resposta HTTP 200 com um corpo HTTP vazio.

Erros

Para obter informações sobre os erros comuns a todas as ações, consulte Erros comuns.

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 onde o stream determinado canal é mapeado.

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

  3. 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 DescribeStreamAPI.

Código de Status HTTP: 400

Consulte também

Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte: