UpdateLedger - Amazon Quantum Ledger Database (Amazon QLDB)

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

UpdateLedger

Actualiza las propiedades de un libro mayor.

Sintaxis de la solicitud

PATCH /ledgers/name HTTP/1.1 Content-type: application/json { "DeletionProtection": boolean, "KmsKey": "string" }

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

name

El nombre de contabilidad.

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 32 caracteres.

Patrón: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Obligatorio: Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

DeletionProtection

Especifica si el libro mayor está protegido contra la eliminación de un usuario. Si no se define durante la creación del libro mayor, esta característica está habilitada (true) de forma predeterminada.

Si la protección contra eliminación está habilitada, primero debe deshabilitarla para poder eliminar el libro mayor. Puede deshabilitarlo llamando alUpdateLedgerpara establecer este parámetro enfalse.

Type: Booleano

Obligatorio: No

KmsKey

La clave enAWS Key Management Service(AWS KMS) para usar para el cifrado de datos en reposo en el libro mayor. Para obtener más información, consulteCifrado en reposoen laGuía para desarrolladores de Amazon QLDB.

Utilice una de las siguientes opciones para especificar este parámetro:

  • AWS_OWNED_KMS_KEY: Utilice unAWS KMSClave que posee y administraAWSen su nombre.

  • Sin definir: No realice cambios en la clave KMS del libro mayor.

  • Una clave KMS simétrica válida administrada por el cliente: Utilice la clave KMS de cifrado simétrica especificada en su cuenta que usted ha creado, posee y administra.

    Amazon QLDB no admite claves asimétricas. Para obtener más información, consulteUsar claves simétricas y asimétricasen la AWS Key Management ServiceGuía para desarrolladores.

Para especificar una clave KMS administrada por el cliente, puede utilizar su ID de clave, Nombre de recurso de Amazon (ARN), nombre de alias o ARN del alias. Cuando utilice un nombre del alias, utilice el prefijo"alias/". Para especificar una clave en otraCuenta de AWS, debe utilizar el ARN del alias o el ARN del alias.

Por ejemplo:

  • ID de clave: 1234abcd-12ab-34cd-56ef-1234567890ab

  • ARN de clave: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Nombre de alias: alias/ExampleAlias

  • ARN del alias:arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

Para obtener más información, consulteIdentificadores de clave (KeyId)en la AWS Key Management ServiceGuía para desarrolladores.

Type: Cadena

Restricciones de longitud: La longitud máxima es de 1600 caracteres.

Obligatorio: No

Sintaxis de la respuesta

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 respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

Arn

El nombre de recurso de Amazon (ARN) para el libro mayor.

Type: Cadena

Restricciones de longitud: Longitud mínima de 20. La longitud máxima es de 1600 caracteres.

CreationDateTime

Es la fecha y la hora en que se creó el libro mayor en formato de tiempo en que se creó el libro mayor. (El formato de tiempo en formato Unix es el número de segundos transcurridos desde las 12:00:00 a.m. del 1 de enero de 1970 en UTC.)

Type: Marca temporal

DeletionProtection

Especifica si el libro mayor está protegido contra la eliminación de un usuario. Si no se define durante la creación del libro mayor, esta característica está habilitada (true) de forma predeterminada.

Si la protección contra eliminación está habilitada, primero debe deshabilitarla para poder eliminar el libro mayor. Puede deshabilitarlo llamando alUpdateLedgerpara establecer este parámetro enfalse.

Type: Booleano

EncryptionDescription

Información sobre el cifrado de datos en reposo en el libro mayor. Esto incluye el estado actual, elAWS KMSy cuando la clave se volvió inaccesible (en caso de error).

Tipo: objeto LedgerEncryptionDescription

Name

El nombre de contabilidad.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 32 caracteres.

Patrón: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

State

El estado actual del libro mayor.

Type: Cadena

Valores válidos: CREATING | ACTIVE | DELETING | DELETED

Errores

Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.

InvalidParameterException

Uno o varios parámetros de la solicitud no son válidos.

Código de estado HTTP: 400

ResourceNotFoundException

El recurso especificado no existe.

Código de estado HTTP: 404

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: