amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 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.LexV2Models.Types.IntentConfirmationSetting

Description

 
Synopsis

Documentation

data IntentConfirmationSetting Source #

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

See: newIntentConfirmationSetting smart constructor.

Constructors

IntentConfirmationSetting' 

Fields

Instances

Instances details
FromJSON IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

ToJSON IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

Generic IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

Associated Types

type Rep IntentConfirmationSetting :: Type -> Type #

Read IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

Show IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

NFData IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

Eq IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

Hashable IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

type Rep IntentConfirmationSetting Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.IntentConfirmationSetting

type Rep IntentConfirmationSetting = D1 ('MetaData "IntentConfirmationSetting" "Amazonka.LexV2Models.Types.IntentConfirmationSetting" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "IntentConfirmationSetting'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "active") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "codeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogCodeHookInvocationSetting)) :*: S1 ('MetaSel ('Just "confirmationConditional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionalSpecification)))) :*: (S1 ('MetaSel ('Just "confirmationNextStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogState)) :*: (S1 ('MetaSel ('Just "confirmationResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResponseSpecification)) :*: S1 ('MetaSel ('Just "declinationConditional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionalSpecification))))) :*: ((S1 ('MetaSel ('Just "declinationNextStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogState)) :*: (S1 ('MetaSel ('Just "declinationResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResponseSpecification)) :*: S1 ('MetaSel ('Just "elicitationCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElicitationCodeHookInvocationSetting)))) :*: ((S1 ('MetaSel ('Just "failureConditional") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConditionalSpecification)) :*: S1 ('MetaSel ('Just "failureNextStep") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogState))) :*: (S1 ('MetaSel ('Just "failureResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResponseSpecification)) :*: S1 ('MetaSel ('Just "promptSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PromptSpecification))))))

newIntentConfirmationSetting Source #

Create a value of IntentConfirmationSetting 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:

IntentConfirmationSetting, intentConfirmationSetting_active - 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 active field isn't specified, the default is true.

$sel:codeHook:IntentConfirmationSetting', intentConfirmationSetting_codeHook - 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.

$sel:confirmationConditional:IntentConfirmationSetting', intentConfirmationSetting_confirmationConditional - A list of conditional branches to evaluate after the intent is closed.

$sel:confirmationNextStep:IntentConfirmationSetting', intentConfirmationSetting_confirmationNextStep - Specifies the next step that the bot executes when the customer confirms the intent.

$sel:confirmationResponse:IntentConfirmationSetting', intentConfirmationSetting_confirmationResponse - Undocumented member.

$sel:declinationConditional:IntentConfirmationSetting', intentConfirmationSetting_declinationConditional - A list of conditional branches to evaluate after the intent is declined.

$sel:declinationNextStep:IntentConfirmationSetting', intentConfirmationSetting_declinationNextStep - Specifies the next step that the bot executes when the customer declines the intent.

$sel:declinationResponse:IntentConfirmationSetting', intentConfirmationSetting_declinationResponse - When the user answers "no" to the question defined in promptSpecification, Amazon Lex responds with this response to acknowledge that the intent was canceled.

$sel:elicitationCodeHook:IntentConfirmationSetting', intentConfirmationSetting_elicitationCodeHook - The DialogCodeHookInvocationSetting used when the code hook is invoked during confirmation prompt retries.

$sel:failureConditional:IntentConfirmationSetting', intentConfirmationSetting_failureConditional - Undocumented member.

$sel:failureNextStep:IntentConfirmationSetting', intentConfirmationSetting_failureNextStep - The next step to take in the conversation if the confirmation step fails.

$sel:failureResponse:IntentConfirmationSetting', intentConfirmationSetting_failureResponse - Undocumented member.

$sel:promptSpecification:IntentConfirmationSetting', intentConfirmationSetting_promptSpecification - 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.

intentConfirmationSetting_active :: Lens' IntentConfirmationSetting (Maybe Bool) Source #

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 active field isn't specified, the default is true.

intentConfirmationSetting_codeHook :: Lens' IntentConfirmationSetting (Maybe DialogCodeHookInvocationSetting) Source #

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.

intentConfirmationSetting_confirmationConditional :: Lens' IntentConfirmationSetting (Maybe ConditionalSpecification) Source #

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

intentConfirmationSetting_confirmationNextStep :: Lens' IntentConfirmationSetting (Maybe DialogState) Source #

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

intentConfirmationSetting_declinationConditional :: Lens' IntentConfirmationSetting (Maybe ConditionalSpecification) Source #

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

intentConfirmationSetting_declinationNextStep :: Lens' IntentConfirmationSetting (Maybe DialogState) Source #

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

intentConfirmationSetting_declinationResponse :: Lens' IntentConfirmationSetting (Maybe ResponseSpecification) Source #

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

intentConfirmationSetting_elicitationCodeHook :: Lens' IntentConfirmationSetting (Maybe ElicitationCodeHookInvocationSetting) Source #

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

intentConfirmationSetting_failureNextStep :: Lens' IntentConfirmationSetting (Maybe DialogState) Source #

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

intentConfirmationSetting_promptSpecification :: Lens' IntentConfirmationSetting PromptSpecification Source #

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.