

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

# DescribeBackupVault
<a name="API_DescribeBackupVault"></a>

Retorna metadados sobre um cofre de backup especificado por seu nome.

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

```
GET /backup-vaults/backupVaultName?backupVaultAccountId=BackupVaultAccountId HTTP/1.1
```

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

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

 ** [BackupVaultAccountId](#API_DescribeBackupVault_RequestSyntax) **   <a name="Backup-DescribeBackupVault-request-uri-BackupVaultAccountId"></a>
O ID da conta do cofre de backup especificado.

 ** [backupVaultName](#API_DescribeBackupVault_RequestSyntax) **   <a name="Backup-DescribeBackupVault-request-uri-BackupVaultName"></a>
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da AWS em que são criados.  
Obrigatório: Sim

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

Essa solicitação não tem corpo.

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

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

{
   "BackupVaultArn": "string",
   "BackupVaultName": "string",
   "CreationDate": number,
   "CreatorRequestId": "string",
   "EncryptionKeyArn": "string",
   "EncryptionKeyType": "string",
   "LatestMpaApprovalTeamUpdate": { 
      "ExpiryDate": number,
      "InitiationDate": number,
      "MpaSessionArn": "string",
      "Status": "string",
      "StatusMessage": "string"
   },
   "LockDate": number,
   "Locked": boolean,
   "MaxRetentionDays": number,
   "MinRetentionDays": number,
   "MpaApprovalTeamArn": "string",
   "MpaSessionArn": "string",
   "NumberOfRecoveryPoints": number,
   "SourceBackupVaultArn": "string",
   "VaultState": "string",
   "VaultType": "string"
}
```

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

 ** [BackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-BackupVaultArn"></a>
Um Nome do recurso da Amazon (ARN) que identifica de forma exclusiva um cofre de backup, por exemplo, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.  
Tipo: string

 ** [BackupVaultName](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-BackupVaultName"></a>
O nome de um contêiner lógico onde os backups são armazenados. Os cofres de backup são identificados por nomes que são exclusivos da conta usada para criá-los e a região da em que são criados.  
Tipo: string

 ** [CreationDate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-CreationDate"></a>
A data e hora em que o cofre de backup foi criado, em formato de hora Unix e Tempo Universal Coordenado (UTC). O valor de `CreationDate` tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.  
Tipo: Timestamp

 ** [CreatorRequestId](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-CreatorRequestId"></a>
Uma string exclusiva que identifica a solicitação e permite que as solicitações com falha sejam repetidas sem o risco de a operação ser executada duas vezes. Esse parâmetro é opcional. Se usado, esse parâmetro deve conter de 1 a 50 caracteres alfanuméricos ou “-\$1” .  
Tipo: string

 ** [EncryptionKeyArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyArn"></a>
A chave de criptografia no lado do servidor usada para proteger seus backups, por exemplo, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`.  
Tipo: string

 ** [EncryptionKeyType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-EncryptionKeyType"></a>
O tipo de chave de criptografia usada para o cofre de backup. Os valores válidos são CUSTOMER\$1MANAGED\$1KMS\$1KEY para chaves gerenciadas pelo cliente ou \$1OWNED\$1KMS\$1KEY para chaves de propriedade própria. AWS AWS  
Tipo: string  
Valores válidos: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY` 

 ** [LatestMpaApprovalTeamUpdate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-LatestMpaApprovalTeamUpdate"></a>
Informações sobre a atualização mais recente da associação da equipe de aprovação MPA para esse cofre de backup.  
Tipo: objeto [LatestMpaApprovalTeamUpdate](API_LatestMpaApprovalTeamUpdate.md)

 ** [LockDate](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-LockDate"></a>
A data e a hora em que a configuração do AWS Backup Vault Lock não pode ser alterada ou excluída.  
Se tiver aplicado o Vault Lock ao seu cofre sem especificar uma data de bloqueio, você poderá alterar qualquer uma das configurações do Vault Lock ou excluir totalmente o Vault Lock do cofre, a qualquer momento.  
Esse valor está no formato Unix, Tempo Universal Coordenado (UTC) e tem precisão de milissegundos. Por exemplo, o valor 1516925490,087 representa sexta-feira, 26 de janeiro de 2018, 0:11:30,087.  
Tipo: Timestamp

 ** [Locked](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-Locked"></a>
Um booleano que indica se o AWS Backup Vault Lock está atualmente protegendo o cofre de backup. `True`significa que o Vault Lock faz com que as operações de exclusão ou atualização nos pontos de recuperação armazenados no cofre falhem.  
Tipo: booliano

 ** [MaxRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MaxRetentionDays"></a>
A configuração AWS Backup Vault Lock que especifica o período máximo de retenção em que o cofre retém seus pontos de recuperação. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período máximo de retenção nos pontos de recuperação no cofre (permitindo o armazenamento indefinido).  
Se esse parâmetro for especificado, qualquer trabalho de backup ou de cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou inferior ao período máximo de retenção. Se o período de retenção do trabalho for maior do que o período máximo de retenção, haverá falha no trabalho de backup ou de cópia do cofre e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. Os pontos de recuperação já armazenados no cofre antes do Vault Lock não serão afetados.  
Tipo: longo

 ** [MinRetentionDays](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MinRetentionDays"></a>
A configuração do AWS Backup Vault Lock que especifica o período mínimo de retenção em que o cofre retém seus pontos de recuperação. Se esse parâmetro não for especificado, o Vault Lock não aplicará um período mínimo de retenção.  
Se esse parâmetro for especificado, qualquer trabalho de backup ou de cópia para o cofre deverá ter uma política de ciclo de vida com um período de retenção igual ou superior ao período mínimo de retenção. Se o período de retenção do trabalho for inferior do que o período mínimo de retenção, haverá falha do cofre no trabalho de backup ou de cópia e você deverá modificar as configurações do ciclo de vida ou usar um cofre diferente. Os pontos de recuperação já armazenados no cofre antes do Vault Lock não serão afetados.  
Tipo: longo

 ** [MpaApprovalTeamArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaApprovalTeamArn"></a>
O ARN da equipe de aprovação MPA associada a esse cofre de backup.  
Tipo: string

 ** [MpaSessionArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-MpaSessionArn"></a>
O ARN da sessão de MPA associada a esse cofre de backup.  
Tipo: string

 ** [NumberOfRecoveryPoints](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-NumberOfRecoveryPoints"></a>
O número de pontos de recuperação armazenados em um cofre de backup.  
O valor da contagem de pontos de recuperação exibido no console pode ser uma aproximação. Use a API [https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ListRecoveryPointsByBackupVault.html) para obter a contagem exata.  
Tipo: longo

 ** [SourceBackupVaultArn](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-SourceBackupVaultArn"></a>
O ARN do cofre de backup de origem pelo qual esse cofre de backup de acesso para restauração foi criado.  
Tipo: string

 ** [VaultState](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultState"></a>
O estado atual do cofre.->  
Tipo: string  
Valores válidos: `CREATING | AVAILABLE | FAILED` 

 ** [VaultType](#API_DescribeBackupVault_ResponseSyntax) **   <a name="Backup-DescribeBackupVault-response-VaultType"></a>
O tipo de cofre descrito.  
Tipo: string  
Valores válidos: `BACKUP_VAULT | LOGICALLY_AIR_GAPPED_BACKUP_VAULT | RESTORE_ACCESS_BACKUP_VAULT` 

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