Sintaxis de la solicitud Parámetros de solicitud del URI Cuerpo de la solicitud Sintaxis de la respuesta Elementos de respuesta Errores Véase también

DescribeLedger

Devuelve información sobre un libro mayor, incluyendo su estado, modo de permisos, configuración de cifrado en reposo y cuándo se creó.

Sintaxis de la solicitud


GET /ledgers/name HTTP/1.1

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

name

El nombre del libro mayor que desea describir.

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 no tiene un cuerpo de la solicitud.

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",
   "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

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 se volvió inaccesible a la clave (en caso de error). Si este parámetro no está definido, el libro mayor utiliza una clave KMS propia AWS para el cifrado.

Tipo: objeto LedgerEncryptionDescription

Name