get_user_defined_functions

get_user_defined_functions(**kwargs)

Retrieves multiple function definitions from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_user_defined_functions(
    CatalogId='string',
    DatabaseName='string',
    Pattern='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• CatalogId (string) -- The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the Amazon Web Services account ID is used by default.
• DatabaseName (string) -- The name of the catalog database where the functions are located. If none is provided, functions from all the databases across the catalog will be returned.
• Pattern (string) --

  [REQUIRED]

  An optional function-name pattern string that filters the function definitions returned.

• NextToken (string) -- A continuation token, if this is a continuation call.
• MaxResults (integer) -- The maximum number of functions to return in one response.

Return type

dict

Returns

Response Syntax

{
    'UserDefinedFunctions': [
        {
            'FunctionName': 'string',
            'DatabaseName': 'string',
            'ClassName': 'string',
            'OwnerName': 'string',
            'OwnerType': 'USER'|'ROLE'|'GROUP',
            'CreateTime': datetime(2015, 1, 1),
            'ResourceUris': [
                {
                    'ResourceType': 'JAR'|'FILE'|'ARCHIVE',
                    'Uri': 'string'
                },
            ],
            'CatalogId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • UserDefinedFunctions (list) --

    A list of requested function definitions.

    • (dict) --

      Represents the equivalent of a Hive user-defined function ( UDF ) definition.

      • FunctionName (string) --

        The name of the function.

      • DatabaseName (string) --

        The name of the catalog database that contains the function.

      • ClassName (string) --

        The Java class that contains the function code.

      • OwnerName (string) --

        The owner of the function.

      • OwnerType (string) --

        The owner type.

      • CreateTime (datetime) --

        The time at which the function was created.

      • ResourceUris (list) --

        The resource URIs for the function.

        • (dict) --

          The URIs for function resources.

          • ResourceType (string) --

            The type of the resource.

          • Uri (string) --

            The URI for accessing the resource.

      • CatalogId (string) --

        The ID of the Data Catalog in which the function resides.

  • NextToken (string) --

    A continuation token, if the list of functions returned does not include the last requested function.

Exceptions

• Glue.Client.exceptions.EntityNotFoundException
• Glue.Client.exceptions.InvalidInputException
• Glue.Client.exceptions.OperationTimeoutException
• Glue.Client.exceptions.InternalServiceException
• Glue.Client.exceptions.GlueEncryptionException