CreateLegalHold - AWS Backup

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á.

CreateLegalHold

Cria uma retenção legal em um ponto de recuperação (backup). Uma retenção legal é uma restrição à alteração ou exclusão de um backup até que um usuário autorizado cancele a retenção legal. haverá falha em qualquer ação para excluir ou desassociar um ponto de recuperação com um erro se uma ou mais retenções legais ativas estiverem no ponto de recuperação.

Sintaxe da Solicitação

POST /legal-holds/ HTTP/1.1 Content-type: application/json { "Description": "string", "IdempotencyToken": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Tags": { "string" : "string" }, "Title": "string" }

URIParâmetros de solicitação

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

Corpo da Solicitação

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

Description

A descrição da retenção legal.

Tipo: string

Obrigatório: Sim

IdempotencyToken

Essa é uma string escolhida pelo usuário usada para distinguir entre chamadas idênticas. Tentar novamente uma solicitação com êxito com o mesmo token de idempotência resultará em uma mensagem de êxito sem nenhuma ação tomada.

Tipo: string

Obrigatório: Não

RecoveryPointSelection

Os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.

Tipo: objeto RecoveryPointSelection

Obrigatório: Não

Tags

Tags opcionais a serem incluídas. Uma tag é um par de chave/valor que ajuda você a gerenciar, filtrar e pesquisar seus recursos. Os caracteres permitidos incluem UTF -8 letras, números, espaços e os seguintes caracteres: + - =. _: /.

Tipo: mapa de string para string

Obrigatório: Não

Title

O título da retenção legal.

Tipo: string

Obrigatório: Sim

Sintaxe da Resposta

HTTP/1.1 200 Content-type: application/json { "CreationDate": number, "Description": "string", "LegalHoldArn": "string", "LegalHoldId": "string", "RecoveryPointSelection": { "DateRange": { "FromDate": number, "ToDate": number }, "ResourceIdentifiers": [ "string" ], "VaultNames": [ "string" ] }, "Status": "string", "Title": "string" }

Elementos de Resposta

Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP de 200.

Os dados a seguir são retornados em JSON formato pelo serviço.

CreationDate

A hora em que a retenção legal foi criada.

Tipo: carimbo de data/hora

Description

A descrição da retenção legal.

Tipo: string

LegalHoldArn

O nome do recurso Amazon (ARN) da retenção legal.

Tipo: string

LegalHoldId

O ID da retenção legal.

Tipo: string

RecoveryPointSelection

Os critérios a serem atribuídos a um conjunto de recursos, como tipos de recursos ou cofres de backup.

Tipo: objeto RecoveryPointSelection

Status

O status da retenção legal.

Tipo: string

Valores Válidos: CREATING | ACTIVE | CANCELING | CANCELED

Title

O título da retenção legal.

Tipo: string

Erros

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

InvalidParameterValueException

Indica que há algo errado com o valor de um parâmetro. Por exemplo, o valor está fora do intervalo.

HTTPCódigo de status: 400

LimitExceededException

Um limite na solicitação foi excedido; por exemplo, o número máximo de itens permitidos em uma solicitação.

HTTPCódigo de status: 400

MissingParameterValueException

Indica que um parâmetro necessário está ausente.

HTTPCódigo de status: 400

ServiceUnavailableException

Houve falha na solicitação devido a um erro temporário do servidor.

HTTPCódigo de status: 500

Consulte também

Para obter mais informações sobre como usar isso API em um idioma específico AWS SDKs, consulte o seguinte: