API de fonction définie par l'utilisateur - AWS Glue
  —  types de données  —UserDefinedFunctionUserDefinedFunctionInput  —  operations  —CreateUserDefinedFunction (create_user_defined_function)UpdateUserDefinedFunction (update_user_defined_function)DeleteUserDefinedFunction (delete_user_defined_function)GetUserDefinedFunction (get_user_defined_function)GetUserDefinedFunctions (get_user_defined_functions)

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

API de fonction définie par l'utilisateur

L'API de fonction définit par l'utilisateur décrit les types de données et les opérations AWS Glue utilisés pour travailler avec les fonctions.

Types de données

Structure UserDefinedFunction

Représente l'équivalent d'une définition de fonction Hive définie par l'utilisateur (UDF).

Champs

  • FunctionName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la fonction.

  • DatabaseName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue qui contient la fonction.

  • ClassName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Classe Java qui contient le code de fonction.

  • OwnerName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Propriétaire de la fonction.

  • OwnerType – Chaîne UTF-8 (valeurs valides : USER | ROLE | GROUP).

    Type de propriétaire.

  • CreateTime – Horodatage.

    Heure à laquelle la fonction a été créée.

  • ResourceUris – Un tableau d'objets ResourceUri, 1000 structures maximum.

    URI de ressource pour la fonction.

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel réside la fonction.

Structure UserDefinedFunctionInput

Structure utilisée pour créer ou mettre à jour une fonction définie par l'utilisateur.

Champs

  • FunctionName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la fonction.

  • ClassName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Classe Java qui contient le code de fonction.

  • OwnerName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Propriétaire de la fonction.

  • OwnerType – Chaîne UTF-8 (valeurs valides : USER | ROLE | GROUP).

    Type de propriétaire.

  • ResourceUris – Un tableau d'objets ResourceUri, 1000 structures maximum.

    URI de ressource pour la fonction.

Opérations

Action CreateUserDefinedFunction (Python : create_user_defined_function)

Crée une nouvelle définition de fonction dans le catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données dans lequel créer la fonction. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • DatabaseName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue dans laquelle créer la fonction.

  • FunctionInput – Obligatoire : un objet UserDefinedFunctionInput.

    Objet FunctionInput qui définit la fonction à créer dans le catalogue de données.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • AlreadyExistsException

  • InvalidInputException

  • InternalServiceException

  • EntityNotFoundException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

Action UpdateUserDefinedFunction (Python : update_user_defined_function)

Met à jour une définition de fonction existante dans le catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données contenant la fonction à mettre à jour. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • DatabaseName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue contenant la fonction à mettre à jour.

  • FunctionName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la fonction.

  • FunctionInput – Obligatoire : un objet UserDefinedFunctionInput.

    Objet FunctionInput qui redéfinit la fonction à créer dans le catalogue de données.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

Action DeleteUserDefinedFunction (Python : delete_user_defined_function)

Supprime une définition de fonction existante du catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données contenant la fonction à supprimer. Si aucun nom n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • DatabaseName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue contenant la fonction.

  • FunctionName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la définition de fonction à supprimer.

Réponse

  • Paramètres d'absence de réponse.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

Action GetUserDefinedFunction (Python : get_user_defined_function)

Extrait une définition de fonction spécifiée du catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données contenant la fonction à extraire. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • DatabaseName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue contenant la fonction.

  • FunctionName – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la fonction.

Réponse
Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

Action GetUserDefinedFunctions (Python : get_user_defined_functions)

Extrait plusieurs définitions de fonction du catalogue de données.

Requête

  • CatalogId – Chaîne d'ID de catalogue, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    ID du catalogue de données contenant les fonction à extraire. Si aucun n'est fourni, l'ID de compte AWS est utilisé par défaut.

  • DatabaseName – Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Nom de la base de données du catalogue contenant les fonctions. Si aucune n'est fournie, des fonctions de toutes les bases de données du catalogue seront renvoyées.

  • Pattern – Obligatoire : Chaîne UTF-8, d'une longueur comprise entre 1 et 255 octets, correspondant au Single-line string pattern.

    Chaîne de modèle nom-fonction facultative qui filtre les définitions de fonction renvoyées.

  • NextToken – Chaîne UTF-8.

    Jeton de continuation, s'il s'agit d'un appel de continuation.

  • MaxResults – Nombre (entier), compris entre 1 et 100.

    Nombre maximum de fonctions renvoyées par réponse.

Réponse

  • UserDefinedFunctions – Un tableau d'objets UserDefinedFunction.

    Liste des définitions de fonction demandées.

  • NextToken – Chaîne UTF-8.

    Jeton de continuation, si la liste de fonctions renvoyée n'inclut pas la dernière fonction demandée.

Erreurs

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • GlueEncryptionException