Verbindungsmetadaten und Vorschau-API

• Entitätsstruktur

• Feldstruktur

Felder

• EntityName – UTF-8-Zeichenfolge.

  Der Name der Entität.

• Label – UTF-8-Zeichenfolge.

  Für die Entität verwendete Bezeichnung.

• IsParentEntity – Boolesch.

  Ein boolescher Wert, mit dem bestimmt werden kann, ob Unterobjekte aufgelistet werden können.

• Description – UTF-8-Zeichenfolge.

  Eine Beschreibung der Entität.

• Category – UTF-8-Zeichenfolge.

  Der Typ der Entitäten, die in der Antwort vorhanden sind. Dieser Wert hängt von der Quellverbindung ab. Dies ist beispielsweise SObjects für Salesforce und databases oder schemas oder tables für Quellen wie Amazon Redshift.

• CustomProperties – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine UTF-8-Zeichenfolge.

  Jeder Wert ist eine UTF-8-Zeichenfolge.

  Eine optionale Zuordnung von Schlüsseln, die für eine Entität von einem Connector zurückgegeben werden können.

Felder

• FieldName – UTF-8-Zeichenfolge.

  Eine eindeutige Kennung für das Feld.

• Label – UTF-8-Zeichenfolge.

  Eine lesbare Bezeichnung, die für das Feld verwendet wird.

• Description – UTF-8-Zeichenfolge.

  Eine Beschreibung des Felds.

• FieldType – UTF-8-Zeichenfolge (zulässige Werte: INT | SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT).

  Der Typ der Daten im Feld.

• IsPrimaryKey – Boolesch.

  Gibt an, ob dieses Feld als Primärschlüssel für die angegebene Entität verwendet werden kann.

• IsNullable – Boolesch.

  Gibt an, ob dieses Feld löschbar ist oder nicht.

• IsRetrievable – Boolesch.

  Gibt an, ob dieses Feld der SELECT-Klausel der SQL-Abfrage hinzugefügt werden kann oder ob es abrufbar ist oder nicht.

• IsFilterable – Boolesch.

  Gibt an, ob dieses Feld in einer Filterklausel (WHERE-Klausel) einer SQL-Anweisung beim Abfragen von Daten verwendet werden kann.

• IsPartitionable – Boolesch.

  Gibt an, ob ein bestimmtes Feld zur Partitionierung der an Software as a Service (SaaS) gestellten Abfrage verwendet werden kann.

• IsCreateable – Boolesch.

  Gibt an, ob dieses Feld im Rahmen eines Schreibvorgangs an das Ziel erstellt werden kann.

• IsUpdateable – Boolesch.

  Gibt an, ob dieses Feld im Rahmen eines Schreibvorgangs an das Ziel aktualisiert werden kann.

• IsUpsertable – Boolesch.

  Gibt an, ob dieses Feld im Rahmen eines Schreibvorgangs an das Ziel geändert werden kann.

• IsDefaultOnCreate – Boolesch.

  Gibt an, ob dieses Feld automatisch gefüllt wird, wenn das Objekt erstellt wird, z. B. ein Erstellt am-Zeitstempel.

• SupportedValues – Ein UTF-8-Zeichenfolgen-Array.

  Eine Liste von unterstützten Werten für das Feld.

• SupportedFilterOperators – Ein UTF-8-Zeichenfolgen-Array.

  Gibt an, welche Filtervorgänge für dieses Feld unterstützt werden.

• ParentField – UTF-8-Zeichenfolge.

  Ein übergeordneter Feldname für ein verschachteltes Feld.

• NativeDataType – UTF-8-Zeichenfolge.

  Der von der SaaS-API zurückgegebene Datentyp, beispielsweise „Picklist“ oder „Textarea“ von Salesforce.

• CustomProperties – Ein Map-Array von Schlüssel-Wert-Paaren.

  Jeder Schlüssel ist eine UTF-8-Zeichenfolge.

  Jeder Wert ist eine UTF-8-Zeichenfolge.

  Optionale Zuordnung von Schlüsseln, die zurückgegeben werden können.

• ListEntities-Aktion (Python: list_entities)

• DescribeEntity-Aktion (Python: describe_entity)

• GetEntityRecords-Aktion (Python: get_entity_records)

Anforderung

• ConnectionName – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Ein Name für die Verbindung, für die Anmeldeinformationen erforderlich sind, um einen beliebigen Verbindungstyp abzufragen.

• CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die Katalog-ID des Katalogs, der die Verbindung enthält. Sie kann null sein. Standardmäßig ist die AWS-Konto-ID die Katalog-ID.

• ParentEntityName – UTF-8-Zeichenfolge.

  Der Name der übergeordneten Entität, für die Sie die untergeordneten Entitäten aufführen möchten. Dieser Parameter verwendet einen vollständig qualifizierten Pfad der Entität, um die untergeordneten Entitäten aufzulisten.

• NextToken – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.

  Ein Fortsetzungs-Token, der enthalten ist, wenn dies ein Fortsetzungsaufruf ist.

• DataStoreApiVersion – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #23.

  Die API-Version des SaaS-Connectors.

Antwort

• Entities – Ein Array mit Entität-Objekten.

  Eine Liste von Entity-Objekten.

• NextToken – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.

  Ein Fortsetzungs-Token, das vorhanden ist, wenn das aktuelle Segment nicht das letzte ist.

Fehler

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

• ValidationException

• FederationSourceException

• AccessDeniedException

Anforderung

• ConnectionName – Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Der Name der Verbindung, die die Verbindungstyp-Anmeldeinformationen enthält.

• CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die Katalog-ID des Katalogs, der die Verbindung enthält. Sie kann Null sein. Standardmäßig ist die AWS-Konto-ID die Katalog-ID.

• EntityName – Erforderlich: UTF-8-Zeichenfolge.

  Der Name der Entität, die Sie anhand des Verbindungstyps beschreiben möchten.

• NextToken – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.

  Ein Fortsetzungs-Token, der enthalten ist, wenn dies ein Fortsetzungsaufruf ist.

• DataStoreApiVersion – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #23.

  Die Version der API, die für den Datenspeicher verwendet wird.

Antwort

• Fields – Ein Array mit Feld-Objekten.

  Beschreibt die Felder für diese Connector-Entität. Dies ist die Liste der Field-Objekte. Field ähnelt sehr einer Spalte in einer Datenbank. Das Field-Objekt enthält Informationen über verschiedene Eigenschaften, die Feldern im Connector zugeordnet sind.

• NextToken – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.

  Ein Fortsetzungs-Token, das vorhanden ist, wenn das aktuelle Segment nicht das letzte ist.

Fehler

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

• ValidationException

• FederationSourceException

• AccessDeniedException

Anforderung

• ConnectionName – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Der Name der Verbindung, die die Verbindungstyp-Anmeldeinformationen enthält.

• CatalogId – Katalog-ID-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.

  Die Katalog-ID des Katalogs, der die Verbindung enthält. Sie kann null sein. Standardmäßig ist die AWS-Konto-ID die Katalog-ID.

• EntityName – Erforderlich: UTF-8-Zeichenfolge.

  Der Name der Entität, für die wir die Vorschaudaten des angegebenen Verbindungstyps abfragen möchten.

• NextToken – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.

  Ein Fortsetzungs-Token, der enthalten ist, wenn dies ein Fortsetzungsaufruf ist.

• DataStoreApiVersion – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, passend zum Custom string pattern #23.

  Die API-Version des SaaS-Connectors.

• ConnectionOptions – Ein Map-Array von Schlüssel-Wert-Paaren, nicht mehr als 100 Paare.

  Jeder Schlüssel ist eine UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, und entspricht dem Custom string pattern #18.

  Jeder Schlüssel ist eine UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 256 Bytes lang, und entspricht dem Custom string pattern #17.

  Connectoroptionen, die zum Abfragen der Daten erforderlich sind.

• FilterPredicate – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 100.000 Bytes lang.

  Ein Filterprädikat, das Sie in der Abfrageanforderung anwenden können.

• Limit – Erforderlich: Zahl (lang), nicht kleiner als 1 oder größer als 1.000.

  Beschränkt die Anzahl der mit der Anfrage abgerufenen Datensätze.

• OrderBy – UTF-8-Zeichenfolge.

  Ein Parameter, der die Antwortvorschaudaten sortiert.

• SelectedFields – Ein Array mit UTF-8-Zeichenfolgen, nicht weniger als 1 und nicht mehr als 1.000 Zeichenfolgen.

  Liste der Felder, die als Teil der Vorschaudaten abgerufen werden sollen.

Antwort

• Records – Eine Reihe von Strukturen.

  Eine Liste der angeforderten -Objekte.

• NextToken – UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.

  Ein Fortsetzungs-Token, das vorhanden ist, wenn das aktuelle Segment nicht das letzte ist.

Fehler

• EntityNotFoundException

• OperationTimeoutException

• InvalidInputException

• GlueEncryptionException

• ValidationException

• FederationSourceException

• AccessDeniedException