User-defined API de fonction

• UserDefinedFunction structure

• UserDefinedFunctionInput structure

Champs

• FunctionName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Nom de la fonction.

• DatabaseName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

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

• ClassName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Classe Java qui contient le code de fonction.

• OwnerName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Propriétaire de la fonction.

• FunctionType— UTF-8 chaîne (valeurs valides : REGULAR_FUNCTION | AGGREGATE_FUNCTION |STORED_PROCEDURE).

  Type de fonction.

• OwnerType— UTF-8 chaîne (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.

Champs

• FunctionName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Nom de la fonction.

• ClassName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Classe Java qui contient le code de fonction.

• OwnerName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant àSingle-line string pattern.

  Propriétaire de la fonction.

• FunctionType— UTF-8 chaîne (valeurs valides : REGULAR_FUNCTION | AGGREGATE_FUNCTION |STORED_PROCEDURE).

  Type de fonction.

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

  Type de propriétaire.

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

  URI de ressource pour la fonction.

• CreateUserDefinedFunction action (Python : create_user_defined_function)

• UpdateUserDefinedFunction action (Python : update_user_defined_function)

• DeleteUserDefinedFunction action (Python : delete_user_defined_function)

• GetUserDefinedFunction action (Python : get_user_defined_function)

• GetUserDefinedFunctions action (Python : get_user_defined_functions)

Demande

• 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 élément n'est fourni, l'identifiant du AWS compte est utilisé par défaut.

• DatabaseName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant à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

Demande

• 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 élément n'est fourni, l'identifiant du AWS compte est utilisé par défaut.

• DatabaseName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

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

• FunctionName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant à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

Demande

• 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 élément n'est fourni, l'identifiant du AWS compte est utilisé par défaut.

• DatabaseName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

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

• FunctionName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant à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

Demande

• 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 élément n'est fourni, l'identifiant du AWS compte est utilisé par défaut.

• DatabaseName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

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

• FunctionName— Obligatoire : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

  Nom de la fonction.

Réponse

• UserDefinedFunction – Un objet UserDefinedFunction.

  Définition de la fonction demandée.

Erreurs

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

Demande

• 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 élément n'est fourni, l'identifiant du AWS compte est utilisé par défaut.

• DatabaseName— UTF-8 chaîne d'une longueur d'au moins 1 ou de plus de 255 octets, correspondant à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 : UTF-8 chaîne d'au moins 1 ou plus de 255 octets, correspondant àSingle-line string pattern.

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

• FunctionType— UTF-8 chaîne (valeurs valides : REGULAR_FUNCTION | AGGREGATE_FUNCTION |STORED_PROCEDURE).

  Chaîne de modèle de type de fonction facultative qui filtre les définitions de fonctions renvoyées par le catalogue d'autorisations fédérées Amazon Redshift.

  Spécifiez la valeur REGULAR_FUNCTION ouSTORED_PROCEDURE. Le type de STORED_PROCEDURE fonction est uniquement compatible avec le catalogue d'autorisations fédérées Amazon Redshift.

• NextToken— UTF-8 ficelle.

  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— UTF-8 ficelle.

  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