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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Evaluates the given code and returns the response. The code definition requirements depend on the specified runtime. For APPSYNC_JS runtimes, the code defines the request and response functions. The request function takes the incoming request after a GraphQL operation is parsed and converts it into a request configuration for the selected data source operation. The response function interprets responses from the data source and maps it to the shape of the GraphQL field output type.

Synopsis

data EvaluateCode = EvaluateCode' {
- function :: Maybe Text
- runtime :: AppSyncRuntime
- code :: Text
- context :: Text
}
newEvaluateCode :: AppSyncRuntime -> Text -> Text -> EvaluateCode
evaluateCode_function :: Lens' EvaluateCode (Maybe Text)
evaluateCode_runtime :: Lens' EvaluateCode AppSyncRuntime
evaluateCode_code :: Lens' EvaluateCode Text
evaluateCode_context :: Lens' EvaluateCode Text
data EvaluateCodeResponse = EvaluateCodeResponse' {
- error :: Maybe EvaluateCodeErrorDetail
- evaluationResult :: Maybe Text
- logs :: Maybe [Text]
- httpStatus :: Int
}
newEvaluateCodeResponse :: Int -> EvaluateCodeResponse
evaluateCodeResponse_error :: Lens' EvaluateCodeResponse (Maybe EvaluateCodeErrorDetail)
evaluateCodeResponse_evaluationResult :: Lens' EvaluateCodeResponse (Maybe Text)
evaluateCodeResponse_logs :: Lens' EvaluateCodeResponse (Maybe [Text])
evaluateCodeResponse_httpStatus :: Lens' EvaluateCodeResponse Int

Creating a Request

data EvaluateCode Source #

See: newEvaluateCode smart constructor.

Constructors

EvaluateCode'

Fields

function :: Maybe Text
The function within the code to be evaluated. If provided, the valid values are request and response.
runtime :: AppSyncRuntime
The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is supported.
code :: Text
The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.
context :: Text
The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

Instances

Instances details

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

newEvaluateCode Source #

Arguments

:: AppSyncRuntime	`EvaluateCode`
-> Text	`EvaluateCode`
-> Text	`$sel:context:EvaluateCode'`
-> EvaluateCode

Create a value of EvaluateCode 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:function:EvaluateCode', evaluateCode_function - The function within the code to be evaluated. If provided, the valid values are request and response.

EvaluateCode, evaluateCode_runtime - The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is supported.

EvaluateCode, evaluateCode_code - The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.

$sel:context:EvaluateCode', evaluateCode_context - The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

Request Lenses

evaluateCode_function :: Lens' EvaluateCode (Maybe Text) Source #

The function within the code to be evaluated. If provided, the valid values are request and response.

evaluateCode_runtime :: Lens' EvaluateCode AppSyncRuntime Source #

The runtime to be used when evaluating the code. Currently, only the APPSYNC_JS runtime is supported.

evaluateCode_code :: Lens' EvaluateCode Text Source #

The code definition to be evaluated. Note that code and runtime are both required for this action. The runtime value must be APPSYNC_JS.

evaluateCode_context :: Lens' EvaluateCode Text Source #

The map that holds all of the contextual information for your resolver invocation. A context is required for this action.

Destructuring the Response

data EvaluateCodeResponse Source #

See: newEvaluateCodeResponse smart constructor.

Constructors

EvaluateCodeResponse'
Fields error :: Maybe EvaluateCodeErrorDetail Contains the payload of the response error. evaluationResult :: Maybe Text The result of the evaluation operation. logs :: Maybe [Text] A list of logs that were generated by calls to `util.log.info` and `util.log.error` in the evaluated code. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newEvaluateCodeResponse Source #

Arguments

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

Create a value of EvaluateCodeResponse 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:error:EvaluateCodeResponse', evaluateCodeResponse_error - Contains the payload of the response error.

$sel:evaluationResult:EvaluateCodeResponse', evaluateCodeResponse_evaluationResult - The result of the evaluation operation.

$sel:logs:EvaluateCodeResponse', evaluateCodeResponse_logs - A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

$sel:httpStatus:EvaluateCodeResponse', evaluateCodeResponse_httpStatus - The response's http status code.

Response Lenses

evaluateCodeResponse_error :: Lens' EvaluateCodeResponse (Maybe EvaluateCodeErrorDetail) Source #

Contains the payload of the response error.

evaluateCodeResponse_evaluationResult :: Lens' EvaluateCodeResponse (Maybe Text) Source #

The result of the evaluation operation.

evaluateCodeResponse_logs :: Lens' EvaluateCodeResponse (Maybe [Text]) Source #

A list of logs that were generated by calls to util.log.info and util.log.error in the evaluated code.

evaluateCodeResponse_httpStatus :: Lens' EvaluateCodeResponse Int Source #

The response's http status code.