Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

# Amazon QLDB API-Referenz
<a name="api-reference"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

In diesem Kapitel werden die Low-Level-API-Operationen für Amazon QLDB beschrieben, auf die über HTTP, die AWS Command Line Interface (AWS CLI) oder ein SDK zugegriffen werden kann: AWS 
+ *Amazon QLDB* *— Die QLDB-Ressourcenmanagement-API (auch als Kontrollebene bezeichnet).* Diese API wird nur für die Verwaltung von Ledger-Ressourcen und für nicht transaktionale Datenoperationen verwendet. Sie können diese Operationen verwenden, um Ledger zu erstellen, zu löschen, zu beschreiben, aufzulisten und zu aktualisieren. Sie können Journaldaten auch kryptografisch überprüfen und Journalblöcke exportieren oder streamen.
+ *Amazon QLDB Session* — Die QLDB-Transaktionsdaten-API. Sie können diese API verwenden, um Datentransaktionen in einem Ledger mit [PartiQL-Anweisungen](ql-reference.md) auszuführen.
**Wichtig**  
Anstatt direkt mit der *QLDB Session* API zu interagieren, empfehlen wir, den QLDB-Treiber oder die QLDB-Shell zu verwenden, um Datentransaktionen in einem Ledger auszuführen.  
Wenn Sie mit einem AWS SDK arbeiten, verwenden Sie den QLDB-Treiber. Der Treiber bietet eine abstrakte Ebene über der *QLDB-Sitzungsdaten-API* und verwaltet den `SendCommand` Vorgang für Sie. Für weitere Informationen und eine Liste der unterstützten Programmiersprachen siehe [Erste Schritte mit dem Treiber](getting-started-driver.md).
Wenn Sie mit dem arbeiten AWS CLI, verwenden Sie die QLDB-Shell. Die Shell ist eine Befehlszeilenschnittstelle, die den QLDB-Treiber verwendet, um mit einem Ledger zu interagieren. Weitere Informationen finden Sie unter [Verwenden der Amazon QLDB-Shell (nur Daten-API)](data-shell.md).

**Topics**
+ [

# Aktionen
](API_Operations.md)
+ [

# Datentypen
](API_Types.md)
+ [

# Häufige Fehler
](CommonErrors.md)
+ [

# Geläufige Parameter
](CommonParameters.md)

# Aktionen
<a name="API_Operations"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgenden Aktionen werden von Amazon QLDB unterstützt:
+  [CancelJournalKinesisStream](API_CancelJournalKinesisStream.md) 
+  [CreateLedger](API_CreateLedger.md) 
+  [DeleteLedger](API_DeleteLedger.md) 
+  [DescribeJournalKinesisStream](API_DescribeJournalKinesisStream.md) 
+  [DescribeJournalS3Export](API_DescribeJournalS3Export.md) 
+  [DescribeLedger](API_DescribeLedger.md) 
+  [ExportJournalToS3](API_ExportJournalToS3.md) 
+  [GetBlock](API_GetBlock.md) 
+  [GetDigest](API_GetDigest.md) 
+  [GetRevision](API_GetRevision.md) 
+  [ListJournalKinesisStreamsForLedger](API_ListJournalKinesisStreamsForLedger.md) 
+  [ListJournalS3Exports](API_ListJournalS3Exports.md) 
+  [ListJournalS3ExportsForLedger](API_ListJournalS3ExportsForLedger.md) 
+  [ListLedgers](API_ListLedgers.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StreamJournalToKinesis](API_StreamJournalToKinesis.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateLedger](API_UpdateLedger.md) 
+  [UpdateLedgerPermissionsMode](API_UpdateLedgerPermissionsMode.md) 

Die folgenden Aktionen werden von Amazon QLDB Session unterstützt:
+  [SendCommand](API_QLDB-Session_SendCommand.md) 

# Amazon QLDB
<a name="API_Operations_Amazon_QLDB"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgenden Aktionen werden von Amazon QLDB unterstützt:
+  [CancelJournalKinesisStream](API_CancelJournalKinesisStream.md) 
+  [CreateLedger](API_CreateLedger.md) 
+  [DeleteLedger](API_DeleteLedger.md) 
+  [DescribeJournalKinesisStream](API_DescribeJournalKinesisStream.md) 
+  [DescribeJournalS3Export](API_DescribeJournalS3Export.md) 
+  [DescribeLedger](API_DescribeLedger.md) 
+  [ExportJournalToS3](API_ExportJournalToS3.md) 
+  [GetBlock](API_GetBlock.md) 
+  [GetDigest](API_GetDigest.md) 
+  [GetRevision](API_GetRevision.md) 
+  [ListJournalKinesisStreamsForLedger](API_ListJournalKinesisStreamsForLedger.md) 
+  [ListJournalS3Exports](API_ListJournalS3Exports.md) 
+  [ListJournalS3ExportsForLedger](API_ListJournalS3ExportsForLedger.md) 
+  [ListLedgers](API_ListLedgers.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [StreamJournalToKinesis](API_StreamJournalToKinesis.md) 
+  [TagResource](API_TagResource.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateLedger](API_UpdateLedger.md) 
+  [UpdateLedgerPermissionsMode](API_UpdateLedgerPermissionsMode.md) 

# CancelJournalKinesisStream
<a name="API_CancelJournalKinesisStream"></a>

Beendet einen bestimmten Amazon QLDB-Journal-Stream. Bevor ein Stream abgebrochen werden kann, muss sein aktueller Status „`ACTIVE`“ lauten.

Sie können einen Stream nicht neu starten, nachdem Sie ihn abgebrochen haben. Stornierte QLDB-Stream-Ressourcen unterliegen einer Aufbewahrungsfrist von 7 Tagen, sodass sie nach Ablauf dieses Limits automatisch gelöscht werden.

## Anforderungssyntax
<a name="API_CancelJournalKinesisStream_RequestSyntax"></a>

```
DELETE /ledgers/name/journal-kinesis-streams/streamId HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_CancelJournalKinesisStream_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_CancelJournalKinesisStream_RequestSyntax) **   <a name="qldb-CancelJournalKinesisStream-request-uri-LedgerName"></a>
Der Name des Ledgers.  
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

 ** [streamId](#API_CancelJournalKinesisStream_RequestSyntax) **   <a name="qldb-CancelJournalKinesisStream-request-uri-StreamId"></a>
Die UUID (dargestellt in Base62-codiertem Text) des QLDB-Journal-Streams, der storniert werden soll.  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

## Anforderungstext
<a name="API_CancelJournalKinesisStream_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_CancelJournalKinesisStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamId": "string"
}
```

## Antwortelemente
<a name="API_CancelJournalKinesisStream_ResponseElements"></a>

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.

 ** [StreamId](#API_CancelJournalKinesisStream_ResponseSyntax) **   <a name="qldb-CancelJournalKinesisStream-response-StreamId"></a>
Die UUID (Base62-codierter Text) des stornierten QLDB-Journal-Streams.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$` 

## Fehler
<a name="API_CancelJournalKinesisStream_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_CancelJournalKinesisStream_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/CancelJournalKinesisStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/CancelJournalKinesisStream) 

# CreateLedger
<a name="API_CreateLedger"></a>

Erstellt ein neues Hauptbuch in Ihrem AWS-Konto in der aktuellen Region.

## Anforderungssyntax
<a name="API_CreateLedger_RequestSyntax"></a>

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

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

## URI-Anfrageparameter
<a name="API_CreateLedger_RequestParameters"></a>

Die Anforderung verwendet keine URI-Parameter.

## Anforderungstext
<a name="API_CreateLedger_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [DeletionProtection](#API_CreateLedger_RequestSyntax) **   <a name="qldb-CreateLedger-request-DeletionProtection"></a>
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  
Erforderlich: Nein

 ** [KmsKey](#API_CreateLedger_RequestSyntax) **   <a name="qldb-CreateLedger-request-KmsKey"></a>
Der Schlüssel in AWS Key Management Service (AWS KMS), der für die Verschlüsselung ruhender Daten im Ledger verwendet werden soll. Weitere Informationen finden Sie unter [Verschlüsselung im Ruhezustand](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) im *Amazon-QLDB-Entwicklerhandbuch*.  
Verwenden Sie eine der folgenden Optionen, um diesen Parameter anzugeben:  
+  `AWS_OWNED_KMS_KEY`: Verwenden Sie einen AWS KMS Schlüssel, der in Ihrem Namen gehört und von AWS diesem verwaltet wird.
+  **Undefiniert**: Verwenden Sie standardmäßig einen AWS eigenen KMS-Schlüssel.
+  **Ein gültiger, symmetrischer, vom Kunden verwalteter KMS-Schlüssel**: Den angegebenen symmetrischen KMS-Verschlüsselungsschlüssel in Ihrem Konto verwenden, den Sie erstellen, besitzen und verwalten.

  Amazon EBS unterstützt keine asymmetrischen Schlüssel. *Weitere Informationen finden Sie unter [Verwenden von symmetrischen und asymmetrischen Schlüsseln im AWS Key Management Service Entwicklerhandbuch](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html).*
Um einen vom Kunden verwalteten KMS-Schlüssel anzugeben, können Sie seine Schlüssel-ID, den Amazon-Ressourcennamen (ARN), den Aliasnamen oder den Alias-ARN verwenden. Wenn Sie einen Aliasnamen verwenden, stellen Sie ihm `"alias/"` voran. Um einen Schlüssel in einem anderen anzugeben AWS-Konto, müssen Sie den Schlüssel ARN oder den Alias ARN verwenden.  
Zum Beispiel:  
+ Schlüssel-ID: `1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Schüssel-ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Alias-Name: `alias/ExampleAlias` 
+ Alias-ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias` 
Weitere Informationen finden Sie unter [Schlüsselkennungen (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) im * AWS Key Management Service Entwicklerhandbuch*.  
Typ: Zeichenfolge  
Längenbeschränkungen: Die maximale Länge beträgt 1600.  
Erforderlich: Nein

 ** [Name](#API_CreateLedger_RequestSyntax) **   <a name="qldb-CreateLedger-request-Name"></a>
Der Name des Ledgers, das Sie erstellen möchten. Der Name muss für alle Ledger AWS-Konto in Ihrer aktuellen Region eindeutig sein.  
Die Beschränkungen für die Namen von Ledgern sind im Abschnitt [Kontingente in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) im *Amazon QLDB-Entwicklerhandbuch* definiert.  
Typ: Zeichenfolge  
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

 ** [PermissionsMode](#API_CreateLedger_RequestSyntax) **   <a name="qldb-CreateLedger-request-PermissionsMode"></a>
Der Berechtigungsmodus, der dem Ledger zugewiesen werden soll, das Sie erstellen möchten. Folgende Parameterwerte sind möglich:  
+  `ALLOW_ALL`: Ein Legacy-Berechtigungsmodus, der die Zugriffskontrolle mit Granularität auf API-Ebene für Ledgers ermöglicht.

  Dieser Modus ermöglicht Benutzern, die `SendCommand`-API-Berechtigung für dieses Ledger zum Ausführen aller PartiQL-Befehle (daher `ALLOW_ALL`) auf beliebigen Tabellen im angegebenen Ledger auszuführen. Dieser Modus ignoriert alle IAM-Berechtigungs-Richtlinien auf Tabellen- oder Befehls-Ebene, die Sie für das Ledger erstellen.
+  `STANDARD`: (*Empfohlen*) Ein Berechtigungsmodus, der Zugriffskontrolle mit feinerer Granularität für Ledger, Tabellen und PartiQL-Befehle ermöglicht.

  Standardmäßig verweigert dieser Modus alle Benutzer-Anforderungen zur Ausführung von PartiQL-Befehlen für Tabellen in diesem Ledger. Damit PartiQL-Befehle ausgeführt werden können, müssen Sie IAM-Berechtigungs-Richtlinien für bestimmte Tabellen-Ressourcen und PartiQL-Aktionen erstellen, zusätzlich zu den `SendCommand` API-Berechtigung für den Ledger. Weitere Informationen finden Sie unter [Erste Schritte mit dem Standard-Berechtigungsmodus](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) im *Amazon-QLDB-Entwicklerhandbuch*.
Wir empfehlen dringend, den `STANDARD` Berechtigungsmodus, um die Sicherheit Ihrer Ledger-Daten zu maximieren.
Typ: Zeichenfolge  
Zulässige Werte: `ALLOW_ALL | STANDARD`   
Erforderlich: Ja

 ** [Tags](#API_CreateLedger_RequestSyntax) **   <a name="qldb-CreateLedger-request-Tags"></a>
Die Schlüssel-Wert-Paare, die dem Ledger, das Sie erstellen möchten, als Tags hinzugefügt werden sollen. Bei Tag-Schlüsseln wird zwischen Groß- und Kleinschreibung unterschieden. Bei Tag-Werten wird zwischen Groß- und Kleinschreibung unterschieden und sie können Null sein.  
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge  
Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 200 Elemente.  
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.  
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.  
Erforderlich: Nein

## Antwortsyntax
<a name="API_CreateLedger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreationDateTime": number,
   "DeletionProtection": boolean,
   "KmsKeyArn": "string",
   "Name": "string",
   "PermissionsMode": "string",
   "State": "string"
}
```

## Antwortelemente
<a name="API_CreateLedger_ResponseElements"></a>

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](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-Arn"></a>
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](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-CreationDateTime"></a>
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](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-DeletionProtection"></a>
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

 ** [KmsKeyArn](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-KmsKeyArn"></a>
Der ARN des vom Kunden verwalteten KMS-Schlüssels, den das Ledger für die Verschlüsselung im Ruhezustand verwendet. Wenn dieser Parameter nicht definiert ist, verwendet das Ledger einen AWS eigenen KMS-Schlüssel für die Verschlüsselung.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.

 ** [Name](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-Name"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.  
Pattern: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-PermissionsMode"></a>
Der Berechtigungsmodus des Ledgers, das Sie erstellt haben.  
Typ: Zeichenfolge  
Zulässige Werte: `ALLOW_ALL | STANDARD` 

 ** [State](#API_CreateLedger_ResponseSyntax) **   <a name="qldb-CreateLedger-response-State"></a>
Der aktuelle Status des Ledgers.  
Typ: Zeichenfolge  
Zulässige Werte: `CREATING | ACTIVE | DELETING | DELETED` 

## Fehler
<a name="API_CreateLedger_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** LimitExceededException **   
Sie haben das Limit für die maximal zulässige Anzahl von Ressourcen erreicht.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
Die angegebene Ressource ist bereits vorhanden.  
HTTP-Statuscode: 409

 ** ResourceInUseException **   
Die angegebene Ressource kann derzeit nicht geändert werden.  
HTTP-Statuscode: 409

## Weitere Informationen finden Sie unter:
<a name="API_CreateLedger_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/CreateLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/CreateLedger) 

# DeleteLedger
<a name="API_DeleteLedger"></a>

Löscht ein Ledger und seinen gesamten Inhalt. Diese Aktion ist unumkehrbar.

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.

## Anforderungssyntax
<a name="API_DeleteLedger_RequestSyntax"></a>

```
DELETE /ledgers/name HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_DeleteLedger_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_DeleteLedger_RequestSyntax) **   <a name="qldb-DeleteLedger-request-uri-Name"></a>
Der Name des Ledgers, das Sie löschen 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
<a name="API_DeleteLedger_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_DeleteLedger_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Antwortelemente
<a name="API_DeleteLedger_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.

## Fehler
<a name="API_DeleteLedger_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceInUseException **   
Die angegebene Ressource kann derzeit nicht geändert werden.  
HTTP-Statuscode: 409

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_DeleteLedger_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DeleteLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DeleteLedger) 

# DescribeJournalKinesisStream
<a name="API_DescribeJournalKinesisStream"></a>

Gibt detaillierte Informationen zu einem bestimmten Amazon QLDB-Journal-Stream zurück. Die Ausgabe umfasst den Amazon-Ressourcennamen (ARN), den Streamnamen, den aktuellen Status, die Erstellungszeit und die Parameter der ursprünglichen Stream-Erstellungsanforderung.

Diese Aktion gibt keine abgelaufenen Journal-Streams zurück. Weitere Informationen finden Sie unter [Ablauf von Terminal-Streams](https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) im *Amazon QLDB Developer Guide*.

## Anforderungssyntax
<a name="API_DescribeJournalKinesisStream_RequestSyntax"></a>

```
GET /ledgers/name/journal-kinesis-streams/streamId HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_DescribeJournalKinesisStream_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_DescribeJournalKinesisStream_RequestSyntax) **   <a name="qldb-DescribeJournalKinesisStream-request-uri-LedgerName"></a>
Der Name des Ledgers.  
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

 ** [streamId](#API_DescribeJournalKinesisStream_RequestSyntax) **   <a name="qldb-DescribeJournalKinesisStream-request-uri-StreamId"></a>
Die UUID (dargestellt in Base62-codiertem Text) des zu beschreibenden QLDB-Journal-Streams.  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

## Anforderungstext
<a name="API_DescribeJournalKinesisStream_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_DescribeJournalKinesisStream_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Stream": { 
      "Arn": "string",
      "CreationTime": number,
      "ErrorCause": "string",
      "ExclusiveEndTime": number,
      "InclusiveStartTime": number,
      "KinesisConfiguration": { 
         "AggregationEnabled": boolean,
         "StreamArn": "string"
      },
      "LedgerName": "string",
      "RoleArn": "string",
      "Status": "string",
      "StreamId": "string",
      "StreamName": "string"
   }
}
```

## Antwortelemente
<a name="API_DescribeJournalKinesisStream_ResponseElements"></a>

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.

 ** [Stream](#API_DescribeJournalKinesisStream_ResponseSyntax) **   <a name="qldb-DescribeJournalKinesisStream-response-Stream"></a>
Informationen über den QLDB-Journal-Stream, der von einer `DescribeJournalS3Export` Anfrage zurückgegeben wurde.  
Typ: [JournalKinesisStreamDescription](API_JournalKinesisStreamDescription.md) Objekt

## Fehler
<a name="API_DescribeJournalKinesisStream_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_DescribeJournalKinesisStream_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeJournalKinesisStream) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeJournalKinesisStream) 

# DescribeJournalS3Export
<a name="API_DescribeJournalS3Export"></a>

Gibt Informationen über einen Journalexportjob zurück, einschließlich des Hauptbuchnamens, der Export-ID, der Erstellungszeit, des aktuellen Status und der Parameter der ursprünglichen Exporterstellungsanforderung.

Diese Aktion gibt keine abgelaufenen Exportaufträge zurück. Weitere Informationen finden Sie unter [Ablauf von Exportaufträgen](https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) im *Amazon QLDB Developer Guide*.

Wenn der Exportauftrag mit dem angegebenen Wert nicht `ExportId` existiert, wird er ausgelöst. `ResourceNotFoundException`

Wenn das Hauptbuch mit dem angegebenen Objekt nicht `Name` existiert, wird geworfen. `ResourceNotFoundException`

## Anforderungssyntax
<a name="API_DescribeJournalS3Export_RequestSyntax"></a>

```
GET /ledgers/name/journal-s3-exports/exportId HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_DescribeJournalS3Export_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [exportId](#API_DescribeJournalS3Export_RequestSyntax) **   <a name="qldb-DescribeJournalS3Export-request-uri-ExportId"></a>
Die UUID (dargestellt in Base62-codiertem Text) des zu beschreibenden Journal-Exportjobs.  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

 ** [name](#API_DescribeJournalS3Export_RequestSyntax) **   <a name="qldb-DescribeJournalS3Export-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_DescribeJournalS3Export_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_DescribeJournalS3Export_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ExportDescription": { 
      "ExclusiveEndTime": number,
      "ExportCreationTime": number,
      "ExportId": "string",
      "InclusiveStartTime": number,
      "LedgerName": "string",
      "OutputFormat": "string",
      "RoleArn": "string",
      "S3ExportConfiguration": { 
         "Bucket": "string",
         "EncryptionConfiguration": { 
            "KmsKeyArn": "string",
            "ObjectEncryptionType": "string"
         },
         "Prefix": "string"
      },
      "Status": "string"
   }
}
```

## Antwortelemente
<a name="API_DescribeJournalS3Export_ResponseElements"></a>

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.

 ** [ExportDescription](#API_DescribeJournalS3Export_ResponseSyntax) **   <a name="qldb-DescribeJournalS3Export-response-ExportDescription"></a>
Informationen über den Journalexportauftrag, der durch eine `DescribeJournalS3Export` Anfrage zurückgegeben wurde.  
Typ: [JournalS3ExportDescription](API_JournalS3ExportDescription.md) Objekt

## Fehler
<a name="API_DescribeJournalS3Export_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_DescribeJournalS3Export_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeJournalS3Export) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeJournalS3Export) 

# DescribeLedger
<a name="API_DescribeLedger"></a>

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
<a name="API_DescribeLedger_RequestSyntax"></a>

```
GET /ledgers/name HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_DescribeLedger_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_DescribeLedger_RequestSyntax) **   <a name="qldb-DescribeLedger-request-uri-Name"></a>
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
<a name="API_DescribeLedger_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_DescribeLedger_ResponseSyntax"></a>

```
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
<a name="API_DescribeLedger_ResponseElements"></a>

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](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Arn"></a>
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](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-CreationDateTime"></a>
Das Datum und die 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](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-DeletionProtection"></a>
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](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-EncryptionDescription"></a>
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](API_LedgerEncryptionDescription.md) Objekt

 ** [Name](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-Name"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.  
Pattern: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-PermissionsMode"></a>
Der Berechtigungsmodus des Ledgers.  
Typ: Zeichenfolge  
Zulässige Werte: `ALLOW_ALL | STANDARD` 

 ** [State](#API_DescribeLedger_ResponseSyntax) **   <a name="qldb-DescribeLedger-response-State"></a>
Der aktuelle Status des Ledgers.  
Typ: Zeichenfolge  
Zulässige Werte: `CREATING | ACTIVE | DELETING | DELETED` 

## Fehler
<a name="API_DescribeLedger_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_DescribeLedger_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/DescribeLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/DescribeLedger) 

# ExportJournalToS3
<a name="API_ExportJournalToS3"></a>

Exportiert Journalinhalte innerhalb eines Datums- und Zeitbereichs aus einem Hauptbuch in einen angegebenen Amazon Simple Storage Service (Amazon S3) -Bucket. Ein Journal-Exportauftrag kann die Datenobjekte entweder in der Text- oder Binärdarstellung des Amazon Ion-Formats oder im *JSON Lines-Textformat* schreiben.

Wenn das Hauptbuch mit den angegebenen Daten nicht `Name` existiert, wird geworfen`ResourceNotFoundException`.

Wenn sich das Hauptbuch mit dem angegebenen Wert im `CREATING` Status `Name` befindet, wird geworfen. `ResourcePreconditionNotMetException`

Sie können bis zu zwei gleichzeitige Journalexportanfragen für jedes Buch initiieren. Bei Überschreitung dieser Grenze werden Journal-Exportanfragen ausgelöst. `LimitExceededException`

## Anforderungssyntax
<a name="API_ExportJournalToS3_RequestSyntax"></a>

```
POST /ledgers/name/journal-s3-exports HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "OutputFormat": "string",
   "RoleArn": "string",
   "S3ExportConfiguration": { 
      "Bucket": "string",
      "EncryptionConfiguration": { 
         "KmsKeyArn": "string",
         "ObjectEncryptionType": "string"
      },
      "Prefix": "string"
   }
}
```

## URI-Anfrageparameter
<a name="API_ExportJournalToS3_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_ExportJournalToS3_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [ExclusiveEndTime](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-ExclusiveEndTime"></a>
Das exklusive Enddatum und die Uhrzeit für den Bereich der zu exportierenden Journalinhalte.  
`ExclusiveEndTime` muss im `ISO 8601`-Datums- und Uhrzeitformat sowie in UTC (Universal Coordinated Time) vorliegen. Beispiel: `2019-06-13T21:36:34Z`.  
`ExclusiveEndTime` muss früher oder gleich dem aktuellen UTC-Datum und der Uhrzeit sein.  
Typ: Zeitstempel  
Erforderlich: Ja

 ** [InclusiveStartTime](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-InclusiveStartTime"></a>
Das inklusive Startdatum und die Startzeit für den Bereich der zu exportierenden Journalinhalte.  
`InclusiveStartTime` muss im `ISO 8601`-Datums- und Uhrzeitformat sowie in UTC (Universal Coordinated Time) vorliegen. Beispiel: `2019-06-13T21:36:34Z`.  
Das `InclusiveStartTime` muss vorher sein`ExclusiveEndTime`.  
Wenn Sie ein angeben`InclusiveStartTime`, das vor dem Ledger steht`CreationDateTime`, verwendet Amazon QLDB standardmäßig das des Ledgers. `CreationDateTime`  
Typ: Zeitstempel  
Erforderlich: Ja

 ** [OutputFormat](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-OutputFormat"></a>
Das Ausgabeformat Ihrer exportierten Journaldaten. Ein Journal-Exportauftrag kann die Datenobjekte entweder in der Text- oder Binärdarstellung des [Amazon Ion-Formats](https://docs.aws.amazon.com/qldb/latest/developerguide/ion.html) oder im [JSON Lines-Textformat](https://jsonlines.org/) schreiben.  
Standard: `ION_TEXT`   
Im Format JSON Lines ist jeder Journalblock in einem exportierten Datenobjekt ein gültiges JSON-Objekt, das durch eine neue Zeile begrenzt ist. Sie können dieses Format verwenden, um JSON-Exporte direkt in Analysetools wie Amazon Athena zu integrieren, und AWS Glue weil diese Dienste JSON mit Zeilenumbrüchen automatisch analysieren können.  
Typ: Zeichenfolge  
Zulässige Werte: `ION_BINARY | ION_TEXT | JSON`   
Erforderlich: Nein

 ** [RoleArn](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-RoleArn"></a>
Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die QLDB-Berechtigungen für einen Journal-Exportauftrag erteilt, um Folgendes auszuführen:  
+ Schreiben Sie Objekte in Ihren Amazon S3 S3-Bucket.
+ (Optional) Verwenden Sie Ihren vom Kunden verwalteten Schlüssel in AWS Key Management Service (AWS KMS) für die serverseitige Verschlüsselung Ihrer exportierten Daten.
Um bei der Anforderung eines Journalexports eine Rolle an QLDB zu übergeben, müssen Sie über die Berechtigungen verfügen, um die `iam:PassRole` Aktion für die IAM-Rollenressource auszuführen. Dies ist für alle Journalexportanfragen erforderlich.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** [S3ExportConfiguration](#API_ExportJournalToS3_RequestSyntax) **   <a name="qldb-ExportJournalToS3-request-S3ExportConfiguration"></a>
Die Konfigurationseinstellungen des Amazon S3 S3-Bucket-Ziels für Ihre Exportanfrage.  
Typ: [S3ExportConfiguration](API_S3ExportConfiguration.md) Objekt  
Erforderlich: Ja

## Antwortsyntax
<a name="API_ExportJournalToS3_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "ExportId": "string"
}
```

## Antwortelemente
<a name="API_ExportJournalToS3_ResponseElements"></a>

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.

 ** [ExportId](#API_ExportJournalToS3_ResponseSyntax) **   <a name="qldb-ExportJournalToS3-response-ExportId"></a>
Die UUID (dargestellt in Base62-codiertem Text), die QLDB jedem Journal-Exportjob zuweist.  
Um Ihre Exportanfrage zu beschreiben und den Status des Jobs zu überprüfen, können Sie anrufen. `ExportId` `DescribeJournalS3Export`  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$` 

## Fehler
<a name="API_ExportJournalToS3_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_ExportJournalToS3_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ExportJournalToS3) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ExportJournalToS3) 

# GetBlock
<a name="API_GetBlock"></a>

Gibt ein Blockobjekt an einer angegebenen Adresse in einem Journal zurück. Gibt auch einen Nachweis für den angegebenen Block zur Überprüfung zurück, wenn `DigestTipAddress` bereitgestellt wird.

Informationen zu den Dateninhalten in einem Block finden Sie unter [Journalinhalte](https://docs.aws.amazon.com/qldb/latest/developerguide/journal-contents.html) im *Amazon QLDB Developer Guide*.

Wenn das angegebene Ledger nicht existiert oder sich im `DELETING` Status befindet, wird ausgelöst. `ResourceNotFoundException`

Wenn sich das angegebene Ledger im `CREATING` Status befindet, wird ausgelöst. `ResourcePreconditionNotMetException`

Wenn kein Block mit der angegebenen Adresse existiert, wird ausgelöst. `InvalidParameterException`

## Anforderungssyntax
<a name="API_GetBlock_RequestSyntax"></a>

```
POST /ledgers/name/block HTTP/1.1
Content-type: application/json

{
   "BlockAddress": { 
      "IonText": "string"
   },
   "DigestTipAddress": { 
      "IonText": "string"
   }
}
```

## URI-Anfrageparameter
<a name="API_GetBlock_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_GetBlock_RequestSyntax) **   <a name="qldb-GetBlock-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_GetBlock_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [BlockAddress](#API_GetBlock_RequestSyntax) **   <a name="qldb-GetBlock-request-BlockAddress"></a>
Die Position des Blocks, den Sie anfordern möchten. Eine Adresse ist eine Amazon Ion-Struktur mit zwei Feldern: `strandId` und`sequenceNo`.  
Beispiel: `{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}`.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt  
Erforderlich: Ja

 ** [DigestTipAddress](#API_GetBlock_RequestSyntax) **   <a name="qldb-GetBlock-request-DigestTipAddress"></a>
Der letzte Blockstandort, für den die Zusammenfassung gilt und für den ein Nachweis angefordert werden soll. Eine Adresse ist eine Amazon Ion-Struktur mit zwei Feldern: `strandId` und`sequenceNo`.  
Beispiel: `{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}`.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt  
Erforderlich: Nein

## Antwortsyntax
<a name="API_GetBlock_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Block": { 
      "IonText": "string"
   },
   "Proof": { 
      "IonText": "string"
   }
}
```

## Antwortelemente
<a name="API_GetBlock_ResponseElements"></a>

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.

 ** [Block](#API_GetBlock_ResponseSyntax) **   <a name="qldb-GetBlock-response-Block"></a>
Das Blockdatenobjekt im Amazon Ion-Format.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt

 ** [Proof](#API_GetBlock_ResponseSyntax) **   <a name="qldb-GetBlock-response-Proof"></a>
Das durch eine `GetBlock` Anfrage zurückgesendete Beweisobjekt im Amazon Ion-Format. Ein Proof enthält die Liste der Hash-Werte, die für die Neuberechnung des angegebenen Digest mithilfe eines Merkle-Baums erforderlich sind, wobei mit dem angegebenen Block begonnen wird.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt

## Fehler
<a name="API_GetBlock_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_GetBlock_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/GetBlock) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/GetBlock) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/GetBlock) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/GetBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/GetBlock) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/GetBlock) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/GetBlock) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/GetBlock) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/GetBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/GetBlock) 

# GetDigest
<a name="API_GetDigest"></a>

Gibt den Digest eines Ledgers zum letzten festgeschriebenen Block im Journal zurück. Die Antwort enthält einen 256-Bit-Hashwert und eine Blockadresse.

## Anforderungssyntax
<a name="API_GetDigest_RequestSyntax"></a>

```
POST /ledgers/name/digest HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_GetDigest_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_GetDigest_RequestSyntax) **   <a name="qldb-GetDigest-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_GetDigest_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_GetDigest_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Digest": blob,
   "DigestTipAddress": { 
      "IonText": "string"
   }
}
```

## Antwortelemente
<a name="API_GetDigest_ResponseElements"></a>

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.

 ** [Digest](#API_GetDigest_ResponseSyntax) **   <a name="qldb-GetDigest-response-Digest"></a>
Der 256-Bit-Hashwert, der den von einer Anfrage zurückgegebenen Digest darstellt. `GetDigest`  
Typ: Base64-kodiertes Binärdatenobjekt  
Längenbeschränkungen: Feste Länge von 32.

 ** [DigestTipAddress](#API_GetDigest_ResponseSyntax) **   <a name="qldb-GetDigest-response-DigestTipAddress"></a>
Die letzte Blockposition, auf die sich der von Ihnen angeforderte Digest bezieht. Eine Adresse ist eine Amazon Ion-Struktur mit zwei Feldern: `strandId` und`sequenceNo`.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt

## Fehler
<a name="API_GetDigest_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_GetDigest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/GetDigest) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/GetDigest) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/GetDigest) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/GetDigest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/GetDigest) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/GetDigest) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/GetDigest) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/GetDigest) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/GetDigest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/GetDigest) 

# GetRevision
<a name="API_GetRevision"></a>

Gibt ein Revisionsdatenobjekt für eine angegebene Dokument-ID und Blockadresse zurück. Gibt auch einen Nachweis der angegebenen Revision zur Überprüfung zurück, falls `DigestTipAddress` bereitgestellt wird.

## Anforderungssyntax
<a name="API_GetRevision_RequestSyntax"></a>

```
POST /ledgers/name/revision HTTP/1.1
Content-type: application/json

{
   "BlockAddress": { 
      "IonText": "string"
   },
   "DigestTipAddress": { 
      "IonText": "string"
   },
   "DocumentId": "string"
}
```

## URI-Anfrageparameter
<a name="API_GetRevision_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_GetRevision_RequestSyntax) **   <a name="qldb-GetRevision-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_GetRevision_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [BlockAddress](#API_GetRevision_RequestSyntax) **   <a name="qldb-GetRevision-request-BlockAddress"></a>
Die Blockposition der Dokumentrevision, die überprüft werden soll. Eine Adresse ist eine Amazon Ion-Struktur mit zwei Feldern: `strandId` und`sequenceNo`.  
Beispiel: `{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}`.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt  
Erforderlich: Ja

 ** [DigestTipAddress](#API_GetRevision_RequestSyntax) **   <a name="qldb-GetRevision-request-DigestTipAddress"></a>
Der letzte Blockstandort, für den die Zusammenfassung gilt und für den ein Nachweis angefordert werden soll. Eine Adresse ist eine Amazon Ion-Struktur mit zwei Feldern: `strandId` und`sequenceNo`.  
Beispiel: `{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}`.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt  
Erforderlich: Nein

 ** [DocumentId](#API_GetRevision_RequestSyntax) **   <a name="qldb-GetRevision-request-DocumentId"></a>
Die UUID (dargestellt in Base62-codiertem Text) des zu verifizierenden Dokuments.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

## Antwortsyntax
<a name="API_GetRevision_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Proof": { 
      "IonText": "string"
   },
   "Revision": { 
      "IonText": "string"
   }
}
```

## Antwortelemente
<a name="API_GetRevision_ResponseElements"></a>

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.

 ** [Proof](#API_GetRevision_ResponseSyntax) **   <a name="qldb-GetRevision-response-Proof"></a>
Das durch eine `GetRevision` Anfrage zurückgesendete Beweisobjekt im Amazon Ion-Format. Ein Proof enthält die Liste der Hash-Werte, die erforderlich sind, um den angegebenen Digest anhand eines Merkle-Baums neu zu berechnen, wobei mit der angegebenen Dokumentrevision begonnen wird.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt

 ** [Revision](#API_GetRevision_ResponseSyntax) **   <a name="qldb-GetRevision-response-Revision"></a>
Das Revisionsdatenobjekt des Dokuments im Amazon Ion-Format.  
Typ: [ValueHolder](API_ValueHolder.md) Objekt

## Fehler
<a name="API_GetRevision_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_GetRevision_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/GetRevision) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/GetRevision) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/GetRevision) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/GetRevision) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/GetRevision) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/GetRevision) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/GetRevision) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/GetRevision) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/GetRevision) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/GetRevision) 

# ListJournalKinesisStreamsForLedger
<a name="API_ListJournalKinesisStreamsForLedger"></a>

Gibt alle Amazon QLDB-Journal-Streams für ein bestimmtes Ledger zurück.

Diese Aktion gibt keine abgelaufenen Journal-Streams zurück. Weitere Informationen finden Sie unter [Ablauf von Terminal-Streams](https://docs.aws.amazon.com/qldb/latest/developerguide/streams.create.html#streams.create.states.expiration) im *Amazon QLDB Developer Guide*.

Diese Aktion gibt ein Maximum an Artikeln zurück. `MaxResults` Sie ist paginiert, sodass Sie alle Elemente abrufen können, indem Sie sie `ListJournalKinesisStreamsForLedger` mehrmals aufrufen.

## Anforderungssyntax
<a name="API_ListJournalKinesisStreamsForLedger_RequestSyntax"></a>

```
GET /ledgers/name/journal-kinesis-streams?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_ListJournalKinesisStreamsForLedger_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_ListJournalKinesisStreamsForLedger_RequestSyntax) **   <a name="qldb-ListJournalKinesisStreamsForLedger-request-uri-LedgerName"></a>
Der Name des Ledgers.  
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

 ** [MaxResults](#API_ListJournalKinesisStreamsForLedger_RequestSyntax) **   <a name="qldb-ListJournalKinesisStreamsForLedger-request-uri-MaxResults"></a>
Die maximale Anzahl von Ergebnissen, die in einer einzigen `ListJournalKinesisStreamsForLedger` Anfrage zurückgegeben werden können. (Die tatsächliche Anzahl der zurückgegebenen Ergebnisse ist möglicherweise geringer.)  
Gültiger Bereich: Mindestwert 1. Maximalwert 100.

 ** [NextToken](#API_ListJournalKinesisStreamsForLedger_RequestSyntax) **   <a name="qldb-ListJournalKinesisStreamsForLedger-request-uri-NextToken"></a>
Ein Paginierungstoken, das angibt, dass Sie die nächste Ergebnisseite abrufen möchten. Wenn Sie `NextToken` in der Antwort eines früheren `ListJournalKinesisStreamsForLedger` Anrufs einen Wert für erhalten haben, sollten Sie diesen Wert hier als Eingabe verwenden.  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Anforderungstext
<a name="API_ListJournalKinesisStreamsForLedger_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_ListJournalKinesisStreamsForLedger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "Streams": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "ErrorCause": "string",
         "ExclusiveEndTime": number,
         "InclusiveStartTime": number,
         "KinesisConfiguration": { 
            "AggregationEnabled": boolean,
            "StreamArn": "string"
         },
         "LedgerName": "string",
         "RoleArn": "string",
         "Status": "string",
         "StreamId": "string",
         "StreamName": "string"
      }
   ]
}
```

## Antwortelemente
<a name="API_ListJournalKinesisStreamsForLedger_ResponseElements"></a>

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.

 ** [NextToken](#API_ListJournalKinesisStreamsForLedger_ResponseSyntax) **   <a name="qldb-ListJournalKinesisStreamsForLedger-response-NextToken"></a>
+ Wenn leer `NextToken` ist, wurde die letzte Ergebnisseite verarbeitet und es können keine weiteren Ergebnisse abgerufen werden.
+ Wenn *nicht* leer `NextToken` ist, sind mehr Ergebnisse verfügbar. Um die nächste Ergebnisseite abzurufen, verwenden Sie den Wert von `NextToken` in einem nachfolgenden `ListJournalKinesisStreamsForLedger`-Aufruf.
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

 ** [Streams](#API_ListJournalKinesisStreamsForLedger_ResponseSyntax) **   <a name="qldb-ListJournalKinesisStreamsForLedger-response-Streams"></a>
Die QLDB-Journal-Streams, die derzeit dem angegebenen Ledger zugeordnet sind.  
Typ: Array von [JournalKinesisStreamDescription](API_JournalKinesisStreamDescription.md)-Objekten

## Fehler
<a name="API_ListJournalKinesisStreamsForLedger_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_ListJournalKinesisStreamsForLedger_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListJournalKinesisStreamsForLedger) 

# ListJournalS3Exports
<a name="API_ListJournalS3Exports"></a>

Gibt alle Journalexportaufträge für alle Bücher zurück, die dem aktuellen AWS-Konto Buch und der Region zugeordnet sind.

Diese Aktion gibt ein Maximum an `MaxResults` Elementen zurück und ist paginiert, sodass Sie alle Elemente abrufen können, indem Sie sie `ListJournalS3Exports` mehrmals aufrufen.

Diese Aktion gibt keine abgelaufenen Exportaufträge zurück. Weitere Informationen finden Sie unter [Ablauf von Exportaufträgen](https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) im *Amazon QLDB Developer Guide*.

## Anforderungssyntax
<a name="API_ListJournalS3Exports_RequestSyntax"></a>

```
GET /journal-s3-exports?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_ListJournalS3Exports_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [MaxResults](#API_ListJournalS3Exports_RequestSyntax) **   <a name="qldb-ListJournalS3Exports-request-uri-MaxResults"></a>
Die maximale Anzahl von Ergebnissen, die in einer einzigen `ListJournalS3Exports` Anfrage zurückgegeben werden können. (Die tatsächliche Anzahl der zurückgegebenen Ergebnisse ist möglicherweise geringer.)  
Gültiger Bereich: Mindestwert 1. Maximalwert 100.

 ** [NextToken](#API_ListJournalS3Exports_RequestSyntax) **   <a name="qldb-ListJournalS3Exports-request-uri-NextToken"></a>
Ein Paginierungstoken, das angibt, dass Sie die nächste Ergebnisseite abrufen möchten. Wenn Sie `NextToken` in der Antwort eines früheren `ListJournalS3Exports` Anrufs einen Wert für erhalten haben, sollten Sie diesen Wert hier als Eingabe verwenden.  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Anforderungstext
<a name="API_ListJournalS3Exports_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_ListJournalS3Exports_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "JournalS3Exports": [ 
      { 
         "ExclusiveEndTime": number,
         "ExportCreationTime": number,
         "ExportId": "string",
         "InclusiveStartTime": number,
         "LedgerName": "string",
         "OutputFormat": "string",
         "RoleArn": "string",
         "S3ExportConfiguration": { 
            "Bucket": "string",
            "EncryptionConfiguration": { 
               "KmsKeyArn": "string",
               "ObjectEncryptionType": "string"
            },
            "Prefix": "string"
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Antwortelemente
<a name="API_ListJournalS3Exports_ResponseElements"></a>

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.

 ** [JournalS3Exports](#API_ListJournalS3Exports_ResponseSyntax) **   <a name="qldb-ListJournalS3Exports-response-JournalS3Exports"></a>
Die Journalexportaufträge für alle Bücher, die dem aktuellen Buch AWS-Konto und der Region zugeordnet sind.  
Typ: Array von [JournalS3ExportDescription](API_JournalS3ExportDescription.md)-Objekten

 ** [NextToken](#API_ListJournalS3Exports_ResponseSyntax) **   <a name="qldb-ListJournalS3Exports-response-NextToken"></a>
+ Wenn leer `NextToken` ist, wurde die letzte Ergebnisseite verarbeitet und es können keine weiteren Ergebnisse abgerufen werden.
+ Wenn *nicht* leer `NextToken` ist, sind weitere Ergebnisse verfügbar. Um die nächste Ergebnisseite abzurufen, verwenden Sie den Wert von `NextToken` in einem nachfolgenden `ListJournalS3Exports`-Aufruf.
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Fehler
<a name="API_ListJournalS3Exports_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

## Weitere Informationen finden Sie unter:
<a name="API_ListJournalS3Exports_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListJournalS3Exports) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListJournalS3Exports) 

# ListJournalS3ExportsForLedger
<a name="API_ListJournalS3ExportsForLedger"></a>

Gibt alle Journalexportaufträge für ein bestimmtes Ledger zurück.

Diese Aktion gibt ein Maximum an `MaxResults` Elementen zurück und ist paginiert, sodass Sie alle Elemente abrufen können, indem Sie sie `ListJournalS3ExportsForLedger` mehrmals aufrufen.

Diese Aktion gibt keine abgelaufenen Exportaufträge zurück. Weitere Informationen finden Sie unter [Ablauf von Exportaufträgen](https://docs.aws.amazon.com/qldb/latest/developerguide/export-journal.request.html#export-journal.request.expiration) im *Amazon QLDB Developer Guide*.

## Anforderungssyntax
<a name="API_ListJournalS3ExportsForLedger_RequestSyntax"></a>

```
GET /ledgers/name/journal-s3-exports?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_ListJournalS3ExportsForLedger_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [MaxResults](#API_ListJournalS3ExportsForLedger_RequestSyntax) **   <a name="qldb-ListJournalS3ExportsForLedger-request-uri-MaxResults"></a>
Die maximale Anzahl von Ergebnissen, die in einer einzigen `ListJournalS3ExportsForLedger` Anfrage zurückgegeben werden können. (Die tatsächliche Anzahl der zurückgegebenen Ergebnisse ist möglicherweise geringer.)  
Gültiger Bereich: Mindestwert 1. Maximalwert 100.

 ** [name](#API_ListJournalS3ExportsForLedger_RequestSyntax) **   <a name="qldb-ListJournalS3ExportsForLedger-request-uri-Name"></a>
Der Name des Ledgers.  
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

 ** [NextToken](#API_ListJournalS3ExportsForLedger_RequestSyntax) **   <a name="qldb-ListJournalS3ExportsForLedger-request-uri-NextToken"></a>
Ein Paginierungstoken, das angibt, dass Sie die nächste Ergebnisseite abrufen möchten. Wenn Sie `NextToken` in der Antwort eines früheren `ListJournalS3ExportsForLedger` Anrufs einen Wert für erhalten haben, sollten Sie diesen Wert hier als Eingabe verwenden.  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Anforderungstext
<a name="API_ListJournalS3ExportsForLedger_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_ListJournalS3ExportsForLedger_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "JournalS3Exports": [ 
      { 
         "ExclusiveEndTime": number,
         "ExportCreationTime": number,
         "ExportId": "string",
         "InclusiveStartTime": number,
         "LedgerName": "string",
         "OutputFormat": "string",
         "RoleArn": "string",
         "S3ExportConfiguration": { 
            "Bucket": "string",
            "EncryptionConfiguration": { 
               "KmsKeyArn": "string",
               "ObjectEncryptionType": "string"
            },
            "Prefix": "string"
         },
         "Status": "string"
      }
   ],
   "NextToken": "string"
}
```

## Antwortelemente
<a name="API_ListJournalS3ExportsForLedger_ResponseElements"></a>

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.

 ** [JournalS3Exports](#API_ListJournalS3ExportsForLedger_ResponseSyntax) **   <a name="qldb-ListJournalS3ExportsForLedger-response-JournalS3Exports"></a>
Die Journalexportaufträge, die derzeit dem angegebenen Ledger zugeordnet sind.  
Typ: Array von [JournalS3ExportDescription](API_JournalS3ExportDescription.md)-Objekten

 ** [NextToken](#API_ListJournalS3ExportsForLedger_ResponseSyntax) **   <a name="qldb-ListJournalS3ExportsForLedger-response-NextToken"></a>
+ Wenn leer `NextToken` ist, wurde die letzte Ergebnisseite verarbeitet und es können keine weiteren Ergebnisse abgerufen werden.
+ Wenn *nicht* leer `NextToken` ist, sind weitere Ergebnisse verfügbar. Um die nächste Ergebnisseite abzurufen, verwenden Sie den Wert von `NextToken` in einem nachfolgenden `ListJournalS3ExportsForLedger`-Aufruf.
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Fehler
<a name="API_ListJournalS3ExportsForLedger_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

## Weitere Informationen finden Sie unter:
<a name="API_ListJournalS3ExportsForLedger_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListJournalS3ExportsForLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListJournalS3ExportsForLedger) 

# ListLedgers
<a name="API_ListLedgers"></a>

Gibt alle Ledger zurück, die dem aktuellen Konto AWS-Konto und der Region zugeordnet sind.

Diese Aktion gibt ein Maximum an `MaxResults` Elementen zurück und ist paginiert, sodass Sie alle Elemente abrufen können, indem Sie sie `ListLedgers` mehrmals aufrufen.

## Anforderungssyntax
<a name="API_ListLedgers_RequestSyntax"></a>

```
GET /ledgers?max_results=MaxResults&next_token=NextToken HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_ListLedgers_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [MaxResults](#API_ListLedgers_RequestSyntax) **   <a name="qldb-ListLedgers-request-uri-MaxResults"></a>
Die maximale Anzahl von Ergebnissen, die in einer einzigen `ListLedgers` Anfrage zurückgegeben werden können. (Die tatsächliche Anzahl der zurückgegebenen Ergebnisse ist möglicherweise geringer.)  
Gültiger Bereich: Mindestwert 1. Maximalwert 100.

 ** [NextToken](#API_ListLedgers_RequestSyntax) **   <a name="qldb-ListLedgers-request-uri-NextToken"></a>
Ein Paginierungstoken, das angibt, dass Sie die nächste Ergebnisseite abrufen möchten. Wenn Sie `NextToken` in der Antwort eines früheren `ListLedgers` Anrufs einen Wert für erhalten haben, sollten Sie diesen Wert hier als Eingabe verwenden.  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Anforderungstext
<a name="API_ListLedgers_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_ListLedgers_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Ledgers": [ 
      { 
         "CreationDateTime": number,
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## Antwortelemente
<a name="API_ListLedgers_ResponseElements"></a>

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.

 ** [Ledgers](#API_ListLedgers_ResponseSyntax) **   <a name="qldb-ListLedgers-response-Ledgers"></a>
Die Ledger, die dem aktuellen Konto AWS-Konto und der Region zugeordnet sind.  
Typ: Array von [LedgerSummary](API_LedgerSummary.md)-Objekten

 ** [NextToken](#API_ListLedgers_ResponseSyntax) **   <a name="qldb-ListLedgers-response-NextToken"></a>
Ein Paginierungstoken, das angibt, ob weitere Ergebnisse verfügbar sind:  
+ Wenn leer `NextToken` ist, wurde die letzte Ergebnisseite verarbeitet und es können keine weiteren Ergebnisse abgerufen werden.
+ Wenn *nicht* leer `NextToken` ist, sind weitere Ergebnisse verfügbar. Um die nächste Ergebnisseite abzurufen, verwenden Sie den Wert von `NextToken` in einem nachfolgenden `ListLedgers`-Aufruf.
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$` 

## Fehler
<a name="API_ListLedgers_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

## Weitere Informationen finden Sie unter:
<a name="API_ListLedgers_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListLedgers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListLedgers) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Gibt alle Tags für eine angegebene Amazon QLDB-Ressource zurück.

## Anforderungssyntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
GET /tags/resourceArn HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_ListTagsForResource_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [resourceArn](#API_ListTagsForResource_RequestSyntax) **   <a name="qldb-ListTagsForResource-request-uri-ResourceArn"></a>
Der Amazon-Ressourcenname (ARN), für den die Tags aufgelistet werden sollen. Zum Beispiel:  
 `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`   
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

## Anforderungstext
<a name="API_ListTagsForResource_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## Antwortelemente
<a name="API_ListTagsForResource_ResponseElements"></a>

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.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="qldb-ListTagsForResource-response-Tags"></a>
Die Tags, die derzeit mit der angegebenen Amazon QLDB-Ressource verknüpft sind.  
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge  
Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 200 Elemente.  
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.  
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.

## Fehler
<a name="API_ListTagsForResource_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_ListTagsForResource_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ListTagsForResource) 

# StreamJournalToKinesis
<a name="API_StreamJournalToKinesis"></a>

Erstellt einen Journal-Stream für ein bestimmtes Amazon QLDB-Ledger. Der Stream erfasst jede Dokumentversion, die im Journal des Ledgers festgeschrieben wurde, und liefert die Daten an eine angegebene Amazon Kinesis Data Streams-Ressource.

## Anforderungssyntax
<a name="API_StreamJournalToKinesis_RequestSyntax"></a>

```
POST /ledgers/name/journal-kinesis-streams HTTP/1.1
Content-type: application/json

{
   "ExclusiveEndTime": number,
   "InclusiveStartTime": number,
   "KinesisConfiguration": { 
      "AggregationEnabled": boolean,
      "StreamArn": "string"
   },
   "RoleArn": "string",
   "StreamName": "string",
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI-Anfrageparameter
<a name="API_StreamJournalToKinesis_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-uri-LedgerName"></a>
Der Name des Ledgers.  
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
<a name="API_StreamJournalToKinesis_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [ExclusiveEndTime](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-ExclusiveEndTime"></a>
Das exklusive Datum und die Uhrzeit, die angeben, wann der Stream endet. Wenn Sie diesen Parameter nicht definieren, wird der Stream auf unbestimmte Zeit ausgeführt, bis Sie ihn abbrechen.  
`ExclusiveEndTime` muss im `ISO 8601`-Datums- und Uhrzeitformat sowie in UTC (Universal Coordinated Time) vorliegen. Beispiel: `2019-06-13T21:36:34Z`.  
Typ: Zeitstempel  
Erforderlich: Nein

 ** [InclusiveStartTime](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-InclusiveStartTime"></a>
Datums- und Uhrzeitangaben zum Zeitpunkt, ab dem das Streamen von Journaldaten gestartet werden soll. Diese Parameter muss im `ISO 8601`-Datums- und Uhrzeitformat sowie in UTC (Universal Coordinated Time) vorliegen. Beispiel: `2019-06-13T21:36:34Z`.  
`InclusiveStartTime` kann nicht in der Zukunft liegen und muss vor `ExclusiveEndTime` liegen.  
Wenn Sie eine `InclusiveStartTime` angeben, die vor der `CreationDateTime` des Ledgers liegt, wird sie von QLDB standardmäßig auf die `CreationDateTime` des Ledgers festgelegt.  
Typ: Zeitstempel  
Erforderlich: Ja

 ** [KinesisConfiguration](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-KinesisConfiguration"></a>
Die Konfigurationseinstellungen des Ziels für Kinesis Data Streams für Ihre Stream-Anforderung.  
Typ: [KinesisConfiguration](API_KinesisConfiguration.md) Objekt  
Erforderlich: Ja

 ** [RoleArn](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-RoleArn"></a>
Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die QLDB-Berechtigungen für einen Journalstream zum Schreiben von Datensätzen in eine Kinesis Data Streams-Ressource gewährt.  
Um beim Anfordern eines Journalstreams eine Rolle an QLDB zu übergeben, müssen Sie über Berechtigungen zum Ausführen der `iam:PassRole`-Aktion für die IAM-Rollenressource verfügen. Dies ist für alle Journalstream-Anforderungen erforderlich.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** [StreamName](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-StreamName"></a>
Der Name, den Sie dem QLDB-Journal-Stream zuweisen möchten. Benutzerdefinierte Namen können helfen, den Zweck eines Streams zu identifizieren und anzugeben.  
Der Stream-Name muss unter anderen *aktiven* Streams für ein bestimmtes Ledger eindeutig sein. Stream-Namen haben dieselben Benennungsbeschränkungen wie Ledgernamen, wie sie unter [Kontingente in Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/limits.html#limits.naming) im *Amazon QLDB-Entwicklerhandbuch * definiert sind.  
Typ: Zeichenfolge  
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

 ** [Tags](#API_StreamJournalToKinesis_RequestSyntax) **   <a name="qldb-StreamJournalToKinesis-request-Tags"></a>
Die Schlüssel-Wert-Paare, die dem Stream, den Sie erstellen möchten, als Tags hinzugefügt werden sollen. Bei Tag-Schlüsseln wird zwischen Groß- und Kleinschreibung unterschieden. Bei Tag-Werten wird zwischen Groß- und Kleinschreibung unterschieden und sie können Null sein.  
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge  
Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 200 Elemente.  
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.  
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.  
Erforderlich: Nein

## Antwortsyntax
<a name="API_StreamJournalToKinesis_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "StreamId": "string"
}
```

## Antwortelemente
<a name="API_StreamJournalToKinesis_ResponseElements"></a>

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.

 ** [StreamId](#API_StreamJournalToKinesis_ResponseSyntax) **   <a name="qldb-StreamJournalToKinesis-response-StreamId"></a>
Die UUID (dargestellt in Base62-codiertem Text), die QLDB jedem QLDB-Journal-Stream zuweist.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$` 

## Fehler
<a name="API_StreamJournalToKinesis_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

 ** ResourcePreconditionNotMetException **   
Der Vorgang ist fehlgeschlagen, weil eine Bedingung nicht im Voraus erfüllt wurde.  
HTTP-Statuscode: 412

## Weitere Informationen finden Sie unter:
<a name="API_StreamJournalToKinesis_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/StreamJournalToKinesis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/StreamJournalToKinesis) 

# TagResource
<a name="API_TagResource"></a>

Fügt einer angegebenen Amazon QLDB-Ressource ein oder mehrere Tags hinzu.

Eine Ressource kann bis zu 50 Tags haben. Wenn Sie versuchen, mehr als 50 Tags für eine Ressource zu erstellen, schlägt Ihre Anfrage fehl und es wird ein Fehler zurückgegeben.

## Anforderungssyntax
<a name="API_TagResource_RequestSyntax"></a>

```
POST /tags/resourceArn HTTP/1.1
Content-type: application/json

{
   "Tags": { 
      "string" : "string" 
   }
}
```

## URI-Anfrageparameter
<a name="API_TagResource_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [resourceArn](#API_TagResource_RequestSyntax) **   <a name="qldb-TagResource-request-uri-ResourceArn"></a>
Der Amazon-Ressourcenname (ARN), zu dem Sie die Tags hinzufügen möchten. Zum Beispiel:  
 `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`   
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

## Anforderungstext
<a name="API_TagResource_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="qldb-TagResource-request-Tags"></a>
Die Schlüssel-Wert-Paare, die der angegebenen QLDB-Ressource als Tags hinzugefügt werden sollen. Bei Tag-Schlüsseln wird zwischen Groß- und Kleinschreibung unterschieden. Wenn Sie einen Schlüssel angeben, der bereits für die Ressource existiert, schlägt Ihre Anfrage fehl und gibt einen Fehler zurück. Bei Tag-Werten wird zwischen Groß- und Kleinschreibung unterschieden und sie können Null sein.  
Typ: Abbildung einer Zeichenfolge auf eine Zeichenfolge  
Karteneinträge: Mindestanzahl von 0 Elementen. Die maximale Anzahl beträgt 200 Elemente.  
Schlüssel-Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 128 Zeichen.  
Längenbeschränkungen für Werte: Mindestlänge von 0. Maximale Länge beträgt 256 Zeichen.  
Erforderlich: Ja

## Antwortsyntax
<a name="API_TagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Antwortelemente
<a name="API_TagResource_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.

## Fehler
<a name="API_TagResource_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_TagResource_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/TagResource) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/TagResource) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/TagResource) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/TagResource) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/TagResource) 

# UntagResource
<a name="API_UntagResource"></a>

Entfernt ein oder mehrere Tags aus einer angegebenen Amazon QLDB-Ressource. Sie können bis zu 50 Tag-Schlüssel angeben, die entfernt werden sollen.

## Anforderungssyntax
<a name="API_UntagResource_RequestSyntax"></a>

```
DELETE /tags/resourceArn?tagKeys=TagKeys HTTP/1.1
```

## URI-Anfrageparameter
<a name="API_UntagResource_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [resourceArn](#API_UntagResource_RequestSyntax) **   <a name="qldb-UntagResource-request-uri-ResourceArn"></a>
Der Amazon-Ressourcenname (ARN), aus dem die Tags entfernt werden sollen. Zum Beispiel:  
 `arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger`   
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="qldb-UntagResource-request-uri-TagKeys"></a>
Die Liste der Tag-Schlüssel, die entfernt werden sollen.  
Array-Mitglieder: Die Mindestanzahl beträgt 0 Elemente. Die maximale Anzahl beträgt 200 Elemente.  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.  
Erforderlich: Ja

## Anforderungstext
<a name="API_UntagResource_RequestBody"></a>

Der Anforderung besitzt keinen Anforderungstext.

## Antwortsyntax
<a name="API_UntagResource_ResponseSyntax"></a>

```
HTTP/1.1 200
```

## Antwortelemente
<a name="API_UntagResource_ResponseElements"></a>

Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP 200-Antwort mit leerem HTTP-Textinhalt zurück.

## Fehler
<a name="API_UntagResource_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_UntagResource_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UntagResource) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UntagResource) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UntagResource) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UntagResource) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UntagResource) 

# UpdateLedger
<a name="API_UpdateLedger"></a>

Aktualisiert die Eigenschaften eines Ledgers.

## Anforderungssyntax
<a name="API_UpdateLedger_RequestSyntax"></a>

```
PATCH /ledgers/name HTTP/1.1
Content-type: application/json

{
   "DeletionProtection": boolean,
   "KmsKey": "string"
}
```

## URI-Anfrageparameter
<a name="API_UpdateLedger_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_UpdateLedger_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [DeletionProtection](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-DeletionProtection"></a>
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  
Erforderlich: Nein

 ** [KmsKey](#API_UpdateLedger_RequestSyntax) **   <a name="qldb-UpdateLedger-request-KmsKey"></a>
Der Schlüssel in AWS Key Management Service (AWS KMS), der für die Verschlüsselung ruhender Daten im Ledger verwendet werden soll. Weitere Informationen finden Sie unter [Verschlüsselung im Ruhezustand](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) im *Amazon-QLDB-Entwicklerhandbuch*.  
Verwenden Sie eine der folgenden Optionen, um diesen Parameter anzugeben:  
+  `AWS_OWNED_KMS_KEY`: Verwenden Sie einen AWS KMS Schlüssel, der in Ihrem Namen gehört und von AWS diesem verwaltet wird.
+  **Undefiniert**: Nehmen Sie keine Änderungen am KMS-Schlüssel des Ledgers vor.
+  **Ein gültiger, symmetrischer, vom Kunden verwalteter KMS-Schlüssel**: Den angegebenen symmetrischen KMS-Verschlüsselungsschlüssel in Ihrem Konto verwenden, den Sie erstellen, besitzen und verwalten.

  Amazon EBS unterstützt keine asymmetrischen Schlüssel. *Weitere Informationen finden Sie unter [Verwenden von symmetrischen und asymmetrischen Schlüsseln](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html) im Entwicklerhandbuch. AWS Key Management Service *
Um einen vom Kunden verwalteten KMS-Schlüssel anzugeben, können Sie seine Schlüssel-ID, den Amazon-Ressourcennamen (ARN), den Aliasnamen oder den Alias-ARN verwenden. Wenn Sie einen Aliasnamen verwenden, stellen Sie ihm `"alias/"` voran. Um einen Schlüssel in einem anderen anzugeben AWS-Konto, müssen Sie den Schlüssel ARN oder den Alias ARN verwenden.  
Zum Beispiel:  
+ Schlüssel-ID: `1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Schüssel-ARN: `arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` 
+ Alias-Name: `alias/ExampleAlias` 
+ Alias-ARN: `arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias` 
Weitere Informationen finden Sie unter [Schlüsselkennungen (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) im * AWS Key Management Service Entwicklerhandbuch*.  
Typ: Zeichenfolge  
Längenbeschränkungen: Die maximale Länge beträgt 1600.  
Erforderlich: Nein

## Antwortsyntax
<a name="API_UpdateLedger_ResponseSyntax"></a>

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

## Antwortelemente
<a name="API_UpdateLedger_ResponseElements"></a>

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](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Arn"></a>
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](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-CreationDateTime"></a>
Das Datum und die 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](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-DeletionProtection"></a>
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](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-EncryptionDescription"></a>
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).  
Typ: [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) Objekt

 ** [Name](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-Name"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.  
Pattern: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [State](#API_UpdateLedger_ResponseSyntax) **   <a name="qldb-UpdateLedger-response-State"></a>
Der aktuelle Status des Ledgers.  
Typ: Zeichenfolge  
Zulässige Werte: `CREATING | ACTIVE | DELETING | DELETED` 

## Fehler
<a name="API_UpdateLedger_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_UpdateLedger_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedger) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedger) 

# UpdateLedgerPermissionsMode
<a name="API_UpdateLedgerPermissionsMode"></a>

Aktualisiert den Berechtigungsmodus eines Ledgers.

**Wichtig**  
Bevor Sie in den `STANDARD` Berechtigungsmodus wechseln, müssen Sie zunächst alle erforderlichen IAM-Richtlinien und Tabellen-Tags erstellen, um Störungen für Ihre Benutzer zu vermeiden. Weitere Informationen finden Sie unter [Migration zum Standardberechtigungsmodus](https://docs.aws.amazon.com/qldb/latest/developerguide/ledger-management.basics.html#ledger-mgmt.basics.update-permissions.migrating) im *Amazon QLDB* Developer Guide.

## Anforderungssyntax
<a name="API_UpdateLedgerPermissionsMode_RequestSyntax"></a>

```
PATCH /ledgers/name/permissions-mode HTTP/1.1
Content-type: application/json

{
   "PermissionsMode": "string"
}
```

## URI-Anfrageparameter
<a name="API_UpdateLedgerPermissionsMode_RequestParameters"></a>

Die Anforderung verwendet die folgenden URI-Parameter.

 ** [name](#API_UpdateLedgerPermissionsMode_RequestSyntax) **   <a name="qldb-UpdateLedgerPermissionsMode-request-uri-Name"></a>
Der Name des Ledgers.  
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
<a name="API_UpdateLedgerPermissionsMode_RequestBody"></a>

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [PermissionsMode](#API_UpdateLedgerPermissionsMode_RequestSyntax) **   <a name="qldb-UpdateLedgerPermissionsMode-request-PermissionsMode"></a>
Der Berechtigungsmodus, der dem Ledger zugewiesen werden soll. Folgende Parameterwerte sind möglich:  
+  `ALLOW_ALL`: Ein Legacy-Berechtigungsmodus, der die Zugriffskontrolle mit Granularität auf API-Ebene für Ledgers ermöglicht.

  Dieser Modus ermöglicht Benutzern, die `SendCommand`-API-Berechtigung für dieses Ledger zum Ausführen aller PartiQL-Befehle (daher `ALLOW_ALL`) auf beliebigen Tabellen im angegebenen Ledger auszuführen. Dieser Modus ignoriert alle IAM-Berechtigungs-Richtlinien auf Tabellen- oder Befehls-Ebene, die Sie für das Ledger erstellen.
+  `STANDARD`: (*Empfohlen*) Ein Berechtigungsmodus, der Zugriffskontrolle mit feinerer Granularität für Ledger, Tabellen und PartiQL-Befehle ermöglicht.

  Standardmäßig verweigert dieser Modus alle Benutzer-Anforderungen zur Ausführung von PartiQL-Befehlen für Tabellen in diesem Ledger. Damit PartiQL-Befehle ausgeführt werden können, müssen Sie IAM-Berechtigungs-Richtlinien für bestimmte Tabellen-Ressourcen und PartiQL-Aktionen erstellen, zusätzlich zu den `SendCommand` API-Berechtigung für den Ledger. Weitere Informationen finden Sie unter [Erste Schritte mit dem Standard-Berechtigungsmodus](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-standard-mode.html) im *Amazon-QLDB-Entwicklerhandbuch*.
Wir empfehlen dringend, den `STANDARD` Berechtigungsmodus, um die Sicherheit Ihrer Ledger-Daten zu maximieren.
Typ: Zeichenfolge  
Zulässige Werte: `ALLOW_ALL | STANDARD`   
Erforderlich: Ja

## Antwortsyntax
<a name="API_UpdateLedgerPermissionsMode_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "Name": "string",
   "PermissionsMode": "string"
}
```

## Antwortelemente
<a name="API_UpdateLedgerPermissionsMode_ResponseElements"></a>

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](#API_UpdateLedgerPermissionsMode_ResponseSyntax) **   <a name="qldb-UpdateLedgerPermissionsMode-response-Arn"></a>
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.

 ** [Name](#API_UpdateLedgerPermissionsMode_ResponseSyntax) **   <a name="qldb-UpdateLedgerPermissionsMode-response-Name"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 32 Zeichen.  
Pattern: `(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$` 

 ** [PermissionsMode](#API_UpdateLedgerPermissionsMode_ResponseSyntax) **   <a name="qldb-UpdateLedgerPermissionsMode-response-PermissionsMode"></a>
Der aktuelle Berechtigungsmodus des Ledgers.  
Typ: Zeichenfolge  
Zulässige Werte: `ALLOW_ALL | STANDARD` 

## Fehler
<a name="API_UpdateLedgerPermissionsMode_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** InvalidParameterException **   
Ein oder mehrere Parameter in der Anfrage sind nicht gültig.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
Die angegebene Ressource ist nicht vorhanden.  
HTTP Status Code: 404

## Weitere Informationen finden Sie unter:
<a name="API_UpdateLedgerPermissionsMode_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-2019-01-02/UpdateLedgerPermissionsMode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/UpdateLedgerPermissionsMode) 

# Amazon QLDB-Sitzung
<a name="API_Operations_Amazon_QLDB_Session"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgenden Aktionen werden von Amazon QLDB Session unterstützt:
+  [SendCommand](API_QLDB-Session_SendCommand.md) 

# SendCommand
<a name="API_QLDB-Session_SendCommand"></a>

Sendet einen Befehl an ein Amazon QLDB-Ledger.

**Anmerkung**  
Anstatt direkt mit dieser API zu interagieren, empfehlen wir, den QLDB-Treiber oder die QLDB-Shell zu verwenden, um Datentransaktionen in einem Ledger auszuführen.  
Wenn Sie mit einem AWS SDK arbeiten, verwenden Sie den QLDB-Treiber. Der Treiber bietet eine abstrakte Ebene über dieser *QLDB-Sitzungsdaten-API* und verwaltet den `SendCommand` Vorgang für Sie. Informationen und eine Liste der unterstützten Programmiersprachen finden Sie unter [Erste Schritte mit dem Treiber](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html) im *Amazon QLDB Developer Guide*.
Wenn Sie mit AWS Command Line Interface (AWS CLI) arbeiten, verwenden Sie die QLDB-Shell. Die Shell ist eine Befehlszeilenschnittstelle, die den QLDB-Treiber verwendet, um mit einem Ledger zu interagieren. Weitere Informationen finden Sie unter [Zugreifen auf Amazon QLDB mithilfe der QLDB-Shell](https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html).

## Anforderungssyntax
<a name="API_QLDB-Session_SendCommand_RequestSyntax"></a>

```
{
   "AbortTransaction": { 
   },
   "CommitTransaction": { 
      "CommitDigest": blob,
      "TransactionId": "string"
   },
   "EndSession": { 
   },
   "ExecuteStatement": { 
      "Parameters": [ 
         { 
            "IonBinary": blob,
            "IonText": "string"
         }
      ],
      "Statement": "string",
      "TransactionId": "string"
   },
   "FetchPage": { 
      "NextPageToken": "string",
      "TransactionId": "string"
   },
   "SessionToken": "string",
   "StartSession": { 
      "LedgerName": "string"
   },
   "StartTransaction": { 
   }
}
```

## Anforderungsparameter
<a name="API_QLDB-Session_SendCommand_RequestParameters"></a>

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter [Allgemeine Parameter](CommonParameters.md).

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

 ** [AbortTransaction](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-AbortTransaction"></a>
Befehl zum Abbrechen der aktuellen Transaktion.  
Typ: [AbortTransactionRequest](API_QLDB-Session_AbortTransactionRequest.md) Objekt  
Erforderlich: Nein

 ** [CommitTransaction](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-CommitTransaction"></a>
Befehl zum Festschreiben der angegebenen Transaktion.  
Typ: [CommitTransactionRequest](API_QLDB-Session_CommitTransactionRequest.md) Objekt  
Erforderlich: Nein

 ** [EndSession](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-EndSession"></a>
Befehl zum Beenden der aktuellen Sitzung.  
Typ: [EndSessionRequest](API_QLDB-Session_EndSessionRequest.md) Objekt  
Erforderlich: Nein

 ** [ExecuteStatement](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-ExecuteStatement"></a>
Befehl zum Ausführen einer Anweisung in der angegebenen Transaktion.  
Typ: [ExecuteStatementRequest](API_QLDB-Session_ExecuteStatementRequest.md) Objekt  
Erforderlich: Nein

 ** [FetchPage](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-FetchPage"></a>
Befehl zum Abrufen einer Seite.  
Typ: [FetchPageRequest](API_QLDB-Session_FetchPageRequest.md) Objekt  
Erforderlich: Nein

 ** [SessionToken](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-SessionToken"></a>
Gibt das Sitzungstoken für den aktuellen Befehl an. Ein Sitzungstoken ist während der gesamten Dauer der Sitzung konstant.  
Führen Sie den `StartSession` Befehl aus, um ein Sitzungstoken zu erhalten. Dies `SessionToken` ist für jeden nachfolgenden Befehl erforderlich, der während der aktuellen Sitzung ausgegeben wird.  
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$`   
Erforderlich: Nein

 ** [StartSession](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-StartSession"></a>
Befehl zum Starten einer neuen Sitzung. Ein Sitzungstoken wird als Teil der Antwort abgerufen.  
Typ: [StartSessionRequest](API_QLDB-Session_StartSessionRequest.md) Objekt  
Erforderlich: Nein

 ** [StartTransaction](#API_QLDB-Session_SendCommand_RequestSyntax) **   <a name="qldb-QLDB-Session_SendCommand-request-StartTransaction"></a>
Befehl zum Starten einer neuen Transaktion.  
Typ: [StartTransactionRequest](API_QLDB-Session_StartTransactionRequest.md) Objekt  
Erforderlich: Nein

## Antwortsyntax
<a name="API_QLDB-Session_SendCommand_ResponseSyntax"></a>

```
{
   "AbortTransaction": { 
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      }
   },
   "CommitTransaction": { 
      "CommitDigest": blob,
      "ConsumedIOs": { 
         "ReadIOs": number,
         "WriteIOs": number
      },
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      },
      "TransactionId": "string"
   },
   "EndSession": { 
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      }
   },
   "ExecuteStatement": { 
      "ConsumedIOs": { 
         "ReadIOs": number,
         "WriteIOs": number
      },
      "FirstPage": { 
         "NextPageToken": "string",
         "Values": [ 
            { 
               "IonBinary": blob,
               "IonText": "string"
            }
         ]
      },
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      }
   },
   "FetchPage": { 
      "ConsumedIOs": { 
         "ReadIOs": number,
         "WriteIOs": number
      },
      "Page": { 
         "NextPageToken": "string",
         "Values": [ 
            { 
               "IonBinary": blob,
               "IonText": "string"
            }
         ]
      },
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      }
   },
   "StartSession": { 
      "SessionToken": "string",
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      }
   },
   "StartTransaction": { 
      "TimingInformation": { 
         "ProcessingTimeMilliseconds": number
      },
      "TransactionId": "string"
   }
}
```

## Antwortelemente
<a name="API_QLDB-Session_SendCommand_ResponseElements"></a>

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.

 ** [AbortTransaction](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-AbortTransaction"></a>
Enthält die Details der abgebrochenen Transaktion.  
Typ: [AbortTransactionResult](API_QLDB-Session_AbortTransactionResult.md) Objekt

 ** [CommitTransaction](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-CommitTransaction"></a>
Enthält die Details der festgeschriebenen Transaktion.  
Typ: [CommitTransactionResult](API_QLDB-Session_CommitTransactionResult.md) Objekt

 ** [EndSession](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-EndSession"></a>
Enthält die Details der beendeten Sitzung.  
Typ: [EndSessionResult](API_QLDB-Session_EndSessionResult.md) Objekt

 ** [ExecuteStatement](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-ExecuteStatement"></a>
Enthält die Details der ausgeführten Anweisung.  
Typ: [ExecuteStatementResult](API_QLDB-Session_ExecuteStatementResult.md) Objekt

 ** [FetchPage](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-FetchPage"></a>
Enthält die Details der abgerufenen Seite.  
Typ: [FetchPageResult](API_QLDB-Session_FetchPageResult.md) Objekt

 ** [StartSession](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-StartSession"></a>
Enthält die Details der gestarteten Sitzung, die ein Sitzungstoken enthält. Dies `SessionToken` ist für jeden nachfolgenden Befehl erforderlich, der während der aktuellen Sitzung ausgegeben wird.  
Typ: [StartSessionResult](API_QLDB-Session_StartSessionResult.md) Objekt

 ** [StartTransaction](#API_QLDB-Session_SendCommand_ResponseSyntax) **   <a name="qldb-QLDB-Session_SendCommand-response-StartTransaction"></a>
Enthält die Details der gestarteten Transaktion.  
Typ: [StartTransactionResult](API_QLDB-Session_StartTransactionResult.md) Objekt

## Fehler
<a name="API_QLDB-Session_SendCommand_Errors"></a>

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter [Häufige Fehler](CommonErrors.md).

 ** BadRequestException **   
Wird zurückgegeben, wenn die Anfrage fehlerhaft ist oder einen Fehler enthält, z. B. einen ungültigen Parameterwert oder einen fehlenden erforderlichen Parameter.  
HTTP Status Code: 400

 ** CapacityExceededException **   
Wird zurückgegeben, wenn die Anfrage die Verarbeitungskapazität des Ledgers überschreitet.  
HTTP Status Code: 400

 ** InvalidSessionException **   
Wird zurückgegeben, wenn die Sitzung nicht mehr existiert, weil das Zeitlimit überschritten wurde oder sie abgelaufen ist.  
HTTP Status Code: 400

 ** LimitExceededException **   
Wird zurückgegeben, wenn ein Ressourcenlimit, z. B. die Anzahl der aktiven Sitzungen, überschritten wird.  
HTTP Status Code: 400

 ** OccConflictException **   
Wird zurückgegeben, wenn eine Transaktion aufgrund eines Fehlers in der Überprüfungsphase von *Optimistic Concurrency Control* (OCC) nicht in das Journal geschrieben werden kann.  
HTTP Status Code: 400

 ** RateExceededException **   
Wird zurückgegeben, wenn die Anzahl der Anfragen den zulässigen Durchsatz überschreitet.  
HTTP Status Code: 400

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_SendCommand_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS -Befehlszeilenschnittstelle](https://docs.aws.amazon.com/goto/aws-cli/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK für JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK für Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK für Python](https://docs.aws.amazon.com/goto/boto3/qldb-session-2019-07-11/SendCommand) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/SendCommand) 

# Datentypen
<a name="API_Types"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgenden Datentypen werden von Amazon QLDB unterstützt:
+  [JournalKinesisStreamDescription](API_JournalKinesisStreamDescription.md) 
+  [JournalS3ExportDescription](API_JournalS3ExportDescription.md) 
+  [KinesisConfiguration](API_KinesisConfiguration.md) 
+  [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) 
+  [LedgerSummary](API_LedgerSummary.md) 
+  [S3EncryptionConfiguration](API_S3EncryptionConfiguration.md) 
+  [S3ExportConfiguration](API_S3ExportConfiguration.md) 
+  [ValueHolder](API_ValueHolder.md) 

Die folgenden Datentypen werden von Amazon QLDB Session unterstützt:
+  [AbortTransactionRequest](API_QLDB-Session_AbortTransactionRequest.md) 
+  [AbortTransactionResult](API_QLDB-Session_AbortTransactionResult.md) 
+  [CommitTransactionRequest](API_QLDB-Session_CommitTransactionRequest.md) 
+  [CommitTransactionResult](API_QLDB-Session_CommitTransactionResult.md) 
+  [EndSessionRequest](API_QLDB-Session_EndSessionRequest.md) 
+  [EndSessionResult](API_QLDB-Session_EndSessionResult.md) 
+  [ExecuteStatementRequest](API_QLDB-Session_ExecuteStatementRequest.md) 
+  [ExecuteStatementResult](API_QLDB-Session_ExecuteStatementResult.md) 
+  [FetchPageRequest](API_QLDB-Session_FetchPageRequest.md) 
+  [FetchPageResult](API_QLDB-Session_FetchPageResult.md) 
+  [IOUsage](API_QLDB-Session_IOUsage.md) 
+  [Page](API_QLDB-Session_Page.md) 
+  [StartSessionRequest](API_QLDB-Session_StartSessionRequest.md) 
+  [StartSessionResult](API_QLDB-Session_StartSessionResult.md) 
+  [StartTransactionRequest](API_QLDB-Session_StartTransactionRequest.md) 
+  [StartTransactionResult](API_QLDB-Session_StartTransactionResult.md) 
+  [TimingInformation](API_QLDB-Session_TimingInformation.md) 
+  [ValueHolder](API_QLDB-Session_ValueHolder.md) 

# Amazon QLDB
<a name="API_Types_Amazon_QLDB"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgenden Datentypen werden von Amazon QLDB unterstützt:
+  [JournalKinesisStreamDescription](API_JournalKinesisStreamDescription.md) 
+  [JournalS3ExportDescription](API_JournalS3ExportDescription.md) 
+  [KinesisConfiguration](API_KinesisConfiguration.md) 
+  [LedgerEncryptionDescription](API_LedgerEncryptionDescription.md) 
+  [LedgerSummary](API_LedgerSummary.md) 
+  [S3EncryptionConfiguration](API_S3EncryptionConfiguration.md) 
+  [S3ExportConfiguration](API_S3ExportConfiguration.md) 
+  [ValueHolder](API_ValueHolder.md) 

# JournalKinesisStreamDescription
<a name="API_JournalKinesisStreamDescription"></a>

Informationen über einen Amazon QLDB-Journal-Stream, einschließlich des Amazon-Ressourcennamens (ARN), des Stream-Namens, der Erstellungszeit, des aktuellen Status und der Parameter der ursprünglichen Stream-Erstellungsanforderung.

## Inhalt
<a name="API_JournalKinesisStreamDescription_Contents"></a>

 ** KinesisConfiguration **   <a name="qldb-Type-JournalKinesisStreamDescription-KinesisConfiguration"></a>
Die Konfigurationseinstellungen des Amazon Kinesis Data Streams Streams-Ziels für einen QLDB-Journal-Stream.  
Typ: [KinesisConfiguration](API_KinesisConfiguration.md) Objekt  
Erforderlich: Ja

 ** LedgerName **   <a name="qldb-Type-JournalKinesisStreamDescription-LedgerName"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
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

 ** RoleArn **   <a name="qldb-Type-JournalKinesisStreamDescription-RoleArn"></a>
Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die QLDB-Berechtigungen für einen Journalstream zum Schreiben von Datensätzen in eine Kinesis Data Streams-Ressource gewährt.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** Status **   <a name="qldb-Type-JournalKinesisStreamDescription-Status"></a>
Der aktuelle Status des QLDB-Journal-Streams.  
Typ: Zeichenfolge  
Zulässige Werte: `ACTIVE | COMPLETED | CANCELED | FAILED | IMPAIRED`   
Erforderlich: Ja

 ** StreamId **   <a name="qldb-Type-JournalKinesisStreamDescription-StreamId"></a>
Die UUID (dargestellt in Base62-codiertem Text) des QLDB-Journal-Streams.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

 ** StreamName **   <a name="qldb-Type-JournalKinesisStreamDescription-StreamName"></a>
Der benutzerdefinierte Name des QLDB-Journal-Streams.  
Typ: Zeichenfolge  
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

 ** Arn **   <a name="qldb-Type-JournalKinesisStreamDescription-Arn"></a>
Der Amazon-Ressourcenname (ARN) des QLDB-Journaldatenstroms.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Nein

 ** CreationTime **   <a name="qldb-Type-JournalKinesisStreamDescription-CreationTime"></a>
Das Datum und die Uhrzeit im Epochenzeitformat, an dem der QLDB-Journal-Stream erstellt wurde. (Das Epochenzeitformat ist die Anzahl der Sekunden, die seit dem 1. Januar 1970 um 00:00:00 Uhr UTC vergangen sind.)  
Typ: Zeitstempel  
Erforderlich: Nein

 ** ErrorCause **   <a name="qldb-Type-JournalKinesisStreamDescription-ErrorCause"></a>
Die Fehlermeldung, die den Grund beschreibt, warum ein Stream den Status oder hat. `IMPAIRED` `FAILED` Dies gilt nicht für Streams mit anderen Statuswerten.  
Typ: Zeichenfolge  
Zulässige Werte: `KINESIS_STREAM_NOT_FOUND | IAM_PERMISSION_REVOKED`   
Erforderlich: Nein

 ** ExclusiveEndTime **   <a name="qldb-Type-JournalKinesisStreamDescription-ExclusiveEndTime"></a>
Das exklusive Datum und die Uhrzeit, die angeben, wann der Stream endet. Wenn dieser Parameter nicht definiert ist, läuft der Stream unbegrenzt, bis Sie ihn abbrechen.  
Typ: Zeitstempel  
Erforderlich: Nein

 ** InclusiveStartTime **   <a name="qldb-Type-JournalKinesisStreamDescription-InclusiveStartTime"></a>
Datums- und Uhrzeitangaben zum Zeitpunkt, ab dem das Streamen von Journaldaten gestartet werden soll.  
Typ: Zeitstempel  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_JournalKinesisStreamDescription_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/JournalKinesisStreamDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/JournalKinesisStreamDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/JournalKinesisStreamDescription) 

# JournalS3ExportDescription
<a name="API_JournalS3ExportDescription"></a>

Informationen zu einem Journalexportauftrag, einschließlich des Hauptbuchnamens, der Export-ID, der Erstellungszeit, des aktuellen Status und der Parameter der ursprünglichen Exporterstellungsanforderung.

## Inhalt
<a name="API_JournalS3ExportDescription_Contents"></a>

 ** ExclusiveEndTime **   <a name="qldb-Type-JournalS3ExportDescription-ExclusiveEndTime"></a>
Das ausschließliche Enddatum und die Uhrzeit für den Bereich der Journalinhalte, der in der ursprünglichen Exportanforderung angegeben wurde.  
Typ: Zeitstempel  
Erforderlich: Ja

 ** ExportCreationTime **   <a name="qldb-Type-JournalS3ExportDescription-ExportCreationTime"></a>
Datum und Uhrzeit im Epochenzeitformat, an dem der Exportauftrag erstellt wurde. (Das Epochenzeitformat ist die Anzahl der Sekunden, die seit dem 1. Januar 1970 um 00:00:00 Uhr UTC vergangen sind.)  
Typ: Zeitstempel  
Erforderlich: Ja

 ** ExportId **   <a name="qldb-Type-JournalS3ExportDescription-ExportId"></a>
Die UUID (dargestellt in Base62-codiertem Text) des Journal-Exportauftrags.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

 ** InclusiveStartTime **   <a name="qldb-Type-JournalS3ExportDescription-InclusiveStartTime"></a>
Das inklusive Startdatum und -uhrzeit für den Bereich der Journalinhalte, der in der ursprünglichen Exportanforderung angegeben wurde.  
Typ: Zeitstempel  
Erforderlich: Ja

 ** LedgerName **   <a name="qldb-Type-JournalS3ExportDescription-LedgerName"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
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

 ** RoleArn **   <a name="qldb-Type-JournalS3ExportDescription-RoleArn"></a>
Der Amazon-Ressourcenname (ARN) der IAM-Rolle, die QLDB-Berechtigungen für einen Journal-Exportauftrag erteilt, um Folgendes auszuführen:  
+ Schreiben Sie Objekte in Ihren Amazon Simple Storage Service (Amazon S3) -Bucket.
+ (Optional) Verwenden Sie Ihren vom Kunden verwalteten Schlüssel in AWS Key Management Service (AWS KMS) für die serverseitige Verschlüsselung Ihrer exportierten Daten.
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** S3ExportConfiguration **   <a name="qldb-Type-JournalS3ExportDescription-S3ExportConfiguration"></a>
Der Bucket-Speicherort von Amazon Simple Storage Service (Amazon S3), in den ein Journalexportjob den Journalinhalt schreibt.  
Typ: [S3ExportConfiguration](API_S3ExportConfiguration.md) Objekt  
Erforderlich: Ja

 ** Status **   <a name="qldb-Type-JournalS3ExportDescription-Status"></a>
Der aktuelle Status des Journal-Exportauftrags.  
Typ: Zeichenfolge  
Zulässige Werte: `IN_PROGRESS | COMPLETED | CANCELLED`   
Erforderlich: Ja

 ** OutputFormat **   <a name="qldb-Type-JournalS3ExportDescription-OutputFormat"></a>
Das Ausgabeformat der exportierten Journaldaten.  
Typ: Zeichenfolge  
Zulässige Werte: `ION_BINARY | ION_TEXT | JSON`   
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_JournalS3ExportDescription_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/JournalS3ExportDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/JournalS3ExportDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/JournalS3ExportDescription) 

# KinesisConfiguration
<a name="API_KinesisConfiguration"></a>

Die Konfigurationseinstellungen des Amazon Kinesis Data Streams-Ziels für einen Amazon QLDB-Journalstream.

## Inhalt
<a name="API_KinesisConfiguration_Contents"></a>

 ** StreamArn **   <a name="qldb-Type-KinesisConfiguration-StreamArn"></a>
Der Amazon-Ressourcenname (ARN) der Kinesis Data Streams-Ressource.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** AggregationEnabled **   <a name="qldb-Type-KinesisConfiguration-AggregationEnabled"></a>
Ermöglicht QLDB, mehrere Datensätze in einem einzelnen Kinesis-Data Streams-Datensatz zu veröffentlichen, wodurch die Anzahl der pro API-Aufruf gesendeten Datensätze erhöht wird.  
Standard: `True`   
Die Datensatzaggregation hat wichtige Auswirkungen auf die Verarbeitung von Datensätzen und erfordert eine Disaggregation in Ihrem Stream-Konsumenten. Weitere Informationen finden Sie unter [KPL – Die wichtigsten Konzepte](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html) und [Datenproduzent – Disaggregation](https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html) im *Amazon Kinesis Data Streams-Entwicklerhandbuch*.
Typ: Boolesch  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_KinesisConfiguration_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/KinesisConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/KinesisConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/KinesisConfiguration) 

# LedgerEncryptionDescription
<a name="API_LedgerEncryptionDescription"></a>

Informationen zur Verschlüsselung ruhender Daten in einem Amazon QLDB-Ledger. Dazu gehören der aktuelle Status, der Schlüssel in AWS Key Management Service (AWS KMS) und der Zeitpunkt, an dem auf den Schlüssel nicht mehr zugegriffen werden konnte (im Falle eines Fehlers).

Weitere Informationen finden Sie unter [Verschlüsselung im Ruhezustand](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html) im *Amazon-QLDB-Entwicklerhandbuch*.

## Inhalt
<a name="API_LedgerEncryptionDescription_Contents"></a>

 ** EncryptionStatus **   <a name="qldb-Type-LedgerEncryptionDescription-EncryptionStatus"></a>
Der aktuelle Status der Verschlüsselung im Ruhezustand für das Ledger. Dabei kann es sich um einen der folgenden Werte handeln:  
+  `ENABLED`: Die Verschlüsselung ist mit dem angegebenen Schlüssel vollständig aktiviert.
+  `UPDATING`: Das Hauptbuch verarbeitet die angegebene Schlüsseländerung aktiv.

  Die wichtigsten Änderungen in QLDB sind asynchron. Während der Verarbeitung der Schlüsseländerung ist der Ledger vollständig zugänglich, ohne dass die Leistung beeinträchtigt wird. Die Zeit, die für die Aktualisierung eines Schlüssels benötigt wird, hängt von der Größe des Hauptbuchs ab.
+  `KMS_KEY_INACCESSIBLE`: Auf den angegebenen, vom Kunden verwalteten KMS-Schlüssel kann nicht zugegriffen werden, und das Ledger ist beeinträchtigt. Entweder wurde der Schlüssel deaktiviert oder gelöscht, oder die Berechtigungen für den Schlüssel wurden widerrufen. Wenn ein Ledger beeinträchtigt ist, kann nicht darauf zugegriffen werden und es werden keine Lese- oder Schreibanforderungen akzeptiert.

  Ein beeinträchtigtes Ledger kehrt automatisch in den aktiven Status zurück, nachdem Sie die Grants für den Schlüssel wiederhergestellt oder den deaktivierten Schlüssel wieder aktiviert haben. Das Löschen eines vom Kunden verwalteten KMS-Schlüssels ist jedoch irreversibel. Nach dem Löschen eines Schlüssels können Sie nicht mehr auf die Ledger zugreifen, die mit diesem Schlüssel geschützt sind, und die Daten können nicht mehr dauerhaft wiederhergestellt werden.
Typ: Zeichenfolge  
Zulässige Werte: `ENABLED | UPDATING | KMS_KEY_INACCESSIBLE`   
Erforderlich: Ja

 ** KmsKeyArn **   <a name="qldb-Type-LedgerEncryptionDescription-KmsKeyArn"></a>
Der Amazon-Ressourcenname (ARN) des vom Kunden verwalteten KMS-Schlüssels, den das Ledger für die Verschlüsselung im Ruhezustand verwendet. Wenn dieser Parameter nicht definiert ist, verwendet das Ledger einen AWS eigenen KMS-Schlüssel für die Verschlüsselung. Er wird angezeigt`AWS_OWNED_KMS_KEY`, wenn die Verschlüsselungskonfiguration des Ledgers auf den AWS eigenen KMS-Schlüssel aktualisiert wird.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Ja

 ** InaccessibleKmsKeyDateTime **   <a name="qldb-Type-LedgerEncryptionDescription-InaccessibleKmsKeyDateTime"></a>
Das Datum und die Uhrzeit im Epochenzeitformat, an dem im Falle eines Fehlers zum ersten Mal auf den AWS KMS Schlüssel nicht zugegriffen werden konnte. (Das Epochenzeitformat ist die Anzahl der Sekunden, die seit dem 1. Januar 1970 um 00:00:00 Uhr UTC vergangen sind.)  
Dieser Parameter ist undefiniert, wenn auf den Schlüssel zugegriffen werden kann. AWS KMS   
Typ: Zeitstempel  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_LedgerEncryptionDescription_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/LedgerEncryptionDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/LedgerEncryptionDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/LedgerEncryptionDescription) 

# LedgerSummary
<a name="API_LedgerSummary"></a>

Informationen über ein Hauptbuch, einschließlich seines Namens, seines Status und des Erstellungsdatums.

## Inhalt
<a name="API_LedgerSummary_Contents"></a>

 ** CreationDateTime **   <a name="qldb-Type-LedgerSummary-CreationDateTime"></a>
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  
Erforderlich: Nein

 ** Name **   <a name="qldb-Type-LedgerSummary-Name"></a>
Der Name des Ledgers.  
Typ: Zeichenfolge  
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: Nein

 ** State **   <a name="qldb-Type-LedgerSummary-State"></a>
Der aktuelle Status des Ledgers.  
Typ: Zeichenfolge  
Zulässige Werte: `CREATING | ACTIVE | DELETING | DELETED`   
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_LedgerSummary_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/LedgerSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/LedgerSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/LedgerSummary) 

# S3EncryptionConfiguration
<a name="API_S3EncryptionConfiguration"></a>

Die Verschlüsselungseinstellungen, die von einem Journal-Exportauftrag verwendet werden, um Daten in einen Amazon Simple Storage Service (Amazon S3) -Bucket zu schreiben.

## Inhalt
<a name="API_S3EncryptionConfiguration_Contents"></a>

 ** ObjectEncryptionType **   <a name="qldb-Type-S3EncryptionConfiguration-ObjectEncryptionType"></a>
Der Amazon S3 S3-Objektverschlüsselungstyp.  
Weitere Informationen zu serverseitigen Verschlüsselungsoptionen in Amazon S3 finden Sie unter [Schützen von Daten mithilfe serverseitiger Verschlüsselung](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html) im *Amazon S3 Developer Guide*.  
Typ: Zeichenfolge  
Zulässige Werte: `SSE_KMS | SSE_S3 | NO_ENCRYPTION`   
Erforderlich: Ja

 ** KmsKeyArn **   <a name="qldb-Type-S3EncryptionConfiguration-KmsKeyArn"></a>
Der Amazon-Ressourcenname (ARN) eines symmetrischen Verschlüsselungsschlüssels in AWS Key Management Service (AWS KMS). Amazon S3 unterstützt keine asymmetrischen KMS-Schlüssel.  
Sie müssen eine angeben`KmsKeyArn`, wenn Sie `SSE_KMS` als. `ObjectEncryptionType`  
 `KmsKeyArn`ist nicht erforderlich, wenn Sie `SSE_S3` als angeben`ObjectEncryptionType`.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 20. Maximale Länge beträgt 1600 Zeichen.  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_S3EncryptionConfiguration_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/S3EncryptionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/S3EncryptionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/S3EncryptionConfiguration) 

# S3ExportConfiguration
<a name="API_S3ExportConfiguration"></a>

Der Bucket-Speicherort von Amazon Simple Storage Service (Amazon S3), in den ein Journalexportauftrag den Journalinhalt schreibt.

## Inhalt
<a name="API_S3ExportConfiguration_Contents"></a>

 ** Bucket **   <a name="qldb-Type-S3ExportConfiguration-Bucket"></a>
Der Amazon S3 S3-Bucket-Name, in den ein Journal-Exportjob den Journalinhalt schreibt.  
Der Bucket-Name muss den Amazon S3 S3-Bucket-Namenskonventionen entsprechen. Weitere Informationen finden Sie unter [Bucket Restrictions and Limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html) im *Amazon S3 Developer Guide*.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 3. Maximale Länge beträgt 255 Zeichen.  
Pattern: `^[A-Za-z-0-9-_.]+$`   
Erforderlich: Ja

 ** EncryptionConfiguration **   <a name="qldb-Type-S3ExportConfiguration-EncryptionConfiguration"></a>
Die Verschlüsselungseinstellungen, die von einem Journal-Exportauftrag verwendet werden, um Daten in einen Amazon S3 S3-Bucket zu schreiben.  
Typ: [S3EncryptionConfiguration](API_S3EncryptionConfiguration.md) Objekt  
Erforderlich: Ja

 ** Prefix **   <a name="qldb-Type-S3ExportConfiguration-Prefix"></a>
Das Präfix für den Amazon S3 S3-Bucket, in den ein Journal-Exportjob den Journalinhalt schreibt.  
Das Präfix muss den Amazon S3 S3-Regeln und Einschränkungen für die Schlüsselbenennung entsprechen. Weitere Informationen finden Sie unter [Objektschlüssel und Metadaten](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html) im *Amazon S3 Developer Guide*.  
Im Folgenden finden Sie Beispiele für gültige `Prefix` Werte:  
+  `JournalExports-ForMyLedger/Testing/` 
+  `JournalExports` 
+  `My:Tests/` 
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge von 0. Maximale Länge beträgt 128 Zeichen.  
Erforderlich: Ja

## Weitere Informationen finden Sie unter:
<a name="API_S3ExportConfiguration_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/S3ExportConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/S3ExportConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/S3ExportConfiguration) 

# ValueHolder
<a name="API_ValueHolder"></a>

Eine Struktur, die einen Wert in mehreren Kodierungsformaten enthalten kann.

## Inhalt
<a name="API_ValueHolder_Contents"></a>

 ** IonText **   <a name="qldb-Type-ValueHolder-IonText"></a>
Ein Amazon Ion-Klartext-Wert, der in einer `ValueHolder` Struktur enthalten ist.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1048576.  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_ValueHolder_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-2019-01-02/ValueHolder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-2019-01-02/ValueHolder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-2019-01-02/ValueHolder) 

# Amazon QLDB-Sitzung
<a name="API_Types_Amazon_QLDB_Session"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgenden Datentypen werden von Amazon QLDB Session unterstützt:
+  [AbortTransactionRequest](API_QLDB-Session_AbortTransactionRequest.md) 
+  [AbortTransactionResult](API_QLDB-Session_AbortTransactionResult.md) 
+  [CommitTransactionRequest](API_QLDB-Session_CommitTransactionRequest.md) 
+  [CommitTransactionResult](API_QLDB-Session_CommitTransactionResult.md) 
+  [EndSessionRequest](API_QLDB-Session_EndSessionRequest.md) 
+  [EndSessionResult](API_QLDB-Session_EndSessionResult.md) 
+  [ExecuteStatementRequest](API_QLDB-Session_ExecuteStatementRequest.md) 
+  [ExecuteStatementResult](API_QLDB-Session_ExecuteStatementResult.md) 
+  [FetchPageRequest](API_QLDB-Session_FetchPageRequest.md) 
+  [FetchPageResult](API_QLDB-Session_FetchPageResult.md) 
+  [IOUsage](API_QLDB-Session_IOUsage.md) 
+  [Page](API_QLDB-Session_Page.md) 
+  [StartSessionRequest](API_QLDB-Session_StartSessionRequest.md) 
+  [StartSessionResult](API_QLDB-Session_StartSessionResult.md) 
+  [StartTransactionRequest](API_QLDB-Session_StartTransactionRequest.md) 
+  [StartTransactionResult](API_QLDB-Session_StartTransactionResult.md) 
+  [TimingInformation](API_QLDB-Session_TimingInformation.md) 
+  [ValueHolder](API_QLDB-Session_ValueHolder.md) 

# AbortTransactionRequest
<a name="API_QLDB-Session_AbortTransactionRequest"></a>

Enthält die Details der Transaktion, die abgebrochen werden soll.

## Inhalt
<a name="API_QLDB-Session_AbortTransactionRequest_Contents"></a>

Die Mitglieder dieser Ausnahmestruktur sind kontextabhängig.

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_AbortTransactionRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/AbortTransactionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/AbortTransactionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/AbortTransactionRequest) 

# AbortTransactionResult
<a name="API_QLDB-Session_AbortTransactionResult"></a>

Enthält die Details der abgebrochenen Transaktion.

## Inhalt
<a name="API_QLDB-Session_AbortTransactionResult_Contents"></a>

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_AbortTransactionResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_AbortTransactionResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/AbortTransactionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/AbortTransactionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/AbortTransactionResult) 

# CommitTransactionRequest
<a name="API_QLDB-Session_CommitTransactionRequest"></a>

Enthält die Details der Transaktion, die festgeschrieben werden soll.

## Inhalt
<a name="API_QLDB-Session_CommitTransactionRequest_Contents"></a>

 ** CommitDigest **   <a name="qldb-Type-QLDB-Session_CommitTransactionRequest-CommitDigest"></a>
Gibt den Commit-Digest für die Transaktion an, für die ein Commit ausgeführt werden soll. Für jede aktive Transaktion muss der Commit-Digest übergeben werden. QLDB validiert den Commit `CommitDigest` und lehnt ihn mit einem Fehler ab, wenn der auf dem Client berechnete Digest nicht mit dem von QLDB berechneten Digest übereinstimmt.  
Der Zweck des `CommitDigest` Parameters besteht darin, sicherzustellen, dass QLDB eine Transaktion genau dann festschreibt, wenn der Server genau die vom Client gesendeten Anweisungen verarbeitet hat, in derselben Reihenfolge, in der der Client sie gesendet hat, und ohne Duplikate.  
Typ: Base64-kodiertes Binärdatenobjekt  
Erforderlich: Ja

 ** TransactionId **   <a name="qldb-Type-QLDB-Session_CommitTransactionRequest-TransactionId"></a>
Gibt die Transaktions-ID der Transaktion an, die festgeschrieben werden soll.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_CommitTransactionRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/CommitTransactionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/CommitTransactionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/CommitTransactionRequest) 

# CommitTransactionResult
<a name="API_QLDB-Session_CommitTransactionResult"></a>

Enthält die Details der bestätigten Transaktion.

## Inhalt
<a name="API_QLDB-Session_CommitTransactionResult_Contents"></a>

 ** CommitDigest **   <a name="qldb-Type-QLDB-Session_CommitTransactionResult-CommitDigest"></a>
Der Commit-Digest der festgeschriebenen Transaktion.  
Typ: Base64-kodiertes Binärdatenobjekt  
Erforderlich: Nein

 ** ConsumedIOs **   <a name="qldb-Type-QLDB-Session_CommitTransactionResult-ConsumedIOs"></a>
Enthält Metriken zur Anzahl der verbrauchten I/O-Anfragen.  
Typ: [IOUsage](API_QLDB-Session_IOUsage.md) Objekt  
Erforderlich: Nein

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_CommitTransactionResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

 ** TransactionId **   <a name="qldb-Type-QLDB-Session_CommitTransactionResult-TransactionId"></a>
Die Transaktions-ID der festgeschriebenen Transaktion.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_CommitTransactionResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/CommitTransactionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/CommitTransactionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/CommitTransactionResult) 

# EndSessionRequest
<a name="API_QLDB-Session_EndSessionRequest"></a>

Spezifiziert eine Anfrage zum Beenden der Sitzung.

## Inhalt
<a name="API_QLDB-Session_EndSessionRequest_Contents"></a>

Die Mitglieder dieser Ausnahmestruktur sind kontextabhängig.

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_EndSessionRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/EndSessionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/EndSessionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/EndSessionRequest) 

# EndSessionResult
<a name="API_QLDB-Session_EndSessionResult"></a>

Enthält die Details der beendeten Sitzung.

## Inhalt
<a name="API_QLDB-Session_EndSessionResult_Contents"></a>

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_EndSessionResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_EndSessionResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/EndSessionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/EndSessionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/EndSessionResult) 

# ExecuteStatementRequest
<a name="API_QLDB-Session_ExecuteStatementRequest"></a>

Spezifiziert eine Anforderung zur Ausführung einer Anweisung.

## Inhalt
<a name="API_QLDB-Session_ExecuteStatementRequest_Contents"></a>

 ** Statement **   <a name="qldb-Type-QLDB-Session_ExecuteStatementRequest-Statement"></a>
Gibt die Anweisung der Anforderung an.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 100000.  
Erforderlich: Ja

 ** TransactionId **   <a name="qldb-Type-QLDB-Session_ExecuteStatementRequest-TransactionId"></a>
Gibt die Transaktions-ID der Anfrage an.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

 ** Parameters **   <a name="qldb-Type-QLDB-Session_ExecuteStatementRequest-Parameters"></a>
Gibt die Parameter für die parametrisierte Anweisung in der Anforderung an.  
Typ: Array von [ValueHolder](API_QLDB-Session_ValueHolder.md)-Objekten  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_ExecuteStatementRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/ExecuteStatementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/ExecuteStatementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/ExecuteStatementRequest) 

# ExecuteStatementResult
<a name="API_QLDB-Session_ExecuteStatementResult"></a>

Enthält die Details der ausgeführten Anweisung.

## Inhalt
<a name="API_QLDB-Session_ExecuteStatementResult_Contents"></a>

 ** ConsumedIOs **   <a name="qldb-Type-QLDB-Session_ExecuteStatementResult-ConsumedIOs"></a>
Enthält Metriken über die Anzahl der verbrauchten I/O-Anfragen.  
Typ: [IOUsage](API_QLDB-Session_IOUsage.md) Objekt  
Erforderlich: Nein

 ** FirstPage **   <a name="qldb-Type-QLDB-Session_ExecuteStatementResult-FirstPage"></a>
Enthält die Details der ersten abgerufenen Seite.  
Typ: [Page](API_QLDB-Session_Page.md) Objekt  
Erforderlich: Nein

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_ExecuteStatementResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_ExecuteStatementResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/ExecuteStatementResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/ExecuteStatementResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/ExecuteStatementResult) 

# FetchPageRequest
<a name="API_QLDB-Session_FetchPageRequest"></a>

Gibt die Details der Seite an, die abgerufen werden soll.

## Inhalt
<a name="API_QLDB-Session_FetchPageRequest_Contents"></a>

 ** NextPageToken **   <a name="qldb-Type-QLDB-Session_FetchPageRequest-NextPageToken"></a>
Gibt das Token für die nächste Seite der abzurufenden Seite an.  
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$`   
Erforderlich: Ja

 ** TransactionId **   <a name="qldb-Type-QLDB-Session_FetchPageRequest-TransactionId"></a>
Gibt die Transaktions-ID der abzurufenden Seite an.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Ja

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_FetchPageRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/FetchPageRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/FetchPageRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/FetchPageRequest) 

# FetchPageResult
<a name="API_QLDB-Session_FetchPageResult"></a>

Enthält die Seite, die abgerufen wurde.

## Inhalt
<a name="API_QLDB-Session_FetchPageResult_Contents"></a>

 ** ConsumedIOs **   <a name="qldb-Type-QLDB-Session_FetchPageResult-ConsumedIOs"></a>
Enthält Metriken über die Anzahl der verbrauchten I/O-Anfragen.  
Typ: [IOUsage](API_QLDB-Session_IOUsage.md) Objekt  
Erforderlich: Nein

 ** Page **   <a name="qldb-Type-QLDB-Session_FetchPageResult-Page"></a>
Enthält Details der abgerufenen Seite.  
Typ: [Page](API_QLDB-Session_Page.md) Objekt  
Erforderlich: Nein

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_FetchPageResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_FetchPageResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/FetchPageResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/FetchPageResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/FetchPageResult) 

# IOUsage
<a name="API_QLDB-Session_IOUsage"></a>

Enthält Metriken zur I/O-Nutzung für einen Befehl, der aufgerufen wurde.

## Inhalt
<a name="API_QLDB-Session_IOUsage_Contents"></a>

 ** ReadIOs **   <a name="qldb-Type-QLDB-Session_IOUsage-ReadIOs"></a>
Die Anzahl der I/O-Leseanforderungen, die der Befehl gestellt hat.  
Type: Long  
Erforderlich: Nein

 ** WriteIOs **   <a name="qldb-Type-QLDB-Session_IOUsage-WriteIOs"></a>
Die Anzahl der I/O-Schreibanforderungen, die der Befehl gestellt hat.  
Type: Long  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_IOUsage_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/IOUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/IOUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/IOUsage) 

# Page
<a name="API_QLDB-Session_Page"></a>

Enthält Details der abgerufenen Seite.

## Inhalt
<a name="API_QLDB-Session_Page_Contents"></a>

 ** NextPageToken **   <a name="qldb-Type-QLDB-Session_Page-NextPageToken"></a>
Das Token der nächsten Seite.  
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$`   
Erforderlich: Nein

 ** Values **   <a name="qldb-Type-QLDB-Session_Page-Values"></a>
Eine Struktur, die Werte in mehreren Kodierungsformaten enthält.  
Typ: Array von [ValueHolder](API_QLDB-Session_ValueHolder.md)-Objekten  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_Page_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/Page) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/Page) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/Page) 

# StartSessionRequest
<a name="API_QLDB-Session_StartSessionRequest"></a>

Spezifiziert eine Anfrage zum Starten einer neuen Sitzung.

## Inhalt
<a name="API_QLDB-Session_StartSessionRequest_Contents"></a>

 ** LedgerName **   <a name="qldb-Type-QLDB-Session_StartSessionRequest-LedgerName"></a>
Der Name des Ledgers, für das eine neue Sitzung gestartet werden soll.  
Typ: Zeichenfolge  
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

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_StartSessionRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/StartSessionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/StartSessionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/StartSessionRequest) 

# StartSessionResult
<a name="API_QLDB-Session_StartSessionResult"></a>

Enthält die Details der gestarteten Sitzung.

## Inhalt
<a name="API_QLDB-Session_StartSessionResult_Contents"></a>

 ** SessionToken **   <a name="qldb-Type-QLDB-Session_StartSessionResult-SessionToken"></a>
Sitzungstoken der gestarteten Sitzung. Dies `SessionToken` ist für jeden nachfolgenden Befehl erforderlich, der während der aktuellen Sitzung ausgegeben wird.  
Typ: Zeichenfolge  
Längenbeschränkungen: Mindestlänge von 4. Maximale Länge beträgt 1024 Zeichen.  
Pattern: `^[A-Za-z-0-9+/=]+$`   
Erforderlich: Nein

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_StartSessionResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_StartSessionResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im AWS SDKs Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/StartSessionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/StartSessionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/StartSessionResult) 

# StartTransactionRequest
<a name="API_QLDB-Session_StartTransactionRequest"></a>

Spezifiziert eine Anfrage zum Starten einer Transaktion.

## Inhalt
<a name="API_QLDB-Session_StartTransactionRequest_Contents"></a>

Die Mitglieder dieser Ausnahmestruktur sind kontextabhängig.

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_StartTransactionRequest_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen finden Sie im Folgenden AWS SDKs:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/StartTransactionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/StartTransactionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/StartTransactionRequest) 

# StartTransactionResult
<a name="API_QLDB-Session_StartTransactionResult"></a>

Enthält die Details der gestarteten Transaktion.

## Inhalt
<a name="API_QLDB-Session_StartTransactionResult_Contents"></a>

 ** TimingInformation **   <a name="qldb-Type-QLDB-Session_StartTransactionResult-TimingInformation"></a>
Enthält serverseitige Leistungsinformationen für den Befehl.  
Typ: [TimingInformation](API_QLDB-Session_TimingInformation.md) Objekt  
Erforderlich: Nein

 ** TransactionId **   <a name="qldb-Type-QLDB-Session_StartTransactionResult-TransactionId"></a>
Die Transaktions-ID der gestarteten Transaktion.  
Typ: Zeichenfolge  
Längenbeschränkungen: Feste Länge von 22.  
Pattern: `^[A-Za-z-0-9]+$`   
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_StartTransactionResult_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/StartTransactionResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/StartTransactionResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/StartTransactionResult) 

# TimingInformation
<a name="API_QLDB-Session_TimingInformation"></a>

Enthält serverseitige Leistungsinformationen für einen Befehl. Amazon QLDB erfasst Zeitinformationen zwischen dem Empfang der Anfrage und dem Senden der entsprechenden Antwort.

## Inhalt
<a name="API_QLDB-Session_TimingInformation_Contents"></a>

 ** ProcessingTimeMilliseconds **   <a name="qldb-Type-QLDB-Session_TimingInformation-ProcessingTimeMilliseconds"></a>
Die Zeit, die QLDB für die Verarbeitung des Befehls aufgewendet hat, gemessen in Millisekunden.  
Type: Long  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_TimingInformation_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/TimingInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/TimingInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/TimingInformation) 

# ValueHolder
<a name="API_QLDB-Session_ValueHolder"></a>

Eine Struktur, die einen Wert in mehreren Kodierungsformaten enthalten kann.

## Inhalt
<a name="API_QLDB-Session_ValueHolder_Contents"></a>

 ** IonBinary **   <a name="qldb-Type-QLDB-Session_ValueHolder-IonBinary"></a>
Ein Amazon Ion-Binärwert, der in einer `ValueHolder` Struktur enthalten ist.  
Typ: Base64-kodiertes Binärdatenobjekt  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 131072.  
Erforderlich: Nein

 ** IonText **   <a name="qldb-Type-QLDB-Session_ValueHolder-IonText"></a>
Ein Amazon Ion-Klartext-Wert, der in einer `ValueHolder` Struktur enthalten ist.  
Typ: Zeichenfolge  
Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Die maximale Länge beträgt 1048576.  
Erforderlich: Nein

## Weitere Informationen finden Sie unter:
<a name="API_QLDB-Session_ValueHolder_SeeAlso"></a>

Weitere Informationen zur Verwendung dieser API in einer der sprachspezifischen Sprachen AWS SDKs finden Sie im Folgenden:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/qldb-session-2019-07-11/ValueHolder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/qldb-session-2019-07-11/ValueHolder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/qldb-session-2019-07-11/ValueHolder) 

# Häufige Fehler
<a name="CommonErrors"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

In diesem Abschnitt sind die Fehler aufgeführt, die bei den API-Aktionen aller Dienste häufig auftreten. AWS Informationen zu Fehlern, die spezifisch für eine API-Aktion für diesen Service sind, finden Sie unter dem Thema für diese API-Aktion.

 **AccessDeniedException**   
Sie haben keinen ausreichenden Zugriff zum Durchführen dieser Aktion.  
HTTP Status Code: 400

 **IncompleteSignature**   
Die Anforderungssignatur entspricht nicht den AWS Standards.  
HTTP Status Code: 400

 **InternalFailure**   <a name="CommonErrors-InternalFailure"></a>
Die Anforderungsverarbeitung ist fehlgeschlagen, da ein unbekannter Fehler, eine Ausnahme oder ein Fehler aufgetreten ist.  
HTTP Status Code: 500

 **InvalidAction**   <a name="CommonErrors-InvalidAction"></a>
Die angeforderte Aktion oder Operation ist ungültig. Überprüfen Sie, ob die Aktion ordnungsgemäß eingegeben wurde.  
HTTP Status Code: 400

 **InvalidClientTokenId**   <a name="CommonErrors-InvalidClientTokenId"></a>
Das angegebene X.509-Zertifikat oder die angegebene AWS Zugriffsschlüssel-ID ist in unseren Aufzeichnungen nicht vorhanden.  
HTTP Status Code: 403

 **NotAuthorized**   <a name="CommonErrors-NotAuthorized"></a>
Sie haben keine Berechtigung zum Ausführen dieser Aktion.  
HTTP Status Code: 400

 **OptInRequired**   <a name="CommonErrors-OptInRequired"></a>
Für die AWS Zugriffsschlüssel-ID ist ein Abonnement für den Dienst erforderlich.  
HTTP Status Code: 403

 **RequestExpired**   <a name="CommonErrors-RequestExpired"></a>
Die Anfrage erreichte den Service mehr als 15 Minuten nach dem Datumsstempel auf der Anfrage oder mehr als 15 Minuten nach dem Ablaufdatum der Anfrage (z. B. bei vorsignierter Anfrage URLs), oder der Datumsstempel auf der Anfrage liegt mehr als 15 Minuten in der future.  
HTTP Status Code: 400

 **ServiceUnavailable**   <a name="CommonErrors-ServiceUnavailable"></a>
Die Anforderung ist aufgrund eines temporären Fehlers des Servers fehlgeschlagen.  
HTTP Status Code: 503

 **ThrottlingException**   <a name="CommonErrors-ThrottlingException"></a>
Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.  
HTTP Status Code: 400

 **ValidationError**   <a name="CommonErrors-ValidationError"></a>
Die Eingabe erfüllt nicht die von einem AWS Dienst angegebenen Einschränkungen.  
HTTP Status Code: 400

# Geläufige Parameter
<a name="CommonParameters"></a>

**Wichtig**  
Hinweis zum Ende des Supports: Bestandskunden können Amazon QLDB bis zum Ende des Supports am 31.07.2025 nutzen. Weitere Informationen finden Sie unter [Migrieren eines Amazon QLDB-Ledgers zu Amazon](https://aws.amazon.com/blogs/database/migrate-an-amazon-qldb-ledger-to-amazon-aurora-postgresql/) Aurora PostgreSQL.

Die folgende Liste enthält die Parameter, die alle Aktionen zum Signieren von Signature-Version-4-Anforderungen mit einer Abfragezeichenfolge verwenden. Alle aktionsspezifischen Parameter werden im Thema für diese Aktion aufgelistet. *Weitere Informationen zu Signature Version 4 finden Sie unter [Signieren von AWS API-Anfragen](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html) im IAM-Benutzerhandbuch.*

 **Action**   <a name="CommonParameters-Action"></a>
Die auszuführende Aktion.  
Typ: Zeichenfolge  
Erforderlich: Ja

 **Version**   <a name="CommonParameters-Version"></a>
Die API-Version, für die die Anfrage geschrieben wurde, ausgedrückt im Format YYYY-MM-DD.  
Typ: Zeichenfolge  
Erforderlich: Ja

 **X-Amz-Algorithm**   <a name="CommonParameters-X-Amz-Algorithm"></a>
Der Hashalgorithmus, den Sie zum Erstellen der Anforderungssignatur verwendet haben.  
Bedingung: Geben Sie diesen Parameter an, wenn Sie Authentifizierungsinformationen in eine Abfragezeichenfolge anstatt in den HTTP-Autorisierungsheader aufnehmen.  
Typ: Zeichenfolge  
Zulässige Werte: `AWS4-HMAC-SHA256`   
Required: Conditional

 **X-Amz-Credential**   <a name="CommonParameters-X-Amz-Credential"></a>
Der Wert des Anmeldeinformationsumfangs. Dabei handelt es sich um eine Zeichenfolge, die Ihren Zugriffsschlüssel, das Datum, die gewünschte Region und eine Zeichenfolge zur Beendigung („aws4\$1request“) beinhaltet. Der Wert wird im folgenden Format ausgedrückt: *Zugriffsschlüssel*/*JJJJMMTT*/*Region*/*Service*/aws4\$1request.  
Weitere Informationen finden Sie im *IAM-Benutzerhandbuch* unter [Erstellen einer signierten AWS API-Anfrage](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html).  
Bedingung: Geben Sie diesen Parameter an, wenn Sie Authentifizierungsinformationen in eine Abfragezeichenfolge anstatt in den HTTP-Autorisierungsheader aufnehmen.  
Typ: Zeichenfolge  
Required: Conditional

 **X-Amz-Date**   <a name="CommonParameters-X-Amz-Date"></a>
Das Datum, das zum Erstellen der Signatur verwendet wird. Das Format muss das ISO 8601-Basisformat (JJJJMMTT'T'SSMMSS'Z') sein. Beispielsweise ist die folgende Datums- und Uhrzeitangabe ein gültiger X-Amz-Date Wert:`20120325T120000Z`.  
Bedingung: X-Amz-Date ist bei allen Anforderungen optional. Damit kann das Datum überschrieben werden, das zum Signieren von Anforderungen verwendet wird. Wenn der Date-Header im ISO 8601-Grundformat angegeben ist, X-Amz-Date ist dies nicht erforderlich. Wenn verwendet X-Amz-Date wird, überschreibt er immer den Wert des Date-Headers. Weitere Informationen finden Sie unter [Elemente einer AWS API-Anforderungssignatur](https://docs.aws.amazon.com/IAM/latest/UserGuide/signing-elements.html) im *IAM-Benutzerhandbuch*.  
Typ: Zeichenfolge  
Required: Conditional

 **X-Amz-Security-Token**   <a name="CommonParameters-X-Amz-Security-Token"></a>
Das temporäre Sicherheitstoken, das durch einen Aufruf von AWS -Security-Token-Service (AWS STS) abgerufen wurde. Eine Liste der Services, die temporäre Sicherheits-Anmeldeinformationen von AWS STS unterstützen, finden Sie im *IAM-Benutzerhandbuch* unter [AWS-Services , die mit IAM funktionieren](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html).  
Bedingung: Wenn Sie temporäre Sicherheitsanmeldedaten von verwenden AWS STS, müssen Sie das Sicherheitstoken angeben.  
Typ: Zeichenfolge  
Required: Conditional

 **X-Amz-Signature**   <a name="CommonParameters-X-Amz-Signature"></a>
Gibt die hex-codierte Signatur an, die aus der zu signierenden Zeichenfolge und dem abgeleiteten Signaturschlüssel berechnet wurde.  
Bedingung: Geben Sie diesen Parameter an, wenn Sie Authentifizierungsinformationen in eine Abfragezeichenfolge anstatt in den HTTP-Autorisierungsheader aufnehmen.  
Typ: Zeichenfolge  
Required: Conditional

 **X-Amz-SignedHeaders**   <a name="CommonParameters-X-Amz-SignedHeaders"></a>
Gibt alle HTTP-Header an, die als Teil der kanonischen Anforderung enthalten waren. Weitere Informationen zur Angabe signierter Header finden Sie unter [Erstellen einer signierten AWS API-Anfrage](https://docs.aws.amazon.com/IAM/latest/UserGuide/create-signed-request.html) im *IAM-Benutzerhandbuch*.  
Bedingung: Geben Sie diesen Parameter an, wenn Sie Authentifizierungsinformationen in eine Abfragezeichenfolge anstatt in den HTTP-Autorisierungsheader aufnehmen.  
Typ: Zeichenfolge  
Required: Conditional