CreateLedger - Amazon Quantum Ledger Database (Amazon QLDB)
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

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.

CreateLedger

Crea un nuevo libro mayor Cuenta de AWS en tu región actual.

Sintaxis de la solicitud

POST /ledgers HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "Tags": { 
      "string" : "string" 
   }
}

Parámetros de solicitud del URI

La solicitud no utiliza ningún parámetro de URI.

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 en false.

Tipo: Booleano

Obligatorio: no

KmsKey

La clave in AWS Key Management Service (AWS KMS) que se utilizará para cifrar los datos almacenados 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.

  • Indefinido: de forma predeterminada, usa una clave de AWS KMS propia.

  • 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 AWS Key Management Service Guía para 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

Name

El nombre del libro mayor que desea crear. El nombre debe ser único entre todos los libros de contabilidad de la Cuenta de AWS región actual.

Las restricciones en la nomenclatura para los nombres de contabilidad se definen en Cuotas en Amazon QLDB en la Guía para desarrolladores de Amazon QLDB.

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-]+$

Obligatorio: sí

PermissionsMode

El modo de permisos que se va a asignar al libro mayor que desea crear. Este parámetro puede tener uno de los siguientes valores:

  • ALLOW_ALL: un modo de permisos heredado que habilita el control de acceso con granularidad de la API para los libros mayores.

    Este modo permite a los usuarios que tengan el permiso de API SendCommand para este libro mayor poner en marcha todos los comandos de PartiQL (por lo tanto, ALLOW_ALL) en cualquier tabla del libro mayor especificado. Este modo no tendrá en cuenta las políticas de permisos de IAM de la tabla o comando que cree para el libro mayor.

  • STANDARD: (recomendado) un modo de permisos que habilita el control de acceso con granularidad más precisa para libros mayores, tablas y comandos de PartiQL.

    De forma predeterminada, este modo deniega todas las solicitudes de los usuarios para poner en marcha cualquier comando de PartiQL en tablas de este libro mayor. Para permitir que se pongan en marcha comandos de PartiQL, debe crear políticas de permisos de IAM para recursos de tablas y acciones de PartiQL específicos, además del permiso de API SendCommand para el libro mayor. Para obtener más información, consulte Getting started with the standard permissions mode (Introducción al modo de permisos estándar) en la Guía para desarrolladores de Amazon QLDB.

nota

Recomendamos encarecidamente el modo STANDARD de permisos para maximizar la seguridad de los datos del libro mayor.

Tipo: cadena

Valores válidos: ALLOW_ALL | STANDARD

Obligatorio: sí

Tags

Los pares clave-valor que quiera agregar como etiquetas a al libro mayor que desea crear. Las claves de etiqueta distinguen entre mayúsculas y minúsculas. Los valores de etiquetas distinguen entre mayúsculas y minúsculas y pueden ser nulos.

Tipo: mapa de cadena a cadena

Entradas de mapa: número mínimo de 0 artículos. La cantidad máxima es de 200 artículos.

Limitaciones de longitud de la clave: longitud mínima de 1. Longitud máxima de 128.

Limitaciones de longitud de los valores: longitud mínima de 0. La longitud máxima es de 256 caracteres.

Obligatorio: no

Sintaxis de la respuesta

HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "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 en false.

Tipo: Booleano

KmsKeyArn

El ARN de la clave KMS administrada por el cliente que emplea el libro mayor para el cifrado en reposo. Si este parámetro no está definido, el libro mayor utiliza una clave KMS propia AWS para el cifrado.

Tipo: cadena

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

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-]+$

PermissionsMode

El modo de permisos del libro mayor que ha creado.

Tipo: cadena

Valores válidos: ALLOW_ALL | STANDARD

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

LimitExceededException

Ha alcanzado el límite del número máximo de recursos permitidos.

Código de estado HTTP: 400

ResourceAlreadyExistsException

El recurso especificado ya existe.

Código de estado HTTP: 409

ResourceInUseException

El recurso especificado no se puede modificar en este momento.

Código de estado HTTP: 409

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, consulte lo siguiente: