Class: AWSCDK::Lex::CfnBot::IntentConfirmationSettingProperty

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

Overview

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(prompt_specification:, code_hook: nil, confirmation_conditional: nil, confirmation_next_step: nil, confirmation_response: nil, declination_conditional: nil, declination_next_step: nil, declination_response: nil, elicitation_code_hook: nil, failure_conditional: nil, failure_next_step: nil, failure_response: nil, is_active: nil) ⇒ IntentConfirmationSettingProperty

Returns a new instance of IntentConfirmationSettingProperty.

Parameters:



3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
 
# File 'lex/cfn_bot.rb', line 3298

def initialize(prompt_specification:, code_hook: nil, confirmation_conditional: nil, confirmation_next_step: nil, confirmation_response: nil, declination_conditional: nil, declination_next_step: nil, declination_response: nil, elicitation_code_hook: nil, failure_conditional: nil, failure_next_step: nil, failure_response: nil, is_active: nil)
  @prompt_specification = prompt_specification.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::PromptSpecificationProperty.new(**prompt_specification.transform_keys(&:to_sym)) : prompt_specification
  Jsii::Type.check_type(@prompt_specification, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlByb21wdFNwZWNpZmljYXRpb25Qcm9wZXJ0eSJ9XX19")), "promptSpecification")
  @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?
  @confirmation_conditional = confirmation_conditional.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ConditionalSpecificationProperty.new(**confirmation_conditional.transform_keys(&:to_sym)) : confirmation_conditional
  Jsii::Type.check_type(@confirmation_conditional, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkNvbmRpdGlvbmFsU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "confirmationConditional") unless @confirmation_conditional.nil?
  @confirmation_next_step = confirmation_next_step.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::DialogStateProperty.new(**confirmation_next_step.transform_keys(&:to_sym)) : confirmation_next_step
  Jsii::Type.check_type(@confirmation_next_step, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkRpYWxvZ1N0YXRlUHJvcGVydHkifV19fQ==")), "confirmationNextStep") unless @confirmation_next_step.nil?
  @confirmation_response = confirmation_response.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ResponseSpecificationProperty.new(**confirmation_response.transform_keys(&:to_sym)) : confirmation_response
  Jsii::Type.check_type(@confirmation_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlJlc3BvbnNlU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "confirmationResponse") unless @confirmation_response.nil?
  @declination_conditional = declination_conditional.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ConditionalSpecificationProperty.new(**declination_conditional.transform_keys(&:to_sym)) : declination_conditional
  Jsii::Type.check_type(@declination_conditional, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkNvbmRpdGlvbmFsU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "declinationConditional") unless @declination_conditional.nil?
  @declination_next_step = declination_next_step.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::DialogStateProperty.new(**declination_next_step.transform_keys(&:to_sym)) : declination_next_step
  Jsii::Type.check_type(@declination_next_step, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LkRpYWxvZ1N0YXRlUHJvcGVydHkifV19fQ==")), "declinationNextStep") unless @declination_next_step.nil?
  @declination_response = declination_response.is_a?(Hash) ? ::AWSCDK::Lex::CfnBot::ResponseSpecificationProperty.new(**declination_response.transform_keys(&:to_sym)) : declination_response
  Jsii::Type.check_type(@declination_response, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19sZXguQ2ZuQm90LlJlc3BvbnNlU3BlY2lmaWNhdGlvblByb3BlcnR5In1dfX0=")), "declinationResponse") unless @declination_response.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?
  @is_active = is_active
  Jsii::Type.check_type(@is_active, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "isActive") unless @is_active.nil?
end

Instance Attribute Details

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

The DialogCodeHookInvocationSetting object associated with intent's confirmation step.

The dialog code hook is triggered based on these invocation settings when the confirmation next step or declination next step or failure next step is InvokeDialogCodeHook .

Returns:

See Also:



3340
3341
3342
 
# File 'lex/cfn_bot.rb', line 3340

def code_hook
  @code_hook
end

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

A list of conditional branches to evaluate after the intent is closed.

Returns:

See Also:



3345
3346
3347
 
# File 'lex/cfn_bot.rb', line 3345

def confirmation_conditional
  @confirmation_conditional
end

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

Specifies the next step that the bot executes when the customer confirms the intent.

Returns:

See Also:



3350
3351
3352
 
# File 'lex/cfn_bot.rb', line 3350

def confirmation_next_step
  @confirmation_next_step
end

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

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

Returns:

See Also:



3355
3356
3357
 
# File 'lex/cfn_bot.rb', line 3355

def confirmation_response
  @confirmation_response
end

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

A list of conditional branches to evaluate after the intent is declined.

Returns:

See Also:



3360
3361
3362
 
# File 'lex/cfn_bot.rb', line 3360

def declination_conditional
  @declination_conditional
end

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

Specifies the next step that the bot executes when the customer declines the intent.

Returns:

See Also:



3365
3366
3367
 
# File 'lex/cfn_bot.rb', line 3365

def declination_next_step
  @declination_next_step
end

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

When the user answers "no" to the question defined in promptSpecification , Amazon Lex responds with this response to acknowledge that the intent was canceled.

Returns:

See Also:



3370
3371
3372
 
# File 'lex/cfn_bot.rb', line 3370

def declination_response
  @declination_response
end

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

The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

Returns:

See Also:



3375
3376
3377
 
# File 'lex/cfn_bot.rb', line 3375

def elicitation_code_hook
  @elicitation_code_hook
end

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

Provides a list of conditional branches.

Branches are evaluated in the order that they are entered in the list. The first branch with a condition that evaluates to true is executed. The last branch in the list is the default branch. The default branch should not have any condition expression. The default branch is executed if no other branch has a matching condition.

Returns:

See Also:



3382
3383
3384
 
# File 'lex/cfn_bot.rb', line 3382

def failure_conditional
  @failure_conditional
end

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

The next step to take in the conversation if the confirmation step fails.

Returns:

See Also:



3387
3388
3389
 
# File 'lex/cfn_bot.rb', line 3387

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 intent confirmation fails.

Returns:

See Also:



3392
3393
3394
 
# File 'lex/cfn_bot.rb', line 3392

def failure_response
  @failure_response
end

#is_active ⇒ Boolean, ... (readonly)

Specifies whether the intent's confirmation is sent to the user.

When this field is false, confirmation and declination responses aren't sent. If the IsActive field isn't specified, the default is true.

Returns:

See Also:



3399
3400
3401
 
# File 'lex/cfn_bot.rb', line 3399

def is_active
  @is_active
end

#prompt_specification ⇒ AWSCDK::IResolvable, AWSCDK::Lex::CfnBot::PromptSpecificationProperty (readonly)

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

Returns:

See Also:



3333
3334
3335
 
# File 'lex/cfn_bot.rb', line 3333

def prompt_specification
  @prompt_specification
end

Class Method Details

.jsii_properties ⇒ Object 



3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
 
# File 'lex/cfn_bot.rb', line 3401

def self.jsii_properties
  {
    :prompt_specification => "promptSpecification",
    :code_hook => "codeHook",
    :confirmation_conditional => "confirmationConditional",
    :confirmation_next_step => "confirmationNextStep",
    :confirmation_response => "confirmationResponse",
    :declination_conditional => "declinationConditional",
    :declination_next_step => "declinationNextStep",
    :declination_response => "declinationResponse",
    :elicitation_code_hook => "elicitationCodeHook",
    :failure_conditional => "failureConditional",
    :failure_next_step => "failureNextStep",
    :failure_response => "failureResponse",
    :is_active => "isActive",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'lex/cfn_bot.rb', line 3419

def to_jsii
  result = {}
  result.merge!({
    "promptSpecification" => @prompt_specification,
    "codeHook" => @code_hook,
    "confirmationConditional" => @confirmation_conditional,
    "confirmationNextStep" => @confirmation_next_step,
    "confirmationResponse" => @confirmation_response,
    "declinationConditional" => @declination_conditional,
    "declinationNextStep" => @declination_next_step,
    "declinationResponse" => @declination_response,
    "elicitationCodeHook" => @elicitation_code_hook,
    "failureConditional" => @failure_conditional,
    "failureNextStep" => @failure_next_step,
    "failureResponse" => @failure_response,
    "isActive" => @is_active,
  })
  result.compact
end