X4 Produktdokumentation

Operation: GetItem

Mit der Operation GetItem des Amazon S3 DynamoDB Connectors rufen Sie ein spezifisches Element aus einer Tabelle ab.

Weitere Informationen zu anderen Operationen des Amazon S3 DynamoDB Connectors finden Sie unter Amazon S3 DynamoDB Connector.

Parameter

keyID

Zugangsschlüssel-ID für Anfragen an AWS (Amazon Web Services)

Hinweis:

Die Zugangsdaten werden über Parameter an den Adapter gesendet. Dabei gibt es verschiedene Konfigurationsmöglichkeiten. Weitere Informationen finden Sie unter Zugangsdaten einrichten.

Mögliche Werte:

Beliebige Zeichenkette mit der Zugangsschlüssel-ID, z. B.  AKIAIOSFODNN7EXAMPLE

secretKey

Geheimer Zugangsschlüssel für Anfragen an AWS

Hinweis:

Die Zugangsdaten werden über Parameter an den Adapter gesendet. Dabei gibt es verschiedene Konfigurationsmöglichkeiten. Weitere Informationen finden Sie unter Zugangsdaten einrichten.

Mögliche Werte:

Beliebige Zeichenkette mit der geheimen Zugangsschlüssel, z. B.  wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

region

Region der Domains

Hinweis:

Buckets, die in einer bestimmten Region erstellt wurden, können nicht von einer anderen Region aus aufgerufen werden. Weitere Informationen finden Sie unter Regionen und Endpoints.

Mögliche Werte:

Beliebige Zeichenkette mit dem Namen der Region, z. B.  us-east-2

tableName

✳️

Dieser Parameter ist erforderlich für diese Operation.

Tabellen-Name

Mögliche Werte:

Zeichenkette mit dem Tabellen-Namen nach folgenden Namensregeln:

  • Alle Namen müssen UTF-8-kodiert sein

  • Die Groß- und Kleinschreibung muss beachtet werden

  • Tabellennamen und Indexnamen müssen zwischen 3 und 255 Zeichen lang sein und dürfen nur folgende Zeichen enthalten:

    • a-z

    • A-Z

    • 0-9

    • _ (Unterstrich)

    • - (Bindestrich)

    • . (Punkt)

  • Attributnamen müssen zwischen 1 und 255 Zeichen lang sein.

partitionKey, partitionType und partitionKeyValue

✳️

Diese Parameter sind erforderlich für diese Operation und müssen mit dem Element übereinstimmen, das abgerufen werden soll.

Elemente des Tabellen-Primärschlüssels

Mögliche Werte:

  • PartitionKey: Name des Partitionsschlüssels

  • PartitionType: Partitionstyp

    • S: Das Attribut ist eine Zeichenkette

    • N: Das Attribut ist eine Zahl

    • B: Das Attribut ist vom Typ Binär

  • PartitionKeyValue: Wert des Elements

sortKey, sortType und sortKeyValue

✳️

Diese Parameter sind bei sortierbaren Schlüsseln erforderlich.

Mögliche Werte:

  • SortKey: Name des Sortierschlüssels

  • SortType: Sortiertyp

    • S: Das Attribut ist eine Zeichenkette

    • N: Das Attribut ist eine Zahl

    • B: Das Attribut ist vom Typ Binär

  • SortKeyValue: Wert des Elements

readCapacityUnits, writeCapacitiyUnits

Read/Write Capacity Units

Mögliche Werte:

  • Integer Capacity Units

consistentRead

DynamoDB verwendet Eventually Consistent Reads, sofern nichts anderes angeben ist. Leseoperationen wie GetItem und Query liefern einen ConsistentRead-Parameter. Wenn dieser Parameter auf true gesetzt ist, verwendet DynamoDB während des Betriebs Strongly Consistent Reads.

Statuswerte

1

Die Operation wurde erfolgreich ausgeführt

0

Die Operation wurde nicht vollständig ausgeführt, es ist aber kein Fehler aufgetreten.

-1

Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.

Output

Der Adapter ruft das spezifische Element aus der gewünschten Tabelle ab und gibt Daten in einer XML-Struktur aus.

<?xml version="1.0" encoding="UTF-8"
<Result>
	<Item partitionKey="ID" partitionKeyValue="2" SortKey="Name" SortKeyValue="Carlos">
		<Attribute name="Address" type="S" value="Pirandello"/>
		<Attribute name="Phone" type="N" value="637559681"/>
		<Attribute name="Bonus" type="BOOL" value="true"/>
		<Attribute name="DocumentCode" type="B" value="qwrqfgdas1223455sdfffr"/>
		<Attribute name="Surname" type="S" value="Delgado"/>
		<Attribute name="Profession" type="S" value="Programmer"/>
	</Item>
</Result>