GetUserDefinedFunctions
Retrieves multiple function definitions from the Data Catalog.
Request Syntax
{
"CatalogId": "string",
"DatabaseName": "string",
"MaxResults": number,
"NextToken": "string",
"Pattern": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- CatalogId
-
The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the AWS account ID is used by default.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- MaxResults
-
The maximum number of functions to return in one response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
A continuation token, if this is a continuation call.
Type: String
Required: No
- Pattern
-
An optional function-name pattern string that filters the function definitions returned.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: Yes
Response Syntax
{
"NextToken": "string",
"UserDefinedFunctions": [
{
"CatalogId": "string",
"ClassName": "string",
"CreateTime": number,
"DatabaseName": "string",
"FunctionName": "string",
"OwnerName": "string",
"OwnerType": "string",
"ResourceUris": [
{
"ResourceType": "string",
"Uri": "string"
}
]
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- NextToken
-
A continuation token, if the list of functions returned does not include the last requested function.
Type: String
- UserDefinedFunctions
-
A list of requested function definitions.
Type: Array of UserDefinedFunction objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityNotFoundException
-
A specified entity does not exist
HTTP Status Code: 400
- GlueEncryptionException
-
An encryption operation failed.
HTTP Status Code: 400
- InternalServiceException
-
An internal service error occurred.
HTTP Status Code: 500
- InvalidInputException
-
The input provided was not valid.
HTTP Status Code: 400
- OperationTimeoutException
-
The operation timed out.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
