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.UpdateIntent

Description

Updates the settings for an intent.

Synopsis

Creating a Request

data UpdateIntent Source #

See: newUpdateIntent smart constructor.

Constructors

UpdateIntent' 

Fields

Instances

Instances details
ToJSON UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

ToHeaders UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

ToPath UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

ToQuery UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

AWSRequest UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Associated Types

type AWSResponse UpdateIntent #

Generic UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Associated Types

type Rep UpdateIntent :: Type -> Type #

Read UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Show UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

NFData UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Methods

rnf :: UpdateIntent -> () #

Eq UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Hashable UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

type AWSResponse UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

type Rep UpdateIntent Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

type Rep UpdateIntent = D1 ('MetaData "UpdateIntent" "Amazonka.LexV2Models.UpdateIntent" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "UpdateIntent'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dialogCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogCodeHookSettings))) :*: (S1 ('MetaSel ('Just "fulfillmentCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FulfillmentCodeHookSettings)) :*: S1 ('MetaSel ('Just "initialResponseSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InitialResponseSetting)))) :*: ((S1 ('MetaSel ('Just "inputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputContext])) :*: S1 ('MetaSel ('Just "intentClosingSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentClosingSetting))) :*: (S1 ('MetaSel ('Just "intentConfirmationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentConfirmationSetting)) :*: S1 ('MetaSel ('Just "kendraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KendraConfiguration))))) :*: (((S1 ('MetaSel ('Just "outputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputContext])) :*: S1 ('MetaSel ('Just "parentIntentSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SampleUtterance])) :*: S1 ('MetaSel ('Just "slotPriorities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SlotPriority])))) :*: ((S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "intentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newUpdateIntent Source #

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

UpdateIntent, updateIntent_description - The new description of the intent.

UpdateIntent, updateIntent_dialogCodeHook - The new Lambda function to use between each turn of the conversation with the bot.

UpdateIntent, updateIntent_fulfillmentCodeHook - The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

UpdateIntent, updateIntent_initialResponseSetting -

UpdateIntent, updateIntent_inputContexts - A new list of contexts that must be active in order for Amazon Lex to consider the intent.

UpdateIntent, updateIntent_intentClosingSetting - The new response that Amazon Lex sends the user when the intent is closed.

UpdateIntent, updateIntent_intentConfirmationSetting - New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

UpdateIntent, updateIntent_kendraConfiguration - New configuration settings for connecting to an Amazon Kendra index.

UpdateIntent, updateIntent_outputContexts - A new list of contexts that Amazon Lex activates when the intent is fulfilled.

UpdateIntent, updateIntent_parentIntentSignature - The signature of the new built-in intent to use as the parent of this intent.

UpdateIntent, updateIntent_sampleUtterances - New utterances used to invoke the intent.

UpdateIntent, updateIntent_slotPriorities - A new list of slots and their priorities that are contained by the intent.

UpdateIntent, updateIntent_intentId - The unique identifier of the intent to update.

UpdateIntent, updateIntent_intentName - The new name for the intent.

UpdateIntent, updateIntent_botId - The identifier of the bot that contains the intent.

UpdateIntent, updateIntent_botVersion - The version of the bot that contains the intent. Must be DRAFT.

UpdateIntent, updateIntent_localeId - The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

Request Lenses

updateIntent_description :: Lens' UpdateIntent (Maybe Text) Source #

The new description of the intent.

updateIntent_dialogCodeHook :: Lens' UpdateIntent (Maybe DialogCodeHookSettings) Source #

The new Lambda function to use between each turn of the conversation with the bot.

updateIntent_fulfillmentCodeHook :: Lens' UpdateIntent (Maybe FulfillmentCodeHookSettings) Source #

The new Lambda function to call when all of the intents required slots are provided and the intent is ready for fulfillment.

updateIntent_inputContexts :: Lens' UpdateIntent (Maybe [InputContext]) Source #

A new list of contexts that must be active in order for Amazon Lex to consider the intent.

updateIntent_intentClosingSetting :: Lens' UpdateIntent (Maybe IntentClosingSetting) Source #

The new response that Amazon Lex sends the user when the intent is closed.

updateIntent_intentConfirmationSetting :: Lens' UpdateIntent (Maybe IntentConfirmationSetting) Source #

New prompts that Amazon Lex sends to the user to confirm the completion of an intent.

updateIntent_kendraConfiguration :: Lens' UpdateIntent (Maybe KendraConfiguration) Source #

New configuration settings for connecting to an Amazon Kendra index.

updateIntent_outputContexts :: Lens' UpdateIntent (Maybe [OutputContext]) Source #

A new list of contexts that Amazon Lex activates when the intent is fulfilled.

updateIntent_parentIntentSignature :: Lens' UpdateIntent (Maybe Text) Source #

The signature of the new built-in intent to use as the parent of this intent.

updateIntent_sampleUtterances :: Lens' UpdateIntent (Maybe [SampleUtterance]) Source #

New utterances used to invoke the intent.

updateIntent_slotPriorities :: Lens' UpdateIntent (Maybe [SlotPriority]) Source #

A new list of slots and their priorities that are contained by the intent.

updateIntent_intentId :: Lens' UpdateIntent Text Source #

The unique identifier of the intent to update.

updateIntent_intentName :: Lens' UpdateIntent Text Source #

The new name for the intent.

updateIntent_botId :: Lens' UpdateIntent Text Source #

The identifier of the bot that contains the intent.

updateIntent_botVersion :: Lens' UpdateIntent Text Source #

The version of the bot that contains the intent. Must be DRAFT.

updateIntent_localeId :: Lens' UpdateIntent Text Source #

The identifier of the language and locale where this intent is used. The string must match one of the supported locales. For more information, see Supported languages.

Destructuring the Response

data UpdateIntentResponse Source #

See: newUpdateIntentResponse smart constructor.

Constructors

UpdateIntentResponse' 

Fields

Instances

Instances details
Generic UpdateIntentResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Associated Types

type Rep UpdateIntentResponse :: Type -> Type #

Read UpdateIntentResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Show UpdateIntentResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

NFData UpdateIntentResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

Methods

rnf :: UpdateIntentResponse -> () #

Eq UpdateIntentResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

type Rep UpdateIntentResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateIntent

type Rep UpdateIntentResponse = D1 ('MetaData "UpdateIntentResponse" "Amazonka.LexV2Models.UpdateIntent" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "UpdateIntentResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "botVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dialogCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DialogCodeHookSettings))))) :*: ((S1 ('MetaSel ('Just "fulfillmentCodeHook") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FulfillmentCodeHookSettings)) :*: S1 ('MetaSel ('Just "initialResponseSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InitialResponseSetting))) :*: (S1 ('MetaSel ('Just "inputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputContext])) :*: (S1 ('MetaSel ('Just "intentClosingSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentClosingSetting)) :*: S1 ('MetaSel ('Just "intentConfirmationSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntentConfirmationSetting)))))) :*: (((S1 ('MetaSel ('Just "intentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "intentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "kendraConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KendraConfiguration)) :*: (S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "outputContexts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputContext])) :*: S1 ('MetaSel ('Just "parentIntentSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "sampleUtterances") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SampleUtterance])) :*: (S1 ('MetaSel ('Just "slotPriorities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SlotPriority])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))))

newUpdateIntentResponse Source #

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

UpdateIntent, updateIntentResponse_botId - The identifier of the bot that contains the intent.

UpdateIntent, updateIntentResponse_botVersion - The version of the bot that contains the intent. Will always be DRAFT.

UpdateIntentResponse, updateIntentResponse_creationDateTime - A timestamp of when the intent was created.

UpdateIntent, updateIntentResponse_description - The updated description of the intent.

UpdateIntent, updateIntentResponse_dialogCodeHook - The updated Lambda function called during each turn of the conversation with the user.

UpdateIntent, updateIntentResponse_fulfillmentCodeHook - The updated Lambda function called when the intent is ready for fulfillment.

UpdateIntent, updateIntentResponse_initialResponseSetting -

UpdateIntent, updateIntentResponse_inputContexts - The updated list of contexts that must be active for the intent to be considered by Amazon Lex.

UpdateIntent, updateIntentResponse_intentClosingSetting - The updated response that Amazon Lex sends the user when the intent is closed.

UpdateIntent, updateIntentResponse_intentConfirmationSetting - The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.

UpdateIntent, updateIntentResponse_intentId - The identifier of the intent that was updated.

UpdateIntent, updateIntentResponse_intentName - The updated name of the intent.

UpdateIntent, updateIntentResponse_kendraConfiguration - The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

UpdateIntentResponse, updateIntentResponse_lastUpdatedDateTime - A timestamp of the last time that the intent was modified.

UpdateIntent, updateIntentResponse_localeId - The updated language and locale of the intent.

UpdateIntent, updateIntentResponse_outputContexts - The updated list of contexts that Amazon Lex activates when the intent is fulfilled.

UpdateIntent, updateIntentResponse_parentIntentSignature - The updated built-in intent that is the parent of this intent.

UpdateIntent, updateIntentResponse_sampleUtterances - The updated list of sample utterances for the intent.

UpdateIntent, updateIntentResponse_slotPriorities - The updated list of slots and their priorities that are elicited from the user for the intent.

$sel:httpStatus:UpdateIntentResponse', updateIntentResponse_httpStatus - The response's http status code.

Response Lenses

updateIntentResponse_botId :: Lens' UpdateIntentResponse (Maybe Text) Source #

The identifier of the bot that contains the intent.

updateIntentResponse_botVersion :: Lens' UpdateIntentResponse (Maybe Text) Source #

The version of the bot that contains the intent. Will always be DRAFT.

updateIntentResponse_creationDateTime :: Lens' UpdateIntentResponse (Maybe UTCTime) Source #

A timestamp of when the intent was created.

updateIntentResponse_description :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated description of the intent.

updateIntentResponse_dialogCodeHook :: Lens' UpdateIntentResponse (Maybe DialogCodeHookSettings) Source #

The updated Lambda function called during each turn of the conversation with the user.

updateIntentResponse_fulfillmentCodeHook :: Lens' UpdateIntentResponse (Maybe FulfillmentCodeHookSettings) Source #

The updated Lambda function called when the intent is ready for fulfillment.

updateIntentResponse_inputContexts :: Lens' UpdateIntentResponse (Maybe [InputContext]) Source #

The updated list of contexts that must be active for the intent to be considered by Amazon Lex.

updateIntentResponse_intentClosingSetting :: Lens' UpdateIntentResponse (Maybe IntentClosingSetting) Source #

The updated response that Amazon Lex sends the user when the intent is closed.

updateIntentResponse_intentConfirmationSetting :: Lens' UpdateIntentResponse (Maybe IntentConfirmationSetting) Source #

The updated prompts that Amazon Lex sends to the user to confirm the completion of an intent.

updateIntentResponse_intentId :: Lens' UpdateIntentResponse (Maybe Text) Source #

The identifier of the intent that was updated.

updateIntentResponse_kendraConfiguration :: Lens' UpdateIntentResponse (Maybe KendraConfiguration) Source #

The updated configuration for connecting to an Amazon Kendra index with the AMAZON.KendraSearchIntent intent.

updateIntentResponse_lastUpdatedDateTime :: Lens' UpdateIntentResponse (Maybe UTCTime) Source #

A timestamp of the last time that the intent was modified.

updateIntentResponse_localeId :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated language and locale of the intent.

updateIntentResponse_outputContexts :: Lens' UpdateIntentResponse (Maybe [OutputContext]) Source #

The updated list of contexts that Amazon Lex activates when the intent is fulfilled.

updateIntentResponse_parentIntentSignature :: Lens' UpdateIntentResponse (Maybe Text) Source #

The updated built-in intent that is the parent of this intent.

updateIntentResponse_sampleUtterances :: Lens' UpdateIntentResponse (Maybe [SampleUtterance]) Source #

The updated list of sample utterances for the intent.

updateIntentResponse_slotPriorities :: Lens' UpdateIntentResponse (Maybe [SlotPriority]) Source #

The updated list of slots and their priorities that are elicited from the user for the intent.