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

# UpdateLedger
<a name="API_UpdateLedger"></a>

Atualiza propriedades em um ledger.

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

```
PATCH /ledgers/name HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string"
}
```

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

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

 ** [name](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-uri-Name"></a>
O nome do ledger.  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 32.  
Padrão: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$`   
Exigido: Sim

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

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

 ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-DeletionProtection"></a>
Especifica se o ledger está protegido contra exclusão por qualquer usuário. Se ele não for fornecido na criação do razão, esse recurso estará habilitado (`true`) por padrão.  
Se a proteção contra exclusão estiver habilitada, você deverá desabilitá-la antes de excluir o razão. Você pode desabilitá-lo chamando a operação `UpdateLedger` para definir esse parâmetro como `false`.  
Tipo: booliano  
Obrigatório: não

 ** [KmsKey](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-KmsKey"></a>
A chave in AWS Key Management Service (AWS KMS) a ser usada para criptografia de dados em repouso no livro contábil. Para obter mais informações, consulte [Criptografia em repouso](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html), no *Guia do desenvolvedor do Amazon QLDB*.  
Utilize uma das seguintes opções para especificar esse parâmetro:  
+  `AWS_OWNED_KMS_KEY`: use uma AWS KMS chave que pertença e seja AWS gerenciada por você.
+  **Indefinido**: não faz alterações na chave KMS do ledger.
+  **Uma chave simétrica do KMS válida e gerenciada pelo cliente**: use a chave do KMS de criptografia simétrica, que você cria, detém e gerencia, especificada na sua conta.

  O Amazon QLDB não oferece suporte a chaves assimétricas. *Para obter mais informações, consulte Como [usar chaves simétricas e assimétricas no Guia](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) do AWS Key Management Service desenvolvedor.*
Para especificar uma chave do KMS gerenciada pelo cliente, use o ID da chave, o nome do recurso da Amazon (ARN), o nome do alias ou o ARN do alias. Ao usar um nome de alias, use `"alias/"` como prefixo. Para especificar uma chave em outra Conta da AWS, você deve usar o ARN da chave ou o alias ARN.  
Por exemplo:  
+ ID da chave: `1234abcd-12ab-34cd-56ef-1234567890ab` 
+ ARN da chave: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Nome do alias: `alias/ExampleAlias` 
+ ARN do alias: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias` 
Para obter mais informações, consulte [Identificadores de chave (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) no *Guia do AWS Key Management Service desenvolvedor*.  
Tipo: String  
Restrições de tamanho: tamanho máximo de 1600.  
Obrigatório: Não

## Sintaxe da Resposta
<a name="API_UpdateLedger_ResponseSyntax"></a>

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

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "EncryptionDescription": { 
      "EncryptionStatus": "string",
      "InaccessibleKmsKeyDateTime": number,
      "KmsKeyArn": "string"
   },
   "Name": "string",
   "State": "string"
}
```

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

 ** [Arn](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Arn"></a>
O nome do recurso da Amazon (ARN) para o ledger.  
Tipo: String  
Restrições de tamanho: tamanho mínimo 20. Comprimento máximo de 1.600.

 ** [CreationDateTime](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-CreationDateTime"></a>
A data e a hora, no formato epoch, quando o ledger foi criado. (O formato de hora epoch é o número de segundos decorridos desde as 0h de 1 de janeiro de 1970 em UTC.)  
Tipo: Timestamp

 ** [DeletionProtection](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-DeletionProtection"></a>
Especifica se o ledger está protegido contra exclusão por qualquer usuário. Se ele não for fornecido na criação do razão, esse recurso estará habilitado (`true`) por padrão.  
Se a proteção contra exclusão estiver habilitada, você deverá desabilitá-la antes de excluir o razão. Você pode desabilitá-lo chamando a operação `UpdateLedger` para definir esse parâmetro como `false`.  
Tipo: booliano

 ** [EncryptionDescription](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-EncryptionDescription"></a>
Informações sobre a criptografia de dados em repouso em um ledger. Isso inclui o status atual, a AWS KMS chave e quando a chave ficou inacessível (no caso de um erro).  
Tipo: objeto [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md)

 ** [Name](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Name"></a>
O nome do ledger.  
Tipo: String  
Restrições de comprimento: tamanho mínimo de 1. Comprimento máximo de 32.  
Padrão: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [State](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-State"></a>
O status atual do ledger.  
Tipo: String  
Valores Válidos: `CREATING | ACTIVE | DELETING | DELETED` 

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

Para obter informações sobre os erros que são comuns a todas as ações, consulte [Erros comuns](CommonErrors.md).

 ** InvalidParameterException **   
Um ou mais parâmetros na solicitação não são válidos.  
Código de status HTTP: 400

 ** ResourceNotFoundException **   
O recurso especificado não existe.  
Código de status HTTP: 404

## Consulte também
<a name="API_UpdateLedger_SeeAlso"></a>

Para obter mais informações sobre como usar essa API em uma das linguagens específicas AWS SDKs, consulte o seguinte:
+  [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK para Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedger)