Glue / Client / get_user_defined_function

get_user_defined_function#

Glue.Client.get_user_defined_function(**kwargs)#

Retrieves a specified function definition from the Data Catalog.

See also: AWS API Documentation

Request Syntax

response = client.get_user_defined_function(
    CatalogId='string',
    DatabaseName='string',
    FunctionName='string'
)
Parameters:

  • CatalogId (string) – The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the Amazon Web Services account ID is used by default.

  • DatabaseName (string) –

    [REQUIRED]

    The name of the catalog database where the function is located.

  • FunctionName (string) –

    [REQUIRED]

    The name of the function.

Return type:

dict

Returns:

Response Syntax

{
    'UserDefinedFunction': {
        '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'
    }
}

Response Structure

  • (dict) –

    • UserDefinedFunction (dict) –

      The requested function 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.

Exceptions

  • Glue.Client.exceptions.EntityNotFoundException

  • Glue.Client.exceptions.InvalidInputException

  • Glue.Client.exceptions.InternalServiceException

  • Glue.Client.exceptions.OperationTimeoutException

  • Glue.Client.exceptions.GlueEncryptionException