

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

# GetLegalHold
<a name="API_GetLegalHold"></a>

Essa ação retorna detalhes de uma retenção legal especificada. Os detalhes são o corpo de uma retenção legal no formato JSON, além dos metadados.

## Sintaxe da Solicitação
<a name="API_GetLegalHold_RequestSyntax"></a>

```
GET /legal-holds/legalHoldId/ HTTP/1.1
```

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

A solicitação usa os seguintes parâmetros de URI:

 ** [legalHoldId](#API_GetLegalHold_RequestSyntax) **   <a name="Backup-GetLegalHold-request-uri-LegalHoldId"></a>
O ID da retenção legal.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

```
HTTP/1.1 200
Content-type: application/json

{
   "CancelDescription": "string",
   "CancellationDate": number,
   "CreationDate": number,
   "Description": "string",
   "LegalHoldArn": "string",
   "LegalHoldId": "string",
   "RecoveryPointSelection": { 
      "DateRange": { 
         "FromDate": number,
         "ToDate": number
      },
      "ResourceIdentifiers": [ "string" ],
      "VaultNames": [ "string" ]
   },
   "RetainRecordUntil": number,
   "Status": "string",
   "Title": "string"
}
```

## Elementos de resposta
<a name="API_GetLegalHold_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.

 ** [CancelDescription](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancelDescription"></a>
O motivo da remoção da retenção legal.  
Tipo: string

 ** [CancellationDate](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-CancellationDate"></a>
Hora em formato numérico em que a retenção legal foi cancelada.  
Tipo: Timestamp

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

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

 ** [LegalHoldArn](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-LegalHoldArn"></a>
O ARN do framework da retenção legal especificada. O formato do ARN depende do tipo de recurso.  
Tipo: string

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

 ** [RecoveryPointSelection](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-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)

 ** [RetainRecordUntil](#API_GetLegalHold_ResponseSyntax) **   <a name="Backup-GetLegalHold-response-RetainRecordUntil"></a>
A data e a hora até as quais o registro da retenção legal será retido.  
Tipo: Timestamp

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

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

## Erros
<a name="API_GetLegalHold_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

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

Código de status HTTP: 400

 ** ResourceNotFoundException **   
Um recurso necessário para a ação não existe.    
 ** 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_GetLegalHold_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/GetLegalHold) 
+  [AWS SDK para .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/backup-2018-11-15/GetLegalHold) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/backup-2018-11-15/GetLegalHold) 