[ aws . glue ]

get-user-defined-function

Description

Retrieves a specified function definition from the Data Catalog.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-user-defined-function
[--catalog-id <value>]
--database-name <value>
--function-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--catalog-id (string)

The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the AWS account ID is used by default.

--database-name (string)

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

--function-name (string)

The name of the function.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

UserDefinedFunction -> (structure)

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 -> (timestamp)

The time at which the function was created.

ResourceUris -> (list)

The resource URIs for the function.

(structure)

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.