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.AppSync.CreateFunction

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Function object.

A function is a reusable entity. You can use multiple functions to compose the resolver logic.

Synopsis

data CreateFunction = CreateFunction' {
- code :: Maybe Text
- description :: Maybe Text
- functionVersion :: Maybe Text
- maxBatchSize :: Maybe Natural
- requestMappingTemplate :: Maybe Text
- responseMappingTemplate :: Maybe Text
- runtime :: Maybe AppSyncRuntime
- syncConfig :: Maybe SyncConfig
- apiId :: Text
- name :: Text
- dataSourceName :: Text
}
newCreateFunction :: Text -> Text -> Text -> CreateFunction
createFunction_code :: Lens' CreateFunction (Maybe Text)
createFunction_description :: Lens' CreateFunction (Maybe Text)
createFunction_functionVersion :: Lens' CreateFunction (Maybe Text)
createFunction_maxBatchSize :: Lens' CreateFunction (Maybe Natural)
createFunction_requestMappingTemplate :: Lens' CreateFunction (Maybe Text)
createFunction_responseMappingTemplate :: Lens' CreateFunction (Maybe Text)
createFunction_runtime :: Lens' CreateFunction (Maybe AppSyncRuntime)
createFunction_syncConfig :: Lens' CreateFunction (Maybe SyncConfig)
createFunction_apiId :: Lens' CreateFunction Text
createFunction_name :: Lens' CreateFunction Text
createFunction_dataSourceName :: Lens' CreateFunction Text
data CreateFunctionResponse = CreateFunctionResponse' {
- functionConfiguration :: Maybe FunctionConfiguration
- httpStatus :: Int
}
newCreateFunctionResponse :: Int -> CreateFunctionResponse
createFunctionResponse_functionConfiguration :: Lens' CreateFunctionResponse (Maybe FunctionConfiguration)
createFunctionResponse_httpStatus :: Lens' CreateFunctionResponse Int

Creating a Request

data CreateFunction Source #

See: newCreateFunction smart constructor.

Constructors

CreateFunction'

Fields

code :: Maybe Text
The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
description :: Maybe Text
The Function description.
functionVersion :: Maybe Text
The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.
maxBatchSize :: Maybe Natural
The maximum batching size for a resolver.
requestMappingTemplate :: Maybe Text
The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
responseMappingTemplate :: Maybe Text
The Function response mapping template.
runtime :: Maybe AppSyncRuntime
syncConfig :: Maybe SyncConfig
apiId :: Text
The GraphQL API ID.
name :: Text
The Function name. The function name does not have to be unique.
dataSourceName :: Text
The Function DataSource name.

Instances

Instances details

ToJSON CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods toJSON :: CreateFunction -> Value # toEncoding :: CreateFunction -> Encoding # toJSONList :: [CreateFunction] -> Value # toEncodingList :: [CreateFunction] -> Encoding #
ToHeaders CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods toHeaders :: CreateFunction -> [Header] #
ToPath CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods toPath :: CreateFunction -> ByteString #
ToQuery CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods toQuery :: CreateFunction -> QueryString #
AWSRequest CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Associated Types type AWSResponse CreateFunction # Methods request :: (Service -> Service) -> CreateFunction -> Request CreateFunction # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFunction -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFunction))) #
Generic CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Associated Types type Rep CreateFunction :: Type -> Type # Methods from :: CreateFunction -> Rep CreateFunction x # to :: Rep CreateFunction x -> CreateFunction #
Read CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods readsPrec :: Int -> ReadS CreateFunction # readList :: ReadS [CreateFunction] # readPrec :: ReadPrec CreateFunction # readListPrec :: ReadPrec [CreateFunction] #
Show CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods showsPrec :: Int -> CreateFunction -> ShowS # show :: CreateFunction -> String # showList :: [CreateFunction] -> ShowS #
NFData CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods rnf :: CreateFunction -> () #
Eq CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods (==) :: CreateFunction -> CreateFunction -> Bool # (/=) :: CreateFunction -> CreateFunction -> Bool #
Hashable CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods hashWithSalt :: Int -> CreateFunction -> Int # hash :: CreateFunction -> Int #
type AWSResponse CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction type AWSResponse CreateFunction = CreateFunctionResponse
type Rep CreateFunction Source #
Instance details Defined in Amazonka.AppSync.CreateFunction type Rep CreateFunction = D1 ('MetaData "CreateFunction" "Amazonka.AppSync.CreateFunction" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateFunction'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "code") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "functionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxBatchSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "requestMappingTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "responseMappingTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "runtime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AppSyncRuntime)) :: S1 ('MetaSel ('Just "syncConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SyncConfig)))) :: (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "dataSourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateFunction Source #

Arguments

:: Text	`CreateFunction`
-> Text	`CreateFunction`
-> Text	`CreateFunction`
-> CreateFunction

Create a value of CreateFunction 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:

CreateFunction, createFunction_code - The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

CreateFunction, createFunction_description - The Function description.

CreateFunction, createFunction_functionVersion - The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

CreateFunction, createFunction_maxBatchSize - The maximum batching size for a resolver.

CreateFunction, createFunction_requestMappingTemplate - The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

CreateFunction, createFunction_responseMappingTemplate - The Function response mapping template.

CreateFunction, createFunction_runtime - Undocumented member.

CreateFunction, createFunction_syncConfig - Undocumented member.

CreateFunction, createFunction_apiId - The GraphQL API ID.

CreateFunction, createFunction_name - The Function name. The function name does not have to be unique.

CreateFunction, createFunction_dataSourceName - The Function DataSource name.

Request Lenses

createFunction_code :: Lens' CreateFunction (Maybe Text) Source #

The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.

createFunction_description :: Lens' CreateFunction (Maybe Text) Source #

The Function description.

createFunction_functionVersion :: Lens' CreateFunction (Maybe Text) Source #

The version of the request mapping template. Currently, the supported value is 2018-05-29. Note that when using VTL and mapping templates, the functionVersion is required.

createFunction_maxBatchSize :: Lens' CreateFunction (Maybe Natural) Source #

The maximum batching size for a resolver.

createFunction_requestMappingTemplate :: Lens' CreateFunction (Maybe Text) Source #

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

createFunction_responseMappingTemplate :: Lens' CreateFunction (Maybe Text) Source #

The Function response mapping template.

createFunction_runtime :: Lens' CreateFunction (Maybe AppSyncRuntime) Source #

Undocumented member.

createFunction_syncConfig :: Lens' CreateFunction (Maybe SyncConfig) Source #

Undocumented member.

createFunction_apiId :: Lens' CreateFunction Text Source #

The GraphQL API ID.

createFunction_name :: Lens' CreateFunction Text Source #

The Function name. The function name does not have to be unique.

createFunction_dataSourceName :: Lens' CreateFunction Text Source #

The Function DataSource name.

Destructuring the Response

data CreateFunctionResponse Source #

See: newCreateFunctionResponse smart constructor.

Constructors

CreateFunctionResponse'
Fields functionConfiguration :: Maybe FunctionConfiguration The `Function` object. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateFunctionResponse Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Associated Types type Rep CreateFunctionResponse :: Type -> Type # Methods from :: CreateFunctionResponse -> Rep CreateFunctionResponse x # to :: Rep CreateFunctionResponse x -> CreateFunctionResponse #
Read CreateFunctionResponse Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods readsPrec :: Int -> ReadS CreateFunctionResponse # readList :: ReadS [CreateFunctionResponse] # readPrec :: ReadPrec CreateFunctionResponse # readListPrec :: ReadPrec [CreateFunctionResponse] #
Show CreateFunctionResponse Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods showsPrec :: Int -> CreateFunctionResponse -> ShowS # show :: CreateFunctionResponse -> String # showList :: [CreateFunctionResponse] -> ShowS #
NFData CreateFunctionResponse Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods rnf :: CreateFunctionResponse -> () #
Eq CreateFunctionResponse Source #
Instance details Defined in Amazonka.AppSync.CreateFunction Methods (==) :: CreateFunctionResponse -> CreateFunctionResponse -> Bool # (/=) :: CreateFunctionResponse -> CreateFunctionResponse -> Bool #
type Rep CreateFunctionResponse Source #
Instance details Defined in Amazonka.AppSync.CreateFunction type Rep CreateFunctionResponse = D1 ('MetaData "CreateFunctionResponse" "Amazonka.AppSync.CreateFunction" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" 'False) (C1 ('MetaCons "CreateFunctionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "functionConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FunctionConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFunctionResponse Source #

Arguments

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

Create a value of CreateFunctionResponse 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:

$sel:functionConfiguration:CreateFunctionResponse', createFunctionResponse_functionConfiguration - The Function object.

$sel:httpStatus:CreateFunctionResponse', createFunctionResponse_httpStatus - The response's http status code.

Response Lenses

createFunctionResponse_functionConfiguration :: Lens' CreateFunctionResponse (Maybe FunctionConfiguration) Source #

The Function object.

createFunctionResponse_httpStatus :: Lens' CreateFunctionResponse Int Source #

The response's http status code.