You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::LexModelBuildingService::Types::FulfillmentActivity

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

Note:

When making an API call, you may pass FulfillmentActivity data as a hash:

{
  type: "ReturnIntent", # required, accepts ReturnIntent, CodeHook
  code_hook: {
    uri: "LambdaARN", # required
    message_version: "MessageVersion", # required
  },
}

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.

Instance Attribute Summary collapse

Instance Attribute Details

#code_hookTypes::CodeHook

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

Returns:



932
933
934
935
936
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 932

class FulfillmentActivity < Struct.new(
  :type,
  :code_hook)
  include Aws::Structure
end

#typeString

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

Returns:

  • (String)


932
933
934
935
936
# File 'gems/aws-sdk-lexmodelbuildingservice/lib/aws-sdk-lexmodelbuildingservice/types.rb', line 932

class FulfillmentActivity < Struct.new(
  :type,
  :code_hook)
  include Aws::Structure
end