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

Description

Updates the settings that a bot has for a specific locale.

Synopsis

Creating a Request

data UpdateBotLocale Source #

See: newUpdateBotLocale smart constructor.

Constructors

UpdateBotLocale' 

Fields

  • description :: Maybe Text

    The new description of the locale.

  • voiceSettings :: Maybe VoiceSettings

    The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

  • botId :: Text

    The unique identifier of the bot that contains the locale.

  • botVersion :: Text

    The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

  • localeId :: Text

    The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

  • nluIntentConfidenceThreshold :: Double

    The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

Instances

Instances details
ToJSON UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

ToHeaders UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

ToPath UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

ToQuery UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

AWSRequest UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Associated Types

type AWSResponse UpdateBotLocale #

Generic UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Associated Types

type Rep UpdateBotLocale :: Type -> Type #

Read UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Show UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

NFData UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Methods

rnf :: UpdateBotLocale -> () #

Eq UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Hashable UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

type AWSResponse UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

type Rep UpdateBotLocale Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

type Rep UpdateBotLocale = D1 ('MetaData "UpdateBotLocale" "Amazonka.LexV2Models.UpdateBotLocale" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "UpdateBotLocale'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "voiceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceSettings)) :*: 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) :*: S1 ('MetaSel ('Just "nluIntentConfidenceThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double)))))

newUpdateBotLocale Source #

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

UpdateBotLocale, updateBotLocale_description - The new description of the locale.

UpdateBotLocale, updateBotLocale_voiceSettings - The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

UpdateBotLocale, updateBotLocale_botId - The unique identifier of the bot that contains the locale.

UpdateBotLocale, updateBotLocale_botVersion - The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

UpdateBotLocale, updateBotLocale_localeId - The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

UpdateBotLocale, updateBotLocale_nluIntentConfidenceThreshold - The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

Request Lenses

updateBotLocale_description :: Lens' UpdateBotLocale (Maybe Text) Source #

The new description of the locale.

updateBotLocale_voiceSettings :: Lens' UpdateBotLocale (Maybe VoiceSettings) Source #

The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

updateBotLocale_botId :: Lens' UpdateBotLocale Text Source #

The unique identifier of the bot that contains the locale.

updateBotLocale_botVersion :: Lens' UpdateBotLocale Text Source #

The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

updateBotLocale_localeId :: Lens' UpdateBotLocale Text Source #

The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

updateBotLocale_nluIntentConfidenceThreshold :: Lens' UpdateBotLocale Double Source #

The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

Destructuring the Response

data UpdateBotLocaleResponse Source #

See: newUpdateBotLocaleResponse smart constructor.

Constructors

UpdateBotLocaleResponse' 

Fields

Instances

Instances details
Generic UpdateBotLocaleResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Associated Types

type Rep UpdateBotLocaleResponse :: Type -> Type #

Read UpdateBotLocaleResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Show UpdateBotLocaleResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

NFData UpdateBotLocaleResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

Methods

rnf :: UpdateBotLocaleResponse -> () #

Eq UpdateBotLocaleResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

type Rep UpdateBotLocaleResponse Source # 
Instance details

Defined in Amazonka.LexV2Models.UpdateBotLocale

type Rep UpdateBotLocaleResponse = D1 ('MetaData "UpdateBotLocaleResponse" "Amazonka.LexV2Models.UpdateBotLocale" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "UpdateBotLocaleResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "botId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "botLocaleStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BotLocaleStatus)) :*: 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 "failureReasons") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 ('MetaSel ('Just "lastUpdatedDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "localeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "localeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "nluIntentConfidenceThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "recommendedActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "voiceSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VoiceSettings)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newUpdateBotLocaleResponse Source #

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

UpdateBotLocale, updateBotLocaleResponse_botId - The identifier of the bot that contains the updated locale.

UpdateBotLocaleResponse, updateBotLocaleResponse_botLocaleStatus - The current status of the locale. When the bot status is Built the locale is ready for use.

UpdateBotLocale, updateBotLocaleResponse_botVersion - The version of the bot that contains the updated locale.

UpdateBotLocaleResponse, updateBotLocaleResponse_creationDateTime - A timestamp of the date and time that the locale was created.

UpdateBotLocale, updateBotLocaleResponse_description - The updated description of the locale.

$sel:failureReasons:UpdateBotLocaleResponse', updateBotLocaleResponse_failureReasons - If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

UpdateBotLocaleResponse, updateBotLocaleResponse_lastUpdatedDateTime - A timestamp of the date and time that the locale was last updated.

UpdateBotLocale, updateBotLocaleResponse_localeId - The language and locale of the updated bot locale.

UpdateBotLocaleResponse, updateBotLocaleResponse_localeName - The updated locale name for the locale.

UpdateBotLocale, updateBotLocaleResponse_nluIntentConfidenceThreshold - The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

$sel:recommendedActions:UpdateBotLocaleResponse', updateBotLocaleResponse_recommendedActions - Recommended actions to take to resolve an error in the failureReasons field.

UpdateBotLocale, updateBotLocaleResponse_voiceSettings - The updated Amazon Polly voice to use for voice interaction with the user.

$sel:httpStatus:UpdateBotLocaleResponse', updateBotLocaleResponse_httpStatus - The response's http status code.

Response Lenses

updateBotLocaleResponse_botId :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The identifier of the bot that contains the updated locale.

updateBotLocaleResponse_botLocaleStatus :: Lens' UpdateBotLocaleResponse (Maybe BotLocaleStatus) Source #

The current status of the locale. When the bot status is Built the locale is ready for use.

updateBotLocaleResponse_botVersion :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The version of the bot that contains the updated locale.

updateBotLocaleResponse_creationDateTime :: Lens' UpdateBotLocaleResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the locale was created.

updateBotLocaleResponse_failureReasons :: Lens' UpdateBotLocaleResponse (Maybe [Text]) Source #

If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

updateBotLocaleResponse_lastUpdatedDateTime :: Lens' UpdateBotLocaleResponse (Maybe UTCTime) Source #

A timestamp of the date and time that the locale was last updated.

updateBotLocaleResponse_localeId :: Lens' UpdateBotLocaleResponse (Maybe Text) Source #

The language and locale of the updated bot locale.

updateBotLocaleResponse_nluIntentConfidenceThreshold :: Lens' UpdateBotLocaleResponse (Maybe Double) Source #

The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

updateBotLocaleResponse_recommendedActions :: Lens' UpdateBotLocaleResponse (Maybe [Text]) Source #

Recommended actions to take to resolve an error in the failureReasons field.

updateBotLocaleResponse_voiceSettings :: Lens' UpdateBotLocaleResponse (Maybe VoiceSettings) Source #

The updated Amazon Polly voice to use for voice interaction with the user.