Sintaxe da Solicitação Parâmetros da Solicitação de URI Corpo da Solicitação Sintaxe da Resposta Elementos de Resposta Erros Consulte Também

UpdateLedger

Atualiza propriedades em um ledger.

Sintaxe da Solicitação


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

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

Parâmetros da Solicitação de URI

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

name

O nome do ledger.

Restrições de tamanho: tamanho mínimo 1. Comprimento máximo de 32.

Padrão: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Exigido: Sim

Corpo da Solicitação

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

DeletionProtection

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

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, 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 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) no Guia do AWS Key Management Service desenvolvedor.

Tipo: sequência

Restrições de tamanho: tamanho máximo de 1600.

Obrigatório: Não

Sintaxe da Resposta


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

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

O nome do recurso da Amazon (ARN) para o ledger.

Tipo: sequência

Restrições de tamanho: tamanho mínimo 20. Comprimento máximo de 1.600.

CreationDateTime

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: carimbo de data/hora

DeletionProtection

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.

Tipo: booliano

EncryptionDescription

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

Name