Class: Aws::LexModelBuildingService::Types::PutIntentResponse

Inherits:

Struct

• Object
• Struct
• Aws::LexModelBuildingService::Types::PutIntentResponse

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelbuildingservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #checksum ⇒ String

  Checksum of the ‘$LATEST`version of the intent created or updated.

• #conclusion_statement ⇒ Types::Statement

  After the Lambda function specified in the`fulfillmentActivity`intent fulfills the intent, Amazon Lex conveys this statement to the user.

• #confirmation_prompt ⇒ Types::Prompt

  If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.

• #create_version ⇒ Boolean

  ‘True` if a new version of the intent was created.

• #created_date ⇒ Time

  The date that the intent was created.

• #description ⇒ String

  A description of the intent.

• #dialog_code_hook ⇒ Types::CodeHook

  If defined in the intent, Amazon Lex invokes this Lambda function for each user input.

• #follow_up_prompt ⇒ Types::FollowUpPrompt

  If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

• #fulfillment_activity ⇒ Types::FulfillmentActivity

  If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.

• #input_contexts ⇒ Array<Types::InputContext>

  An array of ‘InputContext` objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

• #kendra_configuration ⇒ Types::KendraConfiguration

  Configuration information, if any, required to connect to an Amazon Kendra index and use the ‘AMAZON.KendraSearchIntent` intent.

• #last_updated_date ⇒ Time

  The date that the intent was updated.

• #name ⇒ String

  The name of the intent.

• #output_contexts ⇒ Array<Types::OutputContext>

  An array of ‘OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.

• #parent_intent_signature ⇒ String

  A unique identifier for the built-in intent that this intent is based on.

• #rejection_statement ⇒ Types::Statement

  If the user answers “no” to the question defined in ‘confirmationPrompt` Amazon Lex responds with this statement to acknowledge that the intent was canceled.

• #sample_utterances ⇒ Array<String>

  An array of sample utterances that are configured for the intent.

• #slots ⇒ Array<Types::Slot>

  An array of intent slots that are configured for the intent.

• #version ⇒ String

  The version of the intent.

Instance Attribute Details

#checksum ⇒ String

Checksum of the ‘$LATEST`version of the intent created or updated.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#conclusion_statement ⇒ Types::Statement

After the Lambda function specified in the`fulfillmentActivity`intent fulfills the intent, Amazon Lex conveys this statement to the user.

Returns:

• (Types::Statement)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#confirmation_prompt ⇒ Types::Prompt

If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.

Returns:

• (Types::Prompt)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#create_version ⇒ Boolean

‘True` if a new version of the intent was created. If the `createVersion` field was not specified in the request, the `createVersion` field is set to false in the response.

Returns:

• (Boolean)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The date that the intent was created.

Returns:

• (Time)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the intent.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#dialog_code_hook ⇒ Types::CodeHook

If defined in the intent, Amazon Lex invokes this Lambda function for each user input.

Returns:

• (Types::CodeHook)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#follow_up_prompt ⇒ Types::FollowUpPrompt

If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

Returns:

• (Types::FollowUpPrompt)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#fulfillment_activity ⇒ Types::FulfillmentActivity

If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.

Returns:

• (Types::FulfillmentActivity)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#input_contexts ⇒ Array<Types::InputContext>

An array of ‘InputContext` objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.

Returns:

• (Array<Types::InputContext>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#kendra_configuration ⇒ Types::KendraConfiguration

Configuration information, if any, required to connect to an Amazon Kendra index and use the ‘AMAZON.KendraSearchIntent` intent.

Returns:

• (Types::KendraConfiguration)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_date ⇒ Time

The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.

Returns:

• (Time)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the intent.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#output_contexts ⇒ Array<Types::OutputContext>

An array of ‘OutputContext` objects that lists the contexts that the intent activates when the intent is fulfilled.

Returns:

• (Array<Types::OutputContext>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#parent_intent_signature ⇒ String

A unique identifier for the built-in intent that this intent is based on.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#rejection_statement ⇒ Types::Statement

If the user answers “no” to the question defined in ‘confirmationPrompt` Amazon Lex responds with this statement to acknowledge that the intent was canceled.

Returns:

• (Types::Statement)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#sample_utterances ⇒ Array<String>

An array of sample utterances that are configured for the intent.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#slots ⇒ Array<Types::Slot>

An array of intent slots that are configured for the intent.

Returns:

• (Array<Types::Slot>)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the intent. For a new intent, the version is always ‘$LATEST`.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelbuildingservice/types.rb', line 3742

class PutIntentResponse < Struct.new(
  :name,
  :description,
  :slots,
  :sample_utterances,
  :confirmation_prompt,
  :rejection_statement,
  :follow_up_prompt,
  :conclusion_statement,
  :dialog_code_hook,
  :fulfillment_activity,
  :parent_intent_signature,
  :last_updated_date,
  :created_date,
  :version,
  :checksum,
  :create_version,
  :kendra_configuration,
  :input_contexts,
  :output_contexts)
  SENSITIVE = []
  include Aws::Structure
end