Verbindungstypen-API
Die Verbindungstyp-API beschreibt AWS Glue-APIs, die sich auf die Beschreibung von Verbindungstypen beziehen.
Verbindungsverwaltung-APIs
DescribeConnectionType-Aktion (Python: describe_connection_type)
Die DescribeConnectionType-API stellt vollständige Informationen zu den unterstützten Optionen für einen bestimmten Verbindungstyp in AWS Glue bereit.
Anforderung
-
ConnectionType– Erforderlich: UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.Der Name des zu beschreibenden Verbindungstyps.
Antwort
-
ConnectionType– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 255 Bytes lang, passend zum Single-line string pattern.Der Name des Verbindungstyps.
-
Description– UTF-8-Zeichenfolge, nicht mehr als 1.024 Bytes lang.Eine Beschreibung des Verbindungstyps.
-
Capabilities– Ein Capabilities-Objekt.Die unterstützten Authentifizierungstypen, Datenschnittstellentypen (Datenverarbeitungsumgebungen) und Datenoperationen des Connectors.
-
ConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Verbindungseigenschaften, die in allen Datenverarbeitungsumgebungen üblich sind.
-
ConnectionOptions– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Gibt Eigenschaften zurück, die beim Erstellen einer Verbindung in den
ConnectionInput.ConnectionPropertiesfestgelegt werden können.ConnectionOptionsdefiniert Parameter, die in einem Spark-ETL-Skript in der Zuordnung der Verbindungsoptionen festgelegt werden können, die an einen Datenrahmen übergeben wird. -
AuthenticationConfiguration– Ein AuthConfiguration-Objekt.Die Art der für die Verbindung zu verwendenden Authentifizierung.
-
ComputeEnvironmentConfigurations– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A ComputeEnvironmentConfiguration-Objekt.
Die Datenverarbeitungsumgebungen, die von der Verbindung unterstützt werden.
-
PhysicalConnectionRequirements– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Physikalische Anforderungen für eine Verbindung, beispielsweise VPC-, Subnetz- und Sicherheitsgruppenspezifikationen.
-
AthenaConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Spezifische Verbindungseigenschaften für die Athena-Datenverarbeitungsumgebung.
-
PythonConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Verbindungseigenschaften, die für die Python-Datenverarbeitungsumgebung spezifisch sind.
-
SparkConnectionProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Spezifische Verbindungseigenschaften für die Spark-Datenverarbeitungsumgebung.
Fehler
ValidationExceptionInvalidInputExceptionInternalServiceException
ListConnectionTypes-Aktion (Python: list_connection_types)
Die ListConnectionTypes-API stellt einen Erkennungsmechanismus zum Ermitteln verfügbarer Verbindungstypen in AWS Glue bereit. Die Antwort enthält eine Liste von Verbindungstypen mit detaillierten Informationen dazu, was für die einzelnen Verbindungstypen unterstützt wird. Bei den aufgelisteten Verbindungstypen handelt es sich um eine Gruppe unterstützter Optionen für den ConnectionType-Wert in der CreateConnection-API.
Anforderung
-
MaxResults– Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 1000.Die maximale Anzahl der auszugebenden Ergebnisse.
-
NextToken– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.
Antwort
-
ConnectionTypes– Ein Array mit ConnectionTypeBrief-Objekten.Eine Liste von
ConnectionTypeBrief-Objekten mit kurzen Informationen zu den unterstützten Verbindungstypen. -
NextToken– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 2048 Bytes lang, passend zum Custom string pattern #11.Ein Fortsetzungs-Token, wenn das aktuelle Listensegment nicht das letzte ist.
Fehler
InternalServiceException
ConnectionTypeBrief-Struktur
Kurze Informationen zu einem unterstützten Verbindungstyp, der von der ListConnectionTypes-API zurückgegeben wird.
Felder
-
ConnectionType– UTF-8-Zeichenfolge (gültige Werte:JDBC|SFTP|MONGODB|KAFKA|NETWORK|MARKETPLACE|CUSTOM|SALESFORCE|VIEW_VALIDATION_REDSHIFT|VIEW_VALIDATION_ATHENA|GOOGLEADS|GOOGLESHEETS|GOOGLEANALYTICS4|SERVICENOW|MARKETO|SAPODATA|ZENDESK|JIRACLOUD|NETSUITEERP|HUBSPOT|FACEBOOKADS|INSTAGRAMADS|ZOHOCRM|SALESFORCEPARDOT|SALESFORCEMARKETINGCLOUD|SLACK|STRIPE|INTERCOM|SNAPCHATADS).Der Name des Verbindungstyps.
-
DisplayName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang.Der lesbare Name für den Verbindungstyp, der in der AWS Glue-Konsole angezeigt wird.
-
Vendor– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang.Der Name des Anbieters, der diesen Verbindungstyp erstellt oder verwaltet.
-
Description– UTF-8-Zeichenfolge, nicht mehr als 1.024 Bytes lang.Eine Beschreibung des Verbindungstyps.
-
Categories– Ein UTF-8-Zeichenfolgen-Array.Eine Liste der Kategorien, zu denen dieser Verbindungstyp gehört. Mithilfe von Kategorien können Benutzer anhand ihrer Anwendungsfälle geeignete Verbindungstypen filtern und finden.
-
Capabilities– Ein Capabilities-Objekt.Die unterstützten Authentifizierungstypen, Datenschnittstellentypen (Datenverarbeitungsumgebungen) und Datenoperationen des Connectors.
-
LogoUrl– UTF-8-Zeichenfolge.Die URL des Logos, das einem Verbindungstyp zugeordnet ist.
-
ConnectionTypeVariants– Ein Array mit ConnectionTypeVariant-Objekten.Eine Liste der für diesen Verbindungstyp verfügbaren Varianten. Verschiedene Varianten bieten möglicherweise spezielle Konfigurationen für bestimmte Anwendungsfälle oder Implementierungen desselben allgemeinen Verbindungstyps.
ConnectionTypeVariant-Struktur
Stellt eine Variante eines Verbindungstyps im AWS Glue-Datenkatalog dar. Verbindungstypvarianten stellen spezifische Konfigurationen und Verhaltensweisen für verschiedene Implementierungen desselben allgemeinen Verbindungstyps bereit.
Felder
-
ConnectionTypeVariantName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang.Der eindeutige Bezeichner für die Verbindungstypvariante. Dieser Name wird intern verwendet, um die spezifische Variante eines Verbindungstyps zu identifizieren.
-
DisplayName– UTF-8-Zeichenfolge, nicht weniger als 1 oder mehr als 128 Bytes lang.Der lesbare Name für die Verbindungstypvariante, der in der AWS Glue-Konsole angezeigt wird.
-
Description– UTF-8-Zeichenfolge, nicht mehr als 1.024 Bytes lang.Eine ausführliche Beschreibung der Verbindungstypvariante, einschließlich Zweck, Anwendungsfälle und aller spezifischen Konfigurationsanforderungen.
-
LogoUrl– UTF-8-Zeichenfolge.Die URL des Logos, das einer Verbindungstypvariante zugeordnet ist.
Datentypen
Validierungsstruktur
Definiert, wie eine Verbindungseigenschaft validiert wird.
Felder
-
ValidationType– Erforderlich: UTF-8-Zeichenfolge (zulässige Werte:REGEX|RANGE).Die Art der durchzuführenden Validierung, beispielsweise
REGEX. -
Patterns– Ein UTF-8-Zeichenfolgen-Array.Eine Liste von Mustern, die für die Validierung gelten.
-
Description– Erforderlich: UTF-8-Zeichenkette, nicht weniger als 1 oder mehr als 1.024 Bytes lang.Eine Beschreibung der Validierung.
-
MaxLength– Zahl (Ganzzahl).Die maximale Länge für eine Verbindungseigenschaft einer Zeichenfolge.
-
Maximum– Zahl (Ganzzahl).Der Maximalwert bei der Angabe eines
RANGE-Validierungstyps. -
Minimum– Zahl (Ganzzahl).Der Mindestwert bei der Angabe eines
RANGE-Validierungstyps.
AuthConfiguration-Struktur
Die Authentifizierungskonfiguration für eine Verbindung, die von der DescribeConnectionType-API zurückgegeben wurde.
Felder
-
AuthenticationType– Erforderlich: Ein Eigenschaft-Objekt.Die Art der Authentifizierung für eine Verbindung.
-
SecretArn– Ein Eigenschaft-Objekt.Der Amazon-Ressourcenname (ARN) für Secrets Manager.
-
OAuth2Properties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Eine Zuordnung von Schlüssel-Wert-Paaren für die OAuth2-Eigenschaften. Jeder Wert ist ein
Property-Objekt. -
BasicAuthenticationProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Eine Zuordnung von Schlüssel-Wert-Paaren für die OAuth2-Eigenschaften. Jeder Wert ist ein
Property-Objekt. -
CustomAuthenticationProperties– Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Eine Zuordnung von Schlüssel-Wert-Paaren für benutzerdefinierte Authentifizierungseigenschaften. Jeder Wert ist ein
Property-Objekt.
Capabilities-Struktur
Gibt die unterstützten Authentifizierungstypen an, die von der DescribeConnectionType-API zurückgegeben werden.
Felder
-
SupportedAuthenticationTypes– Erforderlich: Ein Array von UTF-8-Zeichenketten.Eine Liste der unterstützten Authentifizierungstypen.
-
SupportedDataOperations– Erforderlich: Ein Array von UTF-8-Zeichenketten.Eine Liste der unterstützten Datenoperationen.
-
SupportedComputeEnvironments– Erforderlich: Ein Array von UTF-8-Zeichenketten.Eine Liste der unterstützten Datenverarbeitungsumgebungen.
Property-Struktur
Ein Objekt, das einen Verbindungstyp für eine Datenverarbeitungsumgebung definiert.
Felder
-
Name– Erforderlich: UTF-8-Zeichenkette, nicht weniger als 1 oder mehr als 128 Bytes lang.Der Name der Eigenschaft.
-
Description– Erforderlich: UTF-8-Zeichenfolge, nicht länger als 1.024 Bytes.Eine Beschreibung der Eigenschaft.
-
Required– Erforderlich: Boolean.Gibt an, ob die Eigenschaft erforderlich ist.
-
DefaultValue– UTF-8-Zeichenfolge.Der Standardwert der Eigenschaft.
-
PropertyTypes– Erforderlich: Ein Array von UTF-8-Zeichenketten.Beschreibt den Eigenschaftentyp.
-
AllowedValues– Ein Array mit AllowedValue-Objekten.Eine Liste von
AllowedValue-Objekten, die die für die Eigenschaft zulässigen Werte darstellen. -
DataOperationScopes– Ein UTF-8-Zeichenfolgen-Array.Gibt an, welche Datenoperationen auf die Eigenschaft anwendbar sind.
AllowedValue-Struktur
Ein Objekt, das einen für eine Eigenschaft zulässigen Wert darstellt.
Felder
-
Description– UTF-8-Zeichenfolge, nicht mehr als 1.024 Bytes lang.Eine Beschreibung des zulässigen Werts.
-
Value– Erforderlich: UTF-8-Zeichenkette, nicht weniger als 1 oder mehr als 128 Bytes lang.Der für die Eigenschaft zulässige Wert.
ComputeEnvironmentConfiguration-Struktur
Ein Objekt, das die Konfiguration für eine Datenverarbeitungsumgebung (wie Spark, Python oder Athena) enthält, die von der DescribeConnectionType-API zurückgegeben wird.
Felder
-
Name– Erforderlich: UTF-8-Zeichenkette, nicht weniger als 1 oder mehr als 128 Bytes lang.Ein Name für die Konfiguration der Datenverarbeitungsumgebung.
-
Description– Erforderlich: UTF-8-Zeichenfolge, nicht länger als 1.024 Bytes.Eine Beschreibung der Datenverarbeitungsumgebung.
-
ComputeEnvironment– Erforderlich: UTF-8-Zeichenfolge (zulässige Werte:SPARK|ATHENA|PYTHON).Der Typ der Datenverarbeitungsumgebung.
-
SupportedAuthenticationTypes– Erforderlich: Ein Array von UTF-8-Zeichenketten.Die unterstützten Authentifizierungstypen für die Datenverarbeitungsumgebung.
-
ConnectionOptions– Erforderlich: Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist ein A Eigenschaft-Objekt.
Die als Verbindungsoptionen für die Datenverarbeitungsumgebung verwendeten Parameter.
-
ConnectionPropertyNameOverrides– Erforderlich: Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Die Überschreibungen des Verbindungseigenschaftsnamens für die Datenverarbeitungsumgebung.
-
ConnectionOptionNameOverrides– Erforderlich: Ein Map-Array von Schlüssel-Wert-Paaren.Jeder Schlüssel ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Jeder Wert ist eine UTF-8-Zeichenfolge, die nicht weniger als 1 oder mehr als 128 Bytes lang ist.
Die Überschreibungen des Verbindungsoptionsnamens für die Datenverarbeitungsumgebung.
-
ConnectionPropertiesRequiredOverrides– Erforderlich: Ein Array von UTF-8-Zeichenketten.Die Verbindungseigenschaften, die als Überschreibungen für die Datenverarbeitungsumgebung erforderlich sind.
-
PhysicalConnectionPropertiesRequired– Boolesch.Gibt an, ob
PhysicalConnectionPropertiesfür die Datenverarbeitungsumgebung erforderlich sind.
