View a markdown version of this page

User-defined Funktions-API - AWS Glue

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.

User-defined Funktions-API

Die User-defined Funktions-API beschreibt AWS Glue Datentypen und Operationen, die bei der Arbeit mit Funktionen verwendet werden.

Datentypen

UserDefinedFunction Struktur

Stellt das Äquivalent einer benutzerdefinierten Hive-Funktion (UDF) dar.

Felder
  • FunctionName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und der entsprichtSingle-line string pattern.

    Der Name der Funktion.

  • DatabaseName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

    Der Name der Katalogdatenbank, die die Funktion enthält

  • ClassName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

    Die Java-Klasse mit dem Funktionscode.

  • OwnerName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

    Der Eigentümer der Funktion.

  • FunctionType— UTF-8 Zeichenfolge (gültige Werte: REGULAR_FUNCTION | AGGREGATE_FUNCTION |STORED_PROCEDURE).

    Der Typ der Funktion.

  • OwnerType— UTF-8 Zeichenfolge (gültige Werte: USER | ROLE |GROUP).

    Der Typ des Eigentümers.

  • CreateTime – Zeitstempel.

    Die Uhrzeit, zu der die Funktion erstellt wurde.

  • ResourceUris – Ein Array mit ResourceUri-Objekten, nicht mehr als 1000 Strukturen.

    Die Ressourcen-URIs für die Funktion.

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

    Die ID des Data Catalog, in dem sich die Funktion befindet.

UserDefinedFunctionInput Struktur

Eine Struktur, mit der eine benutzerdefinierte Funktion angelegt oder aktualisiert wird.

Felder
  • FunctionName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und der entsprichtSingle-line string pattern.

    Der Name der Funktion.

  • ClassName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

    Die Java-Klasse mit dem Funktionscode.

  • OwnerName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

    Der Eigentümer der Funktion.

  • FunctionType— UTF-8 Zeichenfolge (gültige Werte: REGULAR_FUNCTION | AGGREGATE_FUNCTION |STORED_PROCEDURE).

    Der Typ der Funktion.

  • OwnerType— UTF-8 Zeichenfolge (gültige Werte: USER | ROLE |GROUP).

    Der Typ des Eigentümers.

  • ResourceUris – Ein Array mit ResourceUri-Objekten, nicht mehr als 1000 Strukturen.

    Die Ressourcen-URIs für die Funktion.

Operationen

CreateUserDefinedFunction Aktion (Python: create_user_defined_function)

Erstellt eine neue Funktionsdefinition im Data Catalog.

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

    Die ID des Data Catalog, in dem die Funktion erstellt wird. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • DatabaseName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Die Name der Katalogdatenbank, in der die Funktion angelegt wird.

  • FunctionInputErforderlich: Ein UserDefinedFunctionInput-Objekt.

    Das FunctionInput-Objekt, das die im Data Catalog zu erstellende Funktion definiert.

Antwort
  • Keine Antwortparameter.

Fehler
  • AlreadyExistsException

  • InvalidInputException

  • InternalServiceException

  • EntityNotFoundException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

UpdateUserDefinedFunction Aktion (Python: update_user_defined_function)

Aktualisiert eine bestehende Funktionsdefinition im Data Catalog.

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

    Die ID des Data Catalog, in dem sich die zu aktualisierende Funktion befindet. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • DatabaseName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Der Name der Katalogdatenbank, in der sich die zu aktualisierende Funktion befindet.

  • FunctionName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Der Name der Funktion.

  • FunctionInputErforderlich: Ein UserDefinedFunctionInput-Objekt.

    Ein FunctionInput-Objekt, das die Funktion im Data Catalog neu definiert.

Antwort
  • Keine Antwortparameter.

Fehler
  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

DeleteUserDefinedFunction Aktion (Python: delete_user_defined_function)

Löscht eine bestehende Funktionsdefinition im Data Catalog.

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

    Die ID des Data Catalog, in dem sich die zu löschende Funktion befindet. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • DatabaseName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Der Name der Katalogdatenbank, in der sich die Funktion befindet.

  • FunctionName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Der Name der Funktionsdefinition, die gelöscht werden soll.

Antwort
  • Keine Antwortparameter.

Fehler
  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

GetUserDefinedFunction Aktion (Python: get_user_defined_function)

Ruft eine angegebene Funktionsdefinition aus dem Data Catalog ab.

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

    Die ID des Data Catalog, in dem sich die abzurufende Funktion befindet. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • DatabaseName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Der Name der Katalogdatenbank, in der sich die Funktion befindet.

  • FunctionName Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Der Name der Funktion.

Antwort
  • UserDefinedFunction – Ein UserDefinedFunction-Objekt.

    Die angeforderte Funktionsdefinition.

Fehler
  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

GetUserDefinedFunctions Aktion (Python: get_user_defined_functions)

Ruft mehrere Funktionsdefinition aus dem Data Catalog ab.

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

    Die ID des Data Catalog, in dem sich die abzurufenden Funktionen befinden. Wenn keine angegeben wird, wird standardmäßig die AWS Konto-ID verwendet.

  • DatabaseName— UTF-8 Zeichenfolge, die nicht weniger als 1 oder mehr als 255 Byte lang ist und dem entsprichtSingle-line string pattern.

    Der Name der Katalogdatenbank, in der sich die Funktionen befinden. Wenn keine bereitgestellt wird, werden Funktionen aus allen Datenbanken im Katalog zurückgegeben.

  • Pattern Erforderlich: UTF-8 Zeichenfolge, nicht weniger als 1 oder mehr als 255 Byte lang, die dem entsprichtSingle-line string pattern.

    Ein optionaler Musterstring für Funktionsnamen, der die zurückgegebenen Funktionsdefinitionen filtert.

  • FunctionType— UTF-8 Zeichenfolge (gültige Werte: REGULAR_FUNCTION | AGGREGATE_FUNCTION |STORED_PROCEDURE).

    Eine optionale Musterzeichenfolge vom Funktionstyp, die die vom Amazon Redshift Federated Permissions Catalog zurückgegebenen Funktionsdefinitionen filtert.

    Geben Sie den Wert oder an. REGULAR_FUNCTION STORED_PROCEDURE Der STORED_PROCEDURE Funktionstyp ist nur mit dem Amazon Redshift Federated Permissions Catalog kompatibel.

  • NextToken— Zeichenfolge UTF-8 .

    Ein Fortsetzungs-Token, wenn dies ein Fortsetzungsaufruf ist.

  • MaxResults – Zahl (Ganzzahl), nicht kleiner als 1 oder größer als 100.

    Die maximale Anzahl der Funktionen, die in einer Antwort zurückgegeben werden können.

Antwort
  • UserDefinedFunctions – Ein Array mit UserDefinedFunction-Objekten.

    Eine Liste der angeforderten Funktionsdefinitionen.

  • NextToken— UTF-8 Zeichenfolge.

    Ein Fortsetzungs-Token, wenn die Liste der zurückgegebenen Funktionen nicht die zuletzt angeforderte Funktion enthält.

Fehler
  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • GlueEncryptionException