Skip to content

GetUserDefinedFunctionsRequest

Source code in docs_src/capo_glue/types/get_user_defined_functions_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class GetUserDefinedFunctionsRequest(TypedDict, closed=True):
    catalog_id: NotRequired["capo_glue.types.catalog_id_string.CatalogIdString"]
    """<p>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.</p>"""
    database_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>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.</p>"""
    pattern: "capo_glue.types.name_string.NameString"
    """<p>An optional function-name pattern string that filters the function definitions returned.</p>"""
    function_type: NotRequired["capo_glue.types.function_type.FunctionType"]
    """<p>An optional function-type pattern string that filters the function definitions returned from Amazon Redshift Federated Permissions Catalog.</p> <p>Specify a value of <code>REGULAR_FUNCTION</code> or <code>STORED_PROCEDURE</code>. The <code>STORED_PROCEDURE</code> function type is only compatible with Amazon Redshift Federated Permissions Catalog. </p>"""
    next_token: NotRequired["capo_glue.types.token.Token"]
    """<p>A continuation token, if this is a continuation call.</p>"""
    max_results: NotRequired[
        "capo_glue.types.catalog_getter_page_size.CatalogGetterPageSize"
    ]
    """<p>The maximum number of functions to return in one response.</p>"""

catalog_id instance-attribute 

catalog_id: NotRequired[CatalogIdString]

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.

database_name instance-attribute 

database_name: NotRequired[NameString]

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.

function_type instance-attribute 

function_type: NotRequired[FunctionType]

An optional function-type pattern string that filters the function definitions returned from Amazon Redshift Federated Permissions Catalog.

Specify a value of REGULAR_FUNCTION or STORED_PROCEDURE. The STORED_PROCEDURE function type is only compatible with Amazon Redshift Federated Permissions Catalog.

max_results instance-attribute 

max_results: NotRequired[CatalogGetterPageSize]

The maximum number of functions to return in one response.

next_token instance-attribute 

next_token: NotRequired[Token]

A continuation token, if this is a continuation call.

pattern instance-attribute 

pattern: NameString

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