Class: AWSCDK::Lex::CfnBot::SlotCaptureSettingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
lex/cfn_bot.rb

Overview

Settings used when Amazon Lex successfully captures a slot value from a user.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(capture_conditional: nil, capture_next_step: nil, capture_response: nil, code_hook: nil, elicitation_code_hook: nil, failure_conditional: nil, failure_next_step: nil, failure_response: nil) ⇒ SlotCaptureSettingProperty

Returns a new instance of SlotCaptureSettingProperty.

Parameters:



5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
 
# File 'lex/cfn_bot.rb', line 5242

def initialize(capture_conditional: nil, capture_next_step: nil, capture_response: nil, code_hook: nil, elicitation_code_hook: nil, failure_conditional: nil, failure_next_step: nil, failure_response: nil)
  @capture_conditional = capture_conditional.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ConditionalSpecificationProperty.new(**capture_conditional.transform_keys(&:to_sym)) : capture_conditional
  Jsii::Type.check_type(@capture_conditional, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkNvbmRpdGlvbmFsU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "captureConditional") unless @capture_conditional.nil?
  @capture_next_step = capture_next_step.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::DialogStateProperty.new(**capture_next_step.transform_keys(&:to_sym)) : capture_next_step
  Jsii::Type.check_type(@capture_next_step, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkRpYWxvZ1N0YXRlUHJvcGVydHkifV19fQ==")), "captureNextStep") unless @capture_next_step.nil?
  @capture_response = capture_response.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ResponseSpecificationProperty.new(**capture_response.transform_keys(&:to_sym)) : capture_response
  Jsii::Type.check_type(@capture_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlJlc3BvbnNlU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "captureResponse") unless @capture_response.nil?
  @code_hook = code_hook.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::DialogCodeHookInvocationSettingProperty.new(**code_hook.transform_keys(&:to_sym)) : code_hook
  Jsii::Type.check_type(@code_hook, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkRpYWxvZ0NvZGVIb29rSW52b2NhdGlvblNldHRpbmdQcm9wZXJ0eSJ9XX19")), "codeHook") unless @code_hook.nil?
  @elicitation_code_hook = elicitation_code_hook.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ElicitationCodeHookInvocationSettingProperty.new(**elicitation_code_hook.transform_keys(&:to_sym)) : elicitation_code_hook
  Jsii::Type.check_type(@elicitation_code_hook, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkVsaWNpdGF0aW9uQ29kZUhvb2tJbnZvY2F0aW9uU2V0dGluZ1Byb3BlcnR5In1dfX0=")), "elicitationCodeHook") unless @elicitation_code_hook.nil?
  @failure_conditional = failure_conditional.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ConditionalSpecificationProperty.new(**failure_conditional.transform_keys(&:to_sym)) : failure_conditional
  Jsii::Type.check_type(@failure_conditional, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkNvbmRpdGlvbmFsU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "failureConditional") unless @failure_conditional.nil?
  @failure_next_step = failure_next_step.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::DialogStateProperty.new(**failure_next_step.transform_keys(&:to_sym)) : failure_next_step
  Jsii::Type.check_type(@failure_next_step, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkRpYWxvZ1N0YXRlUHJvcGVydHkifV19fQ==")), "failureNextStep") unless @failure_next_step.nil?
  @failure_response = failure_response.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ResponseSpecificationProperty.new(**failure_response.transform_keys(&:to_sym)) : failure_response
  Jsii::Type.check_type(@failure_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlJlc3BvbnNlU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "failureResponse") unless @failure_response.nil?
end

Instance Attribute Details

#capture_conditional ⇒ AWSCDK::IResolvable, ... (readonly)

A list of conditional branches to evaluate after the slot value is captured.

Returns:

See Also:



5265
5266
5267
 
# File 'lex/cfn_bot.rb', line 5265

def capture_conditional
  @capture_conditional
end

#capture_next_step ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies the next step that the bot runs when the slot value is captured before the code hook times out.

Returns:

See Also:



5270
5271
5272
 
# File 'lex/cfn_bot.rb', line 5270

def capture_next_step
  @capture_next_step
end

#capture_response ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies a list of message groups that Amazon Lex uses to respond the user input.

Returns:

See Also:



5275
5276
5277
 
# File 'lex/cfn_bot.rb', line 5275

def capture_response
  @capture_response
end

#code_hook ⇒ AWSCDK::IResolvable, ... (readonly)

Code hook called after Amazon Lex successfully captures a slot value.

Returns:

See Also:



5280
5281
5282
 
# File 'lex/cfn_bot.rb', line 5280

def code_hook
  @code_hook
end

#elicitation_code_hook ⇒ AWSCDK::IResolvable, ... (readonly)

Code hook called when Amazon Lex doesn't capture a slot value.

Returns:

See Also:



5285
5286
5287
 
# File 'lex/cfn_bot.rb', line 5285

def elicitation_code_hook
  @elicitation_code_hook
end

#failure_conditional ⇒ AWSCDK::IResolvable, ... (readonly)

A list of conditional branches to evaluate when the slot value isn't captured.

Returns:

See Also:



5290
5291
5292
 
# File 'lex/cfn_bot.rb', line 5290

def failure_conditional
  @failure_conditional
end

#failure_next_step ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies the next step that the bot runs when the slot value code is not recognized.

Returns:

See Also:



5295
5296
5297
 
# File 'lex/cfn_bot.rb', line 5295

def failure_next_step
  @failure_next_step
end

#failure_response ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies a list of message groups that Amazon Lex uses to respond the user input when the slot fails to be captured.

Returns:

See Also:



5300
5301
5302
 
# File 'lex/cfn_bot.rb', line 5300

def failure_response
  @failure_response
end

Class Method Details

.jsii_properties ⇒ Object 



5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
 
# File 'lex/cfn_bot.rb', line 5302

def self.jsii_properties
  {
    :capture_conditional => "captureConditional",
    :capture_next_step => "captureNextStep",
    :capture_response => "captureResponse",
    :code_hook => "codeHook",
    :elicitation_code_hook => "elicitationCodeHook",
    :failure_conditional => "failureConditional",
    :failure_next_step => "failureNextStep",
    :failure_response => "failureResponse",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
 
# File 'lex/cfn_bot.rb', line 5315

def to_jsii
  result = {}
  result.merge!({
    "captureConditional" => @capture_conditional,
    "captureNextStep" => @capture_next_step,
    "captureResponse" => @capture_response,
    "codeHook" => @code_hook,
    "elicitationCodeHook" => @elicitation_code_hook,
    "failureConditional" => @failure_conditional,
    "failureNextStep" => @failure_next_step,
    "failureResponse" => @failure_response,
  })
  result.compact
end