API de funciones definidas por el usuario

La API de funciones definidas por el usuario describe los tipos de datos y las operaciones de AWS Glue que se utilizan para trabajar con funciones.

Tipos de datos

• Estructura UserDefinedFunction

• Estructura UserDefinedFunctionInput

Estructura UserDefinedFunction

Representa el equivalente a una definición de función Hive definida por el usuario (UDF).

Campos

• FunctionName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la función.

• DatabaseName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  Nombre de la base de datos del catálogo que contiene la función.

• ClassName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  La clase de Java que contiene el código de la función.

• OwnerName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El propietario de la función.

• OwnerType: cadena UTF-8 (valores válidos: USER | ROLE | GROUP).

  El tipo de propietario.

• CreateTime: marca temporal.

  La hora a la que se creó la función.

• ResourceUris: matriz de objetos ResourceUri, con 1000 estructuras como máximo.

  Los URI del recurso para la función.

• CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El ID del Catálogo de datos donde reside la función.

Estructura UserDefinedFunctionInput

Un estructura que se utiliza para crear o actualizar funciones definidas por el usuario.

Campos

• FunctionName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la función.

• ClassName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  La clase de Java que contiene el código de la función.

• OwnerName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El propietario de la función.

• OwnerType: cadena UTF-8 (valores válidos: USER | ROLE | GROUP).

  El tipo de propietario.

• ResourceUris: matriz de objetos ResourceUri, con 1000 estructuras como máximo.

  Los URI del recurso para la función.

Operaciones

• Acción CreateUserDefinedFunction (Python: create_user_defined_function)

• Acción UpdateUserDefinedFunction (Python: update_user_defined_function)

• Acción DeleteUserDefinedFunction (Python: delete_user_defined_function)

• Acción GetUserDefinedFunction (Python: get_user_defined_function)

• Acción GetUserDefinedFunctions (Python: get_user_defined_functions)

Acción CreateUserDefinedFunction (Python: create_user_defined_function)

Crea una nueva definición de función en el Catálogo de datos.

Solicitud

• CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El ID del Catálogo de datos donde se crea la función. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

• DatabaseName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la base de datos de catálogos donde se crea la función.

• FunctionInput – Obligatorio: objeto UserDefinedFunctionInput.

  Objeto FunctionInput que define la función que se va a crear en el Catálogo de datos.

Respuesta

• Sin parámetros de respuesta.

Errores

• AlreadyExistsException

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

Acción UpdateUserDefinedFunction (Python: update_user_defined_function)

Actualiza una definición de función existente en el Catálogo de datos.

Solicitud

• CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El ID del Catálogo de datos donde se encuentra la función que se va a actualizar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

• DatabaseName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la base de datos de catálogos donde se encuentra la función que se va a actualizar.

• FunctionName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la función.

• FunctionInput – Obligatorio: objeto UserDefinedFunctionInput.

  Un objeto FunctionInput que redefine la función que en el Catálogo de datos.

Respuesta

• Sin parámetros de respuesta.

Errores

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

Acción DeleteUserDefinedFunction (Python: delete_user_defined_function)

Elimina una definición de función existente del Catálogo de datos.

Solicitud

• CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El ID del Catálogo de datos donde se encuentra la función que se va a eliminar. Si no se proporciona ninguno, el ID de cuenta de AWS se usará de forma predeterminada.

• DatabaseName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la base de datos de catálogos donde se encuentra la función.

• FunctionName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la definición de la función que se va a eliminar.

Respuesta

• Sin parámetros de respuesta.

Errores

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Acción GetUserDefinedFunction (Python: get_user_defined_function)

Recupera una definición de función especificada del Catálogo de datos.

Solicitud

• CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El ID del Catálogo de datos donde se encuentra la función que se va a recuperar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

• DatabaseName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la base de datos de catálogos donde se encuentra la función.

• FunctionName: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la función.

Respuesta

• UserDefinedFunction: objeto UserDefinedFunction.

  La definición de la función solicitada.

Errores

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

Acción GetUserDefinedFunctions (Python: get_user_defined_functions)

Recupera varias definiciones de función del Catálogo de datos.

Solicitud

• CatalogId: cadena de ID de catálogo, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El ID del Catálogo de datos donde se encuentran las funciones que se van a recuperar. Si no se proporciona ninguno, se usará de forma predeterminada el ID de cuenta de AWS.

• DatabaseName: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  El nombre de la base de datos de catálogos donde se encuentra las funciones. Si no se proporciona ninguno, se devolverán las funciones de todas las bases de datos del catálogo.

• Pattern: obligatorio: cadena UTF-8, con 1 byte de largo como mínimo y 255 bytes de largo como máximo, que coincide con el Single-line string pattern.

  Cadena con patrón nombre-de-función opcional que filtra las definiciones de función que se devuelven.

• NextToken: cadena UTF-8.

  Token de continuación si se trata de una llamada de continuidad.

• MaxResults: número (entero) que no es inferior a 1 ni es superior a 100.

  El número máximo de funciones que se devuelven en una respuesta.

Respuesta

• UserDefinedFunctions: matriz de objetos UserDefinedFunction.

  Lista de las definiciones de función solicitadas.

• NextToken: cadena UTF-8.

  Token de continuación, si la lista de funciones que se devuelve no incluye la última función solicitada.

Errores

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• GlueEncryptionException