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.
Limitaciones 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 por parte de cualquier usuario. Si no se define al crear el libro mayor, esta característica estará habilitada (
true
) de forma predeterminada.Si la protección contra eliminación está habilitada, primero debe desactivarla para poder eliminar el libro mayor. Puede llevar a cabo la desactivación mediante una llamada a la operación
UpdateLedger
para establecer este parámetro enfalse
.Tipo: Booleano
Obligatorio: no
- KmsKey
-
La clave in AWS Key Management Service (AWS KMS) que se utilizará para cifrar los datos en reposo en el libro mayor. Para obtener más información, consulte Encryption at rest (Cifrado en reposo) en la Guía para desarrolladores de Amazon QLDB.
Utilice una de las siguientes opciones para especificar este parámetro:
-
AWS_OWNED_KMS_KEY
: utilice una AWS KMS clave que sea de su propiedad y que esté AWS gestionada por usted. -
Sin definir: no realiza cambios en la clave KMS del libro mayor.
-
Una clave KMS válida y simétrica que administra el cliente: utilice la clave KMS de cifrado simétrico especificada en la cuenta que ha creado y que posee y administra.
Amazon QLDB no es compatible con claves asimétricas. Para obtener más información, consulte Uso de claves simétricas y asimétricas en la Guía para AWS Key Management Service desarrolladores.
Para especificar una clave KMS que administre el cliente, utilice el ID de clave, el nombre de recurso de Amazon (ARN), el nombre de alias o bien el ARN de alias. Cuando utilice un nombre de alias, utilice el prefijo
"alias/"
. Para especificar una clave en otra Cuenta de AWS, debe usar la clave ARN o el alias ARN.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 de alias:
arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
Para obtener más información, consulte los identificadores clave (KeyId) en la AWS Key Management Service Guía para desarrolladores.
Tipo: cadena
Limitaciones de longitud: longitud máxima 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.
Tipo: cadena
Limitaciones de longitud: longitud mínima de 20. La longitud máxima es de 1600 caracteres.
- CreationDateTime
-
La fecha y la hora, en formato de tiempo epoch, en que se creó el libro mayor. (El formato de tiempo Epoch es el número de segundos transcurridos desde las 12:00:00 a.m. del 1 de enero de 1970 en UTC.)
Tipo: marca temporal
- DeletionProtection
-
Especifica si el libro mayor está protegido contra la eliminación por parte de cualquier usuario. Si no se define al crear el libro mayor, esta característica estará habilitada (
true
) de forma predeterminada.Si la protección contra eliminación está habilitada, primero debe desactivarla para poder eliminar el libro mayor. Puede llevar a cabo la desactivación mediante una llamada a la operación
UpdateLedger
para establecer este parámetro enfalse
.Tipo: Booleano
- EncryptionDescription
-
Información sobre el cifrado de los datos en reposo del libro mayor. Esto incluye el estado actual, la AWS KMS clave y cuándo dejó de estar accesible la clave (en caso de error).
Tipo: objeto LedgerEncryptionDescription
- Name
-
El nombre de contabilidad.
Tipo: string
Limitaciones 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.
Tipo: cadena
Valores válidos:
CREATING | ACTIVE | DELETING | DELETED
Errores
Para obtener información acerca de los errores comunes a todas las acciones, consulte Errores comunes.
- InvalidParameterException
-
Uno o más 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 uno de los AWS SDK específicos del idioma, consulta lo siguiente: