Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Glue.GetUserDefinedFunctions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves multiple function definitions from the Data Catalog.

This operation returns paginated results.

Synopsis

Creating a Request

data GetUserDefinedFunctions Source #

See: newGetUserDefinedFunctions smart constructor.

Constructors

GetUserDefinedFunctions'

Fields

catalogId :: Maybe Text
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 :: Maybe Text
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.
maxResults :: Maybe Natural
The maximum number of functions to return in one response.
nextToken :: Maybe Text
A continuation token, if this is a continuation call.
pattern' :: Text
An optional function-name pattern string that filters the function definitions returned.

Instances

Instances details

ToJSON GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods toJSON :: GetUserDefinedFunctions -> Value # toEncoding :: GetUserDefinedFunctions -> Encoding # toJSONList :: [GetUserDefinedFunctions] -> Value # toEncodingList :: [GetUserDefinedFunctions] -> Encoding #
ToHeaders GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods toHeaders :: GetUserDefinedFunctions -> [Header] #
ToPath GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods toPath :: GetUserDefinedFunctions -> ByteString #
ToQuery GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods toQuery :: GetUserDefinedFunctions -> QueryString #
AWSPager GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods page :: GetUserDefinedFunctions -> AWSResponse GetUserDefinedFunctions -> Maybe GetUserDefinedFunctions #
AWSRequest GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Associated Types type AWSResponse GetUserDefinedFunctions # Methods request :: (Service -> Service) -> GetUserDefinedFunctions -> Request GetUserDefinedFunctions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUserDefinedFunctions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUserDefinedFunctions))) #
Generic GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Associated Types type Rep GetUserDefinedFunctions :: Type -> Type # Methods from :: GetUserDefinedFunctions -> Rep GetUserDefinedFunctions x # to :: Rep GetUserDefinedFunctions x -> GetUserDefinedFunctions #
Read GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods readsPrec :: Int -> ReadS GetUserDefinedFunctions # readList :: ReadS [GetUserDefinedFunctions] # readPrec :: ReadPrec GetUserDefinedFunctions # readListPrec :: ReadPrec [GetUserDefinedFunctions] #
Show GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods showsPrec :: Int -> GetUserDefinedFunctions -> ShowS # show :: GetUserDefinedFunctions -> String # showList :: [GetUserDefinedFunctions] -> ShowS #
NFData GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods rnf :: GetUserDefinedFunctions -> () #
Eq GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods (==) :: GetUserDefinedFunctions -> GetUserDefinedFunctions -> Bool # (/=) :: GetUserDefinedFunctions -> GetUserDefinedFunctions -> Bool #
Hashable GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods hashWithSalt :: Int -> GetUserDefinedFunctions -> Int # hash :: GetUserDefinedFunctions -> Int #
type AWSResponse GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions type AWSResponse GetUserDefinedFunctions = GetUserDefinedFunctionsResponse
type Rep GetUserDefinedFunctions Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions type Rep GetUserDefinedFunctions = D1 ('MetaData "GetUserDefinedFunctions" "Amazonka.Glue.GetUserDefinedFunctions" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetUserDefinedFunctions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "catalogId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "databaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pattern'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetUserDefinedFunctions Source #

Arguments

:: Text	`$sel:pattern':GetUserDefinedFunctions'`
-> GetUserDefinedFunctions

Create a value of GetUserDefinedFunctions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUserDefinedFunctions, getUserDefinedFunctions_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.

GetUserDefinedFunctions, getUserDefinedFunctions_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.

$sel:maxResults:GetUserDefinedFunctions', getUserDefinedFunctions_maxResults - The maximum number of functions to return in one response.

GetUserDefinedFunctions, getUserDefinedFunctions_nextToken - A continuation token, if this is a continuation call.

$sel:pattern':GetUserDefinedFunctions', getUserDefinedFunctions_pattern - An optional function-name pattern string that filters the function definitions returned.

Request Lenses

getUserDefinedFunctions_catalogId :: Lens' GetUserDefinedFunctions (Maybe Text) Source #

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.

getUserDefinedFunctions_databaseName :: Lens' GetUserDefinedFunctions (Maybe Text) Source #

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.

getUserDefinedFunctions_maxResults :: Lens' GetUserDefinedFunctions (Maybe Natural) Source #

The maximum number of functions to return in one response.

getUserDefinedFunctions_nextToken :: Lens' GetUserDefinedFunctions (Maybe Text) Source #

A continuation token, if this is a continuation call.

getUserDefinedFunctions_pattern :: Lens' GetUserDefinedFunctions Text Source #

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

Destructuring the Response

data GetUserDefinedFunctionsResponse Source #

See: newGetUserDefinedFunctionsResponse smart constructor.

Constructors

GetUserDefinedFunctionsResponse'
Fields nextToken :: Maybe Text A continuation token, if the list of functions returned does not include the last requested function. userDefinedFunctions :: Maybe [UserDefinedFunction] A list of requested function definitions. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetUserDefinedFunctionsResponse Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Associated Types type Rep GetUserDefinedFunctionsResponse :: Type -> Type # Methods from :: GetUserDefinedFunctionsResponse -> Rep GetUserDefinedFunctionsResponse x # to :: Rep GetUserDefinedFunctionsResponse x -> GetUserDefinedFunctionsResponse #
Read GetUserDefinedFunctionsResponse Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods readsPrec :: Int -> ReadS GetUserDefinedFunctionsResponse # readList :: ReadS [GetUserDefinedFunctionsResponse] # readPrec :: ReadPrec GetUserDefinedFunctionsResponse # readListPrec :: ReadPrec [GetUserDefinedFunctionsResponse] #
Show GetUserDefinedFunctionsResponse Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods showsPrec :: Int -> GetUserDefinedFunctionsResponse -> ShowS # show :: GetUserDefinedFunctionsResponse -> String # showList :: [GetUserDefinedFunctionsResponse] -> ShowS #
NFData GetUserDefinedFunctionsResponse Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods rnf :: GetUserDefinedFunctionsResponse -> () #
Eq GetUserDefinedFunctionsResponse Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions Methods (==) :: GetUserDefinedFunctionsResponse -> GetUserDefinedFunctionsResponse -> Bool # (/=) :: GetUserDefinedFunctionsResponse -> GetUserDefinedFunctionsResponse -> Bool #
type Rep GetUserDefinedFunctionsResponse Source #
Instance details Defined in Amazonka.Glue.GetUserDefinedFunctions type Rep GetUserDefinedFunctionsResponse = D1 ('MetaData "GetUserDefinedFunctionsResponse" "Amazonka.Glue.GetUserDefinedFunctions" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "GetUserDefinedFunctionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userDefinedFunctions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserDefinedFunction])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUserDefinedFunctionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUserDefinedFunctionsResponse'`
-> GetUserDefinedFunctionsResponse

Create a value of GetUserDefinedFunctionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUserDefinedFunctions, getUserDefinedFunctionsResponse_nextToken - A continuation token, if the list of functions returned does not include the last requested function.

$sel:userDefinedFunctions:GetUserDefinedFunctionsResponse', getUserDefinedFunctionsResponse_userDefinedFunctions - A list of requested function definitions.

$sel:httpStatus:GetUserDefinedFunctionsResponse', getUserDefinedFunctionsResponse_httpStatus - The response's http status code.

Response Lenses

getUserDefinedFunctionsResponse_nextToken :: Lens' GetUserDefinedFunctionsResponse (Maybe Text) Source #

A continuation token, if the list of functions returned does not include the last requested function.

getUserDefinedFunctionsResponse_userDefinedFunctions :: Lens' GetUserDefinedFunctionsResponse (Maybe [UserDefinedFunction]) Source #

A list of requested function definitions.

getUserDefinedFunctionsResponse_httpStatus :: Lens' GetUserDefinedFunctionsResponse Int Source #

The response's http status code.