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
<a name="API_CreateLegalHold"></a>

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
<a name="API_CreateLegalHold_RequestSyntax"></a>

```
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"
}
```

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

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

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

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

 ** [Description](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Description"></a>
A descrição da string da retenção legal.  
Tipo: String  
Obrigatório: Sim

 ** [IdempotencyToken](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-IdempotencyToken"></a>
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](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-RecoveryPointSelection"></a>
Os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.  
Tipo: objeto [RecoveryPointSelection](API_RecoveryPointSelection.md)  
Obrigatório: não

 ** [Tags](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Tags"></a>
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 letras, números e espaços em UTF-8, além dos seguintes caracteres especiais: \$1 - = . \$1 : /.   
Tipo: mapa de string para string  
Obrigatório: não

 ** [Title](#API_CreateLegalHold_RequestSyntax) **   <a name="Backup-CreateLegalHold-request-Title"></a>
O título da retenção legal.  
Tipo: String  
Obrigatório: sim

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

```
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
<a name="API_CreateLegalHold_ResponseElements"></a>

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

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

 ** [CreationDate](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-CreationDate"></a>
A hora em que a retenção legal foi criada.  
Tipo: Timestamp

 ** [Description](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Description"></a>
A descrição da string da retenção legal.  
Tipo: string

 ** [LegalHoldArn](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldArn"></a>
O nome do recurso da Amazon (ARN) da retenção legal.  
Tipo: string

 ** [LegalHoldId](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-LegalHoldId"></a>
O ID da retenção legal.  
Tipo: string

 ** [RecoveryPointSelection](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-RecoveryPointSelection"></a>
Os critérios para atribuir um conjunto de recursos, como tipos de recursos ou cofres de backup.  
Tipo: objeto [RecoveryPointSelection](API_RecoveryPointSelection.md)

 ** [Status](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Status"></a>
O status da retenção legal.  
Tipo: string  
Valores válidos: `CREATING | ACTIVE | CANCELING | CANCELED` 

 ** [Title](#API_CreateLegalHold_ResponseSyntax) **   <a name="Backup-CreateLegalHold-response-Title"></a>
O título da retenção legal.  
Tipo: string

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

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

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

Código de status HTTP: 400

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

Código de status HTTP: 400

 ** MissingParameterValueException **   
Indica que um parâmetro necessário está ausente.    
 ** Context **   
  
 ** Type **   

Código de status HTTP: 400

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

Código de status HTTP: 500

## Consulte também
<a name="API_CreateLegalHold_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/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/CreateLegalHold) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/CreateLegalHold)