amazonka-lex-models-2.0: Amazon Lex Model Building Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LexModels.Types.FulfillmentActivity

Description

 
Synopsis

Documentation

data FulfillmentActivity Source #

Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.

Consider the following examples:

  • In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.
  • In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.

See: newFulfillmentActivity smart constructor.

Constructors

FulfillmentActivity' 

Fields

  • codeHook :: Maybe CodeHook

    A description of the Lambda function that is run to fulfill the intent.

  • type' :: FulfillmentActivityType

    How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

Instances

Instances details
FromJSON FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

ToJSON FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

Generic FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

Associated Types

type Rep FulfillmentActivity :: Type -> Type #

Read FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

Show FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

NFData FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

Methods

rnf :: FulfillmentActivity -> () #

Eq FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

Hashable FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

type Rep FulfillmentActivity Source # 
Instance details

Defined in Amazonka.LexModels.Types.FulfillmentActivity

type Rep FulfillmentActivity = D1 ('MetaData "FulfillmentActivity" "Amazonka.LexModels.Types.FulfillmentActivity" "amazonka-lex-models-2.0-8Q1WIjnrCCIAMPuyNOCiG7" 'False) (C1 ('MetaCons "FulfillmentActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CodeHook)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 FulfillmentActivityType)))

newFulfillmentActivity Source #

Create a value of FulfillmentActivity 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:codeHook:FulfillmentActivity', fulfillmentActivity_codeHook - A description of the Lambda function that is run to fulfill the intent.

$sel:type':FulfillmentActivity', fulfillmentActivity_type - How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

fulfillmentActivity_codeHook :: Lens' FulfillmentActivity (Maybe CodeHook) Source #

A description of the Lambda function that is run to fulfill the intent.

fulfillmentActivity_type :: Lens' FulfillmentActivity FulfillmentActivityType Source #

How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.