API User-defined Function

A API User-defined Function descreve os tipos de dados e as operações do AWS Glue usados para trabalhar com funções.

Tipos de dados

• Estrutura UserDefinedFunction

• Estrutura UserDefinedFunctionInput

Estrutura UserDefinedFunction

Representa o equivalente a uma definição de função do Hive definida pelo usuário (UDF).

Campos

• FunctionName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  Nome da função.

• DatabaseName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do banco de dados de catálogo que contém a função.

• ClassName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  A classe Java que contém o código da função.

• OwnerName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O proprietário da função.

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

  Tipo do proprietário.

• CreateTime – Timestamp.

  A hora em que a função foi criada.

• ResourceUris – Uma matriz de objetos ResourceUri, não mais de 1000 estruturas.

  Os URIs do recurso para a função.

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O ID do Data Catalog em que a função reside.

Estrutura UserDefinedFunctionInput

Uma estrutura usada para criar ou atualizar uma função definida pelo usuário.

Campos

• FunctionName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  Nome da função.

• ClassName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  A classe Java que contém o código da função.

• OwnerName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O proprietário da função.

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

  Tipo do proprietário.

• ResourceUris – Uma matriz de objetos ResourceUri, não mais de 1000 estruturas.

  Os URIs do recurso para a função.

Operações

• Ação CreateUserDefinedFunction (Python: create_user_defined_function)

• Ação UpdateUserDefinedFunction (Python: update_user_defined_function)

• Ação DeleteUserDefinedFunction (Python: delete_user_defined_function)

• Ação GetUserDefinedFunction (Python: get_user_defined_function)

• Ação GetUserDefinedFunctions (Python: get_user_defined_functions)

Ação CreateUserDefinedFunction (Python: create_user_defined_function)

Cria uma definição de nova função no catálogo de dados.

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O ID do catálogo de dados em que a função será criada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• DatabaseName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do banco de dados de catálogos no qual a função será criada.

• FunctionInput – Obrigatório: um objeto UserDefinedFunctionInput.

  Um objeto FunctionInput que define a função a ser criada no catálogo de dados.

Resposta

• Nenhum parâmetro de resposta.

Erros

• AlreadyExistsException

• InvalidInputException

• InternalServiceException

• EntityNotFoundException

• OperationTimeoutException

• ResourceNumberLimitExceededException

• GlueEncryptionException

Ação UpdateUserDefinedFunction (Python: update_user_defined_function)

Atualiza uma definição de função existente no catálogo de dados.

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O ID do catálogo de dados no qual está a função a ser atualizada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• DatabaseName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do banco de dados do catálogo no qual está a função a ser atualizada.

• FunctionName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  Nome da função.

• FunctionInput – Obrigatório: um objeto UserDefinedFunctionInput.

  Um objeto FunctionInput que redefine a função no Catálogo de dados.

Resposta

• Nenhum parâmetro de resposta.

Erros

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

Ação DeleteUserDefinedFunction (Python: delete_user_defined_function)

Exclui uma definição função existente do catálogo de dados.

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O ID do catálogo de dados no qual está a função a ser excluída. Se nenhum valor for fornecido, o ID da conta da AWS será usado por padrão.

• DatabaseName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do banco de dados do catálogo no qual a função está.

• FunctionName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome da definição de função a ser excluída.

Resposta

• Nenhum parâmetro de resposta.

Erros

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

Ação GetUserDefinedFunction (Python: get_user_defined_function)

Recupera uma definição de função especificada do catálogo de dados.

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O ID do catálogo de dados no qual está a função a ser recuperada. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• DatabaseName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do banco de dados do catálogo no qual a função está.

• FunctionName – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  Nome da função.

Resposta

• UserDefinedFunction – Um objeto UserDefinedFunction.

  A definição de função solicitada.

Erros

• EntityNotFoundException

• InvalidInputException

• InternalServiceException

• OperationTimeoutException

• GlueEncryptionException

Ação GetUserDefinedFunctions (Python: get_user_defined_functions)

Recupera várias definições de função do Catálogo de dados.

Solicitação

• CatalogId – String de ID de catálogo, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O ID do catálogo de dados no qual estão as funções a serem recuperadas. Se nenhum for fornecido, o ID da conta da AWS será usado por padrão.

• DatabaseName – String UTF-8, superior a 1 e inferior a 255 bytes de comprimento, correspondente a Single-line string pattern.

  O nome do banco de dados do catálogo no qual as funções estão localizadas. Se nenhum for fornecido, as funções de todos os bancos de dados no catálogo serão retornadas.

• Pattern – Obrigatório: string UTF-8, no mínimo 1 ou mais de 255 bytes de comprimento, correspondente a Single-line string pattern.

  Uma string de padrão de função-nome opcional que filtra as definições de função retornadas.

• NextToken – String UTF-8.

  Um token de continuação, se esta for uma chamada de continuação.

• MaxResults: número (inteiro), não menos do que 1 ou superior a 100.

  O número máximo de funções a ser retornado em uma resposta.

Resposta

• UserDefinedFunctions – Uma matriz de objetos UserDefinedFunction.

  Uma lista das definições de função solicitadas.

• NextToken – String UTF-8.

  Um token de continuação, se a lista de funções retornadas não incluir a última função solicitada.

Erros

• EntityNotFoundException

• InvalidInputException

• OperationTimeoutException

• InternalServiceException

• GlueEncryptionException