Skip to content

Retrieves multiple function definitions from the Data Catalog

Description

Retrieves multiple function definitions from the Data Catalog.

Usage

glue_get_user_defined_functions(CatalogId, DatabaseName, Pattern,
  FunctionType, NextToken, MaxResults)

Arguments

  • CatalogId

    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

    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

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

  • 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.

  • NextToken

    A continuation token, if this is a continuation call.

  • MaxResults

    The maximum number of functions to return in one response.

Value

A list with the following syntax:

list(
  UserDefinedFunctions = list(
    list(
      FunctionName = "string",
      DatabaseName = "string",
      ClassName = "string",
      OwnerName = "string",
      FunctionType = "REGULAR_FUNCTION"|"AGGREGATE_FUNCTION"|"STORED_PROCEDURE",
      OwnerType = "USER"|"ROLE"|"GROUP",
      CreateTime = as.POSIXct(
        "2015-01-01"
      ),
      ResourceUris = list(
        list(
          ResourceType = "JAR"|"FILE"|"ARCHIVE",
          Uri = "string"
        )
      ),
      CatalogId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_user_defined_functions(
  CatalogId = "string",
  DatabaseName = "string",
  Pattern = "string",
  FunctionType = "REGULAR_FUNCTION"|"AGGREGATE_FUNCTION"|"STORED_PROCEDURE",
  NextToken = "string",
  MaxResults = 123
)