用户定义的函数 API - AWS Glue
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

如果我们为英文版本指南提供翻译,那么如果存在任何冲突,将以英文版本指南为准。在提供翻译时使用机器翻译。

用户定义的函数 API

用户定义的函数 API 介绍用于处理函数的 AWS Glue 数据类型和操作。

数据类型

UserDefinedFunction 结构

表示与 Hive 用户定义函数 (UDF) 定义等效的函数。

Fields

  • FunctionName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    参数的名称。

  • DatabaseName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    包含函数的目录数据库的名称。

  • ClassName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    包含函数代码的 Java 类。

  • OwnerName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    参数的所有者。

  • OwnerType – UTF-8字符串(有效值: USER || ROLE || GROUP)。

    所有者类型。

  • CreateTime – 时间戳。

    创建函数的时间。

  • ResourceUris – 阵列 ResourceUri 对象,不超过1000个结构。

    函数的资源 URI。

  • CatalogId – 目录ID字符串,不小于1或超过255字节,匹配的 Single-line string pattern.

    函数所在的数据目录的ID。

UserDefinedFunctionInput 结构

用于创建或更新用户定义函数的结构。

Fields

  • FunctionName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    参数的名称。

  • ClassName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    包含函数代码的 Java 类。

  • OwnerName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    参数的所有者。

  • OwnerType – UTF-8字符串(有效值: USER || ROLE || GROUP)。

    所有者类型。

  • ResourceUris – 阵列 ResourceUri 对象,不超过1000个结构。

    函数的资源 URI。

Operations

CreateUserDefinedFunction 操作 (Python: create_user_defined_function)

在数据目录中创建新函数定义。

Request

  • CatalogId – 目录ID字符串,不小于1或超过255字节,匹配的 Single-line string pattern.

    要在其中创建函数的数据目录的 ID。如果没有提供,则默认情况下使用 AWS 账户 ID。

  • DatabaseName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    要在其中创建函数的目录数据库的名称。

  • FunctionInput要求: 一个 UserDefinedFunctionInput 对象。

    一个 FunctionInput 对象,它定义要在数据目录中创建的函数。

Response

  • 无响应参数。

Errors

  • AlreadyExistsException

  • InvalidInputException

  • InternalServiceException

  • EntityNotFoundException

  • OperationTimeoutException

  • ResourceNumberLimitExceededException

  • GlueEncryptionException

UpdateUserDefinedFunction 操作 (Python: update_user_defined_function)

在数据目录中更新现有函数定义。

Request

  • CatalogId – 目录ID字符串,不小于1或超过255字节,匹配的 Single-line string pattern.

    要更新的函数所在的数据目录的 ID。如果没有提供,则默认情况下使用 AWS 账户 ID。

  • DatabaseName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    要更新的函数所在的目录数据库的名称。

  • FunctionName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    参数的名称。

  • FunctionInput要求: 一个 UserDefinedFunctionInput 对象。

    一个 FunctionInput 对象,它重新定义数据目录中的函数。

Response

  • 无响应参数。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

DeleteUserDefinedFunction 操作 (Python: delete_user_defined_function)

从数据目录中删除现有函数定义。

Request

  • CatalogId – 目录ID字符串,不小于1或超过255字节,匹配的 Single-line string pattern.

    要删除的函数所在的数据目录的 ID。如果没有提供,则默认情况下使用 AWS 账户 ID。

  • DatabaseName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    函数所在的目录数据库的名称。

  • FunctionName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    要删除的函数定义的名称。

Response

  • 无响应参数。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

GetUserDefinedFunction 操作 (Python: get_user_defined_function)

从数据目录中检索指定的函数定义。

Request

  • CatalogId – 目录ID字符串,不小于1或超过255字节,匹配的 Single-line string pattern.

    要检索的函数所在的数据目录的 ID。如果没有提供,则默认情况下使用 AWS 账户 ID。

  • DatabaseName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    函数所在的目录数据库的名称。

  • FunctionName要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    参数的名称。

Response

Errors

  • EntityNotFoundException

  • InvalidInputException

  • InternalServiceException

  • OperationTimeoutException

  • GlueEncryptionException

GetUserDefinedFunctions 操作 (Python: get_user_defined_functions)

从数据目录中检索多个函数定义。

Request

  • CatalogId – 目录ID字符串,不小于1或超过255字节,匹配的 Single-line string pattern.

    要检索的函数所在的数据目录的 ID。如果没有提供,则默认情况下使用 AWS 账户 ID。

  • DatabaseName – UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    函数所在的目录数据库的名称。如果未提供任何内容,则将返回来自目录中所有数据库的函数。

  • Pattern要求: UTF-8字符串,不小于1或超过255字节,匹配 Single-line string pattern.

    一个可选的函数名称模式字符串,用于筛选返回的函数定义。

  • NextToken – UTF-8字符串。

    延续标记 (如果这是延续调用)。

  • MaxResults – 数字(整数),不小于1或超过1000。

    要在一个响应中返回的函数的最大数量。

Response

  • UserDefinedFunctions – 阵列 UserDefinedFunction 对象。

    请求的函数定义的列表。

  • NextToken – UTF-8字符串。

    延续令牌 (如果返回函数的列表不包括最后一个请求的函数)。

Errors

  • EntityNotFoundException

  • InvalidInputException

  • OperationTimeoutException

  • InternalServiceException

  • GlueEncryptionException