Anforderungssyntax URI-Anfrageparameter Anforderungstext Antwortsyntax Antwortelemente Fehler Weitere Informationen finden Sie unter:

DescribeLedger

Gibt Informationen über ein Ledger zurück, einschließlich seines Status, seines Berechtigungsmodus, seiner Einstellungen für Verschlüsselung im Ruhezustand und wann es erstellt wurde.

Anforderungssyntax


GET /ledgers/name HTTP/1.1

URI-Anfrageparameter

Die Anforderung verwendet die folgenden URI-Parameter.

name

Der Name des Ledgers, das Sie beschreiben möchten.

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.

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

Erforderlich: Ja

Anforderungstext

Der Anforderung besitzt keinen Anforderungstext.

Antwortsyntax


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

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

Arn

Der Amazon-Ressourcenname (ARN) für das Ledger.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.

CreationDateTime

Datum und Uhrzeit der Erstellung des Ledgers im Epochenzeitformat. (Das Epochenzeitformat ist die Anzahl der Sekunden, die seit dem 1. Januar 1970 um 00:00:00 Uhr UTC vergangen sind.)

Typ: Zeitstempel

DeletionProtection

Gibt an, ob der Ledger vor dem Löschen durch einen beliebigen Benutzer geschützt ist. Wenn es während der Ledger-Erstellung nicht definiert wird, ist diese Funktion standardmäßig aktiviert (true).

Wenn der Löschschutz aktiviert ist, müssen Sie ihn zuerst deaktivieren, bevor Sie das Ledger löschen können. Sie können ihn deaktivieren, indem Sie mit dem UpdateLedger-Vorgang den Parameter auf false einstellen.

Typ: Boolesch

EncryptionDescription

Informationen zur Verschlüsselung ruhender Daten im Hauptbuch. Dazu gehören der aktuelle Status, der AWS KMS Schlüssel und der Zeitpunkt, an dem auf den Schlüssel nicht mehr zugegriffen werden konnte (im Falle eines Fehlers). Wenn dieser Parameter nicht definiert ist, verwendet das Ledger einen AWS eigenen KMS-Schlüssel für die Verschlüsselung.

Typ: LedgerEncryptionDescription Objekt

Name